Share via

az devops service-endpoint

  • 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 service-endpoint command. Learn more about extensions.

Manage service endpoints/connections.

Commands

Name Description Type Status
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 service-endpoint create

Create a service endpoint using configuration file.

You can learn more about this at https://aka.ms/azure-devops-service-endpoint-config.

az devops service-endpoint create --service-endpoint-configuration
                                  [--detect {false, true}]
                                  [--encoding {ascii, utf-16be, utf-16le, utf-8}]
                                  [--org]
                                  [--project]

Required Parameters

--service-endpoint-configuration

Configuration file with service endpoint request.

Optional Parameters

--detect

Automatically detect organization.

Accepted values: false, true
--encoding

Encoding of the input file.

Accepted values: ascii, utf-16be, utf-16le, utf-8
Default value: utf-8
--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/.

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

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 service-endpoint delete

Deletes service endpoint.

az devops service-endpoint delete --id
                                  [--deep]
                                  [--detect {false, true}]
                                  [--org]
                                  [--project]
                                  [--yes]

Required Parameters

--id

Id of the service endpoint to delete.

Optional Parameters

--deep

Specific to AzureRM endpoint created in Automatic flow. When it is specified, this will also delete corresponding AAD application in Azure.

Default value: False
--detect

Automatically detect organization.

Accepted values: false, true
--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/.

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

--yes -y

Do not prompt for confirmation.

Default value: False
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 service-endpoint list

List service endpoints in a project.

:rtype: list of :class:VssJsonCollectionWrapper <service_endpoint.v4_1.models.ServiceEndpoint>.

az devops service-endpoint list [--detect {false, true}]
                                [--org]
                                [--project]

Optional Parameters

--detect

Automatically detect organization.

Accepted values: false, true
--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/.

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

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 service-endpoint show

Get the details of a service endpoint.

az devops service-endpoint show --id
                                [--detect {false, true}]
                                [--org]
                                [--project]

Required Parameters

--id

ID of the service endpoint.

Optional Parameters

--detect

Automatically detect organization.

Accepted values: false, true
--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/.

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

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 service-endpoint update

Update a service endpoint.

az devops service-endpoint update --id
                                  [--detect {false, true}]
                                  [--enable-for-all {false, true}]
                                  [--org]
                                  [--project]

Required Parameters

--id

ID of the service endpoint.

Optional Parameters

--detect

Automatically detect organization.

Accepted values: false, true
--enable-for-all

Allow all pipelines to access this service endpoint.

Accepted values: false, true
--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/.

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

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.