group.yml

### YamlMime:AzureCLIGroup
uid: az_group
name: az group
summary: |-
  Manage resource groups and template deployments.
status: GA
sourceType: Core
directCommands:
- uid: az_group_create
  name: az group create
  summary: |-
    Create a new resource group.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/resource/_help.py
  syntax: >-
    az group create --location
                    --name
                    [--managed-by]
                    [--tags]
  examples:
  - summary: |-
      Create a new resource group in the West US region.
    syntax: az group create -l westus -n MyResourceGroup
  requiredParameters:
  - isRequired: true
    name: --location -l
    summary: |-
      Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=<location>`.
  - isRequired: true
    name: --name --resource-group -g -n
    summary: |-
      Name of the new resource group.
  optionalParameters:
  - name: --managed-by
    summary: |-
      The ID of the resource that manages this resource group.
  - name: --tags
    summary: |-
      Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
- uid: az_group_delete
  name: az group delete
  summary: |-
    Delete a resource group.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/resource/_help.py
  syntax: >-
    az group delete --name
                    [--no-wait]
                    [--yes]
  examples:
  - summary: |-
      Delete a resource group.
    syntax: az group delete -n MyResourceGroup
  - summary: |-
      Force delete all the Virtual Machines in a resource group.
    syntax: az group delete -n MyResourceGroup --force-deletion-types Microsoft.Compute/virtualMachines
  requiredParameters:
  - isRequired: true
    name: --name --resource-group -g -n
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  optionalParameters:
  - name: --no-wait
    defaultValue: "False"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --yes -y
    defaultValue: "False"
    summary: |-
      Do not prompt for confirmation.
- uid: az_group_exists
  name: az group exists
  summary: |-
    Check if a resource group exists.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/resource/_help.py
  syntax: az group exists --name
  examples:
  - summary: |-
      Check if 'MyResourceGroup' exists.
    syntax: az group exists -n MyResourceGroup
  requiredParameters:
  - isRequired: true
    name: --name --resource-group -g -n
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- uid: az_group_export
  name: az group export
  summary: |-
    Captures a resource group as a template.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/resource/_help.py
  syntax: >-
    az group export --name
                    [--include-comments]
                    [--include-parameter-default-value]
                    [--resource-ids]
                    [--skip-all-params]
                    [--skip-resource-name-params]
  requiredParameters:
  - isRequired: true
    name: --name --resource-group -g -n
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  optionalParameters:
  - name: --include-comments
    defaultValue: "False"
    summary: |-
      Export template with comments.
  - name: --include-parameter-default-value
    defaultValue: "False"
    summary: |-
      Export template parameter with default value.
  - name: --resource-ids
    summary: |-
      Space-separated resource ids to filter the export by. To export all resources, do not specify this argument or supply "*".
  - name: --skip-all-params
    defaultValue: "False"
    summary: |-
      Export template parameter and skip all parameterization.
  - name: --skip-resource-name-params
    defaultValue: "False"
    summary: |-
      Export template and skip resource name parameterization.
- uid: az_group_list
  name: az group list
  summary: |-
    List resource groups.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/resource/_help.py
  syntax: az group list [--tag]
  examples:
  - summary: |-
      List all resource groups located in the West US region.
    syntax: az group list --query "[?location=='westus']"
  optionalParameters:
  - name: --tag
    summary: |-
      A single tag in 'key[=value]' format. Use "" to clear existing tags.
- uid: az_group_show
  name: az group show
  summary: |-
    Gets a resource group.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/resource/_help.py
  syntax: az group show --name
  requiredParameters:
  - isRequired: true
    name: --name --resource-group -g -n
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
- uid: az_group_update
  name: az group update
  summary: |-
    Update a resource group.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/resource/_help.py
  syntax: >-
    az group update --name
                    [--add]
                    [--force-string]
                    [--remove]
                    [--set]
                    [--tags]
  examples:
  - summary: |-
      Update a resource group. (autogenerated)
    syntax: az group update --resource-group MyResourceGroup --set tags.CostCenter='{"Dept":"IT","Environment":"Test"}'
  requiredParameters:
  - isRequired: true
    name: --name --resource-group -g -n
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  optionalParameters:
  - name: --add
    defaultValue: "[]"
    summary: |-
      Add an object to a list of objects by specifying a path and key value pairs.  Example: `--add property.listProperty <key=value, string or JSON string>`.
    isDeprecated: true
    deprecateInfo: Argument 'properties_to_add' has been deprecated and will be removed in a future release.
  - name: --force-string
    defaultValue: "False"
    summary: |-
      When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
  - name: --remove
    defaultValue: "[]"
    summary: |-
      Remove a property or an element from a list.  Example: `--remove property.list <indexToRemove>` OR `--remove propertyToRemove`.
    isDeprecated: true
    deprecateInfo: Argument 'properties_to_remove' has been deprecated and will be removed in a future release.
  - name: --set
    defaultValue: "[]"
    summary: |-
      Update an object by specifying a property path and value to set.  Example: `--set property1.property2=<value>`.
  - name: --tags
    summary: |-
      Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
- uid: az_group_wait
  name: az group wait
  summary: |-
    Place the CLI in a waiting state until a condition of the resource group is met.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/resource/_help.py
  syntax: >-
    az group wait --name
                  [--created]
                  [--custom]
                  [--deleted]
                  [--exists]
                  [--interval]
                  [--timeout]
                  [--updated]
  examples:
  - summary: |-
      Place the CLI in a waiting state until a condition of the resource group is met. (autogenerated)
    syntax: az group wait --created  --resource-group MyResourceGroup
  - summary: |-
      Place the CLI in a waiting state until a condition of the resource group is met. (autogenerated)
    syntax: az group wait --deleted --resource-group MyResourceGroup
  requiredParameters:
  - isRequired: true
    name: --name --resource-group -g -n
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  optionalParameters:
  - name: --created
    defaultValue: "False"
    summary: |-
      Wait until created with 'provisioningState' at 'Succeeded'.
  - name: --custom
    summary: |-
      Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
  - name: --deleted
    defaultValue: "False"
    summary: |-
      Wait until deleted.
  - name: --exists
    defaultValue: "False"
    summary: |-
      Wait until the resource exists.
  - name: --interval
    defaultValue: "30"
    summary: |-
      Polling interval in seconds.
  - name: --timeout
    defaultValue: "3600"
    summary: |-
      Maximum wait in seconds.
  - name: --updated
    defaultValue: "False"
    summary: |-
      Wait until updated with provisioningState at 'Succeeded'.
commands:
- az_group_create
- az_group_delete
- az_group_deployment
- az_group_deployment_cancel
- az_group_deployment_create
- az_group_deployment_delete
- az_group_deployment_export
- az_group_deployment_list
- az_group_deployment_operation
- az_group_deployment_operation_list
- az_group_deployment_operation_show
- az_group_deployment_show
- az_group_deployment_validate
- az_group_deployment_wait
- az_group_exists
- az_group_export
- az_group_list
- az_group_lock
- az_group_lock_create
- az_group_lock_delete
- az_group_lock_list
- az_group_lock_show
- az_group_lock_update
- az_group_show
- az_group_update
- az_group_wait
globalParameters:
- name: --debug
  summary: |-
    Increase logging verbosity to show all debug logs.
- name: --help -h
  summary: |-
    Show this help message and exit.
- name: --only-show-errors
  summary: |-
    Only show errors, suppressing warnings.
- name: --output -o
  defaultValue: "json"
  parameterValueGroup: "json, jsonc, none, table, tsv, yaml, yamlc"
  summary: |-
    Output format.
- name: --query
  summary: |-
    JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
- name: --subscription
  summary: |-
    Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --verbose
  summary: |-
    Increase logging verbosity. Use --debug for full debug logs.
metadata:
  ms.date: 01/06/2025
  description: Manage resource groups and template deployments.