共用方式為

ManagedHsmKeysOperations 類別

  • 參考

警告

請勿直接具現化此類別。

相反地，您應該透過 存取下列作業

KeyVaultManagementClient's

<xref:managed_hsm_keys> 屬性。

繼承
builtins.object
ManagedHsmKeysOperations

建構函式

ManagedHsmKeysOperations(*args, **kwargs)

方法

create_if_not_exist

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

從指定的 Managed HSM 取得指定金鑰的目前版本。
get_version

取得指定受控 HSM 中指定之金鑰的指定版本。
list

列出指定受控 HSM 中的金鑰。
list_versions

列出指定受控 HSM 中指定金鑰的版本。

create_if_not_exist

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

create_if_not_exist(resource_group_name: str, name: str, key_name: str, parameters: _models.ManagedHsmKeyCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ManagedHsmKey

參數

resource_group_name
str
必要

資源群組的名稱。 名稱不區分大小寫。 必要。

name
str
必要

指定資源群組內的受控 HSM 集區名稱。 必要。

key_name
str
必要

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

parameters
ManagedHsmKeyCreateParameters 或 IO
必要

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

content_type
str

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

cls
callable

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

傳回

ManagedHsmKey 或 cls 的結果 (回應)

傳回類型

ManagedHsmKey

例外狀況

HttpResponseError

get

從指定的 Managed HSM 取得指定金鑰的目前版本。

get(resource_group_name: str, name: str, key_name: str, **kwargs: Any) -> ManagedHsmKey

參數

resource_group_name
str
必要

資源群組的名稱。 名稱不區分大小寫。 必要。

name
str
必要

指定資源群組內的受控 HSM 集區名稱。 必要。

key_name
str
必要

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

cls
callable

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

傳回

ManagedHsmKey 或 cls 的結果 (回應)

傳回類型

ManagedHsmKey

例外狀況

HttpResponseError

get_version

取得指定受控 HSM 中指定之金鑰的指定版本。

get_version(resource_group_name: str, name: str, key_name: str, key_version: str, **kwargs: Any) -> ManagedHsmKey

參數

resource_group_name
str
必要

資源群組的名稱。 名稱不區分大小寫。 必要。

name
str
必要

指定資源群組內的受控 HSM 集區名稱。 必要。

key_name
str
必要

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

key_version
str
必要

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

cls
callable

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

傳回

ManagedHsmKey 或 cls 的結果 (回應)

傳回類型

ManagedHsmKey

例外狀況

HttpResponseError

list

列出指定受控 HSM 中的金鑰。

list(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[ManagedHsmKey]

參數

resource_group_name
str
必要

資源群組的名稱。 名稱不區分大小寫。 必要。

name
str
必要

指定資源群組內的受控 HSM 集區名稱。 必要。

cls
callable

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

傳回

反覆運算器，例如 ManagedHsmKey 的實例或 cls (回應的結果)

傳回類型

ItemPaged[ManagedHsmKey]

例外狀況

HttpResponseError

list_versions

列出指定受控 HSM 中指定金鑰的版本。

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

參數

resource_group_name
str
必要

資源群組的名稱。 名稱不區分大小寫。 必要。

name
str
必要

指定資源群組內的受控 HSM 集區名稱。 必要。

key_name
str
必要

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

cls
callable

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

傳回

反覆運算器，例如 ManagedHsmKey 的實例或 cls (回應的結果)

傳回類型

ItemPaged[ManagedHsmKey]

例外狀況

HttpResponseError

屬性

models 

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