ManagedHsmsOperations クラス

警告

このクラスを直接インスタンス化しないでください。

代わりに、次の操作にアクセスする必要があります。

KeyVaultManagementClient's

<xref:managed_hsms> 属性を使用する。

継承

builtins.object

ManagedHsmsOperations

コンストラクター

ManagedHsmsOperations(*args, **kwargs)

メソッド

begin_create_or_update	指定したサブスクリプションでマネージド HSM プールを作成または更新します。
begin_delete	指定したマネージド HSM プールを削除します。
begin_purge_deleted	指定したマネージド HSM を完全に削除します。
begin_update	指定したサブスクリプションのマネージド HSM プールを更新します。
check_mhsm_name_availability	マネージド HSM 名が有効であり、まだ使用されていないことを確認します。
get	指定したマネージド HSM プールを取得します。
get_deleted	指定した削除されたマネージド HSM を取得します。
list_by_resource_group	List 操作は、サブスクリプションに関連付けられているマネージド HSM プールと、指定されたリソース グループ内に関する情報を取得します。
list_by_subscription	List 操作は、サブスクリプションに関連付けられているマネージド HSM プールに関する情報を取得します。
list_deleted	List 操作は、サブスクリプションに関連付けられている削除されたマネージド HSM に関する情報を取得します。

begin_create_or_update

指定したサブスクリプションでマネージド HSM プールを作成または更新します。

async begin_create_or_update(resource_group_name: str, name: str, parameters: _models.ManagedHsm, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ManagedHsm]

パラメーター

resource_group_name

str

必須

マネージド HSM プールを含むリソース グループの名前。 必須。

name

str

必須

マネージド HSM プールの名前。 必須。

parameters

ManagedHsm または IO

必須

マネージド HSM プールを作成または更新するためのパラメーター。 ManagedHsm 型または IO 型です。 必須。

content_type

str

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

cls

callable

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

continuation_token

str

保存された状態からポーリングを再開するための継続トークン。

polling

bool または AsyncPollingMethod

既定では、ポーリング メソッドは AsyncARMPolling になります。 この操作でポーリングしない場合は False を渡すか、個人のポーリング戦略に対して独自に初期化されたポーリング オブジェクトを渡します。

polling_interval

int

Retry-After ヘッダーが存在しない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。

戻り値

ManagedHsm または cls(response) の結果を返す AsyncLROPoller のインスタンス

の戻り値の型 :

AsyncLROPoller[ManagedHsm]

例外

HttpResponseError

begin_delete

指定したマネージド HSM プールを削除します。

async begin_delete(resource_group_name: str, name: str, **kwargs: Any) -> AsyncLROPoller[None]

パラメーター

resource_group_name

str

必須

マネージド HSM プールを含むリソース グループの名前。 必須。

name

str

必須

削除するマネージド HSM プールの名前。 必須。

cls

callable

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

continuation_token

str

保存された状態からポーリングを再開するための継続トークン。

polling

bool または AsyncPollingMethod

既定では、ポーリング メソッドは AsyncARMPolling になります。 この操作でポーリングしない場合は False を渡すか、個人のポーリング戦略に対して独自に初期化されたポーリング オブジェクトを渡します。

polling_interval

int

Retry-After ヘッダーが存在しない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。

戻り値

None または cls(response) の結果を返す AsyncLROPoller のインスタンス

の戻り値の型 :

AsyncLROPoller[None]

例外

HttpResponseError

begin_purge_deleted

指定したマネージド HSM を完全に削除します。

async begin_purge_deleted(name: str, location: str, **kwargs: Any) -> AsyncLROPoller[None]

パラメーター

name

str

必須

論理的に削除されたマネージド HSM の名前。 必須。

location

str

必須

論理的に削除されたマネージド HSM の場所。 必須。

cls

callable

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

continuation_token

str

保存された状態からポーリングを再開するための継続トークン。

polling

bool または AsyncPollingMethod

既定では、ポーリング メソッドは AsyncARMPolling になります。 この操作でポーリングしない場合は False を渡すか、個人のポーリング戦略に対して独自に初期化されたポーリング オブジェクトを渡します。

polling_interval

int

Retry-After ヘッダーが存在しない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。

戻り値

None または cls(response) の結果を返す AsyncLROPoller のインスタンス

の戻り値の型 :

AsyncLROPoller[None]

例外

HttpResponseError

begin_update

指定したサブスクリプションのマネージド HSM プールを更新します。

async begin_update(resource_group_name: str, name: str, parameters: _models.ManagedHsm, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ManagedHsm]

パラメーター

resource_group_name

str

必須

マネージド HSM プールを含むリソース グループの名前。 必須。

name

str

必須

マネージド HSM プールの名前。 必須。

parameters

ManagedHsm または IO

必須

マネージド HSM プールにパッチを適用するためのパラメーター。 ManagedHsm 型または IO 型です。 必須。

content_type

str

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

cls

callable

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

continuation_token

str

保存された状態からポーリングを再開するための継続トークン。

polling

bool または AsyncPollingMethod

既定では、ポーリング メソッドは AsyncARMPolling になります。 この操作でポーリングしない場合は False を渡すか、個人のポーリング戦略に対して独自に初期化されたポーリング オブジェクトを渡します。

polling_interval

int

Retry-After ヘッダーが存在しない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。

戻り値

ManagedHsm または cls(response) の結果を返す AsyncLROPoller のインスタンス

の戻り値の型 :

AsyncLROPoller[ManagedHsm]

例外

HttpResponseError

check_mhsm_name_availability

マネージド HSM 名が有効であり、まだ使用されていないことを確認します。

async check_mhsm_name_availability(mhsm_name: _models.CheckMhsmNameAvailabilityParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CheckMhsmNameAvailabilityResult

パラメーター

mhsm_name

CheckMhsmNameAvailabilityParameters または IO

必須

マネージド HSM の名前。 CheckMhsmNameAvailabilityParameters 型または IO 型です。 必須。

content_type

str

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

cls

callable

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

戻り値

CheckMhsmNameAvailabilityResult または cls(response) の結果

の戻り値の型 :

CheckMhsmNameAvailabilityResult

例外

HttpResponseError

get

指定したマネージド HSM プールを取得します。

async get(resource_group_name: str, name: str, **kwargs: Any) -> ManagedHsm | None

パラメーター

resource_group_name

str

必須

マネージド HSM プールを含むリソース グループの名前。 必須。

name

str

必須

マネージド HSM プールの名前。 必須。

cls

callable

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

戻り値

ManagedHsm または None、または cls(response) の結果

の戻り値の型 :

ManagedHsm,

None

例外

HttpResponseError

get_deleted

指定した削除されたマネージド HSM を取得します。

async get_deleted(name: str, location: str, **kwargs: Any) -> DeletedManagedHsm

パラメーター

name

str

必須

削除されたマネージド HSM の名前。 必須。

location

str

必須

削除されたマネージド HSM の場所。 必須。

cls

callable

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

戻り値

DeletedManagedHsm または cls(response) の結果

の戻り値の型 :

DeletedManagedHsm

例外

HttpResponseError

list_by_resource_group

List 操作は、サブスクリプションに関連付けられているマネージド HSM プールと、指定されたリソース グループ内に関する情報を取得します。

list_by_resource_group(resource_group_name: str, top: int | None = None, **kwargs: Any) -> AsyncIterable[ManagedHsm]

パラメーター

resource_group_name

str

必須

マネージド HSM プールを含むリソース グループの名前。 必須。

top

int

必須

返される結果の最大数。 既定値は [なし] です。

cls

callable

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

戻り値

ManagedHsm のインスタンスや cls(response) の結果のような反復子

の戻り値の型 :

AsyncItemPaged[ManagedHsm]

例外

HttpResponseError

list_by_subscription

List 操作は、サブスクリプションに関連付けられているマネージド HSM プールに関する情報を取得します。

list_by_subscription(top: int | None = None, **kwargs: Any) -> AsyncIterable[ManagedHsm]

パラメーター

top

int

必須

返される結果の最大数。 既定値は [なし] です。

cls

callable

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

戻り値

ManagedHsm のインスタンスや cls(response) の結果のような反復子

の戻り値の型 :

AsyncItemPaged[ManagedHsm]

例外

HttpResponseError

list_deleted

List 操作は、サブスクリプションに関連付けられている削除されたマネージド HSM に関する情報を取得します。

list_deleted(**kwargs: Any) -> AsyncIterable[DeletedManagedHsm]

パラメーター

cls

callable

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

戻り値

DeletedManagedHsm のインスタンスや cls(response) の結果のような反復子

の戻り値の型 :

AsyncItemPaged[DeletedManagedHsm]

例外

HttpResponseError

属性

models

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