Keys interface
Interfaccia che rappresenta una chiave.
Metodi
| create |
Crea la prima versione di una nuova chiave se non esiste. Se esiste già, la chiave esistente viene restituita senza eseguire operazioni di scrittura. Questa API non crea versioni successive e non aggiorna le chiavi esistenti. |
| get(string, string, string, Keys |
Ottiene la versione corrente della chiave specificata dall'insieme di credenziali delle chiavi specificato. |
| get |
Ottiene la versione specificata della chiave specificata nell'insieme di credenziali delle chiavi specificato. |
| list(string, string, Keys |
Elenca le chiavi nell'insieme di credenziali delle chiavi specificato. |
| list |
Elenca le versioni della chiave specificata nell'insieme di credenziali delle chiavi specificato. |
Dettagli metodo
createIfNotExist(string, string, string, KeyCreateParameters, KeysCreateIfNotExistOptionalParams)
Crea la prima versione di una nuova chiave se non esiste. Se esiste già, la chiave esistente viene restituita senza eseguire operazioni di scrittura. Questa API non crea versioni successive e non aggiorna le chiavi esistenti.
function createIfNotExist(resourceGroupName: string, vaultName: string, keyName: string, parameters: KeyCreateParameters, options?: KeysCreateIfNotExistOptionalParams): Promise<Key>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'insieme di credenziali delle chiavi specificato.
- vaultName
-
string
Nome dell'insieme di credenziali delle chiavi che contiene la chiave da creare.
- keyName
-
string
Nome della chiave da creare. Il valore specificato può essere copiato a livello globale allo scopo di eseguire il servizio. Il valore specificato non deve includere informazioni personali o sensibili.
- parameters
- KeyCreateParameters
Parametri usati per creare la chiave specificata.
Parametri delle opzioni.
Restituisce
Promise<Key>
get(string, string, string, KeysGetOptionalParams)
Ottiene la versione corrente della chiave specificata dall'insieme di credenziali delle chiavi specificato.
function get(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysGetOptionalParams): Promise<Key>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'insieme di credenziali delle chiavi specificato.
- vaultName
-
string
Nome dell'insieme di credenziali che contiene la chiave da recuperare.
- keyName
-
string
Nome della chiave da recuperare.
- options
- KeysGetOptionalParams
Parametri delle opzioni.
Restituisce
Promise<Key>
getVersion(string, string, string, string, KeysGetVersionOptionalParams)
Ottiene la versione specificata della chiave specificata nell'insieme di credenziali delle chiavi specificato.
function getVersion(resourceGroupName: string, vaultName: string, keyName: string, keyVersion: string, options?: KeysGetVersionOptionalParams): Promise<Key>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'insieme di credenziali delle chiavi specificato.
- vaultName
-
string
Nome dell'insieme di credenziali che contiene la versione della chiave da recuperare.
- keyName
-
string
Nome della versione della chiave da recuperare.
- keyVersion
-
string
Versione della chiave da recuperare.
- options
- KeysGetVersionOptionalParams
Parametri delle opzioni.
Restituisce
Promise<Key>
list(string, string, KeysListOptionalParams)
Elenca le chiavi nell'insieme di credenziali delle chiavi specificato.
function list(resourceGroupName: string, vaultName: string, options?: KeysListOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'insieme di credenziali delle chiavi specificato.
- vaultName
-
string
Nome dell'insieme di credenziali contenente le chiavi da recuperare.
- options
- KeysListOptionalParams
Parametri delle opzioni.
Restituisce
listVersions(string, string, string, KeysListVersionsOptionalParams)
Elenca le versioni della chiave specificata nell'insieme di credenziali delle chiavi specificato.
function listVersions(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysListVersionsOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse che contiene l'insieme di credenziali delle chiavi specificato.
- vaultName
-
string
Nome dell'insieme di credenziali che contiene le versioni chiave da recuperare.
- keyName
-
string
Nome delle versioni chiave da recuperare.
- options
- KeysListVersionsOptionalParams
Parametri delle opzioni.