共用方式為

KeysOperations 類別

  • 參考

警告

請勿直接具現化此類別。

您應該改為透過 存取下列作業

KeyVaultManagementClient's

<xref:keys> 屬性。

繼承
builtins.object
KeysOperations

建構函式

KeysOperations(*args, **kwargs)

方法

create_if_not_exist

如果新金鑰不存在，則會建立第一個版本。 如果已經存在，則會傳回現有的索引鍵，而不會執行任何寫入作業。 此 API 不會建立後續版本，也不會更新現有的金鑰。
get

從指定的金鑰保存庫取得指定金鑰的目前版本。
get_version

取得指定之金鑰保存庫中所指定金鑰的指定版本。
list

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

列出指定之金鑰保存庫中所指定金鑰的版本。

create_if_not_exist

如果新金鑰不存在，則會建立第一個版本。 如果已經存在，則會傳回現有的索引鍵，而不會執行任何寫入作業。 此 API 不會建立後續版本，也不會更新現有的金鑰。

create_if_not_exist(resource_group_name: str, vault_name: str, key_name: str, parameters: _models.KeyCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Key

參數

resource_group_name
str
必要

包含指定金鑰保存庫之資源組名。 必要。

vault_name
str
必要

金鑰保存庫的名稱，其中包含要建立的金鑰。 必要。

key_name
str
必要

要建立的金鑰名稱。 為了執行服務的目的，您可以全域複製您提供的值。 提供的值不應包含可識別個人的資訊或敏感性資訊。 必要。

parameters
KeyCreateParameters 或 IO
必要

用來建立指定索引鍵的參數。 這是 KeyCreateParameters 類型或 IO 類型。 必要。

content_type
str

本文參數內容類型。 已知值為：'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

cls (回應) 的索引鍵或結果

傳回類型

Key

例外狀況

HttpResponseError

get

從指定的金鑰保存庫取得指定金鑰的目前版本。

get(resource_group_name: str, vault_name: str, key_name: str, **kwargs: Any) -> Key

參數

resource_group_name
str
必要

包含指定金鑰保存庫之資源組名。 必要。

vault_name
str
必要

保存庫的名稱，其中包含要擷取的金鑰。 必要。

key_name
str
必要

要擷取的索引鍵名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

cls (回應) 的索引鍵或結果

傳回類型

Key

例外狀況

HttpResponseError

get_version

取得指定之金鑰保存庫中所指定金鑰的指定版本。

get_version(resource_group_name: str, vault_name: str, key_name: str, key_version: str, **kwargs: Any) -> Key

參數

resource_group_name
str
必要

包含指定金鑰保存庫之資源組名。 必要。

vault_name
str
必要

保存庫的名稱，其中包含要擷取的金鑰版本。 必要。

key_name
str
必要

要擷取的金鑰版本名稱。 必要。

key_version
str
必要

要擷取的金鑰版本。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

cls (回應) 的索引鍵或結果

傳回類型

Key

例外狀況

HttpResponseError

list

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

list(resource_group_name: str, vault_name: str, **kwargs: Any) -> Iterable[Key]

參數

resource_group_name
str
必要

包含指定金鑰保存庫之資源組名。 必要。

vault_name
str
必要

保存庫的名稱，其中包含要擷取的金鑰。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

像是 Key 實例或 cls 結果的反覆運算器 (回應)

傳回類型

ItemPaged[Key]

例外狀況

HttpResponseError

list_versions

列出指定之金鑰保存庫中所指定金鑰的版本。

list_versions(resource_group_name: str, vault_name: str, key_name: str, **kwargs: Any) -> Iterable[Key]

參數

resource_group_name
str
必要

包含指定金鑰保存庫之資源組名。 必要。

vault_name
str
必要

保存庫的名稱，其中包含要擷取的金鑰版本。 必要。

key_name
str
必要

要擷取的金鑰版本名稱。 必要。

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

像是 Key 實例或 cls 結果的反覆運算器 (回應)

傳回類型

ItemPaged[Key]

例外狀況

HttpResponseError

屬性

models 

models = <module 'azure.mgmt.keyvault.v2021_10_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\keyvault\\v2021_10_01\\models\\__init__.py'>