az devops service-endpoint azurerm

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

Manage Azure RM service endpoints/connections.

Commands

Name Description Type Status
az devops service-endpoint azurerm create

Create an Azure RM type service endpoint.

 Extension GA

az devops service-endpoint azurerm create

Create an Azure RM type service endpoint.

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.

az devops service-endpoint azurerm create --azure-rm-service-principal-id
                                          --azure-rm-subscription-id
                                          --azure-rm-subscription-name
                                          --azure-rm-tenant-id
                                          --name
                                          [--azure-rm-service-principal-certificate-path]
                                          [--detect {false, true}]
                                          [--org]
                                          [--project]

Required Parameters

--azure-rm-service-principal-id

Service principal id for creating azure rm service endpoint.

--azure-rm-subscription-id

Subscription id for azure rm service endpoint.

--azure-rm-subscription-name

Name of azure subscription for azure rm service endpoint.

--azure-rm-tenant-id

Tenant id for creating azure rm service endpoint.

--name

Name of service endpoint to create.

Optional Parameters

--azure-rm-service-principal-certificate-path

Path to (.pem) which is certificate. Create using command "openssl pkcs12 -in file.pfx -out file.pem -nodes -password pass:<password_here>". More details : https://aka.ms/azure-devops-cli-azurerm-service-endpoint.

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