Azure CLI Documentation

repository·main·Indexed 42 days ago

https://github.com/microsoftdocs/azure-docs-cli

Conceptual guides and reference material for the Azure Command-Line Interface (CLI), including authentication via az login, managing subscriptions, and deploying Azure Container Apps using Docker Compose specifications with the az containerapp compose create command.

Tokens
162.1K
Snippets
588
Records
953
Agent score
53%

What's inside Azure CLI

  1. Manage Azure Notification Hubs with az notification-hub

    main

    The az notification-hub subgroup allows you to manage Azure Notification Hub resources. You can use these commands to set up push notifications, manage namespaces, and configure authorization rules.

    Common tasks include:

    • Creating a Notification Hub: Use az notification-hub namespace to manage the namespace and az notification-hub to create or manage the hub itself.
    • Configuring Credentials: Use az notification-hub credential gcm to set up Google Cloud Messaging (GCM) credentials.
    • Authorization: Use az notification-hub authorization-rule to manage access rules for the hub.

    For a quick start, refer to the guide: Quickstart: Create an Azure notification hub using the Azure CLI.

    # Example: Create a notification hub using the Azure CLI
    # (Refer to the specific quickstart guide for exact parameter requirements)
    az notification-hub create --name <hub-name> --namespace <namespace-name> ...
  2. Manage Bicep resources and tools with Azure CLI

    main

    The az bicep command group provides tools for working with Bicep, a domain-specific language for deploying Azure resources.

    Capabilities include:

    • Installing Bicep tools.
    • Decompiling JSON Azure Resource Manager (ARM) templates into Bicep files.
    • Managing Bicep modules and private module registries.
    • Using Bicep CLI commands for deployment and configuration.
  3. Manage Azure Boards work items and configurations with Azure CLI

    main

    The az boards command group provides integration with Azure DevOps Boards to manage work items and project organization.

    Key capabilities:

    • az boards: Perform queries on work items.
    • az boards work-item: Manage individual work items, including adding, removing, or moving them.
    • az boards work-item relation: Link work items to other objects.
    • az boards area ...: Manage area paths and assign them to teams.
    • az boards iteration ...: Manage iteration paths (sprints) and configure team iterations.
  4. Manage Azure Batch resources with Azure CLI

    main

    The az batch command group allows you to manage Azure Batch resources, including accounts, applications, jobs, pools, and tasks.

    Key reference subgroups include:

    • az batch account: Manage Batch accounts and their keys.
    • az batch application: Manage applications and their packages.
    • az batch job: Manage batch jobs.
    • az batch pool: Manage compute pools, including autoscaling and supported images.
    • az batch task: Manage individual tasks and their associated files.
    • az batch node: Manage compute nodes.
    • az batch location: View available locations.

    Common workflows include creating a Batch account, setting up pools (Windows or Linux), and running jobs with specific tasks.

  5. Manage Azure Billing with Azure CLI

    main

    The az billing command group is used for programmatic management of billing entities.

    Supported resources include:

    • az billing account: Manage billing accounts (e.g., Enterprise Agreement subscriptions).
    • az billing customer: Manage customer information.
    • az billing enrollment-account: Manage enrollment accounts (legacy).
    • az billing profile: Manage billing profiles (e.g., Microsoft Customer Agreement).
  6. Define and assign Azure Blueprints with Azure CLI

    main

    The az blueprint command group allows you to manage Azure Blueprints for governance.

    Key subgroups:

    • az blueprint: Manage the blueprints themselves.
    • az blueprint assignment: Manage the assignment of blueprints to resource groups.
    • az blueprint artifact ...: Manage blueprint artifacts, including policy, role, and template types.
    • az blueprint resource-group: Manage the resource groups associated with blueprints.
  7. Manage Peering Service connections with az peering service

    main

    The az peering service command group allows you to create, change, or delete Peering Service connections. You can manage specific connection attributes using:

    • az peering service country: Manage the country associated with the service.
    • az peering service location: Manage the location associated with the service.
    • az peering service prefix: Manage the IP prefix for the service.
    • az peering service provider: Manage the provider associated with the service.
  8. Manage Azure Container Apps with az containerapp

    main

    The az containerapp command group provides a comprehensive interface for managing Azure Container Apps. You can use it to deploy applications, manage environments, configure networking, handle secrets, and control revisions. Key functional areas include:

    • Deployment & Lifecycle: Use az containerapp up (via the base command) for quick deployments, and manage application revisions and traffic splitting.
    • Environment Management: Configure the Container Apps environment (az containerapp env), including storage mounts, telemetry (App Insights, Datadog, OTLP), and maintenance configurations.
    • Networking & Ingress: Configure ingress settings (az containerapp ingress), including CORS, access restrictions (IP filtering), and custom domain names.
    • Security & Identity: Manage secrets (az containerapp secret), authentication (az containerapp auth), and managed identities (az containerapp identity).
    • Microservices & Dapr: Enable and configure Dapr components and resiliency (az containerapp dapr).
    • Jobs: Manage containerized jobs (az containerapp job) and monitor their execution (az containerapp job execution).
    • Observability: View logs (az containerapp logs) and access container consoles for debugging (az containerapp replica).
  9. Manage Azure Kubernetes Service (AKS) clusters with az aks

    main

    The az aks command group is the primary interface for managing Azure Kubernetes Service (AKS) resources. It supports a wide range of operations including cluster deployment, node pool management, service mesh configuration, and connectivity setup.

    Key functional areas include:

    • Cluster Lifecycle: Deploying, upgrading, and managing AKS clusters.
    • Node Pools: Creating, resizing, and managing system or user node pools (az aks nodepool).
    • Add-ons & Extensions: Managing application routing (az aks approuting), Istio-based service mesh (az aks mesh), and Secrets Store CSI Driver configurations (az aks addon).
    • Connectivity & Security: Setting up service connections (az aks connection), managing pod identities (az aks pod-identity), and configuring OpenID Connect providers (az aks oidc-issuer).
    • Maintenance: Scheduling planned maintenance and upgrades (az aks maintenanceconfiguration).
    # Example: Deploy an AKS cluster (referencing the quickstart concept)
    az aks create --resource-group myResourceGroup --name myAKSCluster --node-count 3
  10. Manage Azure Blueprints with Azure CLI

    main

    The az blueprint command group allows you to define, assign, and manage Azure Blueprints for governance.

    Key subcommands include:

    • az blueprint: Manage the blueprints themselves.
    • az blueprint assignment: Manage the assignment of blueprints to resource groups.
    • az blueprint resource-group: Manage resource groups associated with blueprints.
    • az blueprint artifact *: Manage blueprint artifacts, including policies, roles, and templates.
  11. Manage Azure Billing and subscriptions with Azure CLI

    main

    The az billing command group is used to programmatically manage billing entities.

    Key subgroups:

    • az billing account: Manage billing accounts.
    • az billing customer: Manage customer information.
    • az billing enrollment-account: Manage enrollment accounts (including legacy APIs).
    • az billing profile: Manage billing profiles.

    These commands are used to programmatically create subscriptions for various agreement types, such as Microsoft Customer Agreements, Microsoft Partner Agreements, and Enterprise Agreements.