Share via

az dataprotection backup-vault

  • リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.57.0 以降) のデータ保護拡張機能の一部です。 拡張機能は、az dataprotection backup-vault コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

データ保護を使用してバックアップ コンテナーを管理します。

コマンド

名前 説明 型 Status
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:'LocallyRedundant',datastore-type:'VaultStore'}]" は、短縮構文、json ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。 単数形フラグ: --storage-settings.

--vault-name -v

バックアップ コンテナーの名前。

省略可能のパラメーター

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

失敗したすべてのジョブに対して組み込みの Azure Monitor アラートを発生させるかどうかを指定するプロパティ。

承認された値: Disabled, Enabled
--cmk-encryption-key-uri

暗号化に使用する CMK キーのキー URI。 キーの自動ローテーションを有効にするには、キー URI からバージョン コンポーネントを除外します。

--cmk-encryption-state

Backup Vault の CMK 暗号化状態を有効にします。

承認された値: Disabled, Enabled, Inconsistent
--cmk-identity-type

CMK 暗号化に使用する ID の種類 ( SystemAssigned または UserAssigned ID)。

承認された値: SystemAssigned, UserAssigned
--cmk-infra-encryption --cmk-infrastructure-encryption

このコンテナーで CMK によるインフラストラクチャ暗号化を有効または無効にします。 インフラストラクチャの暗号化は、コンテナーの作成時にのみ構成する必要があります。

承認された値: Disabled, Enabled
--cmk-uami --cmk-user-assigned-identity-id

ID の種類が UserAssigned の場合は、このパラメーターが必要です。 Key Vault へのアクセス許可を持つ、使用するユーザー割り当てマネージド ID を追加します。

--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

Location。 値のソース: 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

"SystemAssigned"、"UserAssigned"、"SystemAssigned、UserAssigned"、または "None" を指定できる identityType。

--uami --user-assigned-identities

ユーザー割り当て ID を取得または設定します。 短縮構文、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

サブスクリプションの名前または ID。 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

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 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

サブスクリプションの名前または ID。 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

サブスクリプションの名前または ID。 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

サブスクリプション ID の一覧。

--vault-id

適用するコンテナー ID フィルターを指定します。

--vaults

コンテナー名の一覧。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 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

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 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

サブスクリプションの名前または ID。 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]

例

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、または JSON 文字列>。

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

失敗したすべてのジョブに対して組み込みの Azure Monitor アラートを発生させるかどうかを指定するプロパティ。

承認された値: Disabled, Enabled
--cmk-encryption-key-uri

カスタマー マネージド キーのキー URI。

--cmk-encryption-state

Backup Vault の CMK 暗号化状態を有効にします。

承認された値: Disabled, Enabled, Inconsistent
--cmk-identity-type

CMK 暗号化に使用する ID の種類 ( SystemAssigned または UserAssigned ID)。

承認された値: SystemAssigned, UserAssigned
--cmk-uami --cmk-user-assigned-identity-id

ID の種類が UserAssigned の場合は、このパラメーターが必要です。 Key Vault へのアクセス許可を持つ、使用するユーザー割り当てマネージド ID を追加します。

--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

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--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 ファイル、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。 単数形フラグ: --operation-requests.

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list OR --remove propertyToRemove。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

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

論理的な削除の保持期間。

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=。

--soft-delete-state

論理的な削除の状態。

承認された値: AlwaysOn, Off, On
--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--tenant-id

テナント間呼び出しのテナント ID。

--type

"SystemAssigned"、"UserAssigned"、"SystemAssigned、UserAssigned"、または "None" を指定できる identityType。

--uami --user-assigned-identities

ユーザー割り当て ID を取得または設定します。 短縮構文、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

サブスクリプションの名前または ID。 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

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: False
--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

既定値: False
--exists

リソースが存在するまで待ちます。

既定値: False
--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--interval

ポーリング間隔 (秒単位)。

既定値: 30
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。