Share via

KeyClient class

  • Referencia
Csomag:
@azure/keyvault-keys

A KeyClient metódusokat biztosít a KeyVaultKey azure-Key Vault való kezeléséhez. 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, törlését, biztonsági mentését, visszaállítását és listázását. Az ügyfél a helyreállítható törlést engedélyező Azure-Key Vault is támogatja a DeletedKey listázását.

Konstruktorok

KeyClient(string, TokenCredential, KeyClientOptions)

Létrehoz egy KeyClient-példányt.

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

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:

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

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

A törlési művelet az Azure Key Vault tárolt kulcsokra 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őt ad vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a kulcs törlődik.

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.
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 végezhető el.

Ez a függvény egy hosszú ideig futó művelet lekérdezőt ad 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.
createEcKey(string, CreateEcKeyOptions)

A createEcKey metódus egy új háromliptikus görbekulcsot hoz létre az Azure Key Vault. Ha a megnevezett kulcs már létezik, az Azure Key Vault létrehozza a kulcs új verzióját. Kulcsok/létrehozási engedély szükséges hozzá.

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 kulcsparamétereket és tulajdonságokat ad vissza az ügyfélnek.
createKey(string, string, CreateKeyOptions)

A kulcs létrehozása művelettel bármilyen kulcstípust létrehozhat az Azure Key Vault. Ha a megnevezett kulcs már létezik, az Azure Key Vault létrehozza a kulcs új verzióját. Kulcsok/létrehozási engedély szükséges hozzá.

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 kulcsparamétereket és tulajdonságokat ad vissza az ügyfélnek.
createOctKey(string, CreateOctKeyOptions)

A createOctKey metódus létrehoz egy új OCT-kulcsot az Azure Key Vault. Ha a megnevezett kulcs már létezik, az Azure Key Vault létrehozza a kulcs új verzióját. Kulcsok/létrehozási engedély szükséges hozzá.

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 kulcsparamétereket és tulajdonságokat ad vissza az ügyfélnek.
createRsaKey(string, CreateRsaKeyOptions)

A createRSAKey metódus létrehoz egy új RSA-kulcsot az Azure Key Vault. Ha a megnevezett kulcs már létezik, az Azure Key Vault létrehozza a kulcs új verzióját. Kulcsok/létrehozási engedély szükséges hozzá.

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 kulcsparamétereket és tulajdonságokat ad vissza az ügyfélnek.
getCryptographyClient(string, GetCryptographyClientOptions)

Lekéri a CryptographyClientet az adott kulcshoz.

Példahasználat:

let client = new KeyClient(url, credentials);
// get a cryptography client for a given key
let 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/lekéré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.
getKey(string, GetKeyOptions)

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

Példahasználat:

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

Adott 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/lekérési engedély szükséges. Példahasználat:

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

Lekéri a kért bájtszámot, amely véletlenszerű értékeket tartalmaz egy felügyelt HSM-ből. 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);
importKey(string, JsonWebKey_2, ImportKeyOptions)

Az importálási kulcs művelettel bármilyen kulcstípust importálhat egy Azure-Key Vault. Ha a megnevezett 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, és kulcsparamétereket és tulajdonságokat ad vissza az ügyfélnek.
listDeletedKeys(ListDeletedKeysOptions)

Iterálja a törölt kulcsokat a tárolóban. A teljes kulcsazonosítót és -tulajdonságokat a válaszban adták meg. A kulcsokhoz nem adnak vissza értékeket. Ehhez a művelethez kulcs/lista engedé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
listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Iterálja a tároló összes kulcsának legújabb verzióját. A teljes kulcsazonosítót és -tulajdonságokat a válaszban adták meg. A kulcsokhoz nem adnak vissza értékeket. Ehhez a művelethez kulcs/lista engedé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
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

Iterálja az adott kulcs összes verzióját a tárolóban. A válaszban a teljes kulcsazonosítót, tulajdonságokat és címkéket adták 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);
}
purgeDeletedKey(string, PurgeDeletedKeyOptions)

A törölt kulcs törlése művelet véglegesen eltávolítja a kulcsot a helyreállítás lehetősége nélkül. 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.
releaseKey(string, string, ReleaseKeyOptions)

Egy kulcsot ad ki egy felügyelt HSM-ből.

A kiadási kulcs művelet minden kulcstípusra alkalmazható. A művelethez a kulcsot exportálhatóként és a kulcsok/kiadási engedélyként kell megjelölni.

Példahasználat:

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

Visszaállít egy biztonsági mentési 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 mentési 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/elforgatási engedély szükséges.

Példahasználat:

let client = new KeyClient(vaultUrl, credentials);
let key = await client.rotateKey("MyKey");
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 kulcsra/beállításra van szükség.

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ítések egy adott kulcstartóban lévő adott kulccsal társított tulajdonságokat.
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 kulcsra/beállításra van szükség.

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ítések egy adott kulcstartóban lévő adott kulccsal társított tulajdonságokat.
updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Frissítések egy Key Vault kulcs 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);

Konstruktor adatai

KeyClient(string, TokenCredential, KeyClientOptions)

Létrehoz egy KeyClient-példányt.

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

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 érvényes Key Vault vagy felügyelt HSM-erőforrásra hivatkozik-e. További részletek: https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

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

pipelineOptions
KeyClientOptions

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

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:

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

name

string

A kulcs neve.

options
BackupKeyOptions

A választható paraméterek.

Válaszok

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

A törlési művelet az Azure Key Vault tárolt kulcsokra 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őt ad vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a kulcs törlődik.

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

name

string

A kulcs neve.

options
BeginDeleteKeyOptions

A választható 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 végezhető el.

Ez a függvény egy hosszú ideig futó művelet lekérdezőt ad 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

name

string

A törölt kulcs neve.

options
BeginRecoverDeletedKeyOptions

A választható 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 Vault. Ha a megnevezett kulcs már létezik, az Azure Key Vault létrehozza a kulcs új verzióját. Kulcsok/létrehozási engedély szükséges hozzá.

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 kulcsparamétereket és tulajdonságokat ad vissza az ügyfélnek.

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

Paraméterek

name

string

A kulcs neve.

options
CreateEcKeyOptions

A választható paraméterek.

Válaszok

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

A kulcs létrehozása művelettel bármilyen kulcstípust létrehozhat az Azure Key Vault. Ha a megnevezett kulcs már létezik, az Azure Key Vault létrehozza a kulcs új verzióját. Kulcsok/létrehozási engedély szükséges hozzá.

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 kulcsparamétereket és tulajdonságokat ad vissza 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. A következők egyike: "EC", "EC-HSM", "RSA", "RSA-HSM", "oct".

options
CreateKeyOptions

A választható paraméterek.

Válaszok

Promise<KeyVaultKey>

createOctKey(string, CreateOctKeyOptions)

A createOctKey metódus létrehoz egy új OCT-kulcsot az Azure Key Vault. Ha a megnevezett kulcs már létezik, az Azure Key Vault létrehozza a kulcs új verzióját. Kulcsok/létrehozási engedély szükséges hozzá.

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 kulcsparamétereket és tulajdonságokat ad vissza az ügyfélnek.

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

Paraméterek

name

string

A kulcs neve.

options
CreateOctKeyOptions

A választható paraméterek.

Válaszok

Promise<KeyVaultKey>

createRsaKey(string, CreateRsaKeyOptions)

A createRSAKey metódus létrehoz egy új RSA-kulcsot az Azure Key Vault. Ha a megnevezett kulcs már létezik, az Azure Key Vault létrehozza a kulcs új verzióját. Kulcsok/létrehozási engedély szükséges hozzá.

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 kulcsparamétereket és tulajdonságokat ad vissza az ügyfélnek.

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

Paraméterek

name

string

A kulcs neve.

options
CreateRsaKeyOptions

A választható paraméterek.

Válaszok

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

Lekéri a CryptographyClientet az adott kulcshoz.

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

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/lekéré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

name

string

A kulcs neve.

options
GetDeletedKeyOptions

A választható paraméterek.

Válaszok

Promise<DeletedKey>

getKey(string, GetKeyOptions)

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

Példahasználat:

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

Adott 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

A választható 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/lekéré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

keyName

string

A kulcs neve.

options
GetKeyRotationPolicyOptions

A választható paraméterek.

Válaszok

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

Lekéri a kért bájtszámot, amely véletlenszerű értékeket tartalmaz egy felügyelt HSM-ből. 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

count

number

Az 1 és 128 között létrehozandó bájtok száma, beleértve az értéket is.

options
GetRandomBytesOptions

A választható paraméterek.

Válaszok

Promise<Uint8Array>

importKey(string, JsonWebKey_2, ImportKeyOptions)

Az importálási kulcs művelettel bármilyen kulcstípust importálhat egy Azure-Key Vault. Ha a megnevezett 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, és kulcsparamétereket és tulajdonságokat ad vissza az ügyfélnek.

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

Paraméterek

name

string

Az importált kulcs neve.

key
JsonWebKey

A JSON webes kulcsa.

options
ImportKeyOptions

A választható paraméterek.

Válaszok

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

Iterálja a törölt kulcsokat a tárolóban. A teljes kulcsazonosítót és -tulajdonságokat a válaszban adták meg. A kulcsokhoz nem adnak vissza értékeket. Ehhez a művelethez kulcs/lista engedé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

options
ListDeletedKeysOptions

A választható paraméterek.

Válaszok

PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Iterálja a tároló összes kulcsának legújabb verzióját. A teljes kulcsazonosítót és -tulajdonságokat a válaszban adták meg. A kulcsokhoz nem adnak vissza értékeket. Ehhez a művelethez kulcs/lista engedé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

options
ListPropertiesOfKeysOptions

A választható 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álaszban a teljes kulcsazonosítót, tulajdonságokat és címkéket adták 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

name

string

A verziókat lekérni kívánt kulcs neve

options
ListPropertiesOfKeyVersionsOptions

A választható paraméterek.

Válaszok

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

A törölt kulcs törlése művelet véglegesen eltávolítja a kulcsot a helyreállítás lehetősége nélkül. 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

name

string

A kulcs neve.

options
PurgeDeletedKeyOptions

A választható paraméterek.

Válaszok

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

Egy kulcsot ad ki egy felügyelt HSM-ből.

A kiadási kulcs művelet minden kulcstípusra alkalmazható. A művelethez a kulcsot exportálhatóként és a kulcsok/kiadási engedélyként kell megjelölni.

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

name

string

A kulcs neve.

targetAttestationToken

string

A kulcskiadás céljának igazolási helyessége.

options
ReleaseKeyOptions

A választható paraméterek.

Válaszok

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

Visszaállít egy biztonsági mentési 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 mentési kulcsot egy tárolóba.

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

Paraméterek

backup

Uint8Array

A kulcscsomaghoz társított biztonsági mentési blob.

options
RestoreKeyBackupOptions

A választható 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/elforgatá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

name

string

Az elforgatni kívánt kulcs neve.

options
RotateKeyOptions

A választható 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 kulcsra/beállításra van szükség.

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ítések egy adott kulcstartóban lévő adott kulccsal társított tulajdonságokat.

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

A választható 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 kulcsra/beállításra van szükség.

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ítések egy adott kulcstartóban lévő adott kulccsal társított tulajdonságokat.

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

Paraméterek

name

string

A kulcs neve.

options
UpdateKeyPropertiesOptions

A választható paraméterek.

Válaszok

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Frissítések egy Key Vault kulcs 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

keyName

string

A kulcs neve.

policy
KeyRotationPolicyProperties
options
UpdateKeyRotationPolicyOptions

A választható paraméterek.

Válaszok

Promise<KeyRotationPolicy>