lock.yml

### YamlMime:AzureCLIGroup
uid: az_group_lock
name: az group lock
summary: |-
  Manage Azure resource group locks.
status: GA
sourceType: Core
directCommands:
- uid: az_group_lock_create
  name: az group lock create
  summary: |-
    Create a resource group lock.
  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 lock create --lock-type {CanNotDelete, ReadOnly}
                         --name
                         --resource-group
                         [--notes]
  examples:
  - summary: |-
      Create a read-only resource group level lock.
    syntax: az group lock create --lock-type ReadOnly -n lockName -g MyResourceGroup
  requiredParameters:
  - isRequired: true
    name: --lock-type -t
    acceptedValues: CanNotDelete, ReadOnly
    summary: |-
      The type of lock restriction.
  - isRequired: true
    name: --name -n
    summary: |-
      Name of the lock.
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  optionalParameters:
  - name: --notes
    summary: |-
      Notes about this lock.
  globalParameters:
  - name: --debug
    defaultValue: "False"
    summary: |-
      Increase logging verbosity to show all debug logs.
  - name: --help -h
    summary: |-
      Show this help message and exit.
  - name: --only-show-errors
    defaultValue: "False"
    summary: |-
      Only show errors, suppressing warnings.
  - name: --output -o
    defaultValue: json
    acceptedValues: json, jsonc, none, table, tsv, yaml, yamlc
    summary: |-
      Output format.
  - name: --query
    summary: |-
      JMESPath query string. See http://jmespath.org/ 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
    defaultValue: "False"
    summary: |-
      Increase logging verbosity. Use --debug for full debug logs.
- uid: az_group_lock_delete
  name: az group lock delete
  summary: |-
    Delete a resource group lock.
  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 lock delete [--ids]
                         [--name]
                         [--resource-group]
  examples:
  - summary: |-
      Delete a resource group lock
    syntax: az group lock delete --name lockName -g MyResourceGroup
  optionalParameters:
  - name: --ids
    summary: |-
      One or more resource IDs (space-delimited). If provided, no other "Resource Id" arguments should be specified.
  - name: --name -n
    summary: |-
      Name of the lock.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  globalParameters:
  - name: --debug
    defaultValue: "False"
    summary: |-
      Increase logging verbosity to show all debug logs.
  - name: --help -h
    summary: |-
      Show this help message and exit.
  - name: --only-show-errors
    defaultValue: "False"
    summary: |-
      Only show errors, suppressing warnings.
  - name: --output -o
    defaultValue: json
    acceptedValues: json, jsonc, none, table, tsv, yaml, yamlc
    summary: |-
      Output format.
  - name: --query
    summary: |-
      JMESPath query string. See http://jmespath.org/ 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
    defaultValue: "False"
    summary: |-
      Increase logging verbosity. Use --debug for full debug logs.
- uid: az_group_lock_list
  name: az group lock list
  summary: |-
    List lock information in the 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 lock list --resource-group
                       [--filter-string]
  examples:
  - summary: |-
      List out all locks on the resource group level
    syntax: az group lock list -g MyResourceGroup
  requiredParameters:
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  optionalParameters:
  - name: --filter-string
    summary: |-
      A query filter to use to restrict the results.
  globalParameters:
  - name: --debug
    defaultValue: "False"
    summary: |-
      Increase logging verbosity to show all debug logs.
  - name: --help -h
    summary: |-
      Show this help message and exit.
  - name: --only-show-errors
    defaultValue: "False"
    summary: |-
      Only show errors, suppressing warnings.
  - name: --output -o
    defaultValue: json
    acceptedValues: json, jsonc, none, table, tsv, yaml, yamlc
    summary: |-
      Output format.
  - name: --query
    summary: |-
      JMESPath query string. See http://jmespath.org/ 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
    defaultValue: "False"
    summary: |-
      Increase logging verbosity. Use --debug for full debug logs.
- uid: az_group_lock_show
  name: az group lock show
  summary: |-
    Show the details of a resource group lock.
  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 lock show [--ids]
                       [--name]
                       [--resource-group]
  examples:
  - summary: |-
      Show a resource group level lock
    syntax: az group lock show -n lockname -g MyResourceGroup
  optionalParameters:
  - name: --ids
    summary: |-
      One or more resource IDs (space-delimited). If provided, no other "Resource Id" arguments should be specified.
  - name: --name -n
    summary: |-
      Name of the lock.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  globalParameters:
  - name: --debug
    defaultValue: "False"
    summary: |-
      Increase logging verbosity to show all debug logs.
  - name: --help -h
    summary: |-
      Show this help message and exit.
  - name: --only-show-errors
    defaultValue: "False"
    summary: |-
      Only show errors, suppressing warnings.
  - name: --output -o
    defaultValue: json
    acceptedValues: json, jsonc, none, table, tsv, yaml, yamlc
    summary: |-
      Output format.
  - name: --query
    summary: |-
      JMESPath query string. See http://jmespath.org/ 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
    defaultValue: "False"
    summary: |-
      Increase logging verbosity. Use --debug for full debug logs.
- uid: az_group_lock_update
  name: az group lock update
  summary: |-
    Update a resource group lock.
  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 lock update [--ids]
                         [--lock-type {CanNotDelete, ReadOnly}]
                         [--name]
                         [--notes]
                         [--resource-group]
  examples:
  - summary: |-
      Update a resource group lock with new notes and type
    syntax: az group lock update --name lockName -g MyResourceGroup --notes newNotesHere --lock-type CanNotDelete
  optionalParameters:
  - name: --ids
    summary: |-
      One or more resource IDs (space-delimited). If provided, no other "Resource Id" arguments should be specified.
  - name: --lock-type -t
    acceptedValues: CanNotDelete, ReadOnly
    summary: |-
      The type of lock restriction.
  - name: --name -n
    summary: |-
      Name of the lock.
  - name: --notes
    summary: |-
      Notes about this lock.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  globalParameters:
  - name: --debug
    defaultValue: "False"
    summary: |-
      Increase logging verbosity to show all debug logs.
  - name: --help -h
    summary: |-
      Show this help message and exit.
  - name: --only-show-errors
    defaultValue: "False"
    summary: |-
      Only show errors, suppressing warnings.
  - name: --output -o
    defaultValue: json
    acceptedValues: json, jsonc, none, table, tsv, yaml, yamlc
    summary: |-
      Output format.
  - name: --query
    summary: |-
      JMESPath query string. See http://jmespath.org/ 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
    defaultValue: "False"
    summary: |-
      Increase logging verbosity. Use --debug for full debug logs.
commands:
- az_group_lock_create
- az_group_lock_delete
- az_group_lock_list
- az_group_lock_show
- az_group_lock_update
metadata:
  ms.date: 02/06/2026
  description: Manage Azure resource group locks.