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

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls

callable

直接応答が渡されるカスタム型または関数

戻り値

cls(response) のキーまたは結果

の戻り値の型 :

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(response) のキーまたは結果

の戻り値の型 :

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(response) のキーまたは結果

の戻り値の型 :

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(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

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(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

ItemPaged[Key]

例外

HttpResponseError

属性

models

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