tldr-pages/tldr

Let's document: az (azure-cli)

Open

#6,141 opened on Jun 18, 2021

View on GitHub
 (2 comments) (10 reactions) (0 assignees)Shell (2,507 forks)batch import
good first issuehelp wantedlet's documentnew command

Repository metrics

Stars
 (30,937 stars)
PR merge metrics
 (Avg merge 7d 5h) (321 merged PRs in 30d)

Description

  • account : Manage Azure subscription information. → #6204
  • acr : Manage private registries with Azure Container Registries. →#10912
  • ad : Manage Azure Active Directory Graph entities needed for Role Based Access Control.
  • advisor : Manage Azure Advisor. → #10962
  • aks : Manage Azure Kubernetes Services. → #10964
  • ams : Manage Azure Media Services resources.
  • apim : Manage Azure API Management services. → #10915
  • appconfig : Manage App Configurations. → #7095
  • appservice : Manage App Service plans.
  • aro : Manage Azure Red Hat OpenShift clusters.
  • artifacts : Manage Azure Artifacts.
  • backup : Manage Azure Backups.
  • batch : Manage Azure Batch.
  • bicep : Bicep CLI command group. → #6718
  • billing : Manage Azure Billing.
  • boards : Manage Azure Boards.
  • bot : Manage Microsoft Azure Bot Service.
  • cache : Commands to manage CLI objects cached using the --defer argument.
  • cdn : Manage Azure Content Delivery Networks (CDNs).
  • cloud : Manage registered Azure clouds.
  • cognitiveservices : Manage Azure Cognitive Services accounts. #19269
  • config : Manage Azure CLI configuration. → #6701
  • configure : Manage Azure CLI configuration. This command is interactive.
  • consumption : Manage consumption of Azure resources.
  • container : Manage Azure Container Instances. #18435
  • cosmosdb : Manage Azure Cosmos DB database accounts.
  • databoxedge : Support data box edge device and management.
  • deployment : Manage Azure Resource Manager template deployment at subscription scope.
  • deployment-scripts : Manage deployment scripts at subscription or resource group scope.
  • deploymentmanager : Create and manage rollouts for your service.
  • devops : Manage Azure DevOps organization level operations. → #9951
  • disk : Manage Azure Managed Disks.
  • disk-access : Manage disk access resources.
  • disk-encryption-set : Disk Encryption Set resource.
  • dla : Manage Data Lake Analytics accounts, jobs, and catalogs.
  • dls : Manage Data Lake Store accounts and filesystems.
  • dms : Manage Azure Data Migration Service (DMS) instances.
  • eventgrid : Manage Azure Event Grid topics, domains, domain topics, system topics partner topics, event subscriptions, system topic event subscriptions and partner topic event subscriptions.
  • eventhubs : Manage Azure Event Hubs namespaces, eventhubs, consumergroups and georecovery configurations - Alias.
  • extension : Manage and update CLI extensions.
  • feature : Manage resource provider features.
  • feedback : Send feedback to the Azure CLI Team. → #6699
  • find : I'm an AI robot, my advice is based on our Azure documentation as well as the usage patterns of Azure CLI and Azure ARM users. Using me improves Azure products and documentation.
  • functionapp : Manage function apps. To install the Azure Functions Core tools see https://github.com/Azure/azure-functions-core-tools.
  • group : Manage resource groups and template deployments. → #8698
  • hdinsight : Manage HDInsight resources.
  • identity : Managed Service Identities.
  • image : Manage custom virtual machine images.
  • interactive : Start interactive mode. Installs the Interactive extension if not installed already.
  • iot : Manage Internet of Things (IoT) assets.
  • keyvault : Manage KeyVault keys, secrets, and certificates.
  • kusto : Manage Azure Kusto resources.
  • lab : Manage Azure DevTest Labs.
  • local-context : Manage Local Context.
  • lock : Manage Azure locks.
  • login : Log in to Azure. → #6228
  • logout : Log out to remove access to Azure subscriptions. → #6229
  • managedapp : Manage template solutions provided and maintained by Independent Software Vendors (ISVs).
  • managedservices : Manage the registration assignments and definitions in Azure.
  • maps : Manage Azure Maps.
  • mariadb : Manage Azure Database for MariaDB servers.
  • monitor : Manage the Azure Monitor Service.
  • mysql : Manage Azure Database for MySQL servers.
  • netappfiles : Manage Azure NetApp Files (ANF) Resources.
  • network : Manage Azure Network resources. → #6761
  • pipelines : Manage Azure Pipelines. → #7186
  • policy : Manage resource policies.
  • postgres : Manage Azure Database for PostgreSQL servers.
  • ppg : Manage Proximity Placement Groups.
  • provider : Manage resource providers. → #8697
  • quantum : Manage Azure Quantum Workspaces and submit jobs to Azure Quantum Providers. → #16630
  • redis : Manage dedicated Redis caches for your Azure applications.→ #8651
  • relay : Manage Azure Relay Service namespaces, WCF relays, hybrid connections, and rules.
  • repos : Manage Azure Repos. → #9953
  • reservations : Manage Azure Reservations.
  • resource : Manage Azure resources.
  • rest : Invoke a custom request.
  • role : Manage user roles for access control with Azure Active Directory and service principals.
  • search : Manage Azure Search services, admin keys and query keys.
  • security : Manage your security posture with Azure Security Center.
  • serial-console : Access serial consoles of virtual machines. #13709
  • servicebus : Manage Azure Service Bus namespaces, queues, topics, subscriptions, rules and geo-disaster recovery configuration alias.
  • sf : Manage and administer Azure Service Fabric clusters.
  • sig : Manage shared image gallery.
  • signalr : Manage Azure SignalR Service.
  • snapshot : Manage point-in-time copies of managed disks, native blobs, or other snapshots.
  • sql : Manage Azure SQL Databases and Data Warehouses.
  • sshkey : Manage ssh public key with VM. → #8603
  • staticwebapp : Manage static apps.
  • storage : Manage Azure Cloud Storage resources.→ #6647
  • storage-account → #8737
  • storage-container → #8736
  • storage-queue → #8732
  • storage-table → #8734
  • synapse : Manage and operate Synapse Workspace, Spark Pool, SQL Pool.
  • tag : Tag Management on a resource. → #6969
  • term : Manage marketplace agreement with marketplaceordering. → #6720
  • ts : Manage template specs at subscription or resource group scope.
  • upgrade : Upgrade Azure CLI and extensions.
  • version : Show the versions of Azure CLI modules and extensions in JSON format by default or format configured by --output. → #8546
  • vm : Manage Linux or Windows virtual machines. → #6222
  • vmss : Manage groupings of virtual machines in an Azure Virtual Machine Scale Set (VMSS).
  • webapp : Manage web apps. → #8845

Contributor guide

Research direction
For each unchecked subcommand in the issue, look up the official Azure CLI documentation or use `az <subcommand> help` to understand its syntax and common use cases. Create a tldr page following the standard format and ensure it covers at least 3-4 useful examples.
Tech stack
shell
Domain
cli
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitFamiliarity with tldr pages formatBasic knowledge of Azure CLI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60