az disk-encryption-set

Disk Encryption Set リソース。

コマンド

名前	説明	型	Status
az disk-encryption-set create	ディスク暗号化セットを作成してください。	コア	GA
az disk-encryption-set delete	ディスク暗号化セットを削除します。	コア	GA
az disk-encryption-set identity	ディスク暗号化セットの ID を管理します。	コア	GA
az disk-encryption-set identity assign	既存のディスク暗号化セットにマネージド ID を追加します。	コア	GA
az disk-encryption-set identity remove	既存のディスク暗号化セットからマネージド ID を削除します。	コア	GA
az disk-encryption-set identity show	ディスク暗号化セットのマネージド ID を表示します。	コア	GA
az disk-encryption-set list	ディスク暗号化セットを一覧表示します。	コア	GA
az disk-encryption-set list-associated-resources	このディスク暗号化セットで暗号化されているすべてのリソースを一覧表示します。	コア	GA
az disk-encryption-set show	ディスク暗号化セットに関する情報を取得します。	コア	GA
az disk-encryption-set update	ディスク暗号化セットを更新します。	コア	GA
az disk-encryption-set wait	条件が満たされるまで CLI を待機状態にします。	コア	GA

az disk-encryption-set create

ディスク暗号化セットを作成してください。

az disk-encryption-set create --key-url
                              --name
                              --resource-group
                              [--auto-rotation {false, true}]
                              [--encryption-type {ConfidentialVmEncryptedWithCustomerKey, EncryptionAtRestWithCustomerKey, EncryptionAtRestWithPlatformAndCustomerKeys, EncryptionAtRestWithPlatformKey}]
                              [--federated-client-id]
                              [--location]
                              [--mi-system-assigned {false, true}]
                              [--mi-user-assigned]
                              [--no-wait]
                              [--source-vault]
                              [--tags]

例

ディスク暗号化セットを作成してください。

az disk-encryption-set create --resource-group MyResourceGroup --name MyDiskEncryptionSet --key-url MyKey --source-vault MyVault

システム割り当て ID を使用してディスク暗号化セットを作成します。

az disk-encryption-set create --resource-group MyResourceGroup --name MyDiskEncryptionSet --key-url MyKey --source-vault MyVault --mi-system-assigned

ユーザー割り当て ID を使用してディスク暗号化セットを作成します。

az disk-encryption-set create --resource-group MyResourceGroup --name MyDiskEncryptionSet --key-url MyKey --source-vault MyVault --mi-user-assigned myAssignedId

システム割り当て ID とユーザー割り当て ID を使用してディスク暗号化セットを作成します。

az disk-encryption-set create --resource-group MyResourceGroup --name MyDiskEncryptionSet --key-url MyKey --source-vault MyVault --mi-system-assigned --mi-user-assigned myAssignedId

マルチテナント アプリケーション クライアント ID を使用してディスク暗号化セットを作成し、別のテナントのキー コンテナーにアクセスします。

az disk-encryption-set create --resource-group MyResourceGroup --name MyDiskEncryptionSet --key-url MyKey --source-vault MyVault --federated-client-id myFederatedClientId

二重暗号化をサポートするディスク暗号化セットを作成します。

az disk-encryption-set create --resource-group MyResourceGroup --name MyDiskEncryptionSet --key-url MyKey --source-vault MyVault --encryption-type EncryptionAtRestWithPlatformAndCustomerKeys

必須のパラメーター

--key-url

KeyVault のキーまたはシークレットを指す URL。

--name -n

ディスク暗号化セットの名前。

--resource-group -g

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

省略可能のパラメーター

--auto-rotation --enable-auto-key-rotation

キーの自動ローテーションを有効にします。

承認された値: false, true

--encryption-type

ディスクのデータを暗号化するために使用されるキーの種類。 EncryptionAtRestWithPlatformKey: ディスクはプラットフォーム マネージド キーを使用して保存時に暗号化されます。 既定の暗号化の種類です。 EncryptionAtRestWithCustomerKey: ディスクは、顧客が変更および取り消すことができるカスタマー マネージド キーを使用して保存時に暗号化されます。 EncryptionAtRestWithPlatformAndCustomerKeys: ディスクは保存時に 2 層の暗号化で暗号化されます。 キーの 1 つはカスタマー マネージドで、もう 1 つのキーはプラットフォーム管理です。 ConfidentialVmEncryptedWithCustomerKey: 機密 VM に対して受け入れられる追加の暗号化の種類。 ディスクは、カスタマー マネージド キーを使用して保存時に暗号化されます。

承認された値: ConfidentialVmEncryptedWithCustomerKey, EncryptionAtRestWithCustomerKey, EncryptionAtRestWithPlatformAndCustomerKeys, EncryptionAtRestWithPlatformKey

--federated-client-id

テナント間のシナリオで使用されるフェデレーション クライアント ID。

--location -l

Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--mi-system-assigned

システム割り当て ID を使用するには、このフラグを指定します。 その他の例については、ヘルプを参照してください。

承認された値: false, true

--mi-user-assigned

ディスク暗号化セットに使用するユーザー割り当て ID。 その他の例については、ヘルプを参照してください。

--no-wait

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

既定値: False

--source-vault

キーまたはシークレットを含む KeyVault の名前または ID。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

グローバル パラメーター

--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 disk-encryption-set delete

ディスク暗号化セットを削除します。

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

例

ディスク暗号化セットを削除します。

az disk-encryption-set delete --name MyDiskEncryptionSet --resource-group MyResourceGroup

省略可能のパラメーター

--disk-encryption-set-name --name -n

ディスク暗号化セットの名前。

--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 を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター

--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 disk-encryption-set list

ディスク暗号化セットを一覧表示します。

az disk-encryption-set list [--max-items]
                            [--next-token]
                            [--resource-group]

省略可能のパラメーター

--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 disk-encryption-set list-associated-resources

このディスク暗号化セットで暗号化されているすべてのリソースを一覧表示します。

az disk-encryption-set list-associated-resources --disk-encryption-set-name
                                                 --resource-group
                                                 [--max-items]
                                                 [--next-token]

必須のパラメーター

--disk-encryption-set-name --name -n

ディスク暗号化セットの名前。

--resource-group -g

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

省略可能のパラメーター

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数に --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

グローバル パラメーター

--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 disk-encryption-set show

ディスク暗号化セットに関する情報を取得します。

az disk-encryption-set show [--disk-encryption-set-name]
                            [--ids]
                            [--resource-group]
                            [--subscription]

例

ディスク暗号化セットの情報を取得する

az disk-encryption-set show --name MyDiskEncryptionSet --resource-group MyResourceGroup

省略可能のパラメーター

--disk-encryption-set-name --name -n

ディスク暗号化セットの名前。

--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 を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター

--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 disk-encryption-set update

ディスク暗号化セットを更新します。

az disk-encryption-set update [--add]
                              [--auto-rotation {false, true}]
                              [--federated-client-id]
                              [--force-string]
                              [--ids]
                              [--key-url]
                              [--name]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--source-vault]
                              [--subscription]

例

ディスク暗号化セットを更新します。 (自動生成)

az disk-encryption-set update --name MyDiskEncryptionSet --resource-group MyResourceGroup --key-url MyKey --source-vault MyVault

ディスク暗号化セットのマルチテナント アプリケーション クライアント ID を更新します。

az disk-encryption-set update --name MyDiskEncryptionSet --resource-group MyResourceGroup --key-url MyKey --source-vault MyVault --federated-client-id myFederatedClientId

ディスク暗号化セットのマルチテナント アプリケーション クライアント ID をクリアします。

az disk-encryption-set update --name MyDiskEncryptionSet --resource-group MyResourceGroup --key-url MyKey --source-vault MyVault --federated-client-id None

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

既定値: []

--auto-rotation --enable-auto-key-rotation

キーの自動ローテーションを有効にします。

承認された値: false, true

--federated-client-id

テナント間のシナリオで使用されるフェデレーション クライアント ID。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

既定値: False

--ids

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

--key-url

KeyVault のキーまたはシークレットを指す URL。

--name -n

ディスク暗号化セットの名前。

--remove

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

既定値: []

--resource-group -g

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

--set

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

既定値: []

--source-vault

キーまたはシークレットを含む KeyVault の名前または ID。

--subscription

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

グローバル パラメーター

--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 disk-encryption-set wait

条件が満たされるまで CLI を待機状態にします。

az disk-encryption-set wait [--created]
                            [--custom]
                            [--deleted]
                            [--disk-encryption-set-name]
                            [--exists]
                            [--ids]
                            [--interval]
                            [--resource-group]
                            [--subscription]
                            [--timeout]
                            [--updated]

省略可能のパラメーター

--created

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

既定値: False

--custom

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

--deleted

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

既定値: False

--disk-encryption-set-name --name -n

ディスク暗号化セットの名前。

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

グローバル パラメーター

--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 を使います。