# -------------------------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for license information. # -------------------------------------------------------------------------------------------- from knack.help_files import helps def load_team_help(): helps['devops'] = """ type: group short-summary: Manage Azure DevOps organization level operations. long-summary: | Related Groups az pipelines: Manage Azure Pipelines az boards: Manage Azure Boards az repos: Manage Azure Repos az artifacts: Manage Azure Artifacts """ helps['devops project'] = """ type: group short-summary: Manage team projects. """ helps['devops service-endpoint'] = """ type: group short-summary: Manage service endpoints/connections """ helps['devops service-endpoint create'] = """ type: command short-summary: Create a service endpoint using configuration file. long-summary: You can learn more about this at https://aka.ms/azure-devops-service-endpoint-config """ helps['devops service-endpoint azurerm'] = """ type: group short-summary: Manage Azure RM service endpoints/connections """ helps['devops service-endpoint azurerm create'] = """ type: command short-summary: Create an Azure RM type service endpoint. long-summary: For automation, set service principal password/secret in AZURE_DEVOPS_EXT_AZURE_RM_SERVICE_PRINCIPAL_KEY environment variable. You can learn more about this at https://aka.ms/azure-devops-cli-azurerm-service-endpoint """ helps['devops service-endpoint github'] = """ type: group short-summary: Manage GitHub service endpoints/connections """ helps['devops service-endpoint github create'] = """ type: command short-summary: Create a GitHub service endpoint. long-summary: For automation, set GitHub PAT token in AZURE_DEVOPS_EXT_GITHUB_PAT environment variable. You can learn more about this at https://aka.ms/azure-devops-cli-service-endpoint """ helps['devops security'] = """ type: group short-summary: Manage security related operations """ helps['devops security group'] = """ type: group short-summary: Manage security groups """ helps['devops security group create'] = """ type: command short-summary: Create a new Azure DevOps group. long-summary: examples: - name: Create an Azure DevOps Group with name and description text: | az devops security group create --name 'Some group name' --description 'Something to describe this group' - name: Add an existing AAD group to an Azure DevOps group text: | Get object ID of an existing AAD group az ad group show -g '{Group Name}' az devops security group create --origin-id '{Object ID}' --groups 'vssgp.someDescriptorForGroup' - name: Add an existing AAD group to an Azure DevOps group with AAD group Email ID text: | az devops security group create --email-id '{Email ID of AAD group}' --groups 'vssgp.someDescriptorForGroup' - name: Create a new Azure DevOps group and add it to existing Azure DevOps groups. text: | az devops security group create --name 'Some group name' --groups 'vssgp.someDescriptorForGroupOne,vssgp.someDescriptorForGroupTwo' """ helps['devops security group membership'] = """ type: group short-summary: Manage memberships for security groups """ helps['devops security permission'] = """ type: group short-summary: Manage security permissions """ helps['devops security permission namespace'] = """ type: group short-summary: Manage security namespaces """ helps['devops security permission update'] = """ type: command short-summary: Assign allow or deny permission to given user/group. long-summary: Learn more at https://aka.ms/azure-devops-cli-security-permission examples: - name: Assign view, edit and delete permission for team projects. text: | az devops security permission update --allow-bit 7 --namespace-id\ 52d39943-cb85-4d7f-8fa8-c6baac873819 --subject user@fabrikam.com\ --token "`$PROJECT:vstfs:///Classification/TeamProject/e479xxxx-2be8-xxxx-bb0b-3a0209cxxxx" You would need to add the bit value of the various permission bits to simultaneously allow/deny multiple permissions. """ helps['devops team'] = """ type: group short-summary: Manage teams """ helps['devops user'] = """ type: group short-summary: Manage users """ helps['devops extension'] = """ type: group short-summary: Manage extensions """ helps['devops invoke'] = """ type: command short-summary: This command will invoke request for any DevOps area and resource. Please use only json output as the response of this command is not fixed. Helpful docs - https://docs.microsoft.com/en-us/rest/api/azure/devops/ long-summary: examples: - name: Discover areas related to 'Wiki' text: | az devops invoke --query "[?contains(area,'wiki')]" - name: Get all wikis in a project text: | az devops invoke --area wiki --resource wikis --route-parameters project={Project Name} -o json az devops invoke --area wiki --resource wikis --route-parameters project=WikiIssue -o json - name: Add page to a wiki text: | az devops invoke --area wiki --resource pages --route-parameters project={Project Name} wikiIdentifier={Wiki Id} --in-file {Full File Path containing text to add to wiki} --query-parameters path={Page Path In Wiki} --http-method PUT --api-version 5.1-preview -o json az devops invoke --area wiki --resource pages --route-parameters project=WikiIssue wikiIdentifier=e479f402-2be8-4953-bb0b-3a0209cbc2d2 --in-file D:/temp/createWikiRequestBody.txt --encoding 'utf-8' --query-parameters path=sample738 --http-method PUT --api-version 5.1-preview -o json """ helps['devops wiki'] = """ type: group short-summary: Manage wikis """ helps['devops wiki create'] = """ type: command examples: - name: Create a project wiki text: | az devops wiki create --name myprojectwiki - name: Create a code wiki from a folder in a code repository text: | az devops wiki create --name WIKI_NAME --type codewiki --version BRANCH_NAME --repository REPO_NAME --mapped-path PATH_TO_PUBLISH """ helps['devops wiki list'] = """ type: command examples: - name: List all wikis for a project text: | az devops wiki list - name: List all wikis in the organization text: | az devops wiki list --scope organization """ helps['devops wiki page'] = """ type: group short-summary: Manage wiki pages """ helps['devops wiki page create'] = """ type: command examples: - name: Create a new page with path 'my page' in a wiki named 'myprojectwiki' with inline content text: | az devops wiki page create --path 'my page' --wiki myprojectwiki --content "Hello World" - name: Create a new page with path 'my page' in a wiki named 'myprojectwiki' with content from a file text: | az devops wiki page create --path 'my page' --wiki myprojectwiki --file-path a.txt\ --encoding utf-8 """ helps['devops wiki page update'] = """ type: command examples: - name: Update content of page with path 'my page' in a wiki named 'myprojectwiki' with inline content text: | az devops wiki page update --path 'my page' --wiki myprojectwiki --content "Hello World"\ --version 4ae78ad5835cb7dd55072fe210c9ee7eb6d6413b - name: Update content of page with path 'my page' in a wiki with content from a file text: | az devops wiki page update --path 'my page' --wiki myprojectwiki --file-path a.txt\ --encoding utf-8 --version 4ae78ad5835cb7dd55072fe210c9ee7eb6d6413b """