az dataprotection backup-vault identity
Note
This reference is part of the dataprotection extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az dataprotection backup-vault identity command. Learn more about extensions.
Manage Identities for Backup Vaults.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az dataprotection backup-vault identity assign |
Assign the user or system managed identities. |
Extension | GA |
| az dataprotection backup-vault identity remove |
Remove the user or system managed identities. |
Extension | GA |
| az dataprotection backup-vault identity show |
Show the details of managed identities. |
Extension | GA |
| az dataprotection backup-vault identity wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az dataprotection backup-vault identity assign
Assign the user or system managed identities.
az dataprotection backup-vault identity assign --resource-group
--vault-name
[--mi-system-assigned]
[--mi-user-assigned]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]Examples
Assign both System and User Assigned Managed Identities
az dataprotection backup-vault identity assign -g testRG -v testVault --system-assigned --user-assigned "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testUAMI" "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testUAMI2"Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the backup vault.
Optional Parameters
Set the system managed identity.
Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az dataprotection backup-vault identity remove
Remove the user or system managed identities.
az dataprotection backup-vault identity remove --resource-group
--vault-name
[--mi-system-assigned]
[--mi-user-assigned]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]Examples
Remove System Identity
az az dataprotection backup-vault identity remove -g testRG -v testVault --system-assignedRemove User Assigned Identity
az az dataprotection backup-vault identity remove -g testRG -v testVault --user-assignedRequired Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the backup vault.
Optional Parameters
Set the system managed identity.
Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az dataprotection backup-vault identity show
Show the details of managed identities.
az dataprotection backup-vault identity show --resource-group
--vault-nameExamples
Show identity of the Backup vault
az dataprotection backup-vault identity show -g testRG -v testVaultRequired Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the backup vault.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az dataprotection backup-vault identity wait
Place the CLI in a waiting state until a condition is met.
az dataprotection backup-vault identity wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
[--vault-name]Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
The name of the backup vault.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
