KeysOperations 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:keys>.

Herança

builtins.object

KeysOperations

Construtor

KeysOperations(*args, **kwargs)

Métodos

create_if_not_exist	Cria a primeira versão de uma nova chave, caso ela não exista. Se ela já existir, a chave existente será retornada sem que nenhuma operação de gravação seja executada. Essa API não cria versões subsequentes e não atualiza as chaves existentes.
get	Obtém a versão atual da chave especificada 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, caso ela não exista. Se ela já existir, a chave existente será retornada sem que nenhuma operação de gravação seja executada. Essa API não cria versões subsequentes e não atualiza as chaves existentes.

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

Obrigatório

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

vault_name

str

Obrigatório

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

key_name

str

Obrigatório

O nome da chave a ser criada. Obrigatórios.

parameters

KeyCreateParameters ou IO

Obrigatório

Os parâmetros usados para criar a chave especificada. É um tipo KeyCreateParameters 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

Chave ou o resultado de cls(response)

Tipo de retorno

Key

Exceções

HttpResponseError

get

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

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

Parâmetros

resource_group_name

str

Obrigatório

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

vault_name

str

Obrigatório

O nome do cofre que contém a chave a ser recuperada. Obrigatórios.

key_name

str

Obrigatório

O nome da chave a ser recuperada. Obrigatórios.

cls

callable

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

Retornos

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.

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

Parâmetros

resource_group_name

str

Obrigatório

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

vault_name

str

Obrigatório

O nome do cofre que contém a versão da chave a ser recuperada. Obrigatórios.

key_name

str

Obrigatório

O nome da versão da chave a ser recuperada. Obrigatórios.

key_version

str

Obrigatório

A versão da chave a ser recuperada. Obrigatórios.

cls

callable

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

Retornos

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) -> Iterable[Key]

Parâmetros

resource_group_name

str

Obrigatório

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

vault_name

str

Obrigatório

O nome do cofre que contém as chaves a serem recuperadas. Obrigatórios.

cls

callable

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

Retornos

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

Tipo de retorno

ItemPaged[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) -> Iterable[Key]

Parâmetros

resource_group_name

str

Obrigatório

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

vault_name

str

Obrigatório

O nome do cofre que contém as versões de chave a serem recuperadas. Obrigatórios.

key_name

str

Obrigatório

O nome das versões de chave a serem recuperadas. Obrigatórios.

cls

callable

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

Retornos

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

Tipo de retorno

ItemPaged[Key]

Exceções

HttpResponseError

Atributos

models

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