Azure CLI

https://learn.microsoft.com/en-us/cli/azure/
Admin
The Azure Command-Line Interface (CLI) is a cross-platform command-line tool to connect to Azure and...
Tokens:17,372,243
Snippets:123,295
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Start hosted agent deployment example

Source: https://learn.microsoft.com/en-us/cli/azure/cognitiveservices/agent

Example command to start a hosted agent deployment using the 'az cognitiveservices agent start' command with required parameters.

```bash
az cognitiveservices agent start --account-name myAccount --project-name myProject --name myAgent --agent-version 1
```

--------------------------------

### Start a function app example

Source: https://learn.microsoft.com/en-us/cli/azure/functionapp

Autogenerated example that starts a function app named 'MyFunctionApp' in resource group 'MyResourceGroup'. Use this as a template for starting a function app.

```bash
az functionapp start --name MyFunctionApp --resource-group MyResourceGroup
```

--------------------------------

### Start the runbook example

Source: https://learn.microsoft.com/en-us/cli/azure/automation/runbook

Example command that starts a runbook named 'myRunbook' in the automation account 'myAutomationAccount' within resource group 'rg'.

```bash
az automation runbook start --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"
```

--------------------------------

### Start interactive configuration

Source: https://learn.microsoft.com/en-us/cli/azure/prototype/config

Runs the interactive setup to create a prototype.yaml file.

```bash
az prototype config init
```

--------------------------------

### Get application details by appId

Source: https://learn.microsoft.com/en-us/cli/azure/ad/app

Gets the details of an application using its appId. The example uses a placeholder GUID.

```azure cli
az ad app show --id 00000000-0000-0000-0000-000000000000
```

--------------------------------

### Start agent and stream console logs example

Source: https://learn.microsoft.com/en-us/cli/azure/cognitiveservices/agent

Example command to start a hosted agent and stream container console logs during startup using the --show-logs flag.

```bash
az cognitiveservices agent start --account-name myAccount --project-name myProject --name myAgent --agent-version 1 --show-logs
```

--------------------------------

### Show Azure service details with example service name

Source: https://learn.microsoft.com/en-us/cli/azure/support/services

Example command to get details of an Azure service using a service name GUID.

```bash
az support services show --service-name "ServiceNameGuid"
```

--------------------------------

### Example: Create settings

Source: https://learn.microsoft.com/en-us/cli/azure/network/application-gateway/settings

Creates backend settings with the specified parameters. This example uses a resource group, gateway name, settings name, port, protocol, and timeout.

```bash
az network application-gateway settings create -g MyResourceGroup --gateway-name MyAppGateway -n MySettings --port 80 --protocol Http --timeout 30
```

--------------------------------

### Show problem classification details with GUIDs

Source: https://learn.microsoft.com/en-us/cli/azure/support/services/problem-classifications

Example that gets details of a problem classification for an Azure service. Replace ServiceNameGuid and ProblemClassificationNameGuid with the actual GUIDs.

```azure cli
az support services problem-classifications show --service-name "ServiceNameGuid" --problem-classification-name "ProblemClassificationNameGuid"
```

--------------------------------

### DeploymentInfo_List example

Source: https://learn.microsoft.com/en-us/cli/azure/elastic/monitor

Example that fetches deployment information for the monitor named myMonitor in resource group myResourceGroup.

```bash
az elastic monitor list-deployment-info --resource-group myResourceGroup --monitor-name myMonitor
```

--------------------------------

### Get email status example

Source: https://learn.microsoft.com/en-us/cli/azure/communication/email/status

Example command to get the status of an email. The --operation-id is the system-generated message ID (GUID) returned from a previous send email call, and --connection-string must be provided for the Azure Communication Service.

```azurecli
az communication email status get --operation-id "01234567-89ab-cdef-0123-012345678901" --connection-string "endpoint=XXXXXXXXXXXXXXXX;accesskey=XXXXXXXXXXXXXXXXXXXXXX"
```

--------------------------------

### List problem classifications with service name GUID

Source: https://learn.microsoft.com/en-us/cli/azure/support/services/problem-classifications

Example that gets the list of problem classifications for a service for which a support ticket can be created. Replace ServiceNameGuid with the actual service name GUID.

```azure cli
az support services problem-classifications list --service-name "ServiceNameGuid"
```

--------------------------------

### List web app settings with subscription (autogenerated example)

Source: https://learn.microsoft.com/en-us/cli/azure/webapp/config/appsettings

Example command that lists app settings for a web app named MyWebapp in resource group MyResourceGroup, using the specified subscription.

```bash
az webapp config appsettings list --name MyWebapp --resource-group MyResourceGroup --subscription MySubscription
```

--------------------------------

### List configurations example

Source: https://learn.microsoft.com/en-us/cli/azure/nginx/deployment/configuration

Example command that lists configurations for a deployment named 'myDeployment' in resource group 'myResourceGroup'.

```bash
az nginx deployment configuration list --deployment-name myDeployment --resource-group myResourceGroup
```

--------------------------------

### Show service principal by appId

Source: https://learn.microsoft.com/en-us/cli/azure/ad/sp

Gets the details of a service principal using its appId. The example uses a placeholder GUID for the appId.

```bash
az ad sp show --id 00000000-0000-0000-0000-000000000000
```

--------------------------------

### Show client example

Source: https://learn.microsoft.com/en-us/cli/azure/eventgrid/namespace/client

Example command that shows a client by specifying resource group, namespace name, and client name.

```bash
az eventgrid namespace client show -g rg --namespace-name name -n client-name
```

--------------------------------

### Get a management group (example)

Source: https://learn.microsoft.com/en-us/cli/azure/account/management-group

Example of getting a management group by name.

```bash
az account management-group show --name GroupName
```

--------------------------------

### Example: Show dataset details

Source: https://learn.microsoft.com/en-us/cli/azure/iot/ops/ns/asset/rest/dataset

Example command using asset 'myrestasset', instance 'myInstance', resource group 'myInstanceResourceGroup', and dataset name 'temperatureData'.

```bash
az iot ops ns asset rest dataset show --asset myrestasset --instance myInstance -g myInstanceResourceGroup --name temperatureData
```

--------------------------------

### Get error detail for a catalog task

Source: https://learn.microsoft.com/en-us/cli/azure/devcenter/admin/catalog-task

Example that gets error details for a customization task. Requires the catalog name, task name, dev center name, and resource group. The dev center extension must be installed (Azure CLI version 2.75.0 or higher).

```bash
az devcenter admin catalog-task get-error-detail --catalog-name "CentralCatalog" --task-name "SampleTask" --dev-center-name "Contoso" --resource-group "rg1"
```

--------------------------------

### Show backup example

Source: https://learn.microsoft.com/en-us/cli/azure/mysql/flexible-server/backup

Example showing details of backup 'testbackup' for server 'testsvr' in resource group 'testgroup'.

```bash
az mysql flexible-server backup show -g testgroup -n testsvr --backup-name testbackup
```

--------------------------------

### Get MonitorsVmHostPayload example

Source: https://learn.microsoft.com/en-us/cli/azure/new-relic/monitor

Example command to get the VM host payload for a specific monitor and resource group. This is the example provided in the documentation.

```bash
az monitor vm-host-payload --monitor-name MyNewRelicMonitor --resource-group MyResourceGroup
```

--------------------------------

### az synapse trigger start example

Source: https://learn.microsoft.com/en-us/cli/azure/synapse/trigger

Example of starting a trigger named testtrigger in the workspace testsynapseworkspace.

```bash
az synapse trigger start --workspace-name testsynapseworkspace \
  --name testtrigger
```

--------------------------------

### Create a Config Template example

Source: https://learn.microsoft.com/en-us/cli/azure/workload-orchestration-preview/config-template

Example command that creates a config template with a description, location, version, and configuration file.

```bash
az workload-orchestration-preview config-template create -g rg1 -n ct1 --description "test" --location eastus --version 1.0.0 --config-template-file config.yaml
```

--------------------------------

### Get example

Source: https://learn.microsoft.com/en-us/cli/azure/devcenter/admin/project-policy

Example command to get a specific project policy using the dev center name, project policy name, and resource group.

```bash
az devcenter admin project-policy show --dev-center-name "Contoso" --project-policy-name "DevOnlyResources" --resource-group "rg1"
```

--------------------------------

### Get a shared limit example

Source: https://learn.microsoft.com/en-us/cli/azure/computelimit/shared-limit

Example command to get a shared limit for the StandardDSv3Family in the eastus location.

```bash
az computelimit shared-limit show --location eastus --name StandardDSv3Family
```

--------------------------------

### List frontends example

Source: https://learn.microsoft.com/en-us/cli/azure/stack-hci-vm/network/lb/frontend-ip

Example command to list frontend IP configurations for a load balancer named 'test-lb' in resource group 'test-rg', output in table format.

```bash
az stack-hci-vm network lb frontend-ip list --lb-name "test-lb" --resource-group "test-rg" -o table
```

--------------------------------

### Start a Kusto cluster with az kusto cluster start

Source: https://learn.microsoft.com/en-us/cli/azure/kusto/cluster

Example that starts a Kusto cluster named 'kustoclusterrptest4' in resource group 'kustorptest'. This is the KustoClustersStart example.

```bash
az kusto cluster start --name "kustoclusterrptest4" --resource-group "kustorptest"
```

--------------------------------

### Create VM template example

Source: https://learn.microsoft.com/en-us/cli/azure/connectedvmware/vm-template

Example command that creates a VM template resource using the required parameters.

```bash
az connectedvmware vm-template create --custom-location "custom location name"                --location "location name" --inventory-item "name or id the inventory item"                --name "vm template name" --resource-group "resource group name"                --vcenter "name or id of the vcenter"
```

--------------------------------

### Example: Show a Config Server for Spring

Source: https://learn.microsoft.com/en-us/cli/azure/containerapp/env/java-component/config-server-for-spring

Example command using shorthand flags -g, -n, and --environment to show a Config Server for Spring component.

```bash
az containerapp env java-component config-server-for-spring show -g MyResourceGroup \
    -n MyJavaComponentName \
    --environment MyEnvironment
```

--------------------------------

### az logicapp start example

Source: https://learn.microsoft.com/en-us/cli/azure/logicapp

Example that starts a logic app named myLogicApp in resource group myRG.

```bash
az logicapp start --name myLogicApp --resource-group myRG
```

--------------------------------

### Example: IntegrationRuntimes_GetConnectionInfo

Source: https://learn.microsoft.com/en-us/cli/azure/datafactory/integration-runtime

Example command that retrieves connection info for a specific integration runtime. Replace the example values with your own.

```bash
az datafactory integration-runtime get-connection-info --factory-name "exampleFactoryName" --name "exampleIntegrationRuntime" --resource-group "exampleResourceGroup"
```

--------------------------------

### Get Gi Version example

Source: https://learn.microsoft.com/en-us/cli/azure/oracle-database/gi-version

Example command to get a specific GiVersion by providing the location and the GiVersion name.

```bash
az oracle-database gi-version show --location <location> --name <gi version name>
```

--------------------------------

### Show a Solution Deployment example

Source: https://learn.microsoft.com/en-us/cli/azure/workload-orchestration-preview/solution-deployment

Example command that shows a Solution Deployment using the -n and -g parameters.

```bash
az workload-orchestration-preview solution-deployment show -n mySolutionDeployment -g myResourceGroup
```

--------------------------------

### Create a simple gallery Application Version - example

Source: https://learn.microsoft.com/en-us/cli/azure/sig/gallery-application/version

Example command to create a simple gallery application version. Requires a package file link to a readable storage page blob and install/remove commands limited to 4096 characters.

```bash
az sig gallery-application version create --gallery-name myGalleryName --application-name myGalleryApplicationName -n 1.0.0 -g myResourceGroup --package-file-link https://{myStorageAccount}.blob.core.windows.net/{myStorageContainer}/{myStorageBlob}  --install-command installCommand  --remove-command removeCommand
```

--------------------------------

### Get association example

Source: https://learn.microsoft.com/en-us/cli/azure/monitor/data-collection/rule/association

Example that gets the specified association. The resource identifier is for a virtual machine in a resource group.

```bash
az monitor data-collection rule association show --name "myAssociation" --resource "subscrip tions/703362b3-f278-4e4b-9179- c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm "
```

--------------------------------

### Get subgroup example

Source: https://learn.microsoft.com/en-us/cli/azure/interconnect-group/subgroup

Example command to get a specific subgroup in an interconnect group using the required parameters.

```bash
az network interconnect-group subgroup show --resource-group rg1 --interconnect-group-name test-ig --subgroup-name subgroup0
```

--------------------------------

### List configuration values for a server (example)

Source: https://learn.microsoft.com/en-us/cli/azure/mariadb/server/configuration

Example command that lists configuration values for a server, using the --resource-group and --server-name parameters.

```bash
az mariadb server configuration list --resource-group MyResourceGroup --server-name MyServer
```

--------------------------------

### Example: Get build details

Source: https://learn.microsoft.com/en-us/cli/azure/devcenter/admin/project-image-definition-build

Example command that retrieves build details for a specific build, catalog, image definition, project, and resource group.

```bash
az devcenter admin project-image-definition-build get-build-detail --build-name "0a28fc61-6f87-4611-8fe2-32df44ab93b7" --catalog-name "CentralCatalog" --image-definition-name "DefaultDevImage" --project-name "DevProject" --resource-group "rg1"
```

--------------------------------

### Get a FHIR Service example

Source: https://learn.microsoft.com/en-us/cli/azure/healthcareapis/workspace/fhir-service

Example that gets the properties of a FHIR Service by name, resource group, and workspace.

```bash
az healthcareapis workspace fhir-service show --name "fhirservices1" --resource-group "testRG" --workspace-name "workspace1"
```

--------------------------------

### Example: Get flows in a connection

Source: https://learn.microsoft.com/en-us/cli/azure/data-transfer/connection/flow

Example that gets flows in a connection named testConnection in resource group testRG.

```bash
az data-transfer connection flow list --resource-group testRG --connection-name testConnection
```

--------------------------------

### List configuration profile versions (example)

Source: https://learn.microsoft.com/en-us/cli/azure/automanage/configuration-profile/version

Example command to list configuration profile versions. Uses the --profile-name and -g flags with placeholder values.

```bash
az automanage configuration-profile version list --profile-name {profile_name} -g {rg}
```

--------------------------------

### Get webhook details example

Source: https://learn.microsoft.com/en-us/cli/azure/acr/webhook

Example that gets the details of a webhook named mywebhook in the registry myregistry.

```azure cli
az acr webhook show -n mywebhook -r myregistry
```

--------------------------------

### Initialize with verbose output

Source: https://learn.microsoft.com/en-us/cli/azure/prototype/config

Runs the interactive setup with debug logging enabled.

```bash
az prototype config init --debug
```

--------------------------------

### Show configuration profile version (example)

Source: https://learn.microsoft.com/en-us/cli/azure/automanage/configuration-profile/version

Example command to show a configuration profile version. Uses --profile-name, -g, and -n flags with placeholder values.

```bash
az automanage configuration-profile version show --profile-name {profile_name} -g {rg} -n {version_name}
```
Tokens:
Raw