Aracılığıyla paylaş

SecretClient class

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

SecretClient, Azure Key Vault KeyVaultSecret'i yönetmek için yöntemler sağlar. İstemci KeyVaultSecrets 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ş bir Azure Key Vault için DeletedSecret listesini de destekler.

Oluşturucular

SecretClient(string, TokenCredential, SecretClientOptions)

SecretClient örneğini oluşturur.

Örnek kullanım: 

import { SecretClient } from "@azure/keyvault-secrets";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new SecretClient(vaultUrl, credentials);

Özellikler

vaultUrl

Kasanın temel URL'si

Yöntemler

backupSecret(string, BackupSecretOptions)

Belirtilen gizli dizi yedeğinin istemciye indirilmesi isteğinde bulunur. Gizli dizinin tüm sürümleri indirilir. Bu işlem gizli diziler/yedekleme izni gerektirir.

Örnek kullanım: 

let client = new SecretClient(url, credentials);
let backupResult = await client.backupSecret("MySecretName");

Belirtilen gizli diziyi yedekler.
beginDeleteSecret(string, BeginDeleteSecretOptions)

Azure Key Vault depolanan bir gizli diziyi siler. Bu işlev, gizli dizi silinene kadar süresiz olarak beklemenize olanak tanıyan uzun süre çalışan bir İşlem poller döndürür.

Bu işlem gizli diziler/silme izni gerektirir.

Örnek kullanım: 

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await deletePoller.pollUntilDone();
console.log(deletedSecret);

Belirtilen anahtar kasasından gizli dizi siler.
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Belirtilen kasada silinen gizli diziyi kurtarır. Bu işlev, gizli dizi kurtarılana kadar süresiz olarak beklemenize olanak tanıyan uzun süre çalışan bir İşlem poller döndürür.

Bu işlem gizli diziler/kurtarma izni gerektirir.

Örnek kullanım: 

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret("MySecretName");

// Serializing the poller
const serialized = recoverPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await recoverPoller.pollUntilDone();
console.log(deletedSecret);

Silinen gizli diziyi en son sürüme kurtarır.
getDeletedSecret(string, GetDeletedSecretOptions)

getDeletedSecret yöntemi, öznitelikleriyle birlikte belirtilen silinen gizli diziyi döndürür. Bu işlem gizli diziler/alma izni gerektirir.

Örnek kullanım: 

let client = new SecretClient(url, credentials);
await client.getDeletedSecret("MyDeletedSecret");

Belirtilen silinen gizli diziyi alır.
getSecret(string, GetSecretOptions)

getSecret yöntemi Azure Key Vault depolanan tüm gizli diziler için geçerlidir. Bu işlem gizli diziler/alma izni gerektirir.

Örnek kullanım: 

let client = new SecretClient(url, credentials);
let secret = await client.getSecret("MySecretName");

Belirli bir anahtar kasasından belirtilen gizli diziyi alın.
listDeletedSecrets(ListDeletedSecretsOptions)

Kasada silinen gizli dizileri yineler. Tam gizli dizi tanımlayıcısı ve öznitelikleri yanıtta sağlanır. Gizli diziler için değer döndürülmedi. Bu işlemler gizli diziler/liste izni gerektirir.

Örnek kullanım: 

let client = new SecretClient(url, credentials);
for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("deleted secret: ", deletedSecret);
}

Kasadaki tüm gizli dizileri listeleyin.
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Kasadaki tüm gizli dizilerin en son sürümünü yineler. Tam gizli dizi tanımlayıcısı ve öznitelikleri yanıtta sağlanır. Gizli diziler için değer döndürülmedi. Bu işlemler gizli diziler/liste izni gerektirir.

Örnek kullanım: 

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecrets()) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret: ", secret);
}

Kasadaki tüm gizli dizileri listeleyin.
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Kasada verilen gizli dizinin tüm sürümlerini yineler. Tam gizli dizi tanımlayıcısı ve öznitelikleri yanıtta sağlanır. Gizli diziler için değer döndürülmedi. Bu işlemler gizli diziler/liste izni gerektirir.

Örnek kullanım: 

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecretVersions("MySecretName")) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret version: ", secret);
}
purgeDeletedSecret(string, PurgeDeletedSecretOptions)

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

Örnek kullanım: 

const client = new SecretClient(url, credentials);
const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();
await client.purgeDeletedSecret("MySecretName");

Belirtilen gizli diziyi kalıcı olarak siler.
restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Yedeklenen bir gizli diziyi ve tüm sürümlerini bir kasaya geri yükler. Bu işlem gizli diziler/geri yükleme izni gerektirir.

Örnek kullanım: 

let client = new SecretClient(url, credentials);
let mySecretBundle = await client.backupSecret("MySecretName");
// ...
await client.restoreSecretBackup(mySecretBundle);

Yedeklenen gizli diziyi kasaya geri yükler.
setSecret(string, string, SetSecretOptions)

setSecret yöntemi, Azure Key Vault bir gizli dizi veya gizli sürüm ekler. Adlandırılmış gizli dizi zaten varsa, Azure Key Vault bu gizli dizinin yeni bir sürümünü oluşturur. Bu işlem gizli diziler/küme izni gerektirir.

Örnek kullanım: 

let client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

Belirtilen anahtar kasasına gizli dizi ekler.
updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

updateSecret yöntemi, mevcut bir depolanan gizli dizinin belirtilen özniteliklerini değiştirir. İstekte belirtilmeyen özellikler değiştirilmeden bırakılır. Gizli dizinin kendisi değiştirilemez. Bu işlem gizli diziler/küme izni gerektirir.

Örnek kullanım: 

let secretName = "MySecretName";
let client = new SecretClient(url, credentials);
let secret = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, secret.properties.version, { enabled: false });

Belirli bir anahtar kasasında belirtilen gizli diziyle ilişkili öznitelikleri Güncelleştirmeler.

Oluşturucu Ayrıntıları

SecretClient(string, TokenCredential, SecretClientOptions)

SecretClient örneğini oluşturur.

Örnek kullanım: 

import { SecretClient } from "@azure/keyvault-secrets";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new SecretClient(vaultUrl, credentials);

new SecretClient(vaultUrl: string, credential: TokenCredential, pipelineOptions?: SecretClientOptions)

Parametreler

vaultUrl

string

Kasanın temel URL'si. Bu URL'nin geçerli bir Key Vault 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 bir nesne. @azure/identity Gereksinimlerinize uygun bir kimlik bilgisi oluşturmak için paketini kullanın.

pipelineOptions
SecretClientOptions

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ı

backupSecret(string, BackupSecretOptions)

Belirtilen gizli dizi yedeğinin istemciye indirilmesi isteğinde bulunur. Gizli dizinin tüm sürümleri indirilir. Bu işlem gizli diziler/yedekleme izni gerektirir.

Örnek kullanım: 

let client = new SecretClient(url, credentials);
let backupResult = await client.backupSecret("MySecretName");

Belirtilen gizli diziyi yedekler.

function backupSecret(secretName: string, options?: BackupSecretOptions): Promise<undefined | Uint8Array>

Parametreler

secretName

string

Gizli dizinin adı.

options
BackupSecretOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

Azure Key Vault depolanan bir gizli diziyi siler. Bu işlev, gizli dizi silinene kadar süresiz olarak beklemenize olanak tanıyan uzun süre çalışan bir İşlem poller döndürür.

Bu işlem gizli diziler/silme izni gerektirir.

Örnek kullanım: 

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await deletePoller.pollUntilDone();
console.log(deletedSecret);

Belirtilen anahtar kasasından gizli dizi siler.

function beginDeleteSecret(name: string, options?: BeginDeleteSecretOptions): Promise<PollerLike<PollOperationState<DeletedSecret>, DeletedSecret>>

Parametreler

name

string

options
BeginDeleteSecretOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<PollerLike<PollOperationState<DeletedSecret>, DeletedSecret>>

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Belirtilen kasada silinen gizli diziyi kurtarır. Bu işlev, gizli dizi kurtarılana kadar süresiz olarak beklemenize olanak tanıyan uzun süre çalışan bir İşlem poller döndürür.

Bu işlem gizli diziler/kurtarma izni gerektirir.

Örnek kullanım: 

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret("MySecretName");

// Serializing the poller
const serialized = recoverPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await recoverPoller.pollUntilDone();
console.log(deletedSecret);

Silinen gizli diziyi en son sürüme kurtarır.

function beginRecoverDeletedSecret(name: string, options?: BeginRecoverDeletedSecretOptions): Promise<PollerLike<PollOperationState<SecretProperties>, SecretProperties>>

Parametreler

name

string

options
BeginRecoverDeletedSecretOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<PollerLike<PollOperationState<SecretProperties>, SecretProperties>>

getDeletedSecret(string, GetDeletedSecretOptions)

getDeletedSecret yöntemi, öznitelikleriyle birlikte belirtilen silinen gizli diziyi döndürür. Bu işlem gizli diziler/alma izni gerektirir.

Örnek kullanım: 

let client = new SecretClient(url, credentials);
await client.getDeletedSecret("MyDeletedSecret");

Belirtilen silinen gizli diziyi alır.

function getDeletedSecret(secretName: string, options?: GetDeletedSecretOptions): Promise<DeletedSecret>

Parametreler

secretName

string

Gizli dizinin adı.

options
GetDeletedSecretOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

getSecret yöntemi Azure Key Vault depolanan tüm gizli diziler için geçerlidir. Bu işlem gizli diziler/alma izni gerektirir.

Örnek kullanım: 

let client = new SecretClient(url, credentials);
let secret = await client.getSecret("MySecretName");

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

function getSecret(secretName: string, options?: GetSecretOptions): Promise<KeyVaultSecret>

Parametreler

secretName

string

Gizli dizinin adı.

options
GetSecretOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<KeyVaultSecret>

listDeletedSecrets(ListDeletedSecretsOptions)

Kasada silinen gizli dizileri yineler. Tam gizli dizi tanımlayıcısı ve öznitelikleri yanıtta sağlanır. Gizli diziler için değer döndürülmedi. Bu işlemler gizli diziler/liste izni gerektirir.

Örnek kullanım: 

let client = new SecretClient(url, credentials);
for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("deleted secret: ", deletedSecret);
}

Kasadaki tüm gizli dizileri listeleyin.

function listDeletedSecrets(options?: ListDeletedSecretsOptions): PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

Parametreler

options
ListDeletedSecretsOptions

İsteğe bağlı parametreler.

Döndürülenler

PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Kasadaki tüm gizli dizilerin en son sürümünü yineler. Tam gizli dizi tanımlayıcısı ve öznitelikleri yanıtta sağlanır. Gizli diziler için değer döndürülmedi. Bu işlemler gizli diziler/liste izni gerektirir.

Örnek kullanım: 

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecrets()) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret: ", secret);
}

Kasadaki tüm gizli dizileri listeleyin.

function listPropertiesOfSecrets(options?: ListPropertiesOfSecretsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

Parametreler

options
ListPropertiesOfSecretsOptions

İsteğe bağlı parametreler.

Döndürülenler

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Kasada verilen gizli dizinin tüm sürümlerini yineler. Tam gizli dizi tanımlayıcısı ve öznitelikleri yanıtta sağlanır. Gizli diziler için değer döndürülmedi. Bu işlemler gizli diziler/liste izni gerektirir.

Örnek kullanım: 

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecretVersions("MySecretName")) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret version: ", secret);
}

function listPropertiesOfSecretVersions(secretName: string, options?: ListPropertiesOfSecretVersionsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

Parametreler

secretName

string

Sürümlerin getirilmeye hazır olduğu gizli dizinin adı.

options
ListPropertiesOfSecretVersionsOptions

İsteğe bağlı parametreler.

Döndürülenler

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

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

Örnek kullanım: 

const client = new SecretClient(url, credentials);
const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();
await client.purgeDeletedSecret("MySecretName");

Belirtilen gizli diziyi kalıcı olarak siler.

function purgeDeletedSecret(secretName: string, options?: PurgeDeletedSecretOptions): Promise<void>

Parametreler

secretName

string

Gizli dizinin adı.

options
PurgeDeletedSecretOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<void>

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Yedeklenen bir gizli diziyi ve tüm sürümlerini bir kasaya geri yükler. Bu işlem gizli diziler/geri yükleme izni gerektirir.

Örnek kullanım: 

let client = new SecretClient(url, credentials);
let mySecretBundle = await client.backupSecret("MySecretName");
// ...
await client.restoreSecretBackup(mySecretBundle);

Yedeklenen gizli diziyi kasaya geri yükler.

function restoreSecretBackup(secretBundleBackup: Uint8Array, options?: RestoreSecretBackupOptions): Promise<SecretProperties>

Parametreler

secretBundleBackup

Uint8Array

Gizli dizi paketiyle ilişkili yedekleme blobu.

options
RestoreSecretBackupOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<SecretProperties>

setSecret(string, string, SetSecretOptions)

setSecret yöntemi, Azure Key Vault bir gizli dizi veya gizli sürüm ekler. Adlandırılmış gizli dizi zaten varsa, Azure Key Vault bu gizli dizinin yeni bir sürümünü oluşturur. Bu işlem gizli diziler/küme izni gerektirir.

Örnek kullanım: 

let client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

Belirtilen anahtar kasasına gizli dizi ekler.

function setSecret(secretName: string, value: string, options?: SetSecretOptions): Promise<KeyVaultSecret>

Parametreler

secretName

string

Gizli dizinin adı.

value

string

Gizli dizinin değeri.

options
SetSecretOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<KeyVaultSecret>

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

updateSecret yöntemi, mevcut bir depolanan gizli dizinin belirtilen özniteliklerini değiştirir. İstekte belirtilmeyen özellikler değiştirilmeden bırakılır. Gizli dizinin kendisi değiştirilemez. Bu işlem gizli diziler/küme izni gerektirir.

Örnek kullanım: 

let secretName = "MySecretName";
let client = new SecretClient(url, credentials);
let secret = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, secret.properties.version, { enabled: false });

Belirli bir anahtar kasasında belirtilen gizli diziyle ilişkili öznitelikleri Güncelleştirmeler.

function updateSecretProperties(secretName: string, secretVersion: string, options?: UpdateSecretPropertiesOptions): Promise<SecretProperties>

Parametreler

secretName

string

Gizli dizinin adı.

secretVersion

string

Gizli dizinin sürümü.

options
UpdateSecretPropertiesOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<SecretProperties>