KeyClient class
KeyClient poskytuje metody pro správu KeyVaultKey ve službě Azure Key Vault. Klient podporuje vytváření, načítání, aktualizaci, odstraňování, mazání, zálohování, obnovení a výpis klíčů KeyVaultKeys. Klient také podporuje výpis DeletedKey pro obnovitelné odstranění s povoleným azure Key Vaultem.
Konstruktory
Key |
Vytvoří instanci KeyClient. Příklad použití:
|
Vlastnosti
vault |
Základní adresa URL trezoru |
Metody
backup |
Požaduje, aby se do klienta stáhla záloha zadaného klíče. Stáhnou se všechny verze klíče. Tato operace vyžaduje oprávnění ke klíčům nebo zálohování. Příklad použití:
Zálohuje zadaný klíč. |
begin |
Operace odstranění se vztahuje na jakýkoli klíč uložený ve službě Azure Key Vault. Jednotlivé verze klíče nelze odstranit, pouze všechny verze daného klíče najednou. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud se klíč nesmazat. Tato operace vyžaduje oprávnění klíče nebo odstranění. Příklad použití:
Odstraní klíč ze zadaného trezoru klíčů. |
begin |
Obnoví odstraněný klíč v zadaném trezoru. Tuto operaci lze provést pouze v trezoru s povoleným obnovitelném odstraněním. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud se odstraněný klíč neobnoví. Tato operace vyžaduje oprávnění klíče nebo obnovení. Příklad použití:
Obnoví odstraněný klíč na nejnovější verzi. |
create |
Metoda createEcKey vytvoří nový klíč se třemi tečkami ve službě Azure Key Vault. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Vyžaduje klíče nebo oprávnění k vytvoření. Příklad použití:
Vytvoří nový klíč, uloží ho a pak klientovi vrátí parametry klíče a vlastnosti. |
create |
Operaci vytvoření klíče je možné použít k vytvoření libovolného typu klíče ve službě Azure Key Vault. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Vyžaduje klíče nebo oprávnění k vytvoření. Příklad použití:
Vytvoří nový klíč, uloží ho a pak klientovi vrátí parametry klíče a vlastnosti. |
create |
Metoda createOctKey vytvoří nový klíč OCT ve službě Azure Key Vault. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Vyžaduje klíče nebo oprávnění k vytvoření. Příklad použití:
Vytvoří nový klíč, uloží ho a pak klientovi vrátí parametry klíče a vlastnosti. |
create |
Metoda createRSAKey vytvoří nový klíč RSA ve službě Azure Key Vault. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Vyžaduje klíče nebo oprávnění k vytvoření. Příklad použití:
Vytvoří nový klíč, uloží ho a pak klientovi vrátí parametry klíče a vlastnosti. |
get |
Získá kryptografický klient pro daný klíč. Příklad použití:
|
get |
Metoda getDeletedKey vrátí zadaný odstraněný klíč spolu s jeho vlastnostmi. Tato operace vyžaduje klíče nebo získat oprávnění. Příklad použití:
Získá zadaný odstraněný klíč. |
get |
Metoda getKey získá zadaný klíč a vztahuje se na jakýkoli klíč uložený ve službě Azure Key Vault. Tato operace vyžaduje klíče nebo získat oprávnění. Příklad použití:
Získání zadaného klíče z daného trezoru klíčů |
get |
Získá zásadu obměny klíče služby Key Vault. Ve výchozím nastavení mají všechny klíče zásadu, která upozorní 30 dní před vypršením platnosti. Tato operace vyžaduje klíče nebo získat oprávnění. Příklad použití:
|
get |
Získá požadovaný počet bajtů obsahujících náhodné hodnoty ze spravovaného HSM. Tato operace vyžaduje oprávnění managedHsm/rng. Příklad použití:
|
import |
Operaci importu klíče je možné použít k importu libovolného typu klíče do služby Azure Key Vault. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Tato operace vyžaduje oprávnění ke klíčům nebo importu. Příklad použití:
Importuje externě vytvořený klíč, uloží ho a vrátí parametry a vlastnosti klíče klientovi. |
list |
Iteruje odstraněné klíče v trezoru. Úplný identifikátor klíče a vlastnosti jsou k dispozici v odpovědi. Pro klíče se nevrácejí žádné hodnoty. Tyto operace vyžadují oprávnění ke klíčům nebo seznamům. Příklad použití:
Výpis všech klíčů v trezoru |
list |
Iteruje nejnovější verzi všech klíčů v trezoru. Úplný identifikátor klíče a vlastnosti jsou k dispozici v odpovědi. Pro klíče se nevrácejí žádné hodnoty. Tyto operace vyžadují oprávnění ke klíčům nebo seznamům. Příklad použití:
Výpis všech klíčů v trezoru |
list |
Iteruje všechny verze daného klíče v trezoru. V odpovědi se poskytuje úplný identifikátor klíče, vlastnosti a značky. Tato operace vyžaduje oprávnění klíče nebo seznamu. Příklad použití:
|
purge |
Operace vyprázdnění odstraněného klíče trvale odebere klíč bez možnosti obnovení. Tuto operaci lze povolit pouze v trezoru s povoleným obnovitelném odstraněním. Tato operace vyžaduje oprávnění klíče/vyprázdnění. Příklad použití:
Trvale odstraní zadaný klíč. |
release |
Uvolní klíč ze spravovaného HSM. Operace klíče vydané verze se vztahuje na všechny typy klíčů. Operace vyžaduje, aby byl klíč označen jako exportovatelný a klíče nebo oprávnění k vydání. Příklad použití:
|
restore |
Obnoví zálohovaný klíč a všechny jeho verze do trezoru. Tato operace vyžaduje oprávnění klíče nebo obnovení. Příklad použití:
Obnoví zálohovaný klíč do trezoru. |
rotate |
Obměna klíče na základě zásad klíče vygenerováním nové verze klíče. Tato operace vyžaduje oprávnění ke klíčům nebo obměně. Příklad použití:
|
update |
Metoda updateKeyProperties změní zadané vlastnosti existujícího uloženého klíče. Vlastnosti, které nejsou zadány v požadavku, zůstanou beze změny. Hodnotu samotného klíče nelze změnit. Tato operace vyžaduje oprávnění klíče nebo nastavení. Příklad použití:
Aktualizuje vlastnosti přidružené k zadanému klíči v daném trezoru klíčů. |
update |
Metoda updateKeyProperties změní zadané vlastnosti nejnovější verze existujícího uloženého klíče. Vlastnosti, které nejsou zadány v požadavku, zůstanou beze změny. Hodnotu samotného klíče nelze změnit. Tato operace vyžaduje oprávnění klíče nebo nastavení. Příklad použití:
Aktualizuje vlastnosti přidružené k zadanému klíči v daném trezoru klíčů. |
update |
Aktualizuje zásady obměny klíče služby Key Vault. Tato operace vyžaduje oprávnění klíče nebo aktualizace. Příklad použití:
|
Podrobnosti konstruktoru
KeyClient(string, TokenCredential, KeyClientOptions)
Vytvoří instanci KeyClient.
Příklad použití:
import { KeyClient } from "@azure/keyvault-keys";
import { DefaultAzureCredential } from "@azure/identity";
let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();
let client = new KeyClient(vaultUrl, credentials);
new KeyClient(vaultUrl: string, credential: TokenCredential, pipelineOptions?: KeyClientOptions)
Parametry
- vaultUrl
-
string
adresa URL služby Key Vault. Měl by mít tento tvar: https://${your-key-vault-name}.vault.azure.net
. Měli byste ověřit, že tato adresa URL odkazuje na platný prostředek key vaultu nebo spravovaného HSM. Podrobnosti najdete v https://aka.ms/azsdk/blog/vault-uri.
- credential
- TokenCredential
Objekt, který implementuje rozhraní TokenCredential
použité k ověřování požadavků na službu. Pomocí balíčku @azure/identity vytvořte přihlašovací údaje, které vyhovují vašim potřebám.
- pipelineOptions
- KeyClientOptions
Možnosti kanálu používané ke konfiguraci požadavků rozhraní API služby Key Vault Tento parametr vynecháte, pokud chcete použít výchozí konfiguraci kanálu.
Podrobnosti vlastnosti
vaultUrl
Základní adresa URL trezoru
vaultUrl: string
Hodnota vlastnosti
string
Podrobnosti metody
backupKey(string, BackupKeyOptions)
Požaduje, aby se do klienta stáhla záloha zadaného klíče. Stáhnou se všechny verze klíče. Tato operace vyžaduje oprávnění ke klíčům nebo zálohování.
Příklad použití:
let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");
Zálohuje zadaný klíč.
function backupKey(name: string, options?: BackupKeyOptions): Promise<undefined | Uint8Array>
Parametry
- name
-
string
Název klíče.
- options
- BackupKeyOptions
Volitelné parametry.
Návraty
Promise<undefined | Uint8Array>
beginDeleteKey(string, BeginDeleteKeyOptions)
Operace odstranění se vztahuje na jakýkoli klíč uložený ve službě Azure Key Vault. Jednotlivé verze klíče nelze odstranit, pouze všechny verze daného klíče najednou.
Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud se klíč nesmazat.
Tato operace vyžaduje oprávnění klíče nebo odstranění.
Příklad použití:
const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const poller = await client.beginDeleteKey("MyKey");
// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginDeleteKey("MyKey", { resumeFrom: serialized });
// Waiting until it's done
const deletedKey = await poller.pollUntilDone();
console.log(deletedKey);
Odstraní klíč ze zadaného trezoru klíčů.
function beginDeleteKey(name: string, options?: BeginDeleteKeyOptions): Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>
Parametry
- name
-
string
Název klíče.
- options
- BeginDeleteKeyOptions
Volitelné parametry.
Návraty
Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>
beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
Obnoví odstraněný klíč v zadaném trezoru. Tuto operaci lze provést pouze v trezoru s povoleným obnovitelném odstraněním.
Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud se odstraněný klíč neobnoví.
Tato operace vyžaduje oprávnění klíče nebo obnovení.
Příklad použití:
const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const deletePoller = await client.beginDeleteKey("MyKey");
await deletePoller.pollUntilDone();
const poller = await client.beginRecoverDeletedKey("MyKey");
// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginRecoverDeletedKey("MyKey", { resumeFrom: serialized });
// Waiting until it's done
const key = await poller.pollUntilDone();
console.log(key);
Obnoví odstraněný klíč na nejnovější verzi.
function beginRecoverDeletedKey(name: string, options?: BeginRecoverDeletedKeyOptions): Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>
Parametry
- name
-
string
Název odstraněného klíče.
- options
- BeginRecoverDeletedKeyOptions
Volitelné parametry.
Návraty
Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>
createEcKey(string, CreateEcKeyOptions)
Metoda createEcKey vytvoří nový klíč se třemi tečkami ve službě Azure Key Vault. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Vyžaduje klíče nebo oprávnění k vytvoření.
Příklad použití:
let client = new KeyClient(url, credentials);
let result = await client.createEcKey("MyKey", { curve: "P-256" });
Vytvoří nový klíč, uloží ho a pak klientovi vrátí parametry klíče a vlastnosti.
function createEcKey(name: string, options?: CreateEcKeyOptions): Promise<KeyVaultKey>
Parametry
- name
-
string
Název klíče.
- options
- CreateEcKeyOptions
Volitelné parametry.
Návraty
Promise<KeyVaultKey>
createKey(string, string, CreateKeyOptions)
Operaci vytvoření klíče je možné použít k vytvoření libovolného typu klíče ve službě Azure Key Vault. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Vyžaduje klíče nebo oprávnění k vytvoření.
Příklad použití:
let client = new KeyClient(url, credentials);
// Create an elliptic-curve key:
let result = await client.createKey("MyKey", "EC");
Vytvoří nový klíč, uloží ho a pak klientovi vrátí parametry klíče a vlastnosti.
function createKey(name: string, keyType: string, options?: CreateKeyOptions): Promise<KeyVaultKey>
Parametry
- name
-
string
Název klíče.
- keyType
-
string
Typ klíče. Jedna z následujících možností: EC, EC-HSM, RSA, RSA-HSM, RSA-HSM, oct.
- options
- CreateKeyOptions
Volitelné parametry.
Návraty
Promise<KeyVaultKey>
createOctKey(string, CreateOctKeyOptions)
Metoda createOctKey vytvoří nový klíč OCT ve službě Azure Key Vault. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Vyžaduje klíče nebo oprávnění k vytvoření.
Příklad použití:
let client = new KeyClient(url, credentials);
let result = await client.createOctKey("MyKey", { hsm: true });
Vytvoří nový klíč, uloží ho a pak klientovi vrátí parametry klíče a vlastnosti.
function createOctKey(name: string, options?: CreateOctKeyOptions): Promise<KeyVaultKey>
Parametry
- name
-
string
Název klíče.
- options
- CreateOctKeyOptions
Volitelné parametry.
Návraty
Promise<KeyVaultKey>
createRsaKey(string, CreateRsaKeyOptions)
Metoda createRSAKey vytvoří nový klíč RSA ve službě Azure Key Vault. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Vyžaduje klíče nebo oprávnění k vytvoření.
Příklad použití:
let client = new KeyClient(url, credentials);
let result = await client.createRsaKey("MyKey", { keySize: 2048 });
Vytvoří nový klíč, uloží ho a pak klientovi vrátí parametry klíče a vlastnosti.
function createRsaKey(name: string, options?: CreateRsaKeyOptions): Promise<KeyVaultKey>
Parametry
- name
-
string
Název klíče.
- options
- CreateRsaKeyOptions
Volitelné parametry.
Návraty
Promise<KeyVaultKey>
getCryptographyClient(string, GetCryptographyClientOptions)
Získá kryptografický klient pro daný klíč.
Příklad použití:
let client = new KeyClient(url, credentials);
// get a cryptography client for a given key
let cryptographyClient = client.getCryptographyClient("MyKey");
function getCryptographyClient(keyName: string, options?: GetCryptographyClientOptions): CryptographyClient
Parametry
- keyName
-
string
- options
- GetCryptographyClientOptions
Návraty
- Kryptografický klient pomocí stejných možností, přihlašovacích údajů a klienta HTTP, jako je tento KeyClient
getDeletedKey(string, GetDeletedKeyOptions)
Metoda getDeletedKey vrátí zadaný odstraněný klíč spolu s jeho vlastnostmi. Tato operace vyžaduje klíče nebo získat oprávnění.
Příklad použití:
let client = new KeyClient(url, credentials);
let key = await client.getDeletedKey("MyDeletedKey");
Získá zadaný odstraněný klíč.
function getDeletedKey(name: string, options?: GetDeletedKeyOptions): Promise<DeletedKey>
Parametry
- name
-
string
Název klíče.
- options
- GetDeletedKeyOptions
Volitelné parametry.
Návraty
Promise<DeletedKey>
getKey(string, GetKeyOptions)
Metoda getKey získá zadaný klíč a vztahuje se na jakýkoli klíč uložený ve službě Azure Key Vault. Tato operace vyžaduje klíče nebo získat oprávnění.
Příklad použití:
let client = new KeyClient(url, credentials);
let key = await client.getKey("MyKey");
Získání zadaného klíče z daného trezoru klíčů
function getKey(name: string, options?: GetKeyOptions): Promise<KeyVaultKey>
Parametry
- name
-
string
Název klíče.
- options
- GetKeyOptions
Volitelné parametry.
Návraty
Promise<KeyVaultKey>
getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)
Získá zásadu obměny klíče služby Key Vault. Ve výchozím nastavení mají všechny klíče zásadu, která upozorní 30 dní před vypršením platnosti.
Tato operace vyžaduje klíče nebo získat oprávnění. Příklad použití:
let client = new KeyClient(vaultUrl, credentials);
let result = await client.getKeyRotationPolicy("myKey");
function getKeyRotationPolicy(keyName: string, options?: GetKeyRotationPolicyOptions): Promise<KeyRotationPolicy>
Parametry
- keyName
-
string
Název klíče.
- options
- GetKeyRotationPolicyOptions
Volitelné parametry.
Návraty
Promise<KeyRotationPolicy>
getRandomBytes(number, GetRandomBytesOptions)
Získá požadovaný počet bajtů obsahujících náhodné hodnoty ze spravovaného HSM. Tato operace vyžaduje oprávnění managedHsm/rng.
Příklad použití:
let client = new KeyClient(vaultUrl, credentials);
let { bytes } = await client.getRandomBytes(10);
function getRandomBytes(count: number, options?: GetRandomBytesOptions): Promise<Uint8Array>
Parametry
- count
-
number
Počet bajtů generovaných mezi 1 a 128 včetně.
- options
- GetRandomBytesOptions
Volitelné parametry.
Návraty
Promise<Uint8Array>
importKey(string, JsonWebKey, ImportKeyOptions)
Operaci importu klíče je možné použít k importu libovolného typu klíče do služby Azure Key Vault. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Tato operace vyžaduje oprávnění ke klíčům nebo importu.
Příklad použití:
let client = new KeyClient(url, credentials);
// Key contents in myKeyContents
let result = await client.importKey("MyKey", myKeyContents);
Importuje externě vytvořený klíč, uloží ho a vrátí parametry a vlastnosti klíče klientovi.
function importKey(name: string, key: JsonWebKey, options?: ImportKeyOptions): Promise<KeyVaultKey>
Parametry
- name
-
string
Název importovaného klíče
- key
- JsonWebKey
Webový klíč JSON.
- options
- ImportKeyOptions
Volitelné parametry.
Návraty
Promise<KeyVaultKey>
listDeletedKeys(ListDeletedKeysOptions)
Iteruje odstraněné klíče v trezoru. Úplný identifikátor klíče a vlastnosti jsou k dispozici v odpovědi. Pro klíče se nevrácejí žádné hodnoty. Tyto operace vyžadují oprávnění ke klíčům nebo seznamům.
Příklad použití:
let client = new KeyClient(url, credentials);
for await (const deletedKey of client.listDeletedKeys()) {
console.log("deleted key: ", deletedKey);
}
Výpis všech klíčů v trezoru
function listDeletedKeys(options?: ListDeletedKeysOptions): PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>
Parametry
- options
- ListDeletedKeysOptions
Volitelné parametry.
Návraty
listPropertiesOfKeys(ListPropertiesOfKeysOptions)
Iteruje nejnovější verzi všech klíčů v trezoru. Úplný identifikátor klíče a vlastnosti jsou k dispozici v odpovědi. Pro klíče se nevrácejí žádné hodnoty. Tyto operace vyžadují oprávnění ke klíčům nebo seznamům.
Příklad použití:
let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeys()) {
const key = await client.getKey(keyProperties.name);
console.log("key: ", key);
}
Výpis všech klíčů v trezoru
function listPropertiesOfKeys(options?: ListPropertiesOfKeysOptions): PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>
Parametry
- options
- ListPropertiesOfKeysOptions
Volitelné parametry.
Návraty
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)
Iteruje všechny verze daného klíče v trezoru. V odpovědi se poskytuje úplný identifikátor klíče, vlastnosti a značky. Tato operace vyžaduje oprávnění klíče nebo seznamu.
Příklad použití:
let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeyVersions("MyKey")) {
const key = await client.getKey(keyProperties.name);
console.log("key version: ", key);
}
function listPropertiesOfKeyVersions(name: string, options?: ListPropertiesOfKeyVersionsOptions): PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>
Parametry
- name
-
string
Název klíče pro načtení verzí pro
Volitelné parametry.
Návraty
purgeDeletedKey(string, PurgeDeletedKeyOptions)
Operace vyprázdnění odstraněného klíče trvale odebere klíč bez možnosti obnovení. Tuto operaci lze povolit pouze v trezoru s povoleným obnovitelném odstraněním. Tato operace vyžaduje oprávnění klíče/vyprázdnění.
Příklad použití:
const client = new KeyClient(url, credentials);
const deletePoller = await client.beginDeleteKey("MyKey")
await deletePoller.pollUntilDone();
await client.purgeDeletedKey("MyKey");
Trvale odstraní zadaný klíč.
function purgeDeletedKey(name: string, options?: PurgeDeletedKeyOptions): Promise<void>
Parametry
- name
-
string
Název klíče.
- options
- PurgeDeletedKeyOptions
Volitelné parametry.
Návraty
Promise<void>
releaseKey(string, string, ReleaseKeyOptions)
Uvolní klíč ze spravovaného HSM.
Operace klíče vydané verze se vztahuje na všechny typy klíčů. Operace vyžaduje, aby byl klíč označen jako exportovatelný a klíče nebo oprávnění k vydání.
Příklad použití:
let client = new KeyClient(vaultUrl, credentials);
let result = await client.releaseKey("myKey", target)
function releaseKey(name: string, targetAttestationToken: string, options?: ReleaseKeyOptions): Promise<ReleaseKeyResult>
Parametry
- name
-
string
Název klíče.
- targetAttestationToken
-
string
Kontrolní výraz ověření identity pro cíl verze klíče.
- options
- ReleaseKeyOptions
Volitelné parametry.
Návraty
Promise<ReleaseKeyResult>
restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)
Obnoví zálohovaný klíč a všechny jeho verze do trezoru. Tato operace vyžaduje oprávnění klíče nebo obnovení.
Příklad použití:
let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");
// ...
let key = await client.restoreKeyBackup(backupContents);
Obnoví zálohovaný klíč do trezoru.
function restoreKeyBackup(backup: Uint8Array, options?: RestoreKeyBackupOptions): Promise<KeyVaultKey>
Parametry
- backup
-
Uint8Array
Záložní objekt blob přidružený ke sadě klíčů.
- options
- RestoreKeyBackupOptions
Volitelné parametry.
Návraty
Promise<KeyVaultKey>
rotateKey(string, RotateKeyOptions)
Obměna klíče na základě zásad klíče vygenerováním nové verze klíče. Tato operace vyžaduje oprávnění ke klíčům nebo obměně.
Příklad použití:
let client = new KeyClient(vaultUrl, credentials);
let key = await client.rotateKey("MyKey");
function rotateKey(name: string, options?: RotateKeyOptions): Promise<KeyVaultKey>
Parametry
- name
-
string
Název klíče, který chcete otočit.
- options
- RotateKeyOptions
Volitelné parametry.
Návraty
Promise<KeyVaultKey>
updateKeyProperties(string, string, UpdateKeyPropertiesOptions)
Metoda updateKeyProperties změní zadané vlastnosti existujícího uloženého klíče. Vlastnosti, které nejsou zadány v požadavku, zůstanou beze změny. Hodnotu samotného klíče nelze změnit. Tato operace vyžaduje oprávnění klíče nebo nastavení.
Příklad použití:
let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, key.properties.version, { enabled: false });
Aktualizuje vlastnosti přidružené k zadanému klíči v daném trezoru klíčů.
function updateKeyProperties(name: string, keyVersion: string, options?: UpdateKeyPropertiesOptions): Promise<KeyVaultKey>
Parametry
- name
-
string
Název klíče.
- keyVersion
-
string
Verze klíče.
- options
- UpdateKeyPropertiesOptions
Volitelné parametry.
Návraty
Promise<KeyVaultKey>
updateKeyProperties(string, UpdateKeyPropertiesOptions)
Metoda updateKeyProperties změní zadané vlastnosti nejnovější verze existujícího uloženého klíče. Vlastnosti, které nejsou zadány v požadavku, zůstanou beze změny. Hodnotu samotného klíče nelze změnit. Tato operace vyžaduje oprávnění klíče nebo nastavení.
Příklad použití:
let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, { enabled: false });
Aktualizuje vlastnosti přidružené k zadanému klíči v daném trezoru klíčů.
function updateKeyProperties(name: string, options?: UpdateKeyPropertiesOptions): Promise<KeyVaultKey>
Parametry
- name
-
string
Název klíče.
- options
- UpdateKeyPropertiesOptions
Volitelné parametry.
Návraty
Promise<KeyVaultKey>
updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)
Aktualizuje zásady obměny klíče služby Key Vault. Tato operace vyžaduje oprávnění klíče nebo aktualizace.
Příklad použití:
let client = new KeyClient(vaultUrl, credentials);
const setPolicy = await client.updateKeyRotationPolicy("MyKey", myPolicy);
function updateKeyRotationPolicy(keyName: string, policy: KeyRotationPolicyProperties, options?: UpdateKeyRotationPolicyOptions): Promise<KeyRotationPolicy>
Parametry
- keyName
-
string
Název klíče.
- policy
- KeyRotationPolicyProperties
- options
- UpdateKeyRotationPolicyOptions
Volitelné parametry.
Návraty
Promise<KeyRotationPolicy>