az dedicated-hsm

  • リファレンス

Note

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

ハードウェア セキュリティ モジュールを使用して専用 HSM を管理します。

コマンド

名前 説明 型 Status
az dedicated-hsm create

指定したサブスクリプションに専用 HSM を作成します。

 拡張 GA
az dedicated-hsm delete

指定した Azure Dedicated HSM を削除します。

 拡張 GA
az dedicated-hsm list

List 操作では、サブスクリプションに関連付けられている専用 HSM と、指定したリソース グループ内に関する情報を取得します。 また、List 操作は、サブスクリプションに関連付けられている専用 HSM に関する情報を取得します。

 拡張 GA
az dedicated-hsm list-outbound-network-dependency-endpoint

指定した専用 HSM リソース内のエグレス エンドポイント (すべての送信依存関係のネットワーク エンドポイント) の一覧を取得します。 この操作は、各エグレス エンドポイントのプロパティを返します。

 拡張 GA
az dedicated-hsm show

指定した Azure 専用 HSM を取得します。

 拡張 GA
az dedicated-hsm update

指定したサブスクリプションの専用 HSM を更新します。

 拡張 GA
az dedicated-hsm wait

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

 拡張 GA

az dedicated-hsm create

指定したサブスクリプションに専用 HSM を作成します。

az dedicated-hsm create --name
                        --resource-group
                        [--location]
                        [--mgmt-network-interfaces]
                        [--mgmt-network-subnet]
                        [--network-interfaces]
                        [--no-wait]
                        [--sku {SafeNet Luna Network HSM A790, payShield10K_LMK1_CPS250, payShield10K_LMK1_CPS2500, payShield10K_LMK1_CPS60, payShield10K_LMK2_CPS250, payShield10K_LMK2_CPS2500, payShield10K_LMK2_CPS60}]
                        [--stamp-id]
                        [--subnet]
                        [--tags]
                        [--zones]

例

新規の作成または既存の専用 HSM の更新

az dedicated-hsm create --name "hsm1" --location "westus" --network-interfaces private-ip-address="1.0.0.1" --subnet id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01" --stamp-id "stamp01" --sku "SafeNet Luna Network HSM A790" --tags Dept="hsm" Environment="dogfood" --resource-group "hsm-group"

新規の作成または既存の支払い HSM の更新

az dedicated-hsm create --name "hsm1" --location "westus" --mgmt-network-interfaces private-ip-address="1.0.0.1" --mgmt-network-subnet id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01" --stamp-id "stamp01" --sku "payShield10K_LMK1_CPS60" --tags Dept="hsm" Environment="dogfood" --resource-group "hsm-group"

管理プロファイルを使用して新しい支払い HSM を作成するか、既存の支払い HSM を更新する

az dedicated-hsm create --name "hsm1" --location "westus" --network-interfaces private-ip-address="1.0.0.2" --subnet id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01" --mgmt-network-interfaces private-ip-address="1.0.0.1" --mgmt-network-subnet id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01" --stamp-id "stamp02" --sku "payShield10K_LMK1_CPS60" --tags Dept="hsm" Environment="dogfood" --resource-group "hsm-group"

必須のパラメーター

--name

専用 Hsm の名前。

--resource-group -g

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

省略可能のパラメーター

--location -l

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

--mgmt-network-interfaces -m

専用 HSM に関連付けられているネットワーク インターフェイスのリソース ID の一覧を指定します。

使用法: --mgmt-network-interfaces private-ip-address=XX

private-ip-address: インターフェイスのプライベート IP アドレス

複数の --mgmt-network-interfaces 引数を使用して、複数のアクションを指定できます。

--mgmt-network-subnet

サブネットの識別子を指定します。

使用法: --mgmt-network-subnet id=XX

id: /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..の形式の ARM リソース ID。

--network-interfaces -i

専用 HSM に関連付けられているネットワーク インターフェイスのリソース ID の一覧を指定します。

使用法: --network-interfaces private-ip-address=XX

private-ip-address: インターフェイスのプライベート IP アドレス

複数の --network-interfaces 引数を使用して、複数のアクションを指定できます。

--no-wait

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

既定値: False
--sku

専用 HSM の SKU。

承認された値: SafeNet Luna Network HSM A790, payShield10K_LMK1_CPS250, payShield10K_LMK1_CPS2500, payShield10K_LMK1_CPS60, payShield10K_LMK2_CPS250, payShield10K_LMK2_CPS2500, payShield10K_LMK2_CPS60
--stamp-id

このフィールドは、RP が可用性ゾーンをサポートしていない場合に使用されます。

--subnet

サブネットの識別子を指定します。

使用法: --subnet id=XX

id: /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..の形式の ARM リソース ID。

--tags

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

--zones

専用 HSM ゾーン。

グローバル パラメーター
--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 dedicated-hsm delete

指定した Azure Dedicated HSM を削除します。

az dedicated-hsm delete [--ids]
                        [--name]
                        [--no-wait]
                        [--resource-group]
                        [--subscription]
                        [--yes]

例

専用 HSM を削除する

az dedicated-hsm delete --name "hsm1" --resource-group "hsm-group"

省略可能のパラメーター

--ids

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

--name

削除する専用 HSM の名前。

--no-wait

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

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

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

--subscription

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

--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 dedicated-hsm list

List 操作では、サブスクリプションに関連付けられている専用 HSM と、指定したリソース グループ内に関する情報を取得します。 また、List 操作は、サブスクリプションに関連付けられている専用 HSM に関する情報を取得します。

az dedicated-hsm list [--resource-group]
                      [--top]

例

リソース グループ内の専用 HSM デバイスを一覧表示する

az dedicated-hsm list --resource-group "hsm-group"

支払い HSM を含むリソース グループ内の専用 HSM デバイスを一覧表示する

az dedicated-hsm list --resource-group "hsm-group"

サブスクリプション内の専用 HSM デバイスを一覧表示する

az dedicated-hsm list

支払い HSM を含むサブスクリプション内の専用 HSM デバイスを一覧表示する

az dedicated-hsm list

省略可能のパラメーター

--resource-group -g

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

--top

返す最大結果数。

グローバル パラメーター
--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 dedicated-hsm list-outbound-network-dependency-endpoint

指定した専用 HSM リソース内のエグレス エンドポイント (すべての送信依存関係のネットワーク エンドポイント) の一覧を取得します。 この操作は、各エグレス エンドポイントのプロパティを返します。

az dedicated-hsm list-outbound-network-dependency-endpoint --name
                                                           --resource-group

例

管理対象クラスター別に OutboundNetworkDependenciesEndpoints を一覧表示する

az dedicated-hsm list-outbound-network-dependency-endpoint --name "hsm1" --resource-group "hsm-group"

必須のパラメーター

--name

専用 HSM の名前。

--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 dedicated-hsm show

指定した Azure 専用 HSM を取得します。

az dedicated-hsm show [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

例

専用 HSM を取得する

az dedicated-hsm show --name "hsm1" --resource-group "hsm-group"

決済用 HSM を取得する

az dedicated-hsm show --name "hsm1" --resource-group "hsm-group"

2018-10-31Preview API バージョンで支払い HSM を取得する

az dedicated-hsm show --name "hsm1" --resource-group "hsm-group"

省略可能のパラメーター

--ids

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

--name

専用 HSM の名前。

--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 dedicated-hsm update

指定したサブスクリプションの専用 HSM を更新します。

az dedicated-hsm update [--ids]
                        [--name]
                        [--no-wait]
                        [--resource-group]
                        [--subscription]
                        [--tags]

例

既存の専用 HSM を更新する

az dedicated-hsm update --name "hsm1" --tags Dept="hsm" Environment="dogfood" Slice="A" --resource-group "hsm-group"

既存の支払い HSM を更新する

az dedicated-hsm update --name "hsm1" --tags Dept="hsm" Environment="dogfood" Slice="A" --resource-group "hsm-group"

省略可能のパラメーター

--ids

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

--name

専用 HSM の名前。

--no-wait

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

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

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_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 dedicated-hsm wait

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

az dedicated-hsm wait [--created]
                      [--custom]
                      [--deleted]
                      [--exists]
                      [--ids]
                      [--interval]
                      [--name]
                      [--resource-group]
                      [--subscription]
                      [--timeout]
                      [--updated]

例

dedicated-hsm が正常に作成されるまで、CLI スクリプトの次の行の実行を一時停止します。

az dedicated-hsm wait --name "hsm1" --resource-group "hsm-group" --created

dedicated-hsm が正常に更新されるまで、CLI スクリプトの次の行の実行を一時停止します。

az dedicated-hsm wait --name "hsm1" --resource-group "hsm-group" --updated

dedicated-hsm が正常に削除されるまで、CLI スクリプトの次の行の実行を一時停止します。

az dedicated-hsm wait --name "hsm1" --resource-group "hsm-group" --deleted

省略可能のパラメーター

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

専用 HSM の名前。

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