Aracılığıyla paylaş

KeyClient class

Paket:
@azure/keyvault-keys

KeyClient, Azure Key Vault'ta KeyVaultKey yönetmek için yöntemler sağlar. İstemci KeyVaultKeys oluşturma, alma, güncelleştirme, silme, temizleme, yedekleme, geri yükleme ve listelemeyi destekler. İstemci ayrıca geçici silme özelliği etkinleştirilmiş Azure Key Vault için DeletedKey listelemeyi de destekler.

Oluşturucular

KeyClient(string, TokenCredential, KeyClientOptions)

KeyClient örneği oluşturur.

Örnek kullanım:

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

Özellikler

vaultUrl

Kasanın temel URL'si

Yöntemler

backupKey(string, BackupKeyOptions)

Belirtilen anahtarın yedeğinin istemciye indirilmesi isteğinde bulunur. Anahtarın tüm sürümleri indirilir. Bu işlem için anahtarlar/yedekleme izni gerekir.

Örnek kullanım:

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

Belirtilen anahtarı yedekler.
beginDeleteKey(string, BeginDeleteKeyOptions)

Silme işlemi, Azure Key Vault'ta depolanan tüm anahtarlar için geçerlidir. Bir anahtarın tek tek sürümleri silinemez, yalnızca belirli bir anahtarın tüm sürümleri aynı anda silinemez.

Bu işlev, anahtar silinene kadar süresiz olarak beklemenize olanak tanıyan uzun süre çalışan bir İşlem poller döndürür.

Bu işlem anahtar/silme izni gerektirir.

Örnek kullanım:

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

Belirtilen anahtar kasasından bir anahtarı siler.
beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Belirtilen kasada silinen anahtarı kurtarır. Bu işlem yalnızca geçici silme özelliği etkinleştirilmiş bir kasada gerçekleştirilebilir.

Bu işlev, silinen anahtar kurtarılana kadar süresiz olarak beklemenizi sağlayan uzun süre çalışan bir İşlem poller döndürür.

Bu işlem anahtarlar/kurtarma izni gerektirir.

Örnek kullanım:

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

Silinen anahtarı en son sürüme kurtarır.
createEcKey(string, CreateEcKeyOptions)

createEcKey yöntemi, Azure Key Vault'ta yeni bir üç nokta eğri anahtarı oluşturur. Adlandırılmış anahtar zaten varsa, Azure Key Vault anahtarın yeni bir sürümünü oluşturur. Anahtarlar/oluşturma izni gerektirir.

Örnek kullanım:

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

Yeni bir anahtar oluşturur, depolar, ardından istemciye anahtar parametreleri ve özellikleri döndürür.
createKey(string, string, CreateKeyOptions)

Anahtar oluşturma işlemi, Azure Key Vault'ta herhangi bir anahtar türü oluşturmak için kullanılabilir. Adlandırılmış anahtar zaten varsa, Azure Key Vault anahtarın yeni bir sürümünü oluşturur. Anahtarlar/oluşturma izni gerektirir.

Örnek kullanım:

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

Yeni bir anahtar oluşturur, depolar, ardından istemciye anahtar parametreleri ve özellikleri döndürür.
createOctKey(string, CreateOctKeyOptions)

createOctKey yöntemi Azure Key Vault'ta yeni bir OCT anahtarı oluşturur. Adlandırılmış anahtar zaten varsa, Azure Key Vault anahtarın yeni bir sürümünü oluşturur. Anahtarlar/oluşturma izni gerektirir.

Örnek kullanım:

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

Yeni bir anahtar oluşturur, depolar, ardından istemciye anahtar parametreleri ve özellikleri döndürür.
createRsaKey(string, CreateRsaKeyOptions)

createRSAKey yöntemi, Azure Key Vault'ta yeni bir RSA anahtarı oluşturur. Adlandırılmış anahtar zaten varsa, Azure Key Vault anahtarın yeni bir sürümünü oluşturur. Anahtarlar/oluşturma izni gerektirir.

Örnek kullanım:

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

Yeni bir anahtar oluşturur, depolar, ardından istemciye anahtar parametreleri ve özellikleri döndürür.
getCryptographyClient(string, GetCryptographyClientOptions)

Verilen anahtar için bir CryptographyClient alır.

Örnek kullanım:

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)

getDeletedKey yöntemi, özellikleriyle birlikte belirtilen silinmiş anahtarı döndürür. Bu işlem için anahtarlar/alma izni gerekir.

Örnek kullanım:

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

Belirtilen silinmiş anahtarı alır.
getKey(string, GetKeyOptions)

getKey yöntemi belirtilen bir anahtarı alır ve Azure Key Vault'ta depolanan tüm anahtarlar için geçerlidir. Bu işlem için anahtarlar/alma izni gerekir.

Örnek kullanım:

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

Belirli bir anahtar kasasından belirtilen anahtarı alın.
getKeyAttestation(string, GetKeyAttestationOptions)

getKeyAttestation yöntemi belirtilen bir anahtarı ve kanıtlama blobunu alır ve Azure Key Vault Yönetilen HSM'de depolanan tüm anahtarlar için geçerlidir. Bu işlem için anahtarlar/alma izni gerekir.

Örnek kullanım:

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

Belirli bir anahtar kasasından belirtilen anahtarı alın.
getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

Key Vault Anahtarının döndürme ilkesini alır. Varsayılan olarak, tüm anahtarların süresi dolmadan 30 gün önce bildirimde bulunan bir ilkesi vardır.

Bu işlem için anahtarlar/alma izni gerekir. Örnek kullanım:

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)

Yönetilen HSM'den rastgele değerler içeren istenen bayt sayısını alır. Bu işlem managedHsm/rng izni gerektirir.

Örnek kullanım:

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)

Anahtar içeri aktarma işlemi herhangi bir anahtar türünü Azure Key Vault'a aktarmak için kullanılabilir. Adlandırılmış anahtar zaten varsa, Azure Key Vault anahtarın yeni bir sürümünü oluşturur. Bu işlem anahtarlar/içeri aktarma izni gerektirir.

Örnek kullanım:

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

Dışarıdan oluşturulan bir anahtarı içeri aktarır, depolar ve anahtar parametrelerini ve özelliklerini istemciye döndürür.
listDeletedKeys(ListDeletedKeysOptions)

Kasada silinen anahtarları yineler. Tam anahtar tanımlayıcısı ve özellikleri yanıtta sağlanır. Anahtarlar için değer döndürülmedi. Bu işlemler için anahtar/liste izni gerekir.

Örnek kullanım:

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

Kasadaki tüm anahtarları listeleme
listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Kasadaki tüm anahtarların en son sürümünü yineler. Tam anahtar tanımlayıcısı ve özellikleri yanıtta sağlanır. Anahtarlar için değer döndürülmedi. Bu işlemler için anahtar/liste izni gerekir.

Örnek kullanım:

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

Kasadaki tüm anahtarları listeleme
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

Kasada verilen anahtarın tüm sürümlerini yineler. Yanıtta tam anahtar tanımlayıcısı, özellikleri ve etiketleri sağlanır. Bu işlem anahtarlar/liste izni gerektirir.

Örnek kullanım:

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)

Silinen anahtarı temizleme işlemi, kurtarma olasılığı olmadan anahtarı kalıcı olarak kaldırır. Bu işlem yalnızca geçici silme özellikli kasada etkinleştirilebilir. Bu işlem anahtarlar/temizleme izni gerektirir.

Örnek kullanım:

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

Belirtilen anahtarı kalıcı olarak siler.
releaseKey(string, string, ReleaseKeyOptions)

Yönetilen HSM'den bir anahtar yayınlar.

Yayın anahtarı işlemi tüm anahtar türleri için geçerlidir. İşlem için anahtarın dışarı aktarılabilir olarak işaretlenmesi ve anahtarların/yayın izninin olması gerekir.

Örnek kullanım:

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)

Yedeklenen bir anahtarı ve tüm sürümlerini bir kasaya geri yükler. Bu işlem anahtarlar/geri yükleme izni gerektirir.

Örnek kullanım:

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

Yedeklenen bir anahtarı kasaya geri yükler.
rotateKey(string, RotateKeyOptions)

Anahtarın yeni bir sürümünü oluşturarak anahtarı anahtar ilkesine göre döndürür. Bu işlem anahtarlar/döndürme izni gerektirir.

Örnek kullanım:

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)

updateKeyProperties yöntemi, mevcut bir depolanan anahtarın belirtilen özelliklerini değiştirir. İstekte belirtilmeyen özellikler değiştirilmeden bırakılır. Anahtarın değeri değiştirilemez. Bu işlem için anahtarlar/ayarlama izni gerekir.

Örnek kullanım:

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

Belirli bir anahtar kasasında belirtilen anahtarla ilişkili özellikleri güncelleştirir.
updateKeyProperties(string, UpdateKeyPropertiesOptions)

updateKeyProperties yöntemi, mevcut bir depolanan anahtarın en son sürümünün belirtilen özelliklerini değiştirir. İstekte belirtilmeyen özellikler değiştirilmeden bırakılır. Anahtarın değeri değiştirilemez. Bu işlem için anahtarlar/ayarlama izni gerekir.

Örnek kullanım:

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

Belirli bir anahtar kasasında belirtilen anahtarla ilişkili özellikleri güncelleştirir.
updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Key Vault Anahtarının döndürme ilkesini güncelleştirir. Bu işlem için anahtarlar/güncelleştirme izni gerekir.

Örnek kullanım:

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

Oluşturucu Ayrıntıları

KeyClient(string, TokenCredential, KeyClientOptions)

KeyClient örneği oluşturur.

Örnek kullanım:

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)

Parametreler

vaultUrl

string

Key Vault'un URL'si. Şu şekle sahip olmalıdır: https://${your-key-vault-name}.vault.azure.net. Bu URL'nin geçerli bir Key Vault veya Yönetilen HSM kaynağına başvurduğunu doğrulamanız gerekir. Ayrıntılar için bkz. https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Hizmete yönelik isteklerin kimliğini doğrulamak için kullanılan TokenCredential arabirimini uygulayan nesne. gereksinimlerinize uygun bir kimlik bilgisi oluşturmak için @azure/identity paketini kullanın.

pipelineOptions
KeyClientOptions

Key Vault API isteklerini yapılandırmak için kullanılan işlem hattı seçenekleri. Varsayılan işlem hattı yapılandırmasını kullanmak için bu parametreyi atlayın.

Özellik Ayrıntıları

vaultUrl

Kasanın temel URL'si

vaultUrl: string

Özellik Değeri

string

Yöntem Ayrıntıları

backupKey(string, BackupKeyOptions)

Belirtilen anahtarın yedeğinin istemciye indirilmesi isteğinde bulunur. Anahtarın tüm sürümleri indirilir. Bu işlem için anahtarlar/yedekleme izni gerekir.

Örnek kullanım:

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

Belirtilen anahtarı yedekler.

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

Parametreler

name

string

Anahtarın adı.

options
BackupKeyOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

Silme işlemi, Azure Key Vault'ta depolanan tüm anahtarlar için geçerlidir. Bir anahtarın tek tek sürümleri silinemez, yalnızca belirli bir anahtarın tüm sürümleri aynı anda silinemez.

Bu işlev, anahtar silinene kadar süresiz olarak beklemenize olanak tanıyan uzun süre çalışan bir İşlem poller döndürür.

Bu işlem anahtar/silme izni gerektirir.

Örnek kullanım:

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

Belirtilen anahtar kasasından bir anahtarı siler.

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

Parametreler

name

string

Anahtarın adı.

options
BeginDeleteKeyOptions

İsteğe bağlı parametreler.

Döndürülenler

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

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Belirtilen kasada silinen anahtarı kurtarır. Bu işlem yalnızca geçici silme özelliği etkinleştirilmiş bir kasada gerçekleştirilebilir.

Bu işlev, silinen anahtar kurtarılana kadar süresiz olarak beklemenizi sağlayan uzun süre çalışan bir İşlem poller döndürür.

Bu işlem anahtarlar/kurtarma izni gerektirir.

Örnek kullanım:

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

Silinen anahtarı en son sürüme kurtarır.

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

Parametreler

name

string

Silinen anahtarın adı.

options
BeginRecoverDeletedKeyOptions

İsteğe bağlı parametreler.

Döndürülenler

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

createEcKey(string, CreateEcKeyOptions)

createEcKey yöntemi, Azure Key Vault'ta yeni bir üç nokta eğri anahtarı oluşturur. Adlandırılmış anahtar zaten varsa, Azure Key Vault anahtarın yeni bir sürümünü oluşturur. Anahtarlar/oluşturma izni gerektirir.

Örnek kullanım:

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

Yeni bir anahtar oluşturur, depolar, ardından istemciye anahtar parametreleri ve özellikleri döndürür.

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

Parametreler

name

string

Anahtarın adı.

options
CreateEcKeyOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

Anahtar oluşturma işlemi, Azure Key Vault'ta herhangi bir anahtar türü oluşturmak için kullanılabilir. Adlandırılmış anahtar zaten varsa, Azure Key Vault anahtarın yeni bir sürümünü oluşturur. Anahtarlar/oluşturma izni gerektirir.

Örnek kullanım:

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

Yeni bir anahtar oluşturur, depolar, ardından istemciye anahtar parametreleri ve özellikleri döndürür.

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

Parametreler

name

string

Anahtarın adı.

keyType

string

Anahtarın türü. Aşağıdakilerden biri: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'.

options
CreateKeyOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<KeyVaultKey>

createOctKey(string, CreateOctKeyOptions)

createOctKey yöntemi Azure Key Vault'ta yeni bir OCT anahtarı oluşturur. Adlandırılmış anahtar zaten varsa, Azure Key Vault anahtarın yeni bir sürümünü oluşturur. Anahtarlar/oluşturma izni gerektirir.

Örnek kullanım:

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

Yeni bir anahtar oluşturur, depolar, ardından istemciye anahtar parametreleri ve özellikleri döndürür.

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

Parametreler

name

string

Anahtarın adı.

options
CreateOctKeyOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<KeyVaultKey>

createRsaKey(string, CreateRsaKeyOptions)

createRSAKey yöntemi, Azure Key Vault'ta yeni bir RSA anahtarı oluşturur. Adlandırılmış anahtar zaten varsa, Azure Key Vault anahtarın yeni bir sürümünü oluşturur. Anahtarlar/oluşturma izni gerektirir.

Örnek kullanım:

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

Yeni bir anahtar oluşturur, depolar, ardından istemciye anahtar parametreleri ve özellikleri döndürür.

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

Parametreler

name

string

Anahtarın adı.

options
CreateRsaKeyOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

Verilen anahtar için bir CryptographyClient alır.

Örnek kullanım:

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

Parametreler

keyName

string

options
GetCryptographyClientOptions

Döndürülenler

CryptographyClient

getDeletedKey(string, GetDeletedKeyOptions)

getDeletedKey yöntemi, özellikleriyle birlikte belirtilen silinmiş anahtarı döndürür. Bu işlem için anahtarlar/alma izni gerekir.

Örnek kullanım:

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

Belirtilen silinmiş anahtarı alır.

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

Parametreler

name

string

Anahtarın adı.

options
GetDeletedKeyOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<DeletedKey>

getKey(string, GetKeyOptions)

getKey yöntemi belirtilen bir anahtarı alır ve Azure Key Vault'ta depolanan tüm anahtarlar için geçerlidir. Bu işlem için anahtarlar/alma izni gerekir.

Örnek kullanım:

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

Belirli bir anahtar kasasından belirtilen anahtarı alın.

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

Parametreler

name

string

Anahtarın adı.

options
GetKeyOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<KeyVaultKey>

getKeyAttestation(string, GetKeyAttestationOptions)

getKeyAttestation yöntemi belirtilen bir anahtarı ve kanıtlama blobunu alır ve Azure Key Vault Yönetilen HSM'de depolanan tüm anahtarlar için geçerlidir. Bu işlem için anahtarlar/alma izni gerekir.

Örnek kullanım:

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

Belirli bir anahtar kasasından belirtilen anahtarı alın.

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

Parametreler

name

string

Anahtarın adı.

options
GetKeyAttestationOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<KeyVaultKey>

getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

Key Vault Anahtarının döndürme ilkesini alır. Varsayılan olarak, tüm anahtarların süresi dolmadan 30 gün önce bildirimde bulunan bir ilkesi vardır.

Bu işlem için anahtarlar/alma izni gerekir. Örnek kullanım:

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>

Parametreler

keyName

string

Anahtarın adı.

options
GetKeyRotationPolicyOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

Yönetilen HSM'den rastgele değerler içeren istenen bayt sayısını alır. Bu işlem managedHsm/rng izni gerektirir.

Örnek kullanım:

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>

Parametreler

count

number

1 ile 128 arasında (dahil) oluşturulacak bayt sayısı.

options
GetRandomBytesOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<Uint8Array>

importKey(string, JsonWebKey, ImportKeyOptions)

Anahtar içeri aktarma işlemi herhangi bir anahtar türünü Azure Key Vault'a aktarmak için kullanılabilir. Adlandırılmış anahtar zaten varsa, Azure Key Vault anahtarın yeni bir sürümünü oluşturur. Bu işlem anahtarlar/içeri aktarma izni gerektirir.

Örnek kullanım:

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

Dışarıdan oluşturulan bir anahtarı içeri aktarır, depolar ve anahtar parametrelerini ve özelliklerini istemciye döndürür.

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

Parametreler

name

string

İçeri aktarılan anahtarın adı.

key
JsonWebKey

JSON web anahtarı.

options
ImportKeyOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

Kasada silinen anahtarları yineler. Tam anahtar tanımlayıcısı ve özellikleri yanıtta sağlanır. Anahtarlar için değer döndürülmedi. Bu işlemler için anahtar/liste izni gerekir.

Örnek kullanım:

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

Kasadaki tüm anahtarları listeleme

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

Parametreler

options
ListDeletedKeysOptions

İsteğe bağlı parametreler.

Döndürülenler

PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Kasadaki tüm anahtarların en son sürümünü yineler. Tam anahtar tanımlayıcısı ve özellikleri yanıtta sağlanır. Anahtarlar için değer döndürülmedi. Bu işlemler için anahtar/liste izni gerekir.

Örnek kullanım:

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

Kasadaki tüm anahtarları listeleme

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

Parametreler

options
ListPropertiesOfKeysOptions

İsteğe bağlı parametreler.

Döndürülenler

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

Kasada verilen anahtarın tüm sürümlerini yineler. Yanıtta tam anahtar tanımlayıcısı, özellikleri ve etiketleri sağlanır. Bu işlem anahtarlar/liste izni gerektirir.

Örnek kullanım:

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>

Parametreler

name

string

Sürümlerin getirilmeye hazır olduğu anahtarın adı

options
ListPropertiesOfKeyVersionsOptions

İsteğe bağlı parametreler.

Döndürülenler

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

Silinen anahtarı temizleme işlemi, kurtarma olasılığı olmadan anahtarı kalıcı olarak kaldırır. Bu işlem yalnızca geçici silme özellikli kasada etkinleştirilebilir. Bu işlem anahtarlar/temizleme izni gerektirir.

Örnek kullanım:

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

Belirtilen anahtarı kalıcı olarak siler.

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

Parametreler

name

string

Anahtarın adı.

options
PurgeDeletedKeyOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

Yönetilen HSM'den bir anahtar yayınlar.

Yayın anahtarı işlemi tüm anahtar türleri için geçerlidir. İşlem için anahtarın dışarı aktarılabilir olarak işaretlenmesi ve anahtarların/yayın izninin olması gerekir.

Örnek kullanım:

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>

Parametreler

name

string

Anahtarın adı.

targetAttestationToken

string

Anahtar sürümünün hedefi için kanıtlama onayı.

options
ReleaseKeyOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

Yedeklenen bir anahtarı ve tüm sürümlerini bir kasaya geri yükler. Bu işlem anahtarlar/geri yükleme izni gerektirir.

Örnek kullanım:

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

Yedeklenen bir anahtarı kasaya geri yükler.

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

Parametreler

backup

Uint8Array

Anahtar paketiyle ilişkili yedekleme blobu.

options
RestoreKeyBackupOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<KeyVaultKey>

rotateKey(string, RotateKeyOptions)

Anahtarın yeni bir sürümünü oluşturarak anahtarı anahtar ilkesine göre döndürür. Bu işlem anahtarlar/döndürme izni gerektirir.

Örnek kullanım:

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>

Parametreler

name

string

Döndürülecek anahtarın adı.

options
RotateKeyOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<KeyVaultKey>

updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

updateKeyProperties yöntemi, mevcut bir depolanan anahtarın belirtilen özelliklerini değiştirir. İstekte belirtilmeyen özellikler değiştirilmeden bırakılır. Anahtarın değeri değiştirilemez. Bu işlem için anahtarlar/ayarlama izni gerekir.

Örnek kullanım:

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

Belirli bir anahtar kasasında belirtilen anahtarla ilişkili özellikleri güncelleştirir.

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

Parametreler

name

string

Anahtarın adı.

keyVersion

string

Anahtarın sürümü.

options
UpdateKeyPropertiesOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<KeyVaultKey>

updateKeyProperties(string, UpdateKeyPropertiesOptions)

updateKeyProperties yöntemi, mevcut bir depolanan anahtarın en son sürümünün belirtilen özelliklerini değiştirir. İstekte belirtilmeyen özellikler değiştirilmeden bırakılır. Anahtarın değeri değiştirilemez. Bu işlem için anahtarlar/ayarlama izni gerekir.

Örnek kullanım:

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

Belirli bir anahtar kasasında belirtilen anahtarla ilişkili özellikleri güncelleştirir.

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

Parametreler

name

string

Anahtarın adı.

options
UpdateKeyPropertiesOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Key Vault Anahtarının döndürme ilkesini güncelleştirir. Bu işlem için anahtarlar/güncelleştirme izni gerekir.

Örnek kullanım:

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>

Parametreler

keyName

string

Anahtarın adı.

policy
KeyRotationPolicyProperties
options
UpdateKeyRotationPolicyOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<KeyRotationPolicy>