az keyvault certificate
管理憑證。
命令
az keyvault certificate backup
備份指定的憑證。
要求將指定憑證的備份下載到用戶端。 系統會下載所有版本的憑證。 此作業需要憑證/備份許可權。
az keyvault certificate backup --file
[--id]
[--name]
[--vault-name]
必要參數
用來儲存憑證備份的本機檔案路徑。
選擇性參數
憑證的識別碼。 如果指定了所有其他 'Id' 引數,則應該省略。
憑證的名稱。 如果未指定 --id,則為必要專案。
金鑰保存庫的名稱。 如果未指定 --id,則為必要專案。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az keyvault certificate create
建立金鑰保存庫憑證。
憑證可作為已布建虛擬機器的秘密。
az keyvault certificate create --name
--policy
--vault-name
[--disabled {false, true}]
[--tags]
[--validity]
範例
使用預設原則建立自我簽署憑證,並將其新增至虛擬機器。
az keyvault certificate create --vault-name vaultname -n cert1 \
-p "$(az keyvault certificate get-default-policy)"
secrets=$(az keyvault secret list-versions --vault-name vaultname \
-n cert1 --query "[?attributes.enabled].id" -o tsv)
vm_secrets=$(az vm secret format -s "$secrets")
az vm create -g group-name -n vm-name --admin-username deploy \
--image Debian11 --secrets "$vm_secrets"
必要參數
憑證的名稱。
JSON 編碼的原則定義。 使用 @{file} 從檔案載入(例如 @my_policy.json) 。
保存庫的名稱。
選擇性參數
建立處於停用狀態的憑證。
以空格分隔的標記:key[=value] [key[=value] ...]。使用 「」 清除現有的標記。
憑證有效的月數。 使用 --policy/-p 覆寫指定的值。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az keyvault certificate delete
警告! 如果您在此金鑰保存庫上已啟用虛刪除保護,此憑證將會移至虛刪除狀態。 在從虛刪除狀態清除憑證之前,您將無法在此金鑰保存庫中建立具有相同名稱的憑證。 如需其他指引,請參閱下列檔。 https://docs.microsoft.com/azure/key-vault/general/soft-delete-overview
從指定的金鑰保存庫刪除憑證。
刪除憑證物件的所有版本及其相關聯的原則。 刪除憑證無法用來移除憑證物件的個別版本。 此作業需要憑證/刪除許可權。
az keyvault certificate delete [--id]
[--name]
[--vault-name]
選擇性參數
憑證的識別碼。 如果指定了所有其他 'Id' 引數,則應該省略。
憑證的名稱。 如果未指定 --id,則為必要專案。
金鑰保存庫的名稱。 如果未指定 --id,則為必要專案。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az keyvault certificate download
下載金鑰保存庫憑證的公用部分。
格式化為 PEM 或 DER 的憑證。 PEM 是預設值。
az keyvault certificate download --file
[--encoding {DER, PEM}]
[--id]
[--name]
[--vault-name]
[--version]
範例
以 PEM 身分下載憑證,並在 openssl 中檢查其指紋。
az keyvault certificate download --vault-name vault -n cert-name -f cert.pem && \
openssl x509 -in cert.pem -inform PEM -noout -sha1 -fingerprint
將憑證下載為 DER,並在 openssl 中檢查其指紋。
az keyvault certificate download --vault-name vault -n cert-name -f cert.crt -e DER && \
openssl x509 -in cert.crt -inform DER -noout -sha1 -fingerprint
必要參數
要接收二進位憑證內容的檔案。
選擇性參數
憑證的編碼方式。 DER 會建立二進位 DER 格式化 x509 憑證,而 PEM 會建立 base64 PEM x509 憑證。
憑證的識別碼。 如果指定了所有其他 'Id' 引數,則應該省略。
憑證的名稱。 如果未指定 --id,則為必要專案。
金鑰保存庫的名稱。 如果未指定 --id,則為必要專案。
憑證版本。 如果省略,請使用最新版本。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az keyvault certificate get-default-policy
取得自我簽署憑證的預設原則。
此預設原則可以與 搭配 az keyvault create
使用,以建立自我簽署憑證。
預設原則也可以作為建立衍生原則的起點。
如需詳細資訊,請參閱 https://docs.microsoft.com/azure/key-vault/certificates/about-certificates#certificate-policy 。
az keyvault certificate get-default-policy [--scaffold]
範例
使用預設原則建立自我簽署憑證
az keyvault certificate create --vault-name vaultname -n cert1 \
-p "$(az keyvault certificate get-default-policy)"
選擇性參數
建立具有預設值的完整格式原則結構。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az keyvault certificate import
將憑證匯入 KeyVault。
憑證也可以當做布建虛擬機器中的秘密使用。
az keyvault certificate import --file
--name
--vault-name
[--disabled {false, true}]
[--password]
[--policy]
[--tags]
範例
使用憑證建立服務主體、將憑證新增至金鑰保存庫,並使用該憑證布建 VM。
service_principal=$(az ad sp create-for-rbac --create-cert)
cert_file=$(echo $service_principal | jq .fileWithCertAndPrivateKey -r)
az keyvault create -g my-group -n vaultname
az keyvault certificate import --vault-name vaultname -n cert_name -f cert_file
secrets=$(az keyvault secret list-versions --vault-name vaultname \
-n cert1 --query "[?attributes.enabled].id" -o tsv)
vm_secrets=$(az vm secret format -s "$secrets")
az vm create -g group-name -n vm-name --admin-username deploy \
--image Debian11 --secrets "$vm_secrets"
必要參數
包含憑證和私密金鑰的 PKCS12 檔案或 PEM 檔案。
憑證的名稱。
保存庫的名稱。
選擇性參數
匯入處於停用狀態的憑證。
如果憑證中的私密金鑰已加密,則用於加密的密碼。
JSON 編碼的原則定義。 使用 @{file} 從檔案載入(例如 @my_policy.json) 。
以空格分隔的標記:key[=value] [key[=value] ...]。使用 「」 清除現有的標記。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az keyvault certificate list
列出指定之金鑰保存庫中的憑證。
GetCertificates 作業會傳回指定金鑰保存庫中的憑證資源集。 此作業需要憑證/清單許可權。
az keyvault certificate list [--id]
[--include-pending {false, true}]
[--maxresults]
[--vault-name]
選擇性參數
保存庫的完整 URI。 如果指定了所有其他 'Id' 引數,則應該省略。
指定是否要包含尚未完全布建的憑證。
在頁面中傳回的結果數目上限。 如果未指定,服務將傳回最多 25 個結果。
金鑰保存庫的名稱。 如果未指定 --id,則為必要專案。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az keyvault certificate list-deleted
列出目前可復原的已刪除憑證。
只有在已啟用虛刪除保存庫時,才可能。 需要憑證/取得/清單許可權。 擷取目前保存庫中處於已刪除狀態且準備好進行復原或清除的憑證。 此作業包含刪除特定資訊。
az keyvault certificate list-deleted [--id]
[--include-pending {false, true}]
[--maxresults]
[--vault-name]
選擇性參數
保存庫的完整 URI。 如果指定了所有其他 'Id' 引數,則應該省略。
指定是否要包含尚未完全布建的憑證。
在頁面中傳回的結果數目上限。 如果未指定,服務將傳回最多 25 個結果。
金鑰保存庫的名稱。 如果未指定 --id,則為必要專案。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az keyvault certificate list-versions
列出憑證的版本。
GetCertificateVersions 作業會傳回指定之金鑰保存庫中憑證的版本。 此作業需要憑證/清單許可權。
az keyvault certificate list-versions [--id]
[--maxresults]
[--name]
[--vault-name]
選擇性參數
憑證的識別碼。 如果指定了所有其他 'Id' 引數,則應該省略。
在頁面中傳回的結果數目上限。 如果未指定,服務將傳回最多 25 個結果。
憑證的名稱。 如果未指定 --id,則為必要專案。
金鑰保存庫的名稱。 如果未指定 --id,則為必要專案。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az keyvault certificate purge
永久刪除指定的已刪除憑證。
PurgeDeletedCertificate 作業會執行無法復原的指定憑證刪除,而無法復原。 如果復原層級未指定 「可清除」,則無法使用此作業。 此作業需要憑證/清除許可權。
az keyvault certificate purge [--id]
[--name]
[--vault-name]
選擇性參數
憑證的復原識別碼。 如果指定了所有其他 'Id' 引數,則應該省略。
憑證的名稱。 如果未指定 --id,則為必要專案。
保存庫的名稱。 如果未指定 --id,則為必要專案。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az keyvault certificate recover
將已刪除的憑證復原至其最新版本。
只能在已啟用虛刪除的保存庫中。 需要憑證/復原許可權。 當此方法傳回金鑰保存庫已開始復原憑證時。 復原可能需要幾秒鐘的時間。 因此,此方法會傳回輪詢器,讓您等候復原完成。 只有在您想要立即在另一個作業中使用復原的憑證時,才需要等候。
az keyvault certificate recover [--id]
[--name]
[--vault-name]
選擇性參數
憑證的復原識別碼。 如果指定了所有其他 'Id' 引數,則應該省略。
憑證的名稱。 如果未指定 --id,則為必要專案。
保存庫的名稱。 如果未指定 --id,則為必要專案。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az keyvault certificate restore
將備份的憑證還原至保存庫。
將備份的憑證及其所有版本還原至保存庫。 此作業需要憑證/還原許可權。
az keyvault certificate restore --file
[--vault-name]
必要參數
要從中還原憑證的本機憑證備份。
選擇性參數
金鑰保存庫的名稱。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az keyvault certificate set-attributes
更新與指定憑證相關聯的指定屬性。
UpdateCertificate 作業會在指定的憑證上套用指定的更新;更新的唯一元素是憑證的屬性。 此作業需要憑證/更新許可權。
az keyvault certificate set-attributes [--enabled {false, true}]
[--id]
[--name]
[--policy]
[--tags]
[--vault-name]
[--version]
選擇性參數
啟用憑證。
憑證的識別碼。 如果指定了所有其他 'Id' 引數,則應該省略。
憑證的名稱。 如果未指定 --id,則為必要專案。
JSON 編碼的原則定義。 使用 @{file} 從檔案載入(例如 @my_policy.json) 。
以空格分隔的標記:key[=value] [key[=value] ...]。使用 「」 清除現有的標記。
金鑰保存庫的名稱。 如果未指定 --id,則為必要專案。
憑證版本。 如果省略,請使用最新版本。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az keyvault certificate show
取得憑證的相關資訊。
取得特定憑證的相關資訊。 此作業需要憑證/取得許可權。
az keyvault certificate show [--id]
[--name]
[--vault-name]
[--version]
選擇性參數
憑證的識別碼。 如果指定了所有其他 'Id' 引數,則應該省略。
憑證的名稱。 如果未指定 --id,則為必要專案。
金鑰保存庫的名稱。 如果未指定 --id,則為必要專案。
憑證版本。 如果省略,請使用最新版本。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az keyvault certificate show-deleted
取得已刪除的憑證。
只能在已啟用虛刪除的保存庫中。 需要憑證/取得許可權。 擷取已刪除的憑證資訊及其屬性,例如保留間隔、排程的永久刪除,以及目前的刪除復原層級。
az keyvault certificate show-deleted [--id]
[--name]
[--vault-name]
選擇性參數
憑證的復原識別碼。 如果指定了所有其他 'Id' 引數,則應該省略。
憑證的名稱。 如果未指定 --id,則為必要專案。
保存庫的名稱。 如果未指定 --id,則為必要專案。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。