ManagedHsmsOperations Classe

Aviso

NÃO instancie essa classe diretamente.

Em vez disso, você deve acessar as operações a seguir por meio de

KeyVaultManagementClient's

Atributo <xref:managed_hsms>.

Herança

builtins.object

ManagedHsmsOperations

Construtor

ManagedHsmsOperations(*args, **kwargs)

Métodos

begin_create_or_update	Crie ou atualize um pool de HSM gerenciado na assinatura especificada.
begin_delete	Exclui o pool de HSM gerenciado especificado.
begin_purge_deleted	Exclui permanentemente o HSM gerenciado especificado.
begin_update	Atualize um pool de HSM gerenciado na assinatura especificada.
check_mhsm_name_availability	Verifica se o nome hsm gerenciado é válido e ainda não está em uso.
get	Obtém o pool de HSM gerenciado especificado.
get_deleted	Obtém o HSM gerenciado excluído especificado.
list_by_resource_group	A operação Lista obtém informações sobre os Pools de HSM gerenciados associados à assinatura e dentro do grupo de recursos especificado.
list_by_subscription	A operação Lista obtém informações sobre os pools de HSM gerenciados associados à assinatura.
list_deleted	A operação Lista obtém informações sobre os HSMs gerenciados excluídos associados à assinatura.

begin_create_or_update

Crie ou atualize um pool de HSM gerenciado na assinatura especificada.

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

Parâmetros

resource_group_name

str

Obrigatório

Nome do grupo de recursos que contém o pool de HSM gerenciado. Obrigatórios.

name

str

Obrigatório

Nome do pool de HSM gerenciado. Obrigatórios.

parameters

ManagedHsm ou IO

Obrigatório

Parâmetros para criar ou atualizar o pool de HSM gerenciado. É um tipo ManagedHsm ou um tipo de E/S. Obrigatórios.

content_type

str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

continuation_token

str

Um token de continuação para reiniciar um poller de um estado salvo.

polling

bool ou AsyncPollingMethod

Por padrão, seu método de sondagem será AsyncARMPolling. Passe em False para que esta operação não sondar ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.

polling_interval

int

Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.

Retornos

Uma instância de AsyncLROPoller que retorna ManagedHsm ou o resultado de cls(response)

Tipo de retorno

AsyncLROPoller[ManagedHsm]

Exceções

HttpResponseError

begin_delete

Exclui o pool de HSM gerenciado especificado.

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

Parâmetros

resource_group_name

str

Obrigatório

Nome do grupo de recursos que contém o pool de HSM gerenciado. Obrigatórios.

name

str

Obrigatório

O nome do pool de HSM gerenciado a ser excluído. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

continuation_token

str

Um token de continuação para reiniciar um poller de um estado salvo.

polling

bool ou AsyncPollingMethod

Por padrão, seu método de sondagem será AsyncARMPolling. Passe em False para que esta operação não sondar ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.

polling_interval

int

Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.

Retornos

Uma instância de AsyncLROPoller que retorna None ou o resultado de cls(response)

Tipo de retorno

AsyncLROPoller[None]

Exceções

HttpResponseError

begin_purge_deleted

Exclui permanentemente o HSM gerenciado especificado.

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

Parâmetros

name

str

Obrigatório

O nome do HSM gerenciado excluído temporariamente. Obrigatórios.

location

str

Obrigatório

O local do HSM gerenciado excluído temporariamente. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

continuation_token

str

Um token de continuação para reiniciar um poller de um estado salvo.

polling

bool ou AsyncPollingMethod

Por padrão, seu método de sondagem será AsyncARMPolling. Passe em False para que esta operação não sondar ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.

polling_interval

int

Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.

Retornos

Uma instância de AsyncLROPoller que retorna None ou o resultado de cls(response)

Tipo de retorno

AsyncLROPoller[None]

Exceções

HttpResponseError

begin_update

Atualize um pool de HSM gerenciado na assinatura especificada.

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

Parâmetros

resource_group_name

str

Obrigatório

Nome do grupo de recursos que contém o pool de HSM gerenciado. Obrigatórios.

name

str

Obrigatório

Nome do pool de HSM gerenciado. Obrigatórios.

parameters

ManagedHsm ou IO

Obrigatório

Parâmetros para corrigir o pool de HSM gerenciado. É um tipo ManagedHsm ou um tipo de E/S. Obrigatórios.

content_type

str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

continuation_token

str

Um token de continuação para reiniciar um poller de um estado salvo.

polling

bool ou AsyncPollingMethod

Por padrão, seu método de sondagem será AsyncARMPolling. Passe em False para que esta operação não sondar ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.

polling_interval

int

Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.

Retornos

Uma instância de AsyncLROPoller que retorna ManagedHsm ou o resultado de cls(response)

Tipo de retorno

AsyncLROPoller[ManagedHsm]

Exceções

HttpResponseError

check_mhsm_name_availability

Verifica se o nome hsm gerenciado é válido e ainda não está em uso.

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

Parâmetros

mhsm_name

CheckMhsmNameAvailabilityParameters ou IO

Obrigatório

O nome do hsm gerenciado. É um tipo CheckMhsmNameAvailabilityParameters ou um tipo de E/S. Obrigatórios.

content_type

str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

CheckMhsmNameAvailabilityResult ou o resultado de cls(response)

Tipo de retorno

CheckMhsmNameAvailabilityResult

Exceções

HttpResponseError

get

Obtém o pool de HSM gerenciado especificado.

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

Parâmetros

resource_group_name

str

Obrigatório

Nome do grupo de recursos que contém o pool de HSM gerenciado. Obrigatórios.

name

str

Obrigatório

O nome do pool de HSM gerenciado. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

ManagedHsm ou None ou o resultado de cls(response)

Tipo de retorno

ManagedHsm,

None

Exceções

HttpResponseError

get_deleted

Obtém o HSM gerenciado excluído especificado.

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

Parâmetros

name

str

Obrigatório

O nome do HSM gerenciado excluído. Obrigatórios.

location

str

Obrigatório

O local do HSM gerenciado excluído. Obrigatórios.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

DeletedManagedHsm ou o resultado de cls(response)

Tipo de retorno

DeletedManagedHsm

Exceções

HttpResponseError

list_by_resource_group

A operação Lista obtém informações sobre os Pools de HSM gerenciados associados à assinatura e dentro do grupo de recursos especificado.

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

Parâmetros

resource_group_name

str

Obrigatório

Nome do grupo de recursos que contém o pool de HSM gerenciado. Obrigatórios.

top

int

Obrigatório

Número máximo de resultados a serem retornados. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Um iterador como a instância do ManagedHsm ou o resultado de cls(response)

Tipo de retorno

AsyncItemPaged[ManagedHsm]

Exceções

HttpResponseError

list_by_subscription

A operação Lista obtém informações sobre os pools de HSM gerenciados associados à assinatura.

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

Parâmetros

top

int

Obrigatório

Número máximo de resultados a serem retornados. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Um iterador como a instância do ManagedHsm ou o resultado de cls(response)

Tipo de retorno

AsyncItemPaged[ManagedHsm]

Exceções

HttpResponseError

list_deleted

A operação Lista obtém informações sobre os HSMs gerenciados excluídos associados à assinatura.

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

Parâmetros

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Um iterador como a instância de DeletedManagedHsm ou o resultado de cls(response)

Tipo de retorno

AsyncItemPaged[DeletedManagedHsm]

Exceções

HttpResponseError

Atributos

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'>