Keys interface
Interfaz que representa una clave.
Métodos
| create |
Crea la primera versión de una clave nueva si no existe. Si ya existe, se devuelve la clave existente sin realizar ninguna operación de escritura. Esta API no crea versiones posteriores y no actualiza las claves existentes. |
| get(string, string, string, Keys |
Obtiene la versión actual de la clave especificada del almacén de claves especificado. |
| get |
Obtiene la versión especificada de la clave especificada en el almacén de claves especificado. |
| list(string, string, Keys |
Enumera las claves del almacén de claves especificado. |
| list |
Enumera las versiones de la clave especificada en el almacén de claves especificado. |
Detalles del método
createIfNotExist(string, string, string, KeyCreateParameters, KeysCreateIfNotExistOptionalParams)
Crea la primera versión de una clave nueva si no existe. Si ya existe, se devuelve la clave existente sin realizar ninguna operación de escritura. Esta API no crea versiones posteriores y no actualiza las claves existentes.
function createIfNotExist(resourceGroupName: string, vaultName: string, keyName: string, parameters: KeyCreateParameters, options?: KeysCreateIfNotExistOptionalParams): Promise<Key>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el almacén de claves especificado.
- vaultName
-
string
Nombre del almacén de claves que contiene la clave que se va a crear.
- keyName
-
string
Nombre de la clave que se va a crear. El valor que proporcione puede copiarse globalmente para ejecutar el servicio. El valor proporcionado no debe incluir información personal identificable o confidencial.
- parameters
- KeyCreateParameters
Parámetros usados para crear la clave especificada.
Parámetros de opciones.
Devoluciones
Promise<Key>
get(string, string, string, KeysGetOptionalParams)
Obtiene la versión actual de la clave especificada del almacén de claves especificado.
function get(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysGetOptionalParams): Promise<Key>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el almacén de claves especificado.
- vaultName
-
string
Nombre del almacén que contiene la clave que se va a recuperar.
- keyName
-
string
Nombre de la clave que se va a recuperar.
- options
- KeysGetOptionalParams
Parámetros de opciones.
Devoluciones
Promise<Key>
getVersion(string, string, string, string, KeysGetVersionOptionalParams)
Obtiene la versión especificada de la clave especificada en el almacén de claves especificado.
function getVersion(resourceGroupName: string, vaultName: string, keyName: string, keyVersion: string, options?: KeysGetVersionOptionalParams): Promise<Key>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el almacén de claves especificado.
- vaultName
-
string
Nombre del almacén que contiene la versión de la clave que se va a recuperar.
- keyName
-
string
Nombre de la versión de la clave que se va a recuperar.
- keyVersion
-
string
Versión de la clave que se va a recuperar.
- options
- KeysGetVersionOptionalParams
Parámetros de opciones.
Devoluciones
Promise<Key>
list(string, string, KeysListOptionalParams)
Enumera las claves del almacén de claves especificado.
function list(resourceGroupName: string, vaultName: string, options?: KeysListOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el almacén de claves especificado.
- vaultName
-
string
Nombre del almacén que contiene las claves que se van a recuperar.
- options
- KeysListOptionalParams
Parámetros de opciones.
Devoluciones
listVersions(string, string, string, KeysListVersionsOptionalParams)
Enumera las versiones de la clave especificada en el almacén de claves especificado.
function listVersions(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysListVersionsOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos que contiene el almacén de claves especificado.
- vaultName
-
string
Nombre del almacén que contiene las versiones de clave que se van a recuperar.
- keyName
-
string
Nombre de las versiones de clave que se van a recuperar.
- options
- KeysListVersionsOptionalParams
Parámetros de opciones.