Megosztás a következőn keresztül:

KeyClient class

Csomag:
@azure/keyvault-keys

A KeyClient metódusokat biztosít KeyVaultKey kezeléséhez az Azure Key Vaultban. Az ügyfél támogatja a KeyVaultKeys létrehozását, lekérését, frissítését, törlését, törlését, biztonsági mentését, visszaállítását és listázását. Az ügyfél emellett támogatja a DeletedKey listázását a helyreállítható törlést engedélyező Azure Key Vaulthoz.

Konstruktorok

KeyClient(string, TokenCredential, KeyClientOptions)

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

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

// Build the URL to reach your key vault
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`; // or `https://${vaultName}.managedhsm.azure.net` for managed HSM.

// Lastly, create our keys client and connect to the service
const client = new KeyClient(url, credential);

Tulajdonságok

vaultUrl

A tároló alap URL-címe

Metódusok

backupKey(string, BackupKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const backupContents = await client.backupKey(keyName);

Biztonsági másolatot készít a megadott kulcsról.
beginDeleteKey(string, BeginDeleteKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const poller = await client.beginDeleteKey(keyName);
await poller.pollUntilDone();

Egy kulcs törlése egy megadott kulcstartóból.
beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const deletePoller = await client.beginDeleteKey(keyName);
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedKey(keyName);
const recoveredKey = await recoverPoller.pollUntilDone();

Visszaállítja a törölt kulcsot a legújabb verzióra.
createEcKey(string, CreateEcKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createEcKey(keyName, { curve: "P-256" });
console.log("result: ", result);

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

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createKey(keyName, "RSA");
console.log("result: ", result);

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

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createOctKey("MyKey", { hsm: true });
console.log("result: ", result);

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

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createRsaKey("MyKey", { keySize: 2048 });
console.log("result: ", result);

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

Lekéri az adott kulcshoz tartozó CryptographyClient.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

// Get a cryptography client for a given key
const cryptographyClient = client.getCryptographyClient("MyKey");
getDeletedKey(string, GetDeletedKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

await client.getDeletedKey(keyName);

Lekéri a megadott törölt kulcsot.
getKey(string, GetKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const latestKey = await client.getKey(keyName);
console.log(`Latest version of the key ${keyName}: `, latestKey);

const specificKey = await client.getKey(keyName, { version: latestKey.properties.version! });
console.log(`The key ${keyName} at the version ${latestKey.properties.version!}: `, specificKey);

Egy megadott kulcs lekérése egy adott kulcstartóból.
getKeyAttestation(string, GetKeyAttestationOptions)

A getKeyAttestation metódus lekéri a megadott kulcsot és annak igazolási blobot, és az Azure Key Vault felügyelt HSM-ben tárolt összes kulcsra alkalmazható. Ehhez a művelethez kulcsok/beolvasási engedély szükséges.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT MANAGED HSM NAME>";
const url = `https://${vaultName}.managedhsm.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const latestKey = await client.getKeyAttestation(keyName);
console.log(`Latest version of the key ${keyName}: `, latestKey);

const specificKey = await client.getKeyAttestation(keyName, {
  version: latestKey.properties.version!,
});
console.log(`The key ${keyName} at the version ${latestKey.properties.version!}: `, specificKey);

Egy megadott kulcs lekérése egy adott kulcstartóból.
getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.getKeyRotationPolicy(keyName);
getRandomBytes(number, GetRandomBytesOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const bytes = await client.getRandomBytes(10);
importKey(string, JsonWebKey, ImportKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const jsonWebKey = {
  kty: "RSA",
  kid: "test-key-123",
  use: "sig",
  alg: "RS256",
  n: new Uint8Array([112, 34, 56, 98, 123, 244, 200, 99]),
  e: new Uint8Array([1, 0, 1]),
  d: new Uint8Array([45, 67, 89, 23, 144, 200, 76, 233]),
  p: new Uint8Array([34, 89, 100, 77, 204, 56, 29, 77]),
  q: new Uint8Array([78, 99, 201, 45, 188, 34, 67, 90]),
  dp: new Uint8Array([23, 45, 78, 56, 200, 144, 32, 67]),
  dq: new Uint8Array([12, 67, 89, 144, 99, 56, 23, 45]),
  qi: new Uint8Array([78, 90, 45, 201, 34, 67, 120, 55]),
};

const result = await client.importKey("MyKey", jsonWebKey);

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

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

for await (const versionProperties of client.listPropertiesOfKeyVersions(keyName)) {
  console.log("Version properties: ", versionProperties);
}

A tároló összes kulcsának listázása
listPropertiesOfKeys(ListPropertiesOfKeysOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

for await (const versionProperties of client.listPropertiesOfKeyVersions(keyName)) {
  console.log("Version properties: ", versionProperties);
}

A tároló összes kulcsának listázása
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

for await (const versionProperties of client.listPropertiesOfKeyVersions(keyName)) {
  console.log("Version properties: ", versionProperties);
}
purgeDeletedKey(string, PurgeDeletedKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const deletePoller = await client.beginDeleteKey(keyName);
await deletePoller.pollUntilDone();

await client.purgeDeletedKey(keyName);

Véglegesen törli a megadott kulcsot.
releaseKey(string, string, ReleaseKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.releaseKey("myKey", "<attestation-target>");
restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const backupContents = await client.backupKey(keyName);

const key = await client.restoreKeyBackup(backupContents);

Visszaállít egy biztonsági másolatban található kulcsot egy tárolóba.
rotateKey(string, RotateKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

// Set the key's automated rotation policy to rotate the key 30 days before expiry.
const policy = await client.updateKeyRotationPolicy(keyName, {
  lifetimeActions: [
    {
      action: "Rotate",
      timeBeforeExpiry: "P30D",
    },
  ],
  // You may also specify the duration after which any newly rotated key will expire.
  // In this case, any new key versions will expire after 90 days.
  expiresIn: "P90D",
});

// You can get the current key rotation policy of a given key by calling the getKeyRotationPolicy method.
const currentPolicy = await client.getKeyRotationPolicy(keyName);

// Finally, you can rotate a key on-demand by creating a new version of the given key.
const rotatedKey = await client.rotateKey(keyName);
updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.createKey(keyName, "RSA");
await client.updateKeyProperties(keyName, result.properties.version, {
  enabled: false,
});

Frissíti a megadott kulcshoz társított tulajdonságokat egy adott kulcstartóban.
updateKeyProperties(string, UpdateKeyPropertiesOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.createKey(keyName, "RSA");
await client.updateKeyProperties(keyName, result.properties.version, {
  enabled: false,
});

Frissíti a megadott kulcshoz társított tulajdonságokat egy adott kulcstartóban.
updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const myPolicy = await client.getKeyRotationPolicy(keyName);

const setPolicy = await client.updateKeyRotationPolicy(keyName, myPolicy);

Konstruktor adatai

KeyClient(string, TokenCredential, KeyClientOptions)

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

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

// Build the URL to reach your key vault
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`; // or `https://${vaultName}.managedhsm.azure.net` for managed HSM.

// Lastly, create our keys client and connect to the service
const client = new KeyClient(url, credential);

new KeyClient(vaultUrl: string, credential: TokenCredential, pipelineOptions?: KeyClientOptions)

Paraméterek

vaultUrl

string

a Key Vault URL-címe. Ennek az alakzatnak a következőnek kell lennie: https://${your-key-vault-name}.vault.azure.net. Ellenőrizze, hogy ez az URL-cím érvényes Key Vault- vagy felügyelt HSM-erőforrásra hivatkozik-e. Részletekért lásd a https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Egy objektum, amely implementálja a szolgáltatáshoz érkező kérések hitelesítéséhez használt TokenCredential felületet. Az @azure/identity csomag használatával hozzon létre egy, az igényeinek megfelelő hitelesítő adatokat.

pipelineOptions
KeyClientOptions

A Key Vault API-kérések konfigurálásához használt folyamatbeállítások. Hagyja ki ezt a paramétert az alapértelmezett folyamatkonfiguráció használatához.

Tulajdonság adatai

vaultUrl

A tároló alap URL-címe

vaultUrl: string

Tulajdonság értéke

string

Metódus adatai

backupKey(string, BackupKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const backupContents = await client.backupKey(keyName);

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

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

Paraméterek

name

string

A kulcs neve.

options
BackupKeyOptions

Az opcionális paraméterek.

Válaszok

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const poller = await client.beginDeleteKey(keyName);
await poller.pollUntilDone();

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

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

Paraméterek

name

string

A kulcs neve.

options
BeginDeleteKeyOptions

Az opcionális paraméterek.

Válaszok

Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const deletePoller = await client.beginDeleteKey(keyName);
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedKey(keyName);
const recoveredKey = await recoverPoller.pollUntilDone();

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

name

string

A törölt kulcs neve.

options
BeginRecoverDeletedKeyOptions

Az opcionális paraméterek.

Válaszok

Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

createEcKey(string, CreateEcKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createEcKey(keyName, { curve: "P-256" });
console.log("result: ", result);

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

name

string

A kulcs neve.

options
CreateEcKeyOptions

Az opcionális paraméterek.

Válaszok

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createKey(keyName, "RSA");
console.log("result: ", result);

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

name

string

A kulcs neve.

keyType

string

A kulcs típusa. Az alábbiak egyike: "EC", "EC-HSM", "RSA", "RSA-HSM", "oct".

options
CreateKeyOptions

Az opcionális paraméterek.

Válaszok

Promise<KeyVaultKey>

createOctKey(string, CreateOctKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createOctKey("MyKey", { hsm: true });
console.log("result: ", result);

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

name

string

A kulcs neve.

options
CreateOctKeyOptions

Az opcionális paraméterek.

Válaszok

Promise<KeyVaultKey>

createRsaKey(string, CreateRsaKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";
const result = await client.createRsaKey("MyKey", { keySize: 2048 });
console.log("result: ", result);

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

name

string

A kulcs neve.

options
CreateRsaKeyOptions

Az opcionális paraméterek.

Válaszok

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

Lekéri az adott kulcshoz tartozó CryptographyClient.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

// Get a cryptography client for a given key
const cryptographyClient = client.getCryptographyClient("MyKey");

function getCryptographyClient(keyName: string, options?: GetCryptographyClientOptions): CryptographyClient

Paraméterek

keyName

string

options
GetCryptographyClientOptions

Válaszok

CryptographyClient

getDeletedKey(string, GetDeletedKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

await client.getDeletedKey(keyName);

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

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

Paraméterek

name

string

A kulcs neve.

options
GetDeletedKeyOptions

Az opcionális paraméterek.

Válaszok

Promise<DeletedKey>

getKey(string, GetKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const latestKey = await client.getKey(keyName);
console.log(`Latest version of the key ${keyName}: `, latestKey);

const specificKey = await client.getKey(keyName, { version: latestKey.properties.version! });
console.log(`The key ${keyName} at the version ${latestKey.properties.version!}: `, specificKey);

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

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

Paraméterek

name

string

A kulcs neve.

options
GetKeyOptions

Az opcionális paraméterek.

Válaszok

Promise<KeyVaultKey>

getKeyAttestation(string, GetKeyAttestationOptions)

A getKeyAttestation metódus lekéri a megadott kulcsot és annak igazolási blobot, és az Azure Key Vault felügyelt HSM-ben tárolt összes kulcsra alkalmazható. Ehhez a művelethez kulcsok/beolvasási engedély szükséges.

Példahasználat:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT MANAGED HSM NAME>";
const url = `https://${vaultName}.managedhsm.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const latestKey = await client.getKeyAttestation(keyName);
console.log(`Latest version of the key ${keyName}: `, latestKey);

const specificKey = await client.getKeyAttestation(keyName, {
  version: latestKey.properties.version!,
});
console.log(`The key ${keyName} at the version ${latestKey.properties.version!}: `, specificKey);

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

function getKeyAttestation(name: string, options?: GetKeyAttestationOptions): Promise<KeyVaultKey>

Paraméterek

name

string

A kulcs neve.

options
GetKeyAttestationOptions

Az opcionális paraméterek.

Válaszok

Promise<KeyVaultKey>

getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.getKeyRotationPolicy(keyName);

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

Paraméterek

keyName

string

A kulcs neve.

options
GetKeyRotationPolicyOptions

Az opcionális paraméterek.

Válaszok

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const bytes = await client.getRandomBytes(10);

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

Paraméterek

count

number

Az 1 és 128 közötti bájtok száma.

options
GetRandomBytesOptions

Az opcionális paraméterek.

Válaszok

Promise<Uint8Array>

importKey(string, JsonWebKey, ImportKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const jsonWebKey = {
  kty: "RSA",
  kid: "test-key-123",
  use: "sig",
  alg: "RS256",
  n: new Uint8Array([112, 34, 56, 98, 123, 244, 200, 99]),
  e: new Uint8Array([1, 0, 1]),
  d: new Uint8Array([45, 67, 89, 23, 144, 200, 76, 233]),
  p: new Uint8Array([34, 89, 100, 77, 204, 56, 29, 77]),
  q: new Uint8Array([78, 99, 201, 45, 188, 34, 67, 90]),
  dp: new Uint8Array([23, 45, 78, 56, 200, 144, 32, 67]),
  dq: new Uint8Array([12, 67, 89, 144, 99, 56, 23, 45]),
  qi: new Uint8Array([78, 90, 45, 201, 34, 67, 120, 55]),
};

const result = await client.importKey("MyKey", jsonWebKey);

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

name

string

Az importált kulcs neve.

key
JsonWebKey

A JSON webkulcs.

options
ImportKeyOptions

Az opcionális paraméterek.

Válaszok

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

for await (const versionProperties of client.listPropertiesOfKeyVersions(keyName)) {
  console.log("Version properties: ", versionProperties);
}

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

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

Paraméterek

options
ListDeletedKeysOptions

Az opcionális paraméterek.

Válaszok

PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

for await (const versionProperties of client.listPropertiesOfKeyVersions(keyName)) {
  console.log("Version properties: ", versionProperties);
}

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

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

Paraméterek

options
ListPropertiesOfKeysOptions

Az opcionális paraméterek.

Válaszok

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

for await (const keyProperties of client.listPropertiesOfKeys()) {
  console.log("Key properties: ", keyProperties);
}

for await (const deletedKey of client.listDeletedKeys()) {
  console.log("Deleted: ", deletedKey);
}

for await (const versionProperties of client.listPropertiesOfKeyVersions(keyName)) {
  console.log("Version properties: ", versionProperties);
}

function listPropertiesOfKeyVersions(name: string, options?: ListPropertiesOfKeyVersionsOptions): PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

Paraméterek

name

string

A verziók lekéréséhez használt kulcs neve

options
ListPropertiesOfKeyVersionsOptions

Az opcionális paraméterek.

Válaszok

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const deletePoller = await client.beginDeleteKey(keyName);
await deletePoller.pollUntilDone();

await client.purgeDeletedKey(keyName);

Véglegesen törli a megadott kulcsot.

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

Paraméterek

name

string

A kulcs neve.

options
PurgeDeletedKeyOptions

Az opcionális paraméterek.

Válaszok

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.releaseKey("myKey", "<attestation-target>");

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

Paraméterek

name

string

A kulcs neve.

targetAttestationToken

string

A kulcskiadás céljára vonatkozó igazolási állítás.

options
ReleaseKeyOptions

Az opcionális paraméterek.

Válaszok

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const backupContents = await client.backupKey(keyName);

const 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

backup

Uint8Array

A kulcsköteghez társított biztonsági mentési blob.

options
RestoreKeyBackupOptions

Az opcionális paraméterek.

Válaszok

Promise<KeyVaultKey>

rotateKey(string, RotateKeyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

// Set the key's automated rotation policy to rotate the key 30 days before expiry.
const policy = await client.updateKeyRotationPolicy(keyName, {
  lifetimeActions: [
    {
      action: "Rotate",
      timeBeforeExpiry: "P30D",
    },
  ],
  // You may also specify the duration after which any newly rotated key will expire.
  // In this case, any new key versions will expire after 90 days.
  expiresIn: "P90D",
});

// You can get the current key rotation policy of a given key by calling the getKeyRotationPolicy method.
const currentPolicy = await client.getKeyRotationPolicy(keyName);

// Finally, you can rotate a key on-demand by creating a new version of the given key.
const rotatedKey = await client.rotateKey(keyName);

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

Paraméterek

name

string

Az elforgatni kívánt kulcs neve.

options
RotateKeyOptions

Az opcionális paraméterek.

Válaszok

Promise<KeyVaultKey>

updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.createKey(keyName, "RSA");
await client.updateKeyProperties(keyName, result.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

name

string

A kulcs neve.

keyVersion

string

A kulcs verziója.

options
UpdateKeyPropertiesOptions

Az opcionális paraméterek.

Válaszok

Promise<KeyVaultKey>

updateKeyProperties(string, UpdateKeyPropertiesOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const result = await client.createKey(keyName, "RSA");
await client.updateKeyProperties(keyName, result.properties.version, {
  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

name

string

A kulcs neve.

options
UpdateKeyPropertiesOptions

Az opcionális paraméterek.

Válaszok

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new KeyClient(url, credential);

const keyName = "MyKeyName";

const myPolicy = await client.getKeyRotationPolicy(keyName);

const setPolicy = await client.updateKeyRotationPolicy(keyName, myPolicy);

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

Paraméterek

keyName

string

A kulcs neve.

policy
KeyRotationPolicyProperties
options
UpdateKeyRotationPolicyOptions

Az opcionális paraméterek.

Válaszok

Promise<KeyRotationPolicy>