Keys interface
Rozhraní představující klíče.
Metody
| create |
Vytvoří první verzi nového klíče, pokud neexistuje. Pokud už existuje, vrátí se existující klíč bez provádění operací zápisu. Toto rozhraní API nevytvoří další verze a neaktualizuje existující klíče. |
| get(string, string, string, Keys |
Získá aktuální verzi zadaného klíče ze zadaného trezoru klíčů. |
| get |
Získá zadanou verzi zadaného klíče v zadaném trezoru klíčů. |
| list(string, string, Keys |
Zobrazí seznam klíčů v zadaném trezoru klíčů. |
| list |
Zobrazí seznam verzí zadaného klíče v zadaném trezoru klíčů. |
Podrobnosti metody
createIfNotExist(string, string, string, KeyCreateParameters, KeysCreateIfNotExistOptionalParams)
Vytvoří první verzi nového klíče, pokud neexistuje. Pokud už existuje, vrátí se existující klíč bez provádění operací zápisu. Toto rozhraní API nevytvoří další verze a neaktualizuje existující klíče.
function createIfNotExist(resourceGroupName: string, vaultName: string, keyName: string, parameters: KeyCreateParameters, options?: KeysCreateIfNotExistOptionalParams): Promise<Key>Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje zadaný trezor klíčů.
- vaultName
-
string
Název trezoru klíčů, který obsahuje klíč, který se má vytvořit.
- keyName
-
string
Název klíče, který se má vytvořit. Zadaná hodnota se může zkopírovat globálně za účelem spuštění služby. Zadaná hodnota by neměla zahrnovat identifikovatelné osobní údaje ani citlivé údaje.
- parameters
- KeyCreateParameters
Parametry použité k vytvoření zadaného klíče.
Parametry možností.
Návraty
Promise<Key>
get(string, string, string, KeysGetOptionalParams)
Získá aktuální verzi zadaného klíče ze zadaného trezoru klíčů.
function get(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysGetOptionalParams): Promise<Key>Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje zadaný trezor klíčů.
- vaultName
-
string
Název trezoru, který obsahuje klíč, který se má načíst.
- keyName
-
string
Název klíče, který se má načíst.
- options
- KeysGetOptionalParams
Parametry možností.
Návraty
Promise<Key>
getVersion(string, string, string, string, KeysGetVersionOptionalParams)
Získá zadanou verzi zadaného klíče v zadaném trezoru klíčů.
function getVersion(resourceGroupName: string, vaultName: string, keyName: string, keyVersion: string, options?: KeysGetVersionOptionalParams): Promise<Key>Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje zadaný trezor klíčů.
- vaultName
-
string
Název trezoru, který obsahuje verzi klíče, která se má načíst.
- keyName
-
string
Název verze klíče, která se má načíst.
- keyVersion
-
string
Verze klíče, který se má načíst.
- options
- KeysGetVersionOptionalParams
Parametry možností.
Návraty
Promise<Key>
list(string, string, KeysListOptionalParams)
Zobrazí seznam klíčů v zadaném trezoru klíčů.
function list(resourceGroupName: string, vaultName: string, options?: KeysListOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje zadaný trezor klíčů.
- vaultName
-
string
Název trezoru, který obsahuje klíče, které se mají načíst.
- options
- KeysListOptionalParams
Parametry možností.
Návraty
listVersions(string, string, string, KeysListVersionsOptionalParams)
Zobrazí seznam verzí zadaného klíče v zadaném trezoru klíčů.
function listVersions(resourceGroupName: string, vaultName: string, keyName: string, options?: KeysListVersionsOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>Parametry
- resourceGroupName
-
string
Název skupiny prostředků, která obsahuje zadaný trezor klíčů.
- vaultName
-
string
Název trezoru, který obsahuje verze klíčů, které se mají načíst.
- keyName
-
string
Název verzí klíčů, které se mají načíst.
- options
- KeysListVersionsOptionalParams
Parametry možností.