Keys interface
Interface que representa chaves.
Métodos
| create |
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, Keys |
Obtém a versão atual da chave especificada do cofre de chaves especificado. |
| get |
Obtém a versão especificada da chave especificada no cofre de chaves especificado. |
| list(string, string, Keys |
Lista as chaves no cofre de chaves especificado. |
| list |
Lista as versões da chave especificada no cofre de chaves especificado. |
Detalhes do método
createIfNotExist(string, string, string, KeyCreateParameters, KeysCreateIfNotExistOptionalParams)
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, vaultName: string, keyName: string, parameters: KeyCreateParameters, options?: KeysCreateIfNotExistOptionalParams): Promise<Key>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o cofre de chaves especificado.
- vaultName
-
string
O nome do cofre de chaves que contém a chave a ser criada.
- 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
- KeyCreateParameters
Os parâmetros usados para criar a chave especificada.
Os parâmetros de opções.
Retornos
Promise<Key>
get(string, string, string, KeysGetOptionalParams)
Obtém a versão atual da chave especificada do cofre de chaves especificado.
function get(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysGetOptionalParams): Promise<Key>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o cofre de chaves especificado.
- vaultName
-
string
O nome do cofre que contém a chave a ser recuperada.
- keyName
-
string
O nome da chave a ser recuperada.
- options
- KeysGetOptionalParams
Os parâmetros de opções.
Retornos
Promise<Key>
getVersion(string, string, string, string, KeysGetVersionOptionalParams)
Obtém a versão especificada da chave especificada no cofre de chaves especificado.
function getVersion(resourceGroupName: string, vaultName: string, keyName: string, keyVersion: string, options?: KeysGetVersionOptionalParams): Promise<Key>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o cofre de chaves especificado.
- vaultName
-
string
O nome do cofre que contém a versão da chave a ser recuperada.
- keyName
-
string
O nome da versão da chave a ser recuperada.
- keyVersion
-
string
A versão da chave a ser recuperada.
- options
- KeysGetVersionOptionalParams
Os parâmetros de opções.
Retornos
Promise<Key>
list(string, string, KeysListOptionalParams)
Lista as chaves no cofre de chaves especificado.
function list(resourceGroupName: string, vaultName: string, options?: KeysListOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o cofre de chaves especificado.
- vaultName
-
string
O nome do cofre que contém as chaves a serem recuperadas.
- options
- KeysListOptionalParams
Os parâmetros de opções.
Retornos
listVersions(string, string, string, KeysListVersionsOptionalParams)
Lista as versões da chave especificada no cofre de chaves especificado.
function listVersions(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysListVersionsOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos que contém o cofre de chaves especificado.
- vaultName
-
string
O nome do cofre que contém as versões de chave a serem recuperadas.
- keyName
-
string
O nome das versões de chave a serem recuperadas.
- options
- KeysListVersionsOptionalParams
Os parâmetros de opções.