KeysOperations Classe

Aviso

NÃO instanciar esta classe diretamente.

Em vez disso, deve aceder às seguintes operações através de

KeyVaultManagementClient's

<xref:keys> atributo.

Herança

builtins.object

KeysOperations

Construtor

KeysOperations(*args, **kwargs)

Métodos

create_if_not_exist	Cria a primeira versão de uma nova chave, se não existir. Se já existir, a chave existente é devolvida sem que sejam executadas operações de escrita. Esta API não cria versões subsequentes e não atualiza as chaves existentes.
get	Obtém a versão atual da chave especificada a partir do cofre de chaves especificado.
get_version	Obtém a versão especificada da chave especificada no cofre de chaves especificado.
list	Lista as chaves no cofre de chaves especificado.
list_versions	Lista as versões da chave especificada no cofre de chaves especificado.

create_if_not_exist

Cria a primeira versão de uma nova chave, se não existir. Se já existir, a chave existente é devolvida sem que sejam executadas operações de escrita. Esta API não cria versões subsequentes e não atualiza as chaves existentes.

async 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

Parâmetros

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o cofre de chaves especificado. Obrigatório.

vault_name

str

Necessário

O nome do cofre de chaves que contém a chave a ser criada. Obrigatório.

key_name

str

Necessário

O nome da chave a ser criada. O valor fornecido pode ser copiado globalmente para efeitos de execução do serviço. O valor fornecido não deve incluir informações pessoais ou confidenciais. Obrigatório.

parameters

KeyCreateParameters ou IO

Necessário

Os parâmetros utilizados para criar a chave especificada. É um tipo KeyCreateParameters ou um tipo de E/S. Obrigatório.

content_type

str

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

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

Chave ou o resultado de cls(response)

Tipo de retorno

Key

Exceções

HttpResponseError

get

Obtém a versão atual da chave especificada a partir do cofre de chaves especificado.

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

Parâmetros

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o cofre de chaves especificado. Obrigatório.

vault_name

str

Necessário

O nome do cofre que contém a chave a obter. Obrigatório.

key_name

str

Necessário

O nome da chave a obter. Obrigatório.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

Chave ou o resultado de cls(response)

Tipo de retorno

Key

Exceções

HttpResponseError

get_version

Obtém a versão especificada da chave especificada no cofre de chaves especificado.

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

Parâmetros

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o cofre de chaves especificado. Obrigatório.

vault_name

str

Necessário

O nome do cofre que contém a versão da chave a obter. Obrigatório.

key_name

str

Necessário

O nome da versão da chave a obter. Obrigatório.

key_version

str

Necessário

A versão da chave a obter. Obrigatório.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

Chave ou o resultado de cls(response)

Tipo de retorno

Key

Exceções

HttpResponseError

list

Lista as chaves no cofre de chaves especificado.

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

Parâmetros

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o cofre de chaves especificado. Obrigatório.

vault_name

str

Necessário

O nome do cofre que contém as chaves a obter. Obrigatório.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

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

Tipo de retorno

AsyncItemPaged[Key]

Exceções

HttpResponseError

list_versions

Lista as versões da chave especificada no cofre de chaves especificado.

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

Parâmetros

resource_group_name

str

Necessário

O nome do grupo de recursos que contém o cofre de chaves especificado. Obrigatório.

vault_name

str

Necessário

O nome do cofre que contém as versões de chave a obter. Obrigatório.

key_name

str

Necessário

O nome das versões principais a obter. Obrigatório.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

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

Tipo de retorno

AsyncItemPaged[Key]

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