az keyvault

管理 KeyVault 金鑰、秘密和憑證。

命令

名稱	Description	類型	狀態
az keyvault backup	管理完整的 HSM 備份。	Core	GA
az keyvault backup start	開始 HSM 的完整備份。	Core	GA
az keyvault certificate	管理憑證。	Core	GA
az keyvault certificate backup	備份指定的憑證。	Core	GA
az keyvault certificate contact	管理憑證管理的聯繫人。	Core	GA
az keyvault certificate contact add	將聯繫人新增至指定的保存庫，以接收憑證作業的通知。	Core	GA
az keyvault certificate contact delete	從指定的保存庫移除憑證聯繫人。	Core	GA
az keyvault certificate contact list	列出指定之金鑰保存庫的憑證聯繫人。	Core	GA
az keyvault certificate create	建立 Key Vault 憑證。	Core	GA
az keyvault certificate delete	從指定的金鑰保存庫刪除憑證。	Core	Deprecated
az keyvault certificate download	下載 Key Vault 憑證的公用部分。	Core	GA
az keyvault certificate get-default-policy	取得自我簽署憑證的默認原則。	Core	GA
az keyvault certificate import	將憑證匯入 KeyVault。	Core	GA
az keyvault certificate issuer	管理憑證簽發者資訊。	Core	GA
az keyvault certificate issuer admin	管理憑證簽發者的系統管理員資訊。	Core	GA
az keyvault certificate issuer admin add	為指定的憑證簽發者新增系統管理員詳細數據。	Core	GA
az keyvault certificate issuer admin delete	拿掉指定之憑證簽發者的系統管理員詳細數據。	Core	GA
az keyvault certificate issuer admin list	列出指定之憑證簽發者的系統管理員。	Core	GA
az keyvault certificate issuer create	建立憑證簽發者記錄。	Core	GA
az keyvault certificate issuer delete	刪除指定的憑證簽發者。	Core	GA
az keyvault certificate issuer list	列出金鑰保存庫之憑證簽發者的屬性。	Core	GA
az keyvault certificate issuer show	取得指定的憑證簽發者。	Core	GA
az keyvault certificate issuer update	更新憑證簽發者記錄。	Core	GA
az keyvault certificate list	列出指定之金鑰保存庫中的憑證。	Core	GA
az keyvault certificate list-deleted	列出目前可復原的已刪除憑證。	Core	GA
az keyvault certificate list-versions	列出憑證的版本。	Core	GA
az keyvault certificate pending	管理擱置的憑證建立作業。	Core	GA
az keyvault certificate pending delete	刪除特定憑證的建立作業。	Core	GA
az keyvault certificate pending merge	將憑證或憑證鏈結與伺服器上現有的金鑰組合並。	Core	GA
az keyvault certificate pending show	取得憑證的建立作業。	Core	GA
az keyvault certificate purge	永久刪除指定的已刪除憑證。	Core	GA
az keyvault certificate recover	將已刪除的憑證復原至其最新版本。	Core	GA
az keyvault certificate restore	將備份的憑證還原至保存庫。	Core	GA
az keyvault certificate set-attributes	更新與指定憑證相關聯的指定屬性。	Core	GA
az keyvault certificate show	取得憑證的相關信息。	Core	GA
az keyvault certificate show-deleted	取得已刪除的憑證。	Core	GA
az keyvault check-name	檢查指定的名稱是否有效，且尚未使用中。	Core	GA
az keyvault create	建立保存庫或 HSM。	Core	GA
az keyvault delete	刪除保存庫或 HSM。	Core	GA
az keyvault delete-policy	刪除 Key Vault 的安全策略設定。	Core	GA
az keyvault key	管理金鑰。	Core	GA
az keyvault key backup	要求將指定金鑰的備份下載到用戶端。	Core	GA
az keyvault key create	建立新的金鑰、儲存金鑰，然後將金鑰參數和屬性傳回給用戶端。	Core	GA
az keyvault key decrypt	解密加密數據的單一區塊。	Core	Preview
az keyvault key delete	從保存庫或 HSM 中的記憶體中刪除任何類型的金鑰。	Core	GA
az keyvault key download	下載預存金鑰的公用部分。	Core	GA
az keyvault key encrypt	使用儲存在保存庫或 HSM 中的加密金鑰，加密任意序列的位元組。	Core	Preview
az keyvault key get-attestation	取得金鑰的證明 Blob。	Core	GA
az keyvault key get-policy-template	將原則範本傳回為 JSON 編碼的原則定義。	Core	Preview
az keyvault key import	匯入私鑰。	Core	GA
az keyvault key list	列出指定保存庫或 HSM 中的金鑰。	Core	GA
az keyvault key list-deleted	列出指定保存庫中已刪除的金鑰或 HSM。	Core	GA
az keyvault key list-versions	列出金鑰版本的識別碼和屬性。	Core	GA
az keyvault key purge	永久刪除指定的索引鍵。	Core	GA
az keyvault key random	從受控 HSM 取得要求的隨機位元組數目。	Core	GA
az keyvault key recover	將已刪除的金鑰復原至其最新版本。	Core	GA
az keyvault key restore	將備份的金鑰還原至保存庫或 HSM。	Core	GA
az keyvault key rotate	藉由產生新版本的金鑰，根據金鑰原則輪替金鑰。	Core	GA
az keyvault key rotation-policy	管理金鑰的輪替原則。	Core	GA
az keyvault key rotation-policy show	取得 Key Vault 金鑰的輪替原則。	Core	GA
az keyvault key rotation-policy update	更新 Key Vault 金鑰的輪替原則。	Core	GA
az keyvault key set-attributes	更新金鑰作業會變更預存金鑰的指定屬性，而且可以套用至儲存在保存庫或 HSM 中的任何密鑰類型和金鑰版本。	Core	GA
az keyvault key show	取得金鑰的屬性，如果是非對稱密鑰，其公開內容。	Core	GA
az keyvault key show-deleted	取得已刪除金鑰的公用部分。	Core	GA
az keyvault key sign	使用儲存在保存庫或 HSM 中的金鑰，從摘要建立簽章。	Core	GA
az keyvault key verify	使用儲存在保存庫或 HSM 中的金鑰來確認簽章。	Core	GA
az keyvault list	列出保存庫和/或 HSM。	Core	GA
az keyvault list-deleted	取得訂用帳戶中已刪除保存庫或 HSM 的相關信息。	Core	GA
az keyvault network-rule	管理保存庫或受管理 HSM 的網路 ACL。	Core	GA
az keyvault network-rule add	將網路規則新增至金鑰保存庫或受控 HSM 的網路 ACL。	Core	GA
az keyvault network-rule list	列出金鑰保存庫或受控 HSM 的網路 ACL 中的網路規則。	Core	GA
az keyvault network-rule remove	從金鑰保存庫或受控 HSM 的網路 ACL 中移除網路規則。	Core	GA
az keyvault network-rule wait	將 CLI 置於等待狀態，直到符合保存庫或受管理 hsm 的條件為止。	Core	GA
az keyvault private-endpoint-connection	管理保存庫/HSM 私人端點連線。	Core	GA
az keyvault private-endpoint-connection approve	核准 Key Vault/HSM 的私人端點連線要求。	Core	GA
az keyvault private-endpoint-connection delete	刪除與 Key Vault/HSM 相關聯的指定私人端點連線。	Core	GA
az keyvault private-endpoint-connection list	列出與 HSM 相關聯的所有私人端點連線。	Core	GA
az keyvault private-endpoint-connection reject	拒絕 Key Vault/HSM 的私人端點連線要求。	Core	GA
az keyvault private-endpoint-connection show	顯示與 Key Vault/HSM 相關聯的私人端點連線詳細數據。	Core	GA
az keyvault private-endpoint-connection wait	將 CLI 置於等候狀態，直到符合私人端點連線的條件為止。	Core	GA
az keyvault private-link-resource	管理保存庫/HSM 私人鏈接資源。	Core	GA
az keyvault private-link-resource list	列出 Key Vault/HSM 支援的私人鏈接資源。	Core	GA
az keyvault purge	永久刪除指定的保存庫或 HSM。 Aka 清除已刪除的保存庫或 HSM。	Core	GA
az keyvault recover	復原保存庫或 HSM。	Core	GA
az keyvault region	管理 MHSM 多重區域。	Core	GA
az keyvault region add	新增受控 HSM 集區的區域。	Core	GA
az keyvault region list	取得與受控 HSM 集區相關聯的區域資訊。	Core	GA
az keyvault region remove	拿掉受控 HSM 集區的區域。	Core	GA
az keyvault region wait	將 CLI 置於等候狀態，直到符合 HSM 的條件為止。	Core	GA
az keyvault restore	管理完整的 HSM 還原。	Core	GA
az keyvault restore start	還原 HSM 的完整備份。	Core	GA
az keyvault role	管理訪問控制的使用者角色。	Core	GA
az keyvault role assignment	管理角色指派。	Core	GA
az keyvault role assignment create	為使用者、群組或服務主體建立新的角色指派。	Core	GA
az keyvault role assignment delete	刪除角色指派。	Core	GA
az keyvault role assignment list	列出角色指派。	Core	GA
az keyvault role definition	管理角色定義。	Core	GA
az keyvault role definition create	建立自定義角色定義。	Core	GA
az keyvault role definition delete	刪除角色定義。	Core	GA
az keyvault role definition list	列出角色定義。	Core	GA
az keyvault role definition show	顯示角色定義的詳細數據。	Core	GA
az keyvault role definition update	更新角色定義。	Core	GA
az keyvault secret	管理秘密。	Core	GA
az keyvault secret backup	備份指定的秘密。	Core	GA
az keyvault secret delete	刪除所有版本的秘密。	Core	Deprecated
az keyvault secret download	從 KeyVault 下載秘密。	Core	GA
az keyvault secret list	列出指定之金鑰保存庫中的秘密。	Core	GA
az keyvault secret list-deleted	列出指定保存庫已刪除的秘密。	Core	GA
az keyvault secret list-versions	列出指定秘密的所有版本。	Core	GA
az keyvault secret purge	永久刪除指定的秘密。	Core	GA
az keyvault secret recover	將已刪除的秘密復原到最新版本。	Core	GA
az keyvault secret restore	將備份的秘密還原至保存庫。	Core	GA
az keyvault secret set	建立秘密（如果密碼不存在），或更新 KeyVault 中的秘密。	Core	GA
az keyvault secret set-attributes	更新與指定金鑰保存庫中指定秘密相關聯的屬性。	Core	GA
az keyvault secret show	從指定的金鑰保存庫取得指定的秘密。	Core	GA
az keyvault secret show-deleted	取得指定的已刪除秘密。	Core	GA
az keyvault security-domain	管理安全性網域作業。	Core	GA
az keyvault security-domain download	從 HSM 下載安全性網域檔案。	Core	GA
az keyvault security-domain init-recovery	擷取 HSM 的交換金鑰。	Core	GA
az keyvault security-domain restore-blob	啟用將安全性網域檔案解密和加密為 Blob。可以在離線環境中執行，再使用安全性網域上傳將檔案上傳至 HSM。	Core	GA
az keyvault security-domain upload	開始還原 HSM。	Core	GA
az keyvault security-domain wait	將 CLI 置於等候狀態，直到 HSM 安全性網域作業完成為止。	Core	GA
az keyvault set-policy	更新 Key Vault 的安全策略設定。	Core	GA
az keyvault setting	管理 MHSM 設定。	Core	GA
az keyvault setting list	取得與受控 HSM 相關聯的所有設定。	Core	GA
az keyvault setting show	取得與受控 HSM 相關聯的特定設定。	Core	GA
az keyvault setting update	更新與受控 HSM 相關聯的特定設定。	Core	GA
az keyvault show	顯示保存庫或 HSM 的詳細數據。	Core	GA
az keyvault show-deleted	顯示已刪除保存庫或 HSM 的詳細數據。	Core	GA
az keyvault update	更新保存庫的屬性。	Core	GA
az keyvault update-hsm	更新 HSM 的屬性。	Core	GA
az keyvault wait	將 CLI 置於等候狀態，直到符合保存庫的條件為止。	Core	GA
az keyvault wait-hsm	將 CLI 置於等候狀態，直到符合 HSM 的條件為止。	Core	GA

az keyvault check-name

編輯

檢查指定的名稱是否有效，且尚未使用中。

az keyvault check-name --name
                       [--resource-type {hsm}]

必要參數

--name -n

指定資源群組內的 HSM 名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--resource-type

資源類型。

屬性	值
預設值:	hsm
接受的值:	hsm

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az keyvault create

編輯

建立保存庫或 HSM。

默認會啟用 RBAC 授權。如果手動指定 --enable-rbac-authorizationfalse，且未指定 --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

必要參數

--resource-group -g

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

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--administrators

[僅限 HSM]受控 HSM 之數據平面作業的系統管理員角色。它會接受將指派之 OID 的空間分隔清單。

--bypass

略過空間分隔用途的流量。

屬性	值
參數群組:	Network Rule Arguments
接受的值:	AzureServices, None

--default-action

未符合規則時要套用的預設動作。

屬性	值
參數群組:	Network Rule Arguments
接受的值:	Allow, Deny

--enable-purge-protection

屬性，指定是否啟用此保存庫/受控 HSM 集區的清除保護。將此屬性設定為 true 會啟用保護，以防止此保存庫/受控 HSM 集區及其內容清除 -- 只有 Key Vault/受控 HSM 服務可能會起始無法復原的硬式刪除。只有在同時啟用虛刪除時，此設定才有效。啟用這項功能是無法復原的。

屬性	值
接受的值:	false, true

--enable-rbac-authorization

控制數據動作授權方式的屬性。若為 true，金鑰保存庫將會使用角色型存取控制（RBAC）進行資料動作的授權，而且會忽略保存庫屬性中指定的存取原則。若為 false，金鑰保存庫將會使用保存庫屬性中指定的存取原則，而且會忽略儲存在 Azure Resource Manager 上的任何原則。如果為 null 或未指定，則會使用預設值 true 建立保存庫。請注意，管理動作一律已獲得 RBAC 的授權。

屬性	值
預設值:	True
接受的值:	false, true

--enabled-for-deployment

[僅限保存庫]屬性，指定是否允許 Azure 虛擬機從金鑰保存庫擷取儲存為秘密的憑證。

屬性	值
接受的值:	false, true

--enabled-for-disk-encryption

[僅限保存庫]屬性，指定是否允許 Azure 磁碟加密從保存庫擷取秘密和解除包裝密鑰。

屬性	值
接受的值:	false, true

--enabled-for-template-deployment

[僅限保存庫]屬性，指定是否允許 Azure Resource Manager 從密鑰保存庫擷取秘密。

屬性	值
接受的值:	false, true

--hsm-name

HSM 的名稱。（--hsm-name 和 --name/-n 互斥，請只指定其中一個。

--location -l

Location. 值的來源：az account list-locations。您可以使用 az configure --defaults location=<location>來設定預設位置。

--mi-user-assigned

[僅限 HSM]啟用受控 HSM 的使用者指派受控識別。接受以空格分隔的身分識別資源標識符清單。

--name -n

保存庫的名稱。

--network-acls

網路 ACL。它會接受 JSON 檔名或 JSON 字串。 JSON 格式：{\"ip\":[<ip1>, <ip2>...],\"vnet\":[<vnet_name_1>/<subnet_name_1>,<subnet_id2>...]}。

屬性	值
參數群組:	Network Rule Arguments

--network-acls-ips

網路 ACL IP 規則。以空格分隔的IP位址清單。

屬性	值
參數群組:	Network Rule Arguments

--network-acls-vnets

網路 ACLS VNet 規則。 Vnet/子網組或子網資源標識符的空間分隔清單。

屬性	值
參數群組:	Network Rule Arguments

--no-self-perms

[僅限保存庫]請勿在新的保存庫中新增目前使用者/服務主體的許可權。

屬性	值
接受的值:	false, true

--no-wait

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

屬性	值
預設值:	False

--public-network-access

在啟用私人端點時，控制來自公用網路的數據平面流量許可權。

屬性	值
接受的值:	Disabled, Enabled

--retention-days

虛刪除數據保留天數。它會接受 >=7，<=90。金鑰保存庫建立的預設值為 90。 MHSM 建立的必要專案。

--sku

Required. SKU 詳細數據。保存庫允許的值：進階、標準。默認值：標準。 HSM 允許的值：Standard_B1、Custom_B32、Custom_B6、Custom_C42、Custom_C10。默認值：Standard_B1。

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「清除現有的標記」。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --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

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--hsm-name

HSM 的名稱。（--hsm-name 和 --name/-n 互斥，請只指定其中一個。

--name -n

保存庫的名稱。

--no-wait

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

屬性	值
預設值:	False

--resource-group -g

資源組名。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az keyvault delete-policy

編輯

刪除 Key Vault 的安全策略設定。

az keyvault delete-policy --name
                          [--application-id]
                          [--no-wait]
                          [--object-id]
                          [--resource-group]
                          [--spn]
                          [--upn]

必要參數

--name -n

保存庫的名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--application-id

代表主體提出要求的用戶端應用程式標識碼。針對使用代理驗證流程的複合身分識別公開。

--no-wait

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

屬性	值
預設值:	False

--object-id

識別將接收許可權之主體的 GUID。

--resource-group -g

資源組名。

--spn

將接收許可權的服務主體名稱。

--upn

將接收許可權的用戶主體名稱。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az keyvault list

編輯

列出保存庫和/或 HSM。

az keyvault list [--resource-group]
                 [--resource-type]

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--resource-group -g

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

--resource-type

當 --resource-type 不存在時，命令會列出所有保存庫和 HSM。 --resource-type 的可能值為保存庫和 hsm。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az keyvault list-deleted

編輯

取得訂用帳戶中已刪除保存庫或 HSM 的相關信息。

az keyvault list-deleted [--resource-type]

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--resource-type

當 --resource-type 不存在時，命令會列出所有已刪除的保存庫和 HSM。 --resource-type 的可能值為保存庫和 hsm。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az keyvault purge

編輯

永久刪除指定的保存庫或 HSM。 Aka 清除已刪除的保存庫或 HSM。

az keyvault purge [--hsm-name]
                  [--location]
                  [--name]
                  [--no-wait]

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--hsm-name

已刪除 HSM 的名稱。（--hsm-name 和 --name/-n 互斥，請只指定其中一個。

--location -l

已刪除保存庫或 HSM 的位置。

--name -n

已刪除保存庫的名稱。

--no-wait

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

屬性	值
預設值:	False

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --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

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--hsm-name

已刪除 HSM 的名稱。（--hsm-name 和 --name/-n 互斥，請只指定其中一個。

--location -l

已刪除保存庫或 HSM 的位置。

--name -n

已刪除保存庫的名稱。

--no-wait

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

屬性	值
預設值:	False

--resource-group -g

已刪除保存庫或 HSM 的資源群組。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --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}

必要參數

--name -n

保存庫的名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--application-id

代表主體提出要求的用戶端應用程式標識碼。針對使用代理驗證流程的複合身分識別公開。

--certificate-permissions

要指派之憑證許可權的空間分隔清單。

屬性	值
參數群組:	Permission Arguments
接受的值:	all, backup, create, delete, deleteissuers, get, getissuers, import, list, listissuers, managecontacts, manageissuers, purge, recover, restore, setissuers, update

--key-permissions

要指派之金鑰許可權的空間分隔清單。

屬性	值
參數群組:	Permission Arguments
接受的值:	all, backup, create, decrypt, delete, encrypt, get, getrotationpolicy, import, list, purge, recover, release, restore, rotate, setrotationpolicy, sign, unwrapKey, update, verify, wrapKey

--no-wait

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

屬性	值
預設值:	False

--object-id

識別將接收許可權之主體的 GUID。

--resource-group -g

資源組名。

--secret-permissions

要指派之秘密許可權的空間分隔清單。

屬性	值
參數群組:	Permission Arguments
接受的值:	all, backup, delete, get, list, purge, recover, restore, set

--spn

將接收許可權的服務主體名稱。

--storage-permissions

要指派之記憶體許可權的空間分隔清單。

屬性	值
參數群組:	Permission Arguments
接受的值:	all, backup, delete, deletesas, get, getsas, list, listsas, purge, recover, regeneratekey, restore, set, setsas, update

--upn

將接收許可權的用戶主體名稱。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az keyvault show

編輯

顯示保存庫或 HSM 的詳細數據。

az keyvault show [--hsm-name]
                 [--name]
                 [--resource-group]

範例

顯示金鑰保存庫的詳細數據。 (autogenerated)

az keyvault show --name MyKeyVault

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--hsm-name

HSM 的名稱。（--hsm-name 和 --name/-n 互斥，請只指定其中一個。

--name -n

保存庫的名稱。

--resource-group -g

資源組名。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az keyvault show-deleted

編輯

顯示已刪除保存庫或 HSM 的詳細數據。

az keyvault show-deleted [--hsm-name]
                         [--location]
                         [--name]

範例

顯示已刪除金鑰保存庫的詳細資料。

az keyvault show-deleted --name MyKeyVault

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--hsm-name

已刪除 HSM 的名稱。（--hsm-name 和 --name/-n 互斥，請只指定其中一個。

--location -l

已刪除保存庫或 HSM 的位置。

--name -n

已刪除保存庫的名稱。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --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

必要參數

--name -n

保存庫的名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。範例： --add property.listProperty <key=value, string or JSON string>.

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--bypass

略過空間分隔用途的流量。

屬性	值
參數群組:	Network Rule Arguments
接受的值:	AzureServices, None

--default-action

未符合規則時要套用的預設動作。

屬性	值
參數群組:	Network Rule Arguments
接受的值:	Allow, Deny

--enable-purge-protection

屬性	值
接受的值:	false, true

--enable-rbac-authorization

屬性	值
接受的值:	false, true

--enabled-for-deployment

[僅限保存庫]屬性，指定是否允許 Azure 虛擬機從金鑰保存庫擷取儲存為秘密的憑證。

屬性	值
接受的值:	false, true

--enabled-for-disk-encryption

[僅限保存庫]屬性，指定是否允許 Azure 磁碟加密從保存庫擷取秘密和解除包裝密鑰。

屬性	值
接受的值:	false, true

--enabled-for-template-deployment

[僅限保存庫]屬性，指定是否允許 Azure Resource Manager 從密鑰保存庫擷取秘密。

屬性	值
接受的值:	false, true

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

屬性	值
參數群組:	Generic Update Arguments
預設值:	False

--no-wait

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

屬性	值
預設值:	False

--public-network-access

在啟用私人端點時，控制來自公用網路的數據平面流量許可權。

屬性	值
接受的值:	Disabled, Enabled

--remove

從清單中移除屬性或專案。範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--resource-group -g

資源組名。

--retention-days

虛刪除數據保留天數。它會接受 >=7，<=90。

--set

指定要設定的屬性路徑和值，以更新物件。範例： --set property1.property2=<value>.

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --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-name

HSM 的名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。範例： --add property.listProperty <key=value, string or JSON string>.

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--bypass

略過空間分隔用途的流量。

屬性	值
參數群組:	Network Rule Arguments
接受的值:	AzureServices, None

--default-action

未符合規則時要套用的預設動作。

屬性	值
參數群組:	Network Rule Arguments
接受的值:	Allow, Deny

--enable-purge-protection -e

屬性	值
接受的值:	false, true

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

屬性	值
參數群組:	Generic Update Arguments
預設值:	False

--mi-user-assigned

啟用受控 HSM 的使用者指派受控識別。接受以空格分隔的身分識別資源標識符清單。

--no-wait

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

屬性	值
預設值:	False

--public-network-access

在啟用私人端點時，控制來自公用網路的數據平面流量許可權。

屬性	值
接受的值:	Disabled, Enabled

--remove

從清單中移除屬性或專案。範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

--resource-group -g

資源組名。

--secondary-locations

--secondary-locations 會將 HSM 集區擴充/合約至列出的區域。無法移除原本建立資源的主要位置。

--set

指定要設定的屬性路徑和值，以更新物件。範例： --set property1.property2=<value>.

屬性	值
參數群組:	Generic Update Arguments
預設值:	[]

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --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

必要參數

--name -n

保存庫的名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--created

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

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--custom

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

屬性	值
參數群組:	Wait Condition Arguments

--deleted

等到刪除為止。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--exists

等候資源存在。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--interval

輪詢間隔以秒為單位。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	30

--resource-group -g

資源組名。

--timeout

以秒為單位的等候上限。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	3600

--updated

等到 provisioningState 更新為 'Succeeded'。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --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-name

HSM 的名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--created

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

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--custom

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

屬性	值
參數群組:	Wait Condition Arguments

--deleted

等到刪除為止。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--exists

等候資源存在。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--interval

輪詢間隔以秒為單位。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	30

--resource-group -g

只有在 HSM 屬於指定的資源群組時，才繼續。

--timeout

以秒為單位的等候上限。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	3600

--updated

等到 provisioningState 更新為 'Succeeded'。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

意見反應

此頁面對您有幫助嗎？

共用方式為

az keyvault

命令

az keyvault check-name

必要參數

選擇性參數

az keyvault create

範例

必要參數

選擇性參數

az keyvault delete

範例

選擇性參數

az keyvault delete-policy

必要參數

選擇性參數

az keyvault list

選擇性參數

az keyvault list-deleted

選擇性參數

az keyvault purge

選擇性參數

az keyvault recover

範例

選擇性參數

az keyvault set-policy

範例

必要參數

選擇性參數

az keyvault show

範例

選擇性參數

az keyvault show-deleted

範例

選擇性參數

az keyvault update

範例

必要參數

選擇性參數

az keyvault update-hsm

範例

必要參數

選擇性參數

az keyvault wait

範例

必要參數

選擇性參數

az keyvault wait-hsm

範例

必要參數

選擇性參數

意見反應