KeyClient class

Létrehozza a KeyClient egy példányát.

Példahasználat:

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)

Paraméterek

A tároló alap URL-címe

vaultUrl: string

Tulajdonság értéke

Kéri, hogy a megadott kulcs biztonsági másolatát letöltse az ügyfélre. A rendszer letölti a kulcs összes verzióját. Ehhez a művelethez kulcsok/biztonsági mentési engedély szükséges.

Példahasználat:

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");

Biztonsági másolatot készít a megadott kulcsról.

function backupKey(name: string, options?: BackupKeyOptions): Promise<undefined | Uint8Array>

Paraméterek

Válaszok

A törlési művelet az Azure Key Vaultban tárolt összes kulcsra vonatkozik. A kulcsok egyes verziói nem törölhetők, csak egy adott kulcs összes verziója egyszerre.

Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon a kulcs törléséig.

Ehhez a művelethez kulcsok/törlési engedély szükséges.

Példahasználat:

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);

Egy kulcs törlése egy megadott kulcstartóból.

function beginDeleteKey(name: string, options?: BeginDeleteKeyOptions): Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

Paraméterek

Válaszok

Helyreállítja a törölt kulcsot a megadott tárolóban. Ez a művelet csak helyreállítható törlést engedélyező tárolón hajtható végre.

Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a törölt kulcs helyreáll.

Ehhez a művelethez kulcsok/helyreállítás engedély szükséges.

Példahasználat:

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);

Visszaállítja a törölt kulcsot a legújabb verzióra.

function beginRecoverDeletedKey(name: string, options?: BeginRecoverDeletedKeyOptions): Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

Paraméterek

Válaszok

A createEcKey metódus egy új háromliptikus görbekulcsot hoz létre az Azure Key Vaultban. Ha a névvel ellátott kulcs már létezik, az Azure Key Vault létrehozza a kulcs új verzióját. Kulcsokat/létrehozási engedélyt igényel.

Példahasználat:

let client = new KeyClient(url, credentials);
let result = await client.createEcKey("MyKey", { curve: "P-256" });

Létrehoz egy új kulcsot, tárolja, majd visszaadja a kulcs paramétereit és tulajdonságait az ügyfélnek.

function createEcKey(name: string, options?: CreateEcKeyOptions): Promise<KeyVaultKey>

Paraméterek

Válaszok

A kulcs létrehozása művelet bármilyen kulcstípus létrehozásához használható az Azure Key Vaultban. Ha a névvel ellátott kulcs már létezik, az Azure Key Vault létrehozza a kulcs új verzióját. Kulcsokat/létrehozási engedélyt igényel.

Példahasználat:

let client = new KeyClient(url, credentials);
// Create an elliptic-curve key:
let result = await client.createKey("MyKey", "EC");

Létrehoz egy új kulcsot, tárolja, majd visszaadja a kulcs paramétereit és tulajdonságait az ügyfélnek.

function createKey(name: string, keyType: string, options?: CreateKeyOptions): Promise<KeyVaultKey>

Paraméterek

Válaszok

A createOctKey metódus létrehoz egy új OCT-kulcsot az Azure Key Vaultban. Ha a névvel ellátott kulcs már létezik, az Azure Key Vault létrehozza a kulcs új verzióját. Kulcsokat/létrehozási engedélyt igényel.

Példahasználat:

let client = new KeyClient(url, credentials);
let result = await client.createOctKey("MyKey", { hsm: true });

Létrehoz egy új kulcsot, tárolja, majd visszaadja a kulcs paramétereit és tulajdonságait az ügyfélnek.

function createOctKey(name: string, options?: CreateOctKeyOptions): Promise<KeyVaultKey>

Paraméterek

Válaszok

A createRSAKey metódus létrehoz egy új RSA-kulcsot az Azure Key Vaultban. Ha a névvel ellátott kulcs már létezik, az Azure Key Vault létrehozza a kulcs új verzióját. Kulcsokat/létrehozási engedélyt igényel.

Példahasználat:

let client = new KeyClient(url, credentials);
let result = await client.createRsaKey("MyKey", { keySize: 2048 });

Létrehoz egy új kulcsot, tárolja, majd visszaadja a kulcs paramétereit és tulajdonságait az ügyfélnek.

function createRsaKey(name: string, options?: CreateRsaKeyOptions): Promise<KeyVaultKey>

Paraméterek

Válaszok

Lekéri az adott kulcshoz tartozó CryptographyClient.

Példahasználat:

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

Paraméterek

Válaszok

• A CryptographyClient ugyanazokkal a beállításokkal, hitelesítő adatokkal és http-ügyféllel, mint ez a KeyClient

A getDeletedKey metódus a megadott törölt kulcsot és annak tulajdonságait adja vissza. Ehhez a művelethez kulcsok/beolvasási engedély szükséges.

Példahasználat:

let client = new KeyClient(url, credentials);
let key = await client.getDeletedKey("MyDeletedKey");

Lekéri a megadott törölt kulcsot.

function getDeletedKey(name: string, options?: GetDeletedKeyOptions): Promise<DeletedKey>

Paraméterek

Válaszok

A getKey metódus lekéri a megadott kulcsot, és az Azure Key Vaultban tárolt összes kulcsra alkalmazható. Ehhez a művelethez kulcsok/beolvasási engedély szükséges.

Példahasználat:

let client = new KeyClient(url, credentials);
let key = await client.getKey("MyKey");

Egy megadott kulcs lekérése egy adott kulcstartóból.

function getKey(name: string, options?: GetKeyOptions): Promise<KeyVaultKey>

Paraméterek

Válaszok

Lekéri egy Key Vault-kulcs forgatási szabályzatát. Alapértelmezés szerint minden kulcs rendelkezik egy szabályzattal, amely a lejárat előtt 30 nappal értesítést küld.

Ehhez a művelethez kulcsok/beolvasási engedély szükséges. Példahasználat:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.getKeyRotationPolicy("myKey");

function getKeyRotationPolicy(keyName: string, options?: GetKeyRotationPolicyOptions): Promise<KeyRotationPolicy>

Paraméterek

Válaszok

Lekéri a felügyelt HSM véletlenszerű értékeit tartalmazó bájtok kért számát. Ehhez a művelethez a managedHsm/rng engedély szükséges.

Példahasználat:

let client = new KeyClient(vaultUrl, credentials);
let { bytes } = await client.getRandomBytes(10);

function getRandomBytes(count: number, options?: GetRandomBytesOptions): Promise<Uint8Array>

Paraméterek

Válaszok

Az importálási kulcs művelettel bármilyen kulcstípus importálható egy Azure Key Vaultba. Ha a névvel ellátott kulcs már létezik, az Azure Key Vault létrehozza a kulcs új verzióját. Ehhez a művelethez kulcsok/importálási engedély szükséges.

Példahasználat:

let client = new KeyClient(url, credentials);
// Key contents in myKeyContents
let result = await client.importKey("MyKey", myKeyContents);

Importál egy külsőleg létrehozott kulcsot, tárolja, majd visszaadja a kulcs paramétereit és tulajdonságait az ügyfélnek.

function importKey(name: string, key: JsonWebKey, options?: ImportKeyOptions): Promise<KeyVaultKey>

Paraméterek

Válaszok

Iterálja a törölt kulcsokat a tárolóban. A válaszban a teljes kulcsazonosító és -tulajdonságok szerepelnek. A rendszer nem ad vissza értékeket a kulcsokhoz. Ehhez a művelethez kulcs-/listaengedély szükséges.

Példahasználat:

let client = new KeyClient(url, credentials);
for await (const deletedKey of client.listDeletedKeys()) {
  console.log("deleted key: ", deletedKey);
}

A tároló összes kulcsának listázása

function listDeletedKeys(options?: ListDeletedKeysOptions): PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

Paraméterek

Válaszok

Iterálja a tároló összes kulcsának legújabb verzióját. A válaszban a teljes kulcsazonosító és -tulajdonságok szerepelnek. A rendszer nem ad vissza értékeket a kulcsokhoz. Ehhez a művelethez kulcs-/listaengedély szükséges.

Példahasználat:

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeys()) {
  const key = await client.getKey(keyProperties.name);
  console.log("key: ", key);
}

A tároló összes kulcsának listázása

function listPropertiesOfKeys(options?: ListPropertiesOfKeysOptions): PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

Paraméterek

Válaszok

Iterálja az adott kulcs összes verzióját a tárolóban. A válasz a teljes kulcsazonosítót, tulajdonságokat és címkéket adja meg. Ehhez a művelethez kulcsok/listaengedély szükséges.

Példahasználat:

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>

Paraméterek

Válaszok

A törölt kulcs törlési művelete véglegesen eltávolítja a kulcsot, anélkül, hogy lehetséges lett a helyreállítás. Ez a művelet csak helyreállítható törlést engedélyező tárolón engedélyezhető. Ehhez a művelethez kulcsok/törlési engedély szükséges.

Példahasználat:

const client = new KeyClient(url, credentials);
const deletePoller = await client.beginDeleteKey("MyKey")
await deletePoller.pollUntilDone();
await client.purgeDeletedKey("MyKey");

Véglegesen törli a megadott kulcsot.

function purgeDeletedKey(name: string, options?: PurgeDeletedKeyOptions): Promise<void>

Paraméterek

Válaszok

Kulcs kiadása felügyelt HSM-ből.

A kiadási kulcs művelete minden kulcstípusra alkalmazható. A művelethez a kulcsot exportálhatóként kell megjelölni, valamint a kulcsokat/kiadási engedélyeket.

Példahasználat:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.releaseKey("myKey", target)

function releaseKey(name: string, targetAttestationToken: string, options?: ReleaseKeyOptions): Promise<ReleaseKeyResult>

Paraméterek

Válaszok

Visszaállít egy biztonsági másolatban található kulcsot és annak összes verzióját egy tárolóba. Ehhez a művelethez kulcsok/visszaállítási engedély szükséges.

Példahasználat:

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");
// ...
let key = await client.restoreKeyBackup(backupContents);

Visszaállít egy biztonsági másolatban található kulcsot egy tárolóba.

function restoreKeyBackup(backup: Uint8Array, options?: RestoreKeyBackupOptions): Promise<KeyVaultKey>

Paraméterek

Válaszok

A kulcs egy új verziójának létrehozásával elforgatja a kulcsot a kulcsházirend alapján. Ehhez a művelethez kulcsok/forgatási engedély szükséges.

Példahasználat:

let client = new KeyClient(vaultUrl, credentials);
let key = await client.rotateKey("MyKey");

function rotateKey(name: string, options?: RotateKeyOptions): Promise<KeyVaultKey>

Paraméterek

Válaszok

Az updateKeyProperties metódus módosítja egy meglévő tárolt kulcs megadott tulajdonságait. A kérelemben nem megadott tulajdonságok változatlanok maradnak. Maga a kulcs értéke nem módosítható. Ehhez a művelethez kulcsok/beállítási engedély szükséges.

Példahasználat:

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 });

Frissíti a megadott kulcshoz társított tulajdonságokat egy adott kulcstartóban.

function updateKeyProperties(name: string, keyVersion: string, options?: UpdateKeyPropertiesOptions): Promise<KeyVaultKey>

Paraméterek

Válaszok

Az updateKeyProperties metódus módosítja a meglévő tárolt kulcs legújabb verziójának megadott tulajdonságait. A kérelemben nem megadott tulajdonságok változatlanok maradnak. Maga a kulcs értéke nem módosítható. Ehhez a művelethez kulcsok/beállítási engedély szükséges.

Példahasználat:

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, { enabled: false });

Frissíti a megadott kulcshoz társított tulajdonságokat egy adott kulcstartóban.

function updateKeyProperties(name: string, options?: UpdateKeyPropertiesOptions): Promise<KeyVaultKey>

Paraméterek

Válaszok

Frissíti a Key Vault-kulcsok rotációs szabályzatát. Ehhez a művelethez kulcsok/frissítési engedély szükséges.

Példahasználat:

let client = new KeyClient(vaultUrl, credentials);
const setPolicy = await client.updateKeyRotationPolicy("MyKey", myPolicy);

function updateKeyRotationPolicy(keyName: string, policy: KeyRotationPolicyProperties, options?: UpdateKeyRotationPolicyOptions): Promise<KeyRotationPolicy>

Paraméterek

Válaszok