az keyvault secret

管理機密。

命令

名稱	Description	類型	狀態
az keyvault secret backup	備份指定的秘密。	核心	GA
az keyvault secret delete	刪除所有版本的秘密。	核心	已取代
az keyvault secret download	從 KeyVault 下載秘密。	核心	GA
az keyvault secret list	列出指定之金鑰保存庫中的秘密。	核心	GA
az keyvault secret list-deleted	列出指定保存庫已刪除的秘密。	核心	GA
az keyvault secret list-versions	列出指定秘密的所有版本。	核心	GA
az keyvault secret purge	永久刪除指定的秘密。	核心	GA
az keyvault secret recover	將已刪除的秘密復原到最新版本。	核心	GA
az keyvault secret restore	將備份的秘密還原至保存庫。	核心	GA
az keyvault secret set	建立秘密（如果密碼不存在），或更新 KeyVault 中的秘密。	核心	GA
az keyvault secret set-attributes	更新與指定金鑰保存庫中指定秘密相關聯的屬性。	核心	GA
az keyvault secret show	從指定的金鑰保存庫取得指定的秘密。	核心	GA
az keyvault secret show-deleted	取得指定的已刪除秘密。	核心	GA

az keyvault secret backup

備份指定的秘密。

要求將指定秘密的備份下載到用戶端。 所有版本的秘密都會下載。 此作業需要秘密/備份許可權。

az keyvault secret backup --file
                          [--id]
                          [--name]
                          [--vault-name]

必要參數

--file -f

要接收秘密內容的檔案。

選擇性參數

--id

秘密的識別碼。 如果指定了所有其他 'Id' 引數，則應該省略。

--name -n

秘密的名稱。 如果未指定 --id，則為必要專案。

--vault-name

金鑰保存庫的名稱。 如果未指定 --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 keyvault secret delete

已被取代

警告! 如果您在此金鑰保存庫上已啟用虛刪除保護，此秘密將會移至虛刪除狀態。 在從虛刪除狀態清除秘密之前，您將無法在此金鑰保存庫中建立具有相同名稱的秘密。 如需其他指引，請參閱下列檔。 https://docs.microsoft.com/azure/key-vault/general/soft-delete-overview

刪除所有版本的秘密。

需要秘密/刪除許可權。 當此方法傳回金鑰保存庫開始刪除秘密時。 在已啟用虛刪除的保存庫中，刪除可能需要幾秒鐘的時間。 因此，此方法會傳回輪詢程式，讓您等待刪除完成。

az keyvault secret delete [--id]
                          [--name]
                          [--vault-name]

選擇性參數

--id

秘密的識別碼。 如果指定了所有其他 'Id' 引數，則應該省略。

--name -n

秘密的名稱。 如果未指定 --id，則為必要專案。

--vault-name

金鑰保存庫的名稱。 如果未指定 --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 keyvault secret download

從 KeyVault 下載秘密。

az keyvault secret download --file
                            [--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
                            [--id]
                            [--name]
                            [--vault-name]
                            [--version]

必要參數

--file -f

要接收秘密內容的檔案。

選擇性參數

--encoding -e

秘密的編碼方式。 根據預設，會在秘密上尋找 「檔案編碼」標記。 否則會假設 'utf-8'。

接受的值: ascii, base64, hex, utf-16be, utf-16le, utf-8

--id

秘密的識別碼。 如果指定了所有其他 'Id' 引數，則應該省略。

--name -n

秘密的名稱。 如果未指定 --id，則為必要專案。

--vault-name

金鑰保存庫的名稱。 如果未指定 --id，則為必要專案。

--version -v

秘密版本。 如果省略，請使用最新版本。

全域參數

--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 keyvault secret list

列出指定之金鑰保存庫中的秘密。

取得秘密作業適用于整個保存庫。 不過，回應中只會提供基底秘密識別碼及其屬性。 回應中未列出個別的秘密版本。 此作業需要秘密/清單許可權。

az keyvault secret list [--id]
                        [--include-managed {false, true}]
                        [--maxresults]
                        [--vault-name]

選擇性參數

--id

保存庫的完整 URI。 如果指定了所有其他 'Id' 引數，則應該省略。

--include-managed

包含受控秘密。 預設：false。

接受的值: false, true

預設值: False

--maxresults

在頁面中傳回的結果數目上限。 如果未指定，服務將傳回最多 25 個結果。

--vault-name

金鑰保存庫的名稱。 如果未指定 --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 keyvault secret list-deleted

列出指定保存庫已刪除的秘密。

取得刪除的秘密作業會傳回已針對已啟用虛刪除之保存庫刪除的秘密。 此作業需要秘密/清單許可權。

az keyvault secret list-deleted [--id]
                                [--maxresults]
                                [--vault-name]

選擇性參數

--id

保存庫的完整 URI。 如果指定了所有其他 'Id' 引數，則應該省略。

--maxresults

在頁面中傳回的結果數目上限。 如果未指定，服務將傳回最多 25 個結果。

--vault-name

金鑰保存庫的名稱。 如果未指定 --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 keyvault secret list-versions

列出指定秘密的所有版本。

回應中會提供完整的秘密識別碼和屬性。 秘密不會傳回任何值。 此作業需要秘密/清單許可權。

az keyvault secret list-versions [--id]
                                 [--maxresults]
                                 [--name]
                                 [--vault-name]

選擇性參數

--id

秘密的識別碼。 如果指定了所有其他 'Id' 引數，則應該省略。

--maxresults

在頁面中傳回的結果數目上限。 如果未指定，服務將傳回最多 25 個結果。

--name -n

秘密的名稱。 如果未指定 --id，則為必要專案。

--vault-name

金鑰保存庫的名稱。 如果未指定 --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 keyvault secret purge

永久刪除指定的秘密。

清除刪除的秘密作業會永久移除秘密，而無法復原。 此作業只能在已啟用虛刪除的保存庫上啟用。 此作業需要秘密/清除許可權。

az keyvault secret purge [--id]
                         [--name]
                         [--vault-name]

選擇性參數

--id

秘密的復原識別碼。 如果指定了所有其他 'Id' 引數，則應該省略。

--name -n

秘密的名稱。 如果未指定 --id，則為必要專案。

--vault-name

保存庫的名稱。 如果未指定 --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 keyvault secret recover

將已刪除的秘密復原到最新版本。

復原指定保存庫中已刪除的秘密。 此作業只能在已啟用虛刪除的保存庫上執行。 此作業需要秘密/復原許可權。

az keyvault secret recover [--id]
                           [--name]
                           [--vault-name]

選擇性參數

--id

秘密的復原識別碼。 如果指定了所有其他 'Id' 引數，則應該省略。

--name -n

秘密的名稱。 如果未指定 --id，則為必要專案。

--vault-name

保存庫的名稱。 如果未指定 --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 keyvault secret restore

將備份的秘密還原至保存庫。

將備份的秘密及其所有版本還原至保存庫。 此作業需要秘密/還原許可權。

az keyvault secret restore --file
                           --vault-name

必要參數

--file -f

要接收秘密內容的檔案。

--vault-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 keyvault secret set

建立秘密（如果密碼不存在），或更新 KeyVault 中的秘密。

az keyvault secret set --name
                       --vault-name
                       [--content-type]
                       [--disabled {false, true}]
                       [--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
                       [--expires]
                       [--file]
                       [--not-before]
                       [--tags]
                       [--value]

範例

建立秘密（如果密碼不存在），或更新 KeyVault 中的秘密。

az keyvault secret set --name MySecretName --vault-name MyKeyVault --value MyVault

建立秘密（如果不存在的話），或透過檔案更新 KeyVault 中的秘密。

az keyvault secret set --name MySecretName --vault-name MyKeyVault --file /path/to/file --encoding MyEncoding

必要參數

--name -n

秘密的名稱。

--vault-name

保存庫的名稱。

選擇性參數

--content-type --description

秘密內容的描述（例如密碼、連接字串等）。

--disabled

建立處於停用狀態的秘密。

接受的值: false, true

--encoding -e

來源檔案編碼。 此值會儲存為標記 （ file-encoding=<val> ），並在下載期間用來自動編碼產生的檔案。

接受的值: ascii, base64, hex, utf-16be, utf-16le, utf-8

預設值: utf-8

--expires

到期 UTC 日期時間（Y-m-d'T'H：M：S'Z'）。

--file -f

秘密的來源檔案。 與 '--encoding' 搭配使用。

--not-before

在提供的 UTC 日期時間之前無法使用秘密（Y-m-d'T'H：M：S'Z'）。

--tags

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

--value

純文字秘密值。 無法與 '--file' 或 '--encoding' 搭配使用。

全域參數

--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 keyvault secret set-attributes

更新與指定金鑰保存庫中指定秘密相關聯的屬性。

UPDATE 作業會變更現有預存秘密的指定屬性。 要求中未指定的屬性會保持不變。 無法變更秘密本身的值。 此作業需要秘密/設定許可權。

az keyvault secret set-attributes [--content-type]
                                  [--enabled {false, true}]
                                  [--expires]
                                  [--id]
                                  [--name]
                                  [--not-before]
                                  [--tags]
                                  [--vault-name]
                                  [--version]

選擇性參數

--content-type

密碼值的型別，例如密碼。

--enabled

啟用秘密。

接受的值: false, true

--expires

到期 UTC 日期時間（Y-m-d'T'H：M：S'Z'）。

--id

秘密的識別碼。 如果指定了所有其他 'Id' 引數，則應該省略。

--name -n

秘密的名稱。 如果未指定 --id，則為必要專案。

--not-before

在提供的 UTC 日期時間之前無法使用秘密（Y-m-d'T'H：M：S'Z'）。

--tags

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

--vault-name

金鑰保存庫的名稱。 如果未指定 --id，則為必要專案。

--version -v

秘密版本。 如果省略，請使用最新版本。

全域參數

--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 keyvault secret show

從指定的金鑰保存庫取得指定的秘密。

GET 作業適用于 Azure 金鑰保存庫中儲存的任何秘密。 此作業需要秘密/取得許可權。

az keyvault secret show [--id]
                        [--name]
                        [--vault-name]
                        [--version]

選擇性參數

--id

秘密的識別碼。 如果指定了所有其他 'Id' 引數，則應該省略。

--name -n

秘密的名稱。 如果未指定 --id，則為必要專案。

--vault-name

金鑰保存庫的名稱。 如果未指定 --id，則為必要專案。

--version -v

秘密版本。 如果省略，請使用最新版本。

全域參數

--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 keyvault secret show-deleted

取得指定的已刪除秘密。

取得刪除的秘密作業會傳回指定的已刪除秘密及其屬性。 此作業需要秘密/取得許可權。

az keyvault secret show-deleted [--id]
                                [--name]
                                [--vault-name]

選擇性參數

--id

秘密的復原識別碼。 如果指定了所有其他 'Id' 引數，則應該省略。

--name -n

秘密的名稱。 如果未指定 --id，則為必要專案。

--vault-name

保存庫的名稱。 如果未指定 --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 來取得完整偵錯記錄。