az devops

Reference

Note

This reference is part of the azure-devops extension for the Azure CLI (version 2.30.0 or higher). The extension will automatically install the first time you run an az devops command. Learn more about extensions.

Manage Azure DevOps organization level operations.

Related Groups az pipelines: Manage Azure Pipelines az boards: Manage Azure Boards az repos: Manage Azure Repos az artifacts: Manage Azure Artifacts.

Commands

Name	Description	Type	Status
az devops admin	Manage administration operations.	Extension	GA
az devops admin banner	Manage organization banner.	Extension	GA
az devops admin banner add	Add a new banner and immediately show it.	Extension	GA
az devops admin banner list	List banners.	Extension	GA
az devops admin banner remove	Remove a banner.	Extension	GA
az devops admin banner show	Show details for a banner.	Extension	GA
az devops admin banner update	Update the message, level, or expiration date for a banner.	Extension	GA
az devops configure	Configure the Azure DevOps CLI or view your configuration.	Extension	GA
az devops extension	Manage extensions.	Extension	GA
az devops extension disable	Disable an extension.	Extension	GA
az devops extension enable	Enable an extension.	Extension	GA
az devops extension install	Install an extension.	Extension	GA
az devops extension list	List extensions installed in an organization.	Extension	GA
az devops extension search	Search extensions from marketplace.	Extension	GA
az devops extension show	Get detail of single extension.	Extension	GA
az devops extension uninstall	Uninstall an extension.	Extension	GA
az devops feedback	Displays information on how to provide feedback to the Azure DevOps CLI team.	Extension	Deprecated
az devops invoke	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/.	Extension	GA
az devops login	Set the credential (PAT) to use for a particular organization.	Extension	GA
az devops logout	Clear the credential for all or a particular organization.	Extension	GA
az devops project	Manage team projects.	Extension	GA
az devops project create	Create a team project.	Extension	GA
az devops project delete	Delete team project.	Extension	GA
az devops project list	List team projects.	Extension	GA
az devops project show	Show team project.	Extension	GA
az devops security	Manage security related operations.	Extension	GA
az devops security group	Manage security groups.	Extension	GA
az devops security group create	Create a new Azure DevOps group.	Extension	GA
az devops security group delete	Delete an Azure DevOps group.	Extension	GA
az devops security group list	List all the groups in a project or organization.	Extension	GA
az devops security group membership	Manage memberships for security groups.	Extension	GA
az devops security group membership add	Add membership.	Extension	GA
az devops security group membership list	List memberships for a group or user.	Extension	GA
az devops security group membership remove	Remove membership.	Extension	GA
az devops security group show	Show group details.	Extension	GA
az devops security group update	Update name AND/OR description for an Azure DevOps group.	Extension	GA
az devops security permission	Manage security permissions.	Extension	GA
az devops security permission list	List tokens for given user/group and namespace.	Extension	GA
az devops security permission namespace	Manage security namespaces.	Extension	GA
az devops security permission namespace list	List all available namespaces for an organization.	Extension	GA
az devops security permission namespace show	Show details of permissions available in each namespace.	Extension	GA
az devops security permission reset	Reset permission for given permission bit(s).	Extension	GA
az devops security permission reset-all	Clear all permissions of this token for a user/group.	Extension	GA
az devops security permission show	Show permissions for given token, namespace and user/group.	Extension	GA
az devops security permission update	Assign allow or deny permission to given user/group.	Extension	GA
az devops service-endpoint	Manage service endpoints/connections.	Extension	GA
az devops service-endpoint azurerm	Manage Azure RM service endpoints/connections.	Extension	GA
az devops service-endpoint azurerm create	Create an Azure RM type service endpoint.	Extension	GA
az devops service-endpoint create	Create a service endpoint using configuration file.	Extension	GA
az devops service-endpoint delete	Deletes service endpoint.	Extension	GA
az devops service-endpoint github	Manage GitHub service endpoints/connections.	Extension	GA
az devops service-endpoint github create	Create a GitHub service endpoint.	Extension	GA
az devops service-endpoint list	List service endpoints in a project.	Extension	GA
az devops service-endpoint show	Get the details of a service endpoint.	Extension	GA
az devops service-endpoint update	Update a service endpoint.	Extension	GA
az devops team	Manage teams.	Extension	GA
az devops team create	Create a team.	Extension	GA
az devops team delete	Delete a team.	Extension	GA
az devops team list	List all teams in a project.	Extension	GA
az devops team list-member	List members of a team.	Extension	GA
az devops team show	Show team details.	Extension	GA
az devops team update	Update a team's name and/or description.	Extension	GA
az devops user	Manage users.	Extension	GA
az devops user add	Add user.	Extension	GA
az devops user list	List users in an organization [except for users which are added via AAD groups].	Extension	GA
az devops user remove	Remove user from an organization.	Extension	GA
az devops user show	Show user details.	Extension	GA
az devops user update	Update license type for a user.	Extension	GA
az devops wiki	Manage wikis.	Extension	GA
az devops wiki create	Create a wiki.	Extension	GA
az devops wiki delete	Delete a wiki.	Extension	GA
az devops wiki list	List all the wikis in a project or organization.	Extension	GA
az devops wiki page	Manage wiki pages.	Extension	GA
az devops wiki page create	Add a new page.	Extension	GA
az devops wiki page delete	Delete a page.	Extension	GA
az devops wiki page show	Get the content of a page or open a page.	Extension	GA
az devops wiki page update	Edit a page.	Extension	GA
az devops wiki show	Show details of a wiki.	Extension	GA

az devops configure

Configure the Azure DevOps CLI or view your configuration.

az devops configure [--defaults]
                    [--list]
                    [--use-git-aliases {false, true}]

Optional Parameters

--defaults -d

Space separated 'name=value' pairs for common arguments defaults, e.g. '--defaults project=my-project-name organization=https://dev.azure.com/organizationName arg=value'. Use '' to clear the defaults, e.g. --defaults project=''.

--list -l

Lists the contents of the config file.

default value: False

--use-git-aliases

Set to 'true' to configure Git aliases global git config file (to enable commands like "git pr list"). Set to 'false' to remove any aliases set by the tool.

accepted values: false, true

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az devops feedback

Deprecated

This command has been deprecated and will be removed in a future release. Use 'az feedback' instead.

Displays information on how to provide feedback to the Azure DevOps CLI team.

az devops feedback

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az devops invoke

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/.

az devops invoke [--accept-media-type]
                 [--api-version]
                 [--area]
                 [--detect {false, true}]
                 [--encoding {ascii, utf-16be, utf-16le, utf-8}]
                 [--http-method {DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT}]
                 [--in-file]
                 [--media-type]
                 [--org]
                 [--out-file]
                 [--query-parameters]
                 [--resource]
                 [--route-parameters]

Examples

Discover areas related to 'Wiki'

az devops invoke --query "[?contains(area,'wiki')]"

Get all wikis in a project

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

Add page to a wiki

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

Optional Parameters

--accept-media-type

Specifies the content type of the response.

default value: application/json

--api-version

The version of the API to target.

default value: 5.0

--area

The area to find the resource.

--detect

Automatically detect organization.

accepted values: false, true

--encoding

Encoding of the input file. Used in conjunction with --in-file.

accepted values: ascii, utf-16be, utf-16le, utf-8

default value: utf-8

--http-method

Specifies the method used for the request.

accepted values: DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT

default value: GET

--in-file

Path and file name to the file that contains the contents of the request.

--media-type

Specifies the content type of the request.

default value: application/json

--org --organization

Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.

--out-file

Path and file name to the file for which this function saves the response body.

--query-parameters

Specifies the list of query parameters.

--resource

The name of the resource to operate on.

--route-parameters

Specifies the list of route parameters.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Set the credential (PAT) to use for a particular organization.

Refer https://aka.ms/azure-devops-cli-auth for more information on providing PAT as input.

az devops login [--org]

--org --organization

Azure DevOps organization URL. Example: https://dev.azure.com/MyOrganizationName.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az devops logout

Clear the credential for all or a particular organization.

az devops logout [--org]

Optional Parameters

--org --organization

Azure DevOps organization URL. Example: https://dev.azure.com/MyOrganizationName/. If no organization is specified, all organizations will be logged out.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az devops

Commands

az devops configure

Optional Parameters

az devops feedback

az devops invoke

Examples

Optional Parameters

az devops logout

Optional Parameters

Feedback

Additional resources