az dedicated-hsm

參考

注意

此參考是 Azure CLI 的硬體安全性模組 擴充功能的一部分 （2.15.0 版或更高版本）。擴充功能會在您第一次執行 az dedicated-hsm 命令時自動安裝。深入了解擴充功能。

使用硬體安全性模組管理專用 hsm。

命令

名稱	Description	類型	狀態
az dedicated-hsm create	在指定的訂用帳戶中建立專用 HSM。	擴充	GA
az dedicated-hsm delete	刪除指定的 Azure 專用 HSM。	擴充	GA
az dedicated-hsm list	List 作業會取得與訂用帳戶和指定資源群組內相關聯之專用 hsms 的相關資訊。而清單作業會取得與訂用帳戶相關聯的專用 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	將 CLI 置於等候狀態，直到符合 dedicated-hsm 的條件為止。	擴充	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

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 相關聯之網路介面的資源識別碼清單。

使用方式：--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 資源識別碼

--network-interfaces -i

指定與專用 HSM 相關聯之網路介面的資源識別碼清單。

使用方式：--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 資源識別碼

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

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

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az dedicated-hsm delete

刪除指定的 Azure 專用 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

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

--name

要刪除的專用 HSM 名稱。

--no-wait

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

預設值: False

--resource-group -g

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

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

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

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az dedicated-hsm list

List 作業會取得與訂用帳戶和指定資源群組內相關聯之專用 hsms 的相關資訊。而清單作業會取得與訂用帳戶相關聯的專用 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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

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

--name

專用 HSM 的名稱。

--resource-group -g

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

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

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

--name

專用 HSM 的名稱。

--no-wait

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

預設值: False

--resource-group -g

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

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

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

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az dedicated-hsm wait

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

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

範例

暫停執行下一行 CLI 腳本，直到成功建立 dedicated-hsm 為止。

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

暫停執行下一行 CLI 腳本，直到成功更新 dedicated-hsm 為止。

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

暫停執行下一行 CLI 腳本，直到成功刪除 dedicated-hsm 為止。

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

選擇性參數

--created

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

預設值: False

--custom

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

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--ids

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

--interval

輪詢間隔以秒為單位。

預設值: 30

--name

專用 HSM 的名稱。

--resource-group -g

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

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 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

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

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

共用方式為

az dedicated-hsm

命令

az dedicated-hsm create

範例

必要參數

選擇性參數

az dedicated-hsm delete

範例

選擇性參數

az dedicated-hsm list

範例

選擇性參數

az dedicated-hsm list-outbound-network-dependency-endpoint

範例

必要參數

az dedicated-hsm show

範例

選擇性參數

az dedicated-hsm update

範例

選擇性參數

az dedicated-hsm wait

範例

選擇性參數

其他資源