az keyvault
管理 KeyVault 金鑰、秘密和憑證。
命令
az keyvault check-name
檢查指定的名稱是否有效,且尚未使用中。
az keyvault check-name --name
[--resource-type {hsm}]
必要參數
指定資源群組內的 HSM 名稱。
選擇性參數
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
資源類型。
屬性 | 值 |
---|---|
預設值: | hsm |
接受的值: | hsm |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
屬性 | 值 |
---|---|
預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
屬性 | 值 |
---|---|
預設值: | False |
Output format.
屬性 | 值 |
---|---|
預設值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
屬性 | 值 |
---|---|
預設值: | False |
az keyvault create
建立保存庫或 HSM。
默認會啟用 RBAC 授權。 如果手動指定 --enable-rbac-authorization
false
,且未指定 --no-self-perms
旗標,則會為目前用戶或服務主體建立默認許可權。
如果您要指定預設權限,您必須先使用 az account set
變更預設訂用帳戶,而不是使用 --subscription
。
az keyvault create --resource-group
[--administrators]
[--bypass {AzureServices, None}]
[--default-action {Allow, Deny}]
[--enable-purge-protection {false, true}]
[--enable-rbac-authorization {false, true}]
[--enabled-for-deployment {false, true}]
[--enabled-for-disk-encryption {false, true}]
[--enabled-for-template-deployment {false, true}]
[--hsm-name]
[--location]
[--mi-user-assigned]
[--name]
[--network-acls]
[--network-acls-ips]
[--network-acls-vnets]
[--no-self-perms {false, true}]
[--no-wait]
[--public-network-access {Disabled, Enabled}]
[--retention-days]
[--sku]
[--tags]
範例
使用指定的網路 ACL 建立金鑰保存庫(使用 --network-acls 使用 JSON 字串來指定 IP 和 VNet 規則)。
az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls "{\"ip\": [\"1.2.3.4\", \"2.3.4.0/24\"], \"vnet\": [\"vnet_name_1/subnet_name1\", \"vnet_name_2/subnet_name2\", \"/subscriptions/000000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/MyVNet/subnets/MySubnet\"]}"
使用指定的網路 ACL 建立金鑰保存庫(使用 --network-acls 使用 JSON 檔案來指定 IP 和 VNet 規則)。
az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls network-acls-example.json
使用指定的網路 ACL 建立密鑰保存庫(使用 --network-acls-ips 來指定 IP 規則)。
az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls-ips 3.4.5.0/24 4.5.6.0/24
使用指定的網路 ACL 建立密鑰保存庫(使用 --network-acls-vnet 來指定 VNet 規則)。
az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls-vnets vnet_name_2/subnet_name_2 vnet_name_3/subnet_name_3 /subscriptions/000000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet_name_4/subnets/subnet_name_4
使用指定的網路 ACL 建立密鑰保存庫(使用 --network-acls、-network-acls-ips 和 --network-acls-vnet,將會移除備援規則,最後會有 4 個 IP 規則和 3 個 VNet 規則)。
az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls "{\"ip\": [\"1.2.3.4\", \"2.3.4.0/24\"], \"vnet\": [\"vnet_name_1/subnet_name1\", \"vnet_name_2/subnet_name2\"]}" --network-acls-ips 3.4.5.0/24 4.5.6.0/24 --network-acls-vnets vnet_name_2/subnet_name_2 vnet_name_3/subnet_name_3 /subscriptions/000000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet_name_4/subnets/subnet_name_4
建立金鑰保存庫。 (autogenerated)
az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup
必要參數
資源組名。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
選擇性參數
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
[僅限 HSM]受控 HSM 之數據平面作業的系統管理員角色。 它會接受將指派之 OID 的空間分隔清單。
略過空間分隔用途的流量。
屬性 | 值 |
---|---|
Parameter group: | Network Rule Arguments |
接受的值: | AzureServices, None |
未符合規則時要套用的預設動作。
屬性 | 值 |
---|---|
Parameter group: | Network Rule Arguments |
接受的值: | Allow, Deny |
屬性,指定是否啟用此保存庫/受控 HSM 集區的清除保護。 將此屬性設定為 true 會啟用保護,以防止此保存庫/受控 HSM 集區及其內容清除 -- 只有 Key Vault/受控 HSM 服務可能會起始無法復原的硬式刪除。 只有在同時啟用虛刪除時,此設定才有效。 啟用這項功能是無法復原的。
屬性 | 值 |
---|---|
接受的值: | false, true |
控制數據動作授權方式的屬性。 若為 true,金鑰保存庫將會使用角色型存取控制 (RBAC) 進行資料動作的授權,而且會忽略保存庫屬性中指定的存取原則。 若為 false,金鑰保存庫將會使用保存庫屬性中指定的存取原則,而且會忽略儲存在 Azure Resource Manager 上的任何原則。 如果為 null 或未指定,則會使用預設值 true 建立保存庫。 請注意,管理動作一律已獲得 RBAC 的授權。
屬性 | 值 |
---|---|
預設值: | True |
接受的值: | false, true |
[僅限保存庫]屬性,指定是否允許 Azure 虛擬機從金鑰保存庫擷取儲存為秘密的憑證。
屬性 | 值 |
---|---|
接受的值: | false, true |
[僅限保存庫]屬性,指定是否允許 Azure 磁碟加密從保存庫擷取秘密和解除包裝密鑰。
屬性 | 值 |
---|---|
接受的值: | false, true |
[僅限保存庫]屬性,指定是否允許 Azure Resource Manager 從密鑰保存庫擷取秘密。
屬性 | 值 |
---|---|
接受的值: | false, true |
HSM 的名稱。 (--hsm-name 和 --name/-n 互斥,請只指定其中一個。
Location. 值的來源:az account list-locations
。 您可以使用 az configure --defaults location=<location>
來設定預設位置。
[僅限 HSM]啟用受控 HSM 的使用者指派受控識別。 接受以空格分隔的身分識別資源標識符清單。
保存庫的名稱。
Network ACLs. 它會接受 JSON 檔名或 JSON 字串。 JSON 格式:{\"ip\":[<ip1>, <ip2>...],\"vnet\":[<vnet_name_1>/<subnet_name_1>,<subnet_id2>...]}
。
屬性 | 值 |
---|---|
Parameter group: | Network Rule Arguments |
網路 ACL IP 規則。 以空格分隔的IP位址清單。
屬性 | 值 |
---|---|
Parameter group: | Network Rule Arguments |
網路 ACLS VNet 規則。 Vnet/子網組或子網資源標識符的空間分隔清單。
屬性 | 值 |
---|---|
Parameter group: | Network Rule Arguments |
[僅限保存庫]請勿在新的保存庫中新增目前使用者/服務主體的許可權。
屬性 | 值 |
---|---|
接受的值: | false, true |
請勿等候長時間執行的作業完成。
屬性 | 值 |
---|---|
預設值: | False |
在啟用私人端點時,控制來自公用網路的數據平面流量許可權。
屬性 | 值 |
---|---|
接受的值: | Disabled, Enabled |
虛刪除數據保留天數。 它會接受 >=7,<=90。 金鑰保存庫建立的預設值為 90。 MHSM 建立的必要專案。
Required. SKU details. 保存庫允許的值:進階、標準。 Default: standard. HSM 允許的值:Standard_B1、Custom_B32、Custom_B6、Custom_C42、Custom_C10。 Default: Standard_B1.
以空格分隔的標記:key[=value] [key[=value] ...]。使用 「清除現有的標記」。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
屬性 | 值 |
---|---|
預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
屬性 | 值 |
---|---|
預設值: | False |
Output format.
屬性 | 值 |
---|---|
預設值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
屬性 | 值 |
---|---|
預設值: | False |
az keyvault delete
刪除保存庫或 HSM。
az keyvault delete [--hsm-name]
[--name]
[--no-wait]
[--resource-group]
範例
刪除金鑰保存庫。 (autogenerated)
az keyvault delete --name MyKeyVault --resource-group MyResourceGroup
選擇性參數
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
HSM 的名稱。 (--hsm-name 和 --name/-n 互斥,請只指定其中一個。
保存庫的名稱。
請勿等候長時間執行的作業完成。
屬性 | 值 |
---|---|
預設值: | False |
只有在 Key Vault 屬於指定的資源群組時,才繼續。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
屬性 | 值 |
---|---|
預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
屬性 | 值 |
---|---|
預設值: | False |
Output format.
屬性 | 值 |
---|---|
預設值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
屬性 | 值 |
---|---|
預設值: | False |
az keyvault delete-policy
刪除 Key Vault 的安全策略設定。
az keyvault delete-policy --name
[--application-id]
[--no-wait]
[--object-id]
[--resource-group]
[--spn]
[--upn]
必要參數
保存庫的名稱。
選擇性參數
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
代表主體提出要求的用戶端應用程式標識碼。 針對使用代理驗證流程的複合身分識別公開。
請勿等候長時間執行的作業完成。
屬性 | 值 |
---|---|
預設值: | False |
識別將接收許可權之主體的 GUID。
只有在 Key Vault 屬於指定的資源群組時,才繼續。
將接收許可權的服務主體名稱。
將接收許可權的用戶主體名稱。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
屬性 | 值 |
---|---|
預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
屬性 | 值 |
---|---|
預設值: | False |
Output format.
屬性 | 值 |
---|---|
預設值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
屬性 | 值 |
---|---|
預設值: | False |
az keyvault list
列出保存庫和/或 HSM。
az keyvault list [--resource-group]
[--resource-type]
選擇性參數
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
資源組名。 您可以使用 az configure --defaults group=<name>
來設定預設群組。
當 --resource-type 不存在時,命令會列出所有保存庫和 HSM。 --resource-type 的可能值為保存庫和 hsm。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
屬性 | 值 |
---|---|
預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
屬性 | 值 |
---|---|
預設值: | False |
Output format.
屬性 | 值 |
---|---|
預設值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
屬性 | 值 |
---|---|
預設值: | False |
az keyvault list-deleted
取得訂用帳戶中已刪除保存庫或 HSM 的相關信息。
az keyvault list-deleted [--resource-type]
選擇性參數
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
當 --resource-type 不存在時,命令會列出所有已刪除的保存庫和 HSM。 --resource-type 的可能值為保存庫和 hsm。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
屬性 | 值 |
---|---|
預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
屬性 | 值 |
---|---|
預設值: | False |
Output format.
屬性 | 值 |
---|---|
預設值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
屬性 | 值 |
---|---|
預設值: | False |
az keyvault purge
永久刪除指定的保存庫或 HSM。 Aka 清除已刪除的保存庫或 HSM。
az keyvault purge [--hsm-name]
[--location]
[--name]
[--no-wait]
選擇性參數
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
已刪除 HSM 的名稱。 (--hsm-name 和 --name/-n 互斥,請只指定其中一個。
已刪除保存庫或 HSM 的位置。
已刪除保存庫的名稱。
請勿等候長時間執行的作業完成。
屬性 | 值 |
---|---|
預設值: | False |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
屬性 | 值 |
---|---|
預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
屬性 | 值 |
---|---|
預設值: | False |
Output format.
屬性 | 值 |
---|---|
預設值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
屬性 | 值 |
---|---|
預設值: | False |
az keyvault recover
復原保存庫或 HSM。
復原先前已刪除的保存庫或已啟用虛刪除的 HSM。
az keyvault recover [--hsm-name]
[--location]
[--name]
[--no-wait]
[--resource-group]
範例
復原金鑰保存庫。 (autogenerated)
az keyvault recover --location westus2 --name MyKeyVault --resource-group MyResourceGroup
選擇性參數
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
已刪除 HSM 的名稱。 (--hsm-name 和 --name/-n 互斥,請只指定其中一個。
已刪除保存庫或 HSM 的位置。
已刪除保存庫的名稱。
請勿等候長時間執行的作業完成。
屬性 | 值 |
---|---|
預設值: | False |
已刪除保存庫或 HSM 的資源群組。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
屬性 | 值 |
---|---|
預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
屬性 | 值 |
---|---|
預設值: | False |
Output format.
屬性 | 值 |
---|---|
預設值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
屬性 | 值 |
---|---|
預設值: | False |
az keyvault set-policy
更新 Key Vault 的安全策略設定。
az keyvault set-policy --name
[--application-id]
[--certificate-permissions {all, backup, create, delete, deleteissuers, get, getissuers, import, list, listissuers, managecontacts, manageissuers, purge, recover, restore, setissuers, update}]
[--key-permissions {all, backup, create, decrypt, delete, encrypt, get, getrotationpolicy, import, list, purge, recover, release, restore, rotate, setrotationpolicy, sign, unwrapKey, update, verify, wrapKey}]
[--no-wait]
[--object-id]
[--resource-group]
[--secret-permissions {all, backup, delete, get, list, purge, recover, restore, set}]
[--spn]
[--storage-permissions {all, backup, delete, deletesas, get, getsas, list, listsas, purge, recover, regeneratekey, restore, set, setsas, update}]
[--upn]
範例
將密鑰限 'get'、'list'、'import' 和秘密許可權 'backup'、'restore' 指派給對象標識符。
az keyvault set-policy -n MyVault --key-permissions get list import --secret-permissions backup restore --object-id {GUID}
將密鑰限 'get'、'list' 指派給 UPN(用戶主體名稱)。
az keyvault set-policy -n MyVault --key-permissions get list --upn {UPN}
將密鑰限 'get'、'list' 指派給 SPN(服務主體名稱)。
az keyvault set-policy -n MyVault --key-permissions get list --spn {SPN}
必要參數
保存庫的名稱。
選擇性參數
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
代表主體提出要求的用戶端應用程式標識碼。 針對使用代理驗證流程的複合身分識別公開。
要指派之憑證許可權的空間分隔清單。
屬性 | 值 |
---|---|
Parameter group: | Permission Arguments |
接受的值: | all, backup, create, delete, deleteissuers, get, getissuers, import, list, listissuers, managecontacts, manageissuers, purge, recover, restore, setissuers, update |
要指派之金鑰許可權的空間分隔清單。
屬性 | 值 |
---|---|
Parameter group: | Permission Arguments |
接受的值: | all, backup, create, decrypt, delete, encrypt, get, getrotationpolicy, import, list, purge, recover, release, restore, rotate, setrotationpolicy, sign, unwrapKey, update, verify, wrapKey |
請勿等候長時間執行的作業完成。
屬性 | 值 |
---|---|
預設值: | False |
識別將接收許可權之主體的 GUID。
只有在 Key Vault 屬於指定的資源群組時,才繼續。
要指派之秘密許可權的空間分隔清單。
屬性 | 值 |
---|---|
Parameter group: | Permission Arguments |
接受的值: | all, backup, delete, get, list, purge, recover, restore, set |
將接收許可權的服務主體名稱。
要指派之記憶體許可權的空間分隔清單。
屬性 | 值 |
---|---|
Parameter group: | Permission Arguments |
接受的值: | all, backup, delete, deletesas, get, getsas, list, listsas, purge, recover, regeneratekey, restore, set, setsas, update |
將接收許可權的用戶主體名稱。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
屬性 | 值 |
---|---|
預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
屬性 | 值 |
---|---|
預設值: | False |
Output format.
屬性 | 值 |
---|---|
預設值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
屬性 | 值 |
---|---|
預設值: | False |
az keyvault show
顯示保存庫或 HSM 的詳細數據。
az keyvault show [--hsm-name]
[--name]
[--resource-group]
範例
顯示金鑰保存庫的詳細數據。 (autogenerated)
az keyvault show --name MyKeyVault
選擇性參數
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
HSM 的名稱。 (--hsm-name 和 --name/-n 互斥,請只指定其中一個。
保存庫的名稱。
只有在 Key Vault 屬於指定的資源群組時,才繼續。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
屬性 | 值 |
---|---|
預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
屬性 | 值 |
---|---|
預設值: | False |
Output format.
屬性 | 值 |
---|---|
預設值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
屬性 | 值 |
---|---|
預設值: | False |
az keyvault show-deleted
顯示已刪除保存庫或 HSM 的詳細數據。
az keyvault show-deleted [--hsm-name]
[--location]
[--name]
範例
顯示已刪除金鑰保存庫的詳細資料。
az keyvault show-deleted --name MyKeyVault
選擇性參數
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
已刪除 HSM 的名稱。 (--hsm-name 和 --name/-n 互斥,請只指定其中一個。
已刪除保存庫或 HSM 的位置。
已刪除保存庫的名稱。
全域參數
提高日誌詳細程度以顯示所有調試日誌。
屬性 | 值 |
---|---|
預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
屬性 | 值 |
---|---|
預設值: | False |
Output format.
屬性 | 值 |
---|---|
預設值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
屬性 | 值 |
---|---|
預設值: | False |
az keyvault update
更新保存庫的屬性。
az keyvault update --name
[--add]
[--bypass {AzureServices, None}]
[--default-action {Allow, Deny}]
[--enable-purge-protection {false, true}]
[--enable-rbac-authorization {false, true}]
[--enabled-for-deployment {false, true}]
[--enabled-for-disk-encryption {false, true}]
[--enabled-for-template-deployment {false, true}]
[--force-string]
[--no-wait]
[--public-network-access {Disabled, Enabled}]
[--remove]
[--resource-group]
[--retention-days]
[--set]
範例
更新保存庫的屬性。 (autogenerated)
az keyvault update --enabled-for-disk-encryption true --name MyKeyVault --resource-group MyResourceGroup
必要參數
保存庫的名稱。
選擇性參數
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
藉由指定路徑和索引鍵值組,將物件加入物件清單。 範例: --add property.listProperty <key=value, string or JSON string>
.
屬性 | 值 |
---|---|
Parameter group: | Generic Update Arguments |
預設值: | [] |
略過空間分隔用途的流量。
屬性 | 值 |
---|---|
Parameter group: | Network Rule Arguments |
接受的值: | AzureServices, None |
未符合規則時要套用的預設動作。
屬性 | 值 |
---|---|
Parameter group: | Network Rule Arguments |
接受的值: | Allow, Deny |
屬性,指定是否啟用此保存庫/受控 HSM 集區的清除保護。 將此屬性設定為 true 會啟用保護,以防止此保存庫/受控 HSM 集區及其內容清除 -- 只有 Key Vault/受控 HSM 服務可能會起始無法復原的硬式刪除。 只有在同時啟用虛刪除時,此設定才有效。 啟用這項功能是無法復原的。
屬性 | 值 |
---|---|
接受的值: | false, true |
控制數據動作授權方式的屬性。 若為 true,金鑰保存庫將會使用角色型存取控制 (RBAC) 進行資料動作的授權,而且會忽略保存庫屬性中指定的存取原則。 若為 false,金鑰保存庫將會使用保存庫屬性中指定的存取原則,而且會忽略儲存在 Azure Resource Manager 上的任何原則。 如果為 null 或未指定,則會使用預設值 true 建立保存庫。 請注意,管理動作一律已獲得 RBAC 的授權。
屬性 | 值 |
---|---|
接受的值: | false, true |
[僅限保存庫]屬性,指定是否允許 Azure 虛擬機從金鑰保存庫擷取儲存為秘密的憑證。
屬性 | 值 |
---|---|
接受的值: | false, true |
[僅限保存庫]屬性,指定是否允許 Azure 磁碟加密從保存庫擷取秘密和解除包裝密鑰。
屬性 | 值 |
---|---|
接受的值: | false, true |
[僅限保存庫]屬性,指定是否允許 Azure Resource Manager 從密鑰保存庫擷取秘密。
屬性 | 值 |
---|---|
接受的值: | false, true |
使用 'set' 或 'add' 時,請保留字串常值,而不是嘗試轉換成 JSON。
屬性 | 值 |
---|---|
Parameter group: | Generic Update Arguments |
預設值: | False |
請勿等候長時間執行的作業完成。
屬性 | 值 |
---|---|
預設值: | False |
在啟用私人端點時,控制來自公用網路的數據平面流量許可權。
屬性 | 值 |
---|---|
接受的值: | Disabled, Enabled |
從清單中移除屬性或專案。 範例: --remove property.list <indexToRemove>
或 --remove propertyToRemove
。
屬性 | 值 |
---|---|
Parameter group: | Generic Update Arguments |
預設值: | [] |
只有在 Key Vault 屬於指定的資源群組時,才繼續。
虛刪除數據保留天數。 它會接受 >=7,<=90。
指定要設定的屬性路徑和值,以更新物件。 範例: --set property1.property2=<value>
.
屬性 | 值 |
---|---|
Parameter group: | Generic Update Arguments |
預設值: | [] |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
屬性 | 值 |
---|---|
預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
屬性 | 值 |
---|---|
預設值: | False |
Output format.
屬性 | 值 |
---|---|
預設值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
屬性 | 值 |
---|---|
預設值: | False |
az keyvault update-hsm
更新 HSM 的屬性。
az keyvault update-hsm --hsm-name
[--add]
[--bypass {AzureServices, None}]
[--default-action {Allow, Deny}]
[--enable-purge-protection {false, true}]
[--force-string]
[--mi-user-assigned]
[--no-wait]
[--public-network-access {Disabled, Enabled}]
[--remove]
[--resource-group]
[--secondary-locations]
[--set]
範例
更新 HSM 的屬性。
az keyvault update-hsm --enable-purge-protection true --hsm-name MyHSM --resource-group MyResourceGroup
必要參數
HSM 的名稱。
選擇性參數
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
藉由指定路徑和索引鍵值組,將物件加入物件清單。 範例: --add property.listProperty <key=value, string or JSON string>
.
屬性 | 值 |
---|---|
Parameter group: | Generic Update Arguments |
預設值: | [] |
略過空間分隔用途的流量。
屬性 | 值 |
---|---|
Parameter group: | Network Rule Arguments |
接受的值: | AzureServices, None |
未符合規則時要套用的預設動作。
屬性 | 值 |
---|---|
Parameter group: | Network Rule Arguments |
接受的值: | Allow, Deny |
屬性,指定是否啟用此保存庫/受控 HSM 集區的清除保護。 將此屬性設定為 true 會啟用保護,以防止此保存庫/受控 HSM 集區及其內容清除 -- 只有 Key Vault/受控 HSM 服務可能會起始無法復原的硬式刪除。 只有在同時啟用虛刪除時,此設定才有效。 啟用這項功能是無法復原的。
屬性 | 值 |
---|---|
接受的值: | false, true |
使用 'set' 或 'add' 時,請保留字串常值,而不是嘗試轉換成 JSON。
屬性 | 值 |
---|---|
Parameter group: | Generic Update Arguments |
預設值: | False |
啟用受控 HSM 的使用者指派受控識別。 接受以空格分隔的身分識別資源標識符清單。
請勿等候長時間執行的作業完成。
屬性 | 值 |
---|---|
預設值: | False |
在啟用私人端點時,控制來自公用網路的數據平面流量許可權。
屬性 | 值 |
---|---|
接受的值: | Disabled, Enabled |
從清單中移除屬性或專案。 範例: --remove property.list <indexToRemove>
或 --remove propertyToRemove
。
屬性 | 值 |
---|---|
Parameter group: | Generic Update Arguments |
預設值: | [] |
只有在 Key Vault 屬於指定的資源群組時,才繼續。
--secondary-locations 會將 HSM 集區擴充/合約至列出的區域。 無法移除原本建立資源的主要位置。
指定要設定的屬性路徑和值,以更新物件。 範例: --set property1.property2=<value>
.
屬性 | 值 |
---|---|
Parameter group: | Generic Update Arguments |
預設值: | [] |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
屬性 | 值 |
---|---|
預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
屬性 | 值 |
---|---|
預設值: | False |
Output format.
屬性 | 值 |
---|---|
預設值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
屬性 | 值 |
---|---|
預設值: | False |
az keyvault wait
將 CLI 置於等候狀態,直到符合保存庫的條件為止。
az keyvault wait --name
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--resource-group]
[--timeout]
[--updated]
範例
暫停 CLI,直到建立保存庫為止。
az keyvault wait --name MyVault --created
必要參數
保存庫的名稱。
選擇性參數
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
請等候在 'Succeeded' 使用 'provisioningState' 建立。
屬性 | 值 |
---|---|
Parameter group: | Wait Condition Arguments |
預設值: | False |
等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。
屬性 | 值 |
---|---|
Parameter group: | Wait Condition Arguments |
等到刪除為止。
屬性 | 值 |
---|---|
Parameter group: | Wait Condition Arguments |
預設值: | False |
等候資源存在。
屬性 | 值 |
---|---|
Parameter group: | Wait Condition Arguments |
預設值: | False |
輪詢間隔以秒為單位。
屬性 | 值 |
---|---|
Parameter group: | Wait Condition Arguments |
預設值: | 30 |
只有在 Key Vault 屬於指定的資源群組時,才繼續。
以秒為單位的等候上限。
屬性 | 值 |
---|---|
Parameter group: | Wait Condition Arguments |
預設值: | 3600 |
等到 provisioningState 更新為 'Succeeded'。
屬性 | 值 |
---|---|
Parameter group: | Wait Condition Arguments |
預設值: | False |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
屬性 | 值 |
---|---|
預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
屬性 | 值 |
---|---|
預設值: | False |
Output format.
屬性 | 值 |
---|---|
預設值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
屬性 | 值 |
---|---|
預設值: | False |
az keyvault wait-hsm
將 CLI 置於等候狀態,直到符合 HSM 的條件為止。
az keyvault wait-hsm --hsm-name
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--resource-group]
[--timeout]
[--updated]
範例
暫停 CLI,直到 HSM 建立為止。
az keyvault wait-hsm --hsm-name MyHSM --created
必要參數
HSM 的名稱。
選擇性參數
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
請等候在 'Succeeded' 使用 'provisioningState' 建立。
屬性 | 值 |
---|---|
Parameter group: | Wait Condition Arguments |
預設值: | False |
等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。
屬性 | 值 |
---|---|
Parameter group: | Wait Condition Arguments |
等到刪除為止。
屬性 | 值 |
---|---|
Parameter group: | Wait Condition Arguments |
預設值: | False |
等候資源存在。
屬性 | 值 |
---|---|
Parameter group: | Wait Condition Arguments |
預設值: | False |
輪詢間隔以秒為單位。
屬性 | 值 |
---|---|
Parameter group: | Wait Condition Arguments |
預設值: | 30 |
只有在 HSM 屬於指定的資源群組時,才繼續。
以秒為單位的等候上限。
屬性 | 值 |
---|---|
Parameter group: | Wait Condition Arguments |
預設值: | 3600 |
等到 provisioningState 更新為 'Succeeded'。
屬性 | 值 |
---|---|
Parameter group: | Wait Condition Arguments |
預設值: | False |
全域參數
提高日誌詳細程度以顯示所有調試日誌。
屬性 | 值 |
---|---|
預設值: | False |
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
屬性 | 值 |
---|---|
預設值: | False |
Output format.
屬性 | 值 |
---|---|
預設值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID
來設定預設訂用帳戶。
增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。
屬性 | 值 |
---|---|
預設值: | False |