KeyClient class

  • Başvuru
Paket:
@azure/keyvault-keys

KeyClient, Azure Key Vault KeyVaultKey'i 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 listesini de destekler.

Oluşturucular

KeyClient(string, TokenCredential, KeyClientOptions)

KeyClient'ın bir örneğini oluşturur.

Örnek kullanım: 

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

Özellikler

vaultUrl

Kasanın temel URL'si

Yöntemler

backupKey(string, BackupKeyOptions)

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

Örnek kullanım: 

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

Belirtilen anahtarı yedekler.
beginDeleteKey(string, BeginDeleteKeyOptions)

Silme işlemi, Azure Key Vault'de 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 silinir.

Bu işlev, anahtar silinene kadar süresiz olarak beklemenizi sağlayan Uzun Süre Çalışan bir İşlem poller döndürür.

Bu işlem anahtarlar/silme izni gerektirir.

Örnek kullanım: 

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

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

Belirtilen kasada silinen anahtarı kurtarır. Bu işlem yalnızca geçici silme özellikli 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: 

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

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

createEcKey yöntemi, Azure Key Vault'de yeni bir üç nokta eğrisi 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: 

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

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

Anahtar oluşturma işlemi, Azure Key Vault'da 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: 

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

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

createOctKey yöntemi, Azure Key Vault'de 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: 

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

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

createRSAKey yöntemi, Azure Key Vault'de 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: 

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

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

Verilen anahtar için bir CryptographyClient alır.

Örnek kullanım: 

let client = new KeyClient(url, credentials);
// get a cryptography client for a given key
let cryptographyClient = client.getCryptographyClient("MyKey");
getDeletedKey(string, GetDeletedKeyOptions)

getDeletedKey yöntemi, belirtilen silinen anahtarı ve özelliklerini döndürür. Bu işlem anahtarlar/alma izni gerektirir.

Örnek kullanım: 

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

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

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

Örnek kullanım: 

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

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 bulunabilecek bir ilkesi vardır.

Bu işlem anahtarlar/alma izni gerektirir. Örnek kullanım: 

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

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

Örnek kullanım: 

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

Anahtar içeri aktarma işlemi, herhangi bir anahtar türünü Azure Key Vault içeri 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: 

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

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: 

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

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: 

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

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

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

Örnek kullanım: 

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)

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: 

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

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

Yönetilen HSM'den bir anahtar serbest bırakır.

Sürüm anahtarı işlemi tüm anahtar türleri için geçerlidir. İşlem, anahtarın dışarı aktarılabilir olarak işaretlenmesini ve anahtarların/yayın izninin verilmesini gerektirir.

Örnek kullanım: 

let client = new KeyClient(vaultUrl, credentials);
let result = await client.releaseKey("myKey", 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: 

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");
// ...
let 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: 

let client = new KeyClient(vaultUrl, credentials);
let key = await client.rotateKey("MyKey");
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 kendisi değiştirilemez. Bu işlem anahtarlar/ayarlama izni gerektirir.

Örnek kullanım: 

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

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

updateKeyProperties yöntemi, mevcut bir saklı 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 kendisi değiştirilemez. Bu işlem anahtarlar/ayarlama izni gerektirir.

Örnek kullanım: 

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

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

Key Vault Anahtarının döndürme ilkesini Güncelleştirmeler. Bu işlem anahtarlar/güncelleştirme izni gerektirir.

Örnek kullanım: 

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

Oluşturucu Ayrıntıları

KeyClient(string, TokenCredential, KeyClientOptions)

KeyClient'ın bir örneğini oluşturur.

Örnek kullanım: 

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)

Parametreler

vaultUrl

string

Key Vault 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 TokenCredential kimliğini doğrulamak için kullanılan arabirimi uygulayan nesne. @azure/identity Gereksinimlerinize uygun bir kimlik bilgisi oluşturmak için 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 bir yedeğinin istemciye indirilmesi isteğinde bulunur. Anahtarın tüm sürümleri indirilir. Bu işlem anahtarlar/yedekleme izni gerektirir.

Örnek kullanım: 

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

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'de 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 silinir.

Bu işlev, anahtar silinene kadar süresiz olarak beklemenizi sağlayan Uzun Süre Çalışan bir İşlem poller döndürür.

Bu işlem anahtarlar/silme izni gerektirir.

Örnek kullanım: 

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

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 özellikli 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: 

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

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'de yeni bir üç nokta eğrisi 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: 

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

Yeni bir anahtar oluşturur, depolar, ardından anahtar parametrelerini ve özelliklerini istemciye 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'da 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: 

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

Yeni bir anahtar oluşturur, depolar, ardından anahtar parametrelerini ve özelliklerini istemciye 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'de 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: 

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

Yeni bir anahtar oluşturur, depolar, ardından anahtar parametrelerini ve özelliklerini istemciye 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'de 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: 

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

Yeni bir anahtar oluşturur, depolar, ardından anahtar parametrelerini ve özelliklerini istemciye 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: 

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

Parametreler

keyName

string

options
GetCryptographyClientOptions

Döndürülenler

CryptographyClient

getDeletedKey(string, GetDeletedKeyOptions)

getDeletedKey yöntemi, belirtilen silinen anahtarı ve özelliklerini döndürür. Bu işlem anahtarlar/alma izni gerektirir.

Örnek kullanım: 

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

Belirtilen silinen 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 anahtarı alır ve Azure Key Vault'de depolanan tüm anahtarlar için geçerlidir. Bu işlem anahtarlar/alma izni gerektirir.

Örnek kullanım: 

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

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>

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 bulunabilecek bir ilkesi vardır.

Bu işlem anahtarlar/alma izni gerektirir. Örnek kullanım: 

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

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 bir HSM'den rastgele değerler içeren istenen bayt sayısını alır. Bu işlem managedHsm/rng izni gerektirir.

Örnek kullanım: 

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

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

Parametreler

count

number

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

options
GetRandomBytesOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<Uint8Array>

importKey(string, JsonWebKey_2, ImportKeyOptions)

Anahtar içeri aktarma işlemi, herhangi bir anahtar türünü Azure Key Vault içeri 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: 

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

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_2, 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: 

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

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: 

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

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)

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

Örnek kullanım: 

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>

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: 

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

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 serbest bırakır.

Sürüm anahtarı işlemi tüm anahtar türleri için geçerlidir. İşlem, anahtarın dışarı aktarılabilir olarak işaretlenmesini ve anahtarların/yayın izninin verilmesini gerektirir.

Örnek kullanım: 

let client = new KeyClient(vaultUrl, credentials);
let result = await client.releaseKey("myKey", 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: 

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

Yedeklenen bir anahtarı kasaya geri yükler.

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

Parametreler

backup

Uint8Array

Bir 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: 

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

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 kendisi değiştirilemez. Bu işlem anahtarlar/ayarlama izni gerektirir.

Örnek kullanım: 

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

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

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 saklı 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 kendisi değiştirilemez. Bu işlem anahtarlar/ayarlama izni gerektirir.

Örnek kullanım: 

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

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

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ştirmeler. Bu işlem anahtarlar/güncelleştirme izni gerektirir.

Örnek kullanım: 

let client = new KeyClient(vaultUrl, credentials);
const setPolicy = await client.updateKeyRotationPolicy("MyKey", 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>