Compartilhar via


ManagedHsmKeys interface

Interface que representa um ManagedHsmKeys.

Métodos

createIfNotExist(string, string, string, ManagedHsmKeyCreateParameters, ManagedHsmKeysCreateIfNotExistOptionalParams)

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(string, string, string, ManagedHsmKeysGetOptionalParams)

Obtém a versão atual da chave especificada do HSM gerenciado especificado.

getVersion(string, string, string, string, ManagedHsmKeysGetVersionOptionalParams)

Obtém a versão especificada da chave especificada no HSM gerenciado especificado.

list(string, string, ManagedHsmKeysListOptionalParams)

Lista as chaves no HSM gerenciado especificado.

listVersions(string, string, string, ManagedHsmKeysListVersionsOptionalParams)

Lista as versões da chave especificada no HSM gerenciado especificado.

Detalhes do método

createIfNotExist(string, string, string, ManagedHsmKeyCreateParameters, ManagedHsmKeysCreateIfNotExistOptionalParams)

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.

function createIfNotExist(resourceGroupName: string, name: string, keyName: string, parameters: ManagedHsmKeyCreateParameters, options?: ManagedHsmKeysCreateIfNotExistOptionalParams): Promise<ManagedHsmKey>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

name

string

O nome do Pool de HSM Gerenciado dentro do grupo de recursos especificado.

keyName

string

O nome da chave a ser criada. O valor fornecido pode ser copiado globalmente para fins de execução do serviço. O valor fornecido não deve incluir informações pessoais identificáveis ou confidenciais.

parameters
ManagedHsmKeyCreateParameters

Os parâmetros usados para criar a chave especificada.

options
ManagedHsmKeysCreateIfNotExistOptionalParams

Os parâmetros de opções.

Retornos

Promise<ManagedHsmKey>

get(string, string, string, ManagedHsmKeysGetOptionalParams)

Obtém a versão atual da chave especificada do HSM gerenciado especificado.

function get(resourceGroupName: string, name: string, keyName: string, options?: ManagedHsmKeysGetOptionalParams): Promise<ManagedHsmKey>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

name

string

O nome do Pool de HSM Gerenciado dentro do grupo de recursos especificado.

keyName

string

O nome da chave a ser criada. O valor fornecido pode ser copiado globalmente para fins de execução do serviço. O valor fornecido não deve incluir informações pessoais identificáveis ou confidenciais.

options
ManagedHsmKeysGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<ManagedHsmKey>

getVersion(string, string, string, string, ManagedHsmKeysGetVersionOptionalParams)

Obtém a versão especificada da chave especificada no HSM gerenciado especificado.

function getVersion(resourceGroupName: string, name: string, keyName: string, keyVersion: string, options?: ManagedHsmKeysGetVersionOptionalParams): Promise<ManagedHsmKey>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

name

string

O nome do Pool de HSM Gerenciado dentro do grupo de recursos especificado.

keyName

string

O nome da chave a ser criada. O valor fornecido pode ser copiado globalmente para fins de execução do serviço. O valor fornecido não deve incluir informações pessoais identificáveis ou confidenciais.

keyVersion

string

A versão da chave a ser recuperada.

options
ManagedHsmKeysGetVersionOptionalParams

Os parâmetros de opções.

Retornos

Promise<ManagedHsmKey>

list(string, string, ManagedHsmKeysListOptionalParams)

Lista as chaves no HSM gerenciado especificado.

function list(resourceGroupName: string, name: string, options?: ManagedHsmKeysListOptionalParams): PagedAsyncIterableIterator<ManagedHsmKey, ManagedHsmKey[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

name

string

O nome do Pool de HSM Gerenciado dentro do grupo de recursos especificado.

options
ManagedHsmKeysListOptionalParams

Os parâmetros de opções.

Retornos

listVersions(string, string, string, ManagedHsmKeysListVersionsOptionalParams)

Lista as versões da chave especificada no HSM gerenciado especificado.

function listVersions(resourceGroupName: string, name: string, keyName: string, options?: ManagedHsmKeysListVersionsOptionalParams): PagedAsyncIterableIterator<ManagedHsmKey, ManagedHsmKey[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

name

string

O nome do Pool de HSM Gerenciado dentro do grupo de recursos especificado.

keyName

string

O nome da chave a ser criada. O valor fornecido pode ser copiado globalmente para fins de execução do serviço. O valor fornecido não deve incluir informações pessoais identificáveis ou confidenciais.

options
ManagedHsmKeysListVersionsOptionalParams

Os parâmetros de opções.

Retornos