az dataprotection backup-vault

參考

備註

此參考是 Azure CLI 的 資料保護 延伸模組的一部分（2.57.0 版或更高版本）。擴充功能會在您第一次執行 az dataprotection backup-vault 命令時自動安裝。深入瞭解擴充功能。

使用數據保護管理備份保存庫。

命令

名稱	Description	類型	狀態
az dataprotection backup-vault create	建立屬於資源群組的BackupVault資源。	擴充套件	GA
az dataprotection backup-vault delete	從資源群組中刪除BackupVault資源。	擴充套件	GA
az dataprotection backup-vault list	取得訂用帳戶或資源群組中的備份保存庫清單。	擴充套件	GA
az dataprotection backup-vault list-from-resourcegraph	列出訂用帳戶、資源群組和保存庫之間的備份保存庫。	擴充套件	GA
az dataprotection backup-vault resource-guard-mapping	管理備份保存庫的 ResourceGuard 對應。	擴充套件	GA
az dataprotection backup-vault resource-guard-mapping create	建立 ResourceGuard 對應。	擴充套件	GA
az dataprotection backup-vault resource-guard-mapping delete	刪除 ResourceGuard 對應。	擴充套件	GA
az dataprotection backup-vault resource-guard-mapping show	取得與保存庫相關聯的 ResourceGuard 對應物件，且符合要求中的名稱。	擴充套件	GA
az dataprotection backup-vault show	取得屬於資源群組的資源。	擴充套件	GA
az dataprotection backup-vault update	更新屬於資源群組的BackupVault資源。例如，更新資源的標記。	擴充套件	GA
az dataprotection backup-vault wait	將 CLI 置於等候狀態，直到符合條件為止。	擴充套件	GA

az dataprotection backup-vault create

建立屬於資源群組的BackupVault資源。

az dataprotection backup-vault create --resource-group
                                      --storage-setting
                                      --vault-name
                                      [--azure-monitor-alerts-for-job-failures {Disabled, Enabled}]
                                      [--cmk-encryption-key-uri]
                                      [--cmk-encryption-state {Disabled, Enabled, Inconsistent}]
                                      [--cmk-identity-type {SystemAssigned, UserAssigned}]
                                      [--cmk-infra-encryption {Disabled, Enabled}]
                                      [--cmk-uami]
                                      [--cross-region-restore-state {Disabled, Enabled}]
                                      [--cross-subscription-restore-state {Disabled, Enabled, PermanentlyDisabled}]
                                      [--e-tag]
                                      [--immutability-state {Disabled, Locked, Unlocked}]
                                      [--location]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--retention-duration-in-days]
                                      [--soft-delete-state {AlwaysOn, Off, On}]
                                      [--tags]
                                      [--type]
                                      [--uami]

範例

建立 BackupVault

az dataprotection backup-vault create --type "None" --location "WestUS" --azure-monitor-alerts-for-job-failures "Enabled" --storage-setting "[{type:'LocallyRedundant',datastore-type:'VaultStore'}]" --tags key1="val1" --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

使用 MSI 建立 BackupVault

az dataprotection backup-vault create --type "systemAssigned" --location "WestUS" --azure-monitor-alerts-for-job-failures "Enabled" --storage-setting "[{type:'LocallyRedundant',datastore-type:'VaultStore'}]" --tags key1="val1" --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

使用 CMK 加密建立 BackupVault

az dataprotection backup-vault create -g "resourceGroupName" -v "vaultName" --location "eastasia" --storage-setting "[{type:'LocallyRedundant',datastore-type:'VaultStore'}]" --type "UserAssigned" --user-assigned-identities '{"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleuami":{}}' --cmk-encryption-key-uri "https://samplekvazbckp.vault.azure.net/keys/testkey/3cd5235ad6ac4c11b40a6f35444bcbe1" --cmk-encryption-state "Enabled" --cmk-identity-type "UserAssigned" --cmk-infrastructure-encryption "Enabled" --cmk-user-assigned-identity-id  "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleuami"

必要參數

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

--storage-setting --storage-settings

記憶體設定。使用方式：-storage-setting “[{type：'LocalRedundant'，datastore-type：'VaultStore'}]” 支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。單一旗標：--storage-settings。

--vault-name -v

備份保存庫的名稱。

選擇性參數

--azure-monitor-alerts-for-job-failures --job-failure-alerts

屬性，指定是否應該針對所有失敗的作業引發內建 Azure 監視器警示。

接受的值: Disabled, Enabled

--cmk-encryption-key-uri

要用於加密之 CMK 金鑰的金鑰 URI。若要啟用金鑰的自動輪替，請從金鑰 URI 中排除版本元件。

--cmk-encryption-state

啟用備份保存庫的 CMK 加密狀態。

接受的值: Disabled, Enabled, Inconsistent

--cmk-identity-type

要用於 CMK 加密的身分識別類型 - SystemAssigned 或 UserAssigned Identity。

接受的值: SystemAssigned, UserAssigned

--cmk-infra-encryption --cmk-infrastructure-encryption

在此保存庫上啟用/停用CMK的基礎結構加密。只有在建立保存庫時，才能設定基礎結構加密。

接受的值: Disabled, Enabled

--cmk-uami --cmk-user-assigned-identity-id

如果身分識別類型為UserAssigned，則需要此參數。新增使用者指派的受控識別標識碼，以用來具有 Key Vault 訪問許可權。

--cross-region-restore-state --crr-state

設定 CrossRegionRestore 狀態。啟用之後，就無法將它設定為停用。

接受的值: Disabled, Enabled

--cross-subscription-restore-state --csr-state

CrossSubscriptionRestore 狀態。

接受的值: Disabled, Enabled, PermanentlyDisabled

--e-tag

選擇性 ETag。

--immutability-state

不變性狀態。

接受的值: Disabled, Locked, Unlocked

--location -l

位置。值的來源：az account list-locations。您可以使用 az configure --defaults location=<location>來設定預設位置。未指定時，將會使用資源群組的位置。

--no-wait

請勿等候長時間執行的作業完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--retention-duration-in-days --soft-delete-retention

虛刪除保留期間。

預設值: 14.0

--soft-delete-state

虛刪除的狀態。

接受的值: AlwaysOn, Off, On

預設值: On

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「清除現有的標記」。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

--type

identityType，可以是 “SystemAssigned”、“UserAssigned”、“SystemAssigned、UserAssigned” 或 “None”。

--uami --user-assigned-identities

取得或設定使用者指派的身分識別。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

az dataprotection backup-vault delete

從資源群組中刪除BackupVault資源。

az dataprotection backup-vault delete [--ids]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--resource-group]
                                      [--subscription]
                                      [--vault-name]
                                      [--yes]

範例

刪除 BackupVault

az dataprotection backup-vault delete --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

選擇性參數

--ids

一或多個資源識別碼（以空格分隔）。它應該是包含「資源標識碼」自變數所有資訊的完整資源識別碼。您應該提供 --ids 或其他「資源識別碼」自變數。

--no-wait

請勿等候長時間執行的作業完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--vault-name -v

備份保存庫的名稱。

--yes -y

請勿提示確認。

預設值: False

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

az dataprotection backup-vault list

取得訂用帳戶或資源群組中的備份保存庫清單。

az dataprotection backup-vault list [--max-items]
                                    [--next-token]
                                    [--resource-group]

範例

列出訂用帳戶中的備份保存庫

az dataprotection backup-vault list

列出資源群組中的備份保存庫

az dataprotection backup-vault list -g sarath-rg

選擇性參數

--max-items

命令輸出中要傳回的項目總數。如果可用的專案總數超過指定的值，則會在命令的輸出中提供令牌。若要繼續分頁，請在後續命令的 --next-token 自變數中提供令牌值。

--next-token

標記，指定要開始分頁的位置。這是先前截斷回應中的令牌值。

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

az dataprotection backup-vault list-from-resourcegraph

列出訂用帳戶、資源群組和保存庫之間的備份保存庫。

az dataprotection backup-vault list-from-resourcegraph [--resource-groups]
                                                       [--subscriptions]
                                                       [--vault-id]
                                                       [--vaults]

範例

擷取特定的備份保存庫

az dataprotection backup-vault list-from-resourcegraph --subscriptions 00000000-0000-0000-0000-000000000000 --resource-groups sample_rg --vaults sample_vault

選擇性參數

--resource-groups

資源群組的清單。

--subscriptions

訂用帳戶標識碼清單。

--vault-id

指定要套用的保存庫標識碼篩選。

--vaults

保存庫名稱的清單。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

az dataprotection backup-vault show

取得屬於資源群組的資源。

az dataprotection backup-vault show [--ids]
                                    [--resource-group]
                                    [--subscription]
                                    [--vault-name]

範例

取得 BackupVault

az dataprotection backup-vault show --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

使用 MSI 取得 BackupVault

az dataprotection backup-vault show --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

選擇性參數

--ids

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--vault-name -v

備份保存庫的名稱。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

az dataprotection backup-vault update

更新屬於資源群組的BackupVault資源。例如，更新資源的標記。

az dataprotection backup-vault update [--add]
                                      [--azure-monitor-alerts-for-job-failures {Disabled, Enabled}]
                                      [--cmk-encryption-key-uri]
                                      [--cmk-encryption-state {Disabled, Enabled, Inconsistent}]
                                      [--cmk-identity-type {SystemAssigned, UserAssigned}]
                                      [--cmk-uami]
                                      [--cross-region-restore-state {Disabled, Enabled}]
                                      [--cross-subscription-restore-state {Disabled, Enabled, PermanentlyDisabled}]
                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--ids]
                                      [--immutability-state {Disabled, Locked, Unlocked}]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--operation-requests]
                                      [--remove]
                                      [--resource-group]
                                      [--retention-duration-in-days]
                                      [--set]
                                      [--soft-delete-state {AlwaysOn, Off, On}]
                                      [--subscription]
                                      [--tags]
                                      [--tenant-id]
                                      [--type]
                                      [--uami]
                                      [--vault-name]

範例

Patch BackupVault

az dataprotection backup-vault update --azure-monitor-alerts-for-job-failures "Enabled" --tags newKey="newVal" --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

選擇性參數

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。範例： --add property.listProperty <key=value, string or JSON string>.

--azure-monitor-alerts-for-job-failures --job-failure-alerts

屬性，指定是否應該針對所有失敗的作業引發內建 Azure 監視器警示。

接受的值: Disabled, Enabled

--cmk-encryption-key-uri

客戶自控金鑰的金鑰 URI。

--cmk-encryption-state

啟用備份保存庫的 CMK 加密狀態。

接受的值: Disabled, Enabled, Inconsistent

--cmk-identity-type

要用於 CMK 加密的身分識別類型 - SystemAssigned 或 UserAssigned Identity。

接受的值: SystemAssigned, UserAssigned

--cmk-uami --cmk-user-assigned-identity-id

如果身分識別類型為UserAssigned，則需要此參數。新增使用者指派的受控識別標識碼，以用來具有 Key Vault 訪問許可權。

--cross-region-restore-state --crr-state

設定 CrossRegionRestore 狀態。啟用之後，就無法將它設定為停用。

接受的值: Disabled, Enabled

--cross-subscription-restore-state --csr-state

CrossSubscriptionRestore 狀態。

接受的值: Disabled, Enabled, PermanentlyDisabled

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--ids

--immutability-state

不變性狀態。

接受的值: Disabled, Locked, Unlocked

--no-wait

請勿等候長時間執行的作業完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--operation-requests --resource-guard-operation-requests

將執行 LAC 檢查的 ResourceGuardOperationRequests 支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。單一旗標：--operation-requests。

--remove

從清單中移除屬性或專案。範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

--retention-duration-in-days --soft-delete-retention

虛刪除保留期間。

--set

指定要設定的屬性路徑和值，以更新物件。範例： --set property1.property2=<value>.

--soft-delete-state

虛刪除的狀態。

接受的值: AlwaysOn, Off, On

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--tags

資源標籤。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

--tenant-id

跨租使用者呼叫的租用戶標識碼。

--type

identityType，可以是 “SystemAssigned”、“UserAssigned”、“SystemAssigned、UserAssigned” 或 “None”。

--uami --user-assigned-identities

取得或設定使用者指派的身分識別。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

--vault-name -v

備份保存庫的名稱。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

az dataprotection backup-vault wait

將 CLI 置於等候狀態，直到符合條件為止。

az dataprotection backup-vault wait [--created]
                                    [--custom]
                                    [--deleted]
                                    [--exists]
                                    [--ids]
                                    [--interval]
                                    [--resource-group]
                                    [--subscription]
                                    [--timeout]
                                    [--updated]
                                    [--vault-name]

選擇性參數

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

預設值: False

--custom

等到條件符合自定義 JMESPath 查詢為止。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--ids

--interval

輪詢間隔以秒為單位。

預設值: 30

--resource-group -g

資源組名。您可以使用 az configure --defaults group=<name>來設定預設群組。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--timeout

以秒為單位的等候上限。

預設值: 3600

--updated

等到 provisioningState 更新為 'Succeeded'。

預設值: False

--vault-name -v

備份保存庫的名稱。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

共用方式為

az dataprotection backup-vault

命令

az dataprotection backup-vault create

範例

必要參數

選擇性參數

az dataprotection backup-vault delete

範例

選擇性參數

az dataprotection backup-vault list

範例

選擇性參數

az dataprotection backup-vault list-from-resourcegraph

範例

選擇性參數

az dataprotection backup-vault show

範例

選擇性參數

az dataprotection backup-vault update

範例

選擇性參數

az dataprotection backup-vault wait

選擇性參數

其他資源