Keys interface

Schnittstelle, die einen Schlüssel darstellt.

Methoden

createIfNotExist(string, string, string, KeyCreateParameters, KeysCreateIfNotExistOptionalParams)

Erstellt die erste Version eines neuen Schlüssels, wenn er nicht vorhanden ist. Wenn er bereits vorhanden ist, wird der vorhandene Schlüssel zurückgegeben, ohne dass Schreibvorgänge ausgeführt werden. Diese API erstellt keine nachfolgenden Versionen und aktualisiert vorhandene Schlüssel nicht.

get(string, string, string, KeysGetOptionalParams)

Ruft die aktuelle Version des angegebenen Schlüssels aus dem angegebenen Schlüsseltresor ab.

getVersion(string, string, string, string, KeysGetVersionOptionalParams)

Ruft die angegebene Version des angegebenen Schlüssels im angegebenen Schlüsseltresor ab.

list(string, string, KeysListOptionalParams)

Listet die Schlüssel im angegebenen Schlüsseltresor auf.

listVersions(string, string, string, KeysListVersionsOptionalParams)

Listet die Versionen des angegebenen Schlüssels im angegebenen Schlüsseltresor auf.

Details zur Methode

createIfNotExist(string, string, string, KeyCreateParameters, KeysCreateIfNotExistOptionalParams)

Erstellt die erste Version eines neuen Schlüssels, wenn er nicht vorhanden ist. Wenn er bereits vorhanden ist, wird der vorhandene Schlüssel zurückgegeben, ohne dass Schreibvorgänge ausgeführt werden. Diese API erstellt keine nachfolgenden Versionen und aktualisiert vorhandene Schlüssel nicht.

function createIfNotExist(resourceGroupName: string, vaultName: string, keyName: string, parameters: KeyCreateParameters, options?: KeysCreateIfNotExistOptionalParams): Promise<Key>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den angegebenen Schlüsseltresor enthält.

vaultName

string

Der Name des Schlüsseltresors, der den zu erstellenden Schlüssel enthält.

keyName

string

Der Name des zu erstellenden Schlüssels. Der von Ihnen bereitgestellte Wert kann global kopiert werden, um den Dienst auszuführen. Der bereitgestellte Wert sollte keine persönlich identifizierbaren oder sensiblen Informationen enthalten.

parameters
KeyCreateParameters

Die Parameter, die zum Erstellen des angegebenen Schlüssels verwendet werden.

options
KeysCreateIfNotExistOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Key>

get(string, string, string, KeysGetOptionalParams)

Ruft die aktuelle Version des angegebenen Schlüssels aus dem angegebenen Schlüsseltresor ab.

function get(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysGetOptionalParams): Promise<Key>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den angegebenen Schlüsseltresor enthält.

vaultName

string

Der Name des Tresors, der den abzurufenden Schlüssel enthält.

keyName

string

Der Name des abzurufenden Schlüssels.

options
KeysGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Key>

getVersion(string, string, string, string, KeysGetVersionOptionalParams)

Ruft die angegebene Version des angegebenen Schlüssels im angegebenen Schlüsseltresor ab.

function getVersion(resourceGroupName: string, vaultName: string, keyName: string, keyVersion: string, options?: KeysGetVersionOptionalParams): Promise<Key>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den angegebenen Schlüsseltresor enthält.

vaultName

string

Der Name des Tresors, der die abzurufende Schlüsselversion enthält.

keyName

string

Der Name der abzurufenden Schlüsselversion.

keyVersion

string

Die Version des abzurufenden Schlüssels.

options
KeysGetVersionOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Key>

list(string, string, KeysListOptionalParams)

Listet die Schlüssel im angegebenen Schlüsseltresor auf.

function list(resourceGroupName: string, vaultName: string, options?: KeysListOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den angegebenen Schlüsseltresor enthält.

vaultName

string

Der Name des Tresors, der die abzurufenden Schlüssel enthält.

options
KeysListOptionalParams

Die Optionsparameter.

Gibt zurück

listVersions(string, string, string, KeysListVersionsOptionalParams)

Listet die Versionen des angegebenen Schlüssels im angegebenen Schlüsseltresor auf.

function listVersions(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysListVersionsOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, die den angegebenen Schlüsseltresor enthält.

vaultName

string

Der Name des Tresors, der die abzurufenden Schlüsselversionen enthält.

keyName

string

Der Name der abzurufenden Schlüsselversionen.

options
KeysListVersionsOptionalParams

Die Optionsparameter.

Gibt zurück