Keys interface

Paket:

@azure/arm-keyvault

Gränssnitt som representerar nycklar.

Metoder

createIfNotExist(string, string, string, KeyCreateParameters, KeysCreateIfNotExistOptionalParams)	Skapar den första versionen av en ny nyckel om den inte finns. Om den redan finns returneras den befintliga nyckeln utan att några skrivåtgärder utförs. Det här API:et skapar inte efterföljande versioner och uppdaterar inte befintliga nycklar.
get(string, string, string, KeysGetOptionalParams)	Hämtar den aktuella versionen av den angivna nyckeln från det angivna nyckelvalvet.
getVersion(string, string, string, string, KeysGetVersionOptionalParams)	Hämtar den angivna versionen av den angivna nyckeln i det angivna nyckelvalvet.
list(string, string, KeysListOptionalParams)	Visar nycklarna i det angivna nyckelvalvet.
listVersions(string, string, string, KeysListVersionsOptionalParams)	Visar en lista över versionerna av den angivna nyckeln i det angivna nyckelvalvet.

Metodinformation

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

Skapar den första versionen av en ny nyckel om den inte finns. Om den redan finns returneras den befintliga nyckeln utan att några skrivåtgärder utförs. Det här API:et skapar inte efterföljande versioner och uppdaterar inte befintliga nycklar.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen som innehåller det angivna nyckelvalvet.

vaultName

string

Namnet på nyckelvalvet som innehåller nyckeln som ska skapas.

keyName

string

Namnet på nyckeln som ska skapas. Värdet som du anger kan kopieras globalt i syfte att köra tjänsten. Det angivna värdet bör inte innehålla personligt identifierbar eller känslig information.

parameters

KeyCreateParameters

De parametrar som används för att skapa den angivna nyckeln.

options

KeysCreateIfNotExistOptionalParams

Alternativparametrarna.

Returer

Promise<Key>

get(string, string, string, KeysGetOptionalParams)

Hämtar den aktuella versionen av den angivna nyckeln från det angivna nyckelvalvet.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen som innehåller det angivna nyckelvalvet.

vaultName

string

Namnet på valvet som innehåller nyckeln som ska hämtas.

keyName

string

Namnet på nyckeln som ska hämtas.

options

KeysGetOptionalParams

Alternativparametrarna.

Returer

Promise<Key>

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

Hämtar den angivna versionen av den angivna nyckeln i det angivna nyckelvalvet.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen som innehåller det angivna nyckelvalvet.

vaultName

string

Namnet på valvet som innehåller nyckelversionen som ska hämtas.

keyName

string

Namnet på den nyckelversion som ska hämtas.

keyVersion

string

Den version av nyckeln som ska hämtas.

options

KeysGetVersionOptionalParams

Alternativparametrarna.

Returer

Promise<Key>

list(string, string, KeysListOptionalParams)

Visar nycklarna i det angivna nyckelvalvet.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen som innehåller det angivna nyckelvalvet.

vaultName

string

Namnet på valvet som innehåller de nycklar som ska hämtas.

options

KeysListOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<Key, Key[], PageSettings>

listVersions(string, string, string, KeysListVersionsOptionalParams)

Visar en lista över versionerna av den angivna nyckeln i det angivna nyckelvalvet.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen som innehåller det angivna nyckelvalvet.

vaultName

string

Namnet på valvet som innehåller de nyckelversioner som ska hämtas.

keyName

string

Namnet på de nyckelversioner som ska hämtas.

options

KeysListVersionsOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<Key, Key[], PageSettings>