Aracılığıyla paylaş

SecretClient class

Paket:
@azure/keyvault-secrets

SecretClient, Azure Key Vault'ta KeyVaultSecret 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ş Azure Key Vault için DeletedSecret listelemeyi de destekler.

Oluşturucular

SecretClient(string, TokenCredential, SecretClientOptions)

SecretClient örneği oluşturur.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

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

Özellikler

vaultUrl

Kasanın temel URL'si

Yöntemler

backupSecret(string, BackupSecretOptions)

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

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const backupResult = await client.backupSecret(secretName);

Belirtilen gizli diziyi yedekler.
beginDeleteSecret(string, BeginDeleteSecretOptions)

Azure Key Vault'ta 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 dizi/silme izni gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

await client.beginDeleteSecret(secretName);

Belirtilen anahtar kasasından gizli diziyi 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 dizi/kurtarma izni gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const deletePoller = await client.beginDeleteSecret(secretName);
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret(secretName);
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 dizileri/alma iznini gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const result = await client.getDeletedSecret("MyDeletedSecret");

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

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

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const latestSecret = await client.getSecret(secretName);
console.log(`Latest version of the secret ${secretName}: `, latestSecret);

const specificSecret = await client.getSecret(secretName, {
  version: latestSecret.properties.version!,
});
console.log(
  `The secret ${secretName} at the version ${latestSecret.properties.version!}: `,
  specificSecret,
);

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ülmüyor. Bu işlemler gizli dizi/liste izni gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

for await (const secretProperties of client.listPropertiesOfSecrets()) {
  console.log("Secret properties: ", secretProperties);
}

for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("Deleted secret: ", deletedSecret);
}

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

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ülmüyor. Bu işlemler gizli dizi/liste izni gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

for await (const secretProperties of client.listPropertiesOfSecrets()) {
  console.log("Secret properties: ", secretProperties);
}

for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("Deleted secret: ", deletedSecret);
}

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

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

Kasadaki belirli gizli dizilerin 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ülmüyor. Bu işlemler gizli dizi/liste izni gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

for await (const secretProperties of client.listPropertiesOfSecrets()) {
  console.log("Secret properties: ", secretProperties);
}

for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("Deleted secret: ", deletedSecret);
}

for await (const versionProperties of client.listPropertiesOfSecretVersions(secretName)) {
  console.log("Version properties: ", versionProperties);
}
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:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const deletePoller = await client.beginDeleteSecret(secretName);
await deletePoller.pollUntilDone();

await client.purgeDeletedSecret(secretName);

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 dizi/geri yükleme izni gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const backupResult = await client.backupSecret(secretName);

await client.restoreSecretBackup(backupResult);

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

setSecret yöntemi, Azure Key Vault'a bir gizli dizi veya gizli dizi 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 dizi/küme izni gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const result = await client.setSecret(secretName, "MySecretValue");
console.log("result: ", result);

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

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

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const result = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, result.properties.version, { enabled: false });

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

Oluşturucu Ayrıntıları

SecretClient(string, TokenCredential, SecretClientOptions)

SecretClient örneği oluşturur.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

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

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 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
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 dizinin yedeğinin istemciye indirilmesi istenir. Gizli dizinin tüm sürümleri indirilir. Bu işlem gizli dizi/yedekleme izni gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const backupResult = await client.backupSecret(secretName);

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'ta 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 dizi/silme izni gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

await client.beginDeleteSecret(secretName);

Belirtilen anahtar kasasından gizli diziyi 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 dizi/kurtarma izni gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const deletePoller = await client.beginDeleteSecret(secretName);
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret(secretName);
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 dizileri/alma iznini gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const result = 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'ta depolanan tüm gizli diziler için geçerlidir. Bu işlem gizli dizileri/alma iznini gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const latestSecret = await client.getSecret(secretName);
console.log(`Latest version of the secret ${secretName}: `, latestSecret);

const specificSecret = await client.getSecret(secretName, {
  version: latestSecret.properties.version!,
});
console.log(
  `The secret ${secretName} at the version ${latestSecret.properties.version!}: `,
  specificSecret,
);

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ülmüyor. Bu işlemler gizli dizi/liste izni gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

for await (const secretProperties of client.listPropertiesOfSecrets()) {
  console.log("Secret properties: ", secretProperties);
}

for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("Deleted secret: ", deletedSecret);
}

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

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ülmüyor. Bu işlemler gizli dizi/liste izni gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

for await (const secretProperties of client.listPropertiesOfSecrets()) {
  console.log("Secret properties: ", secretProperties);
}

for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("Deleted secret: ", deletedSecret);
}

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

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)

Kasadaki belirli gizli dizilerin 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ülmüyor. Bu işlemler gizli dizi/liste izni gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

for await (const secretProperties of client.listPropertiesOfSecrets()) {
  console.log("Secret properties: ", secretProperties);
}

for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("Deleted secret: ", deletedSecret);
}

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

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:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const deletePoller = await client.beginDeleteSecret(secretName);
await deletePoller.pollUntilDone();

await client.purgeDeletedSecret(secretName);

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 dizi/geri yükleme izni gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const backupResult = await client.backupSecret(secretName);

await client.restoreSecretBackup(backupResult);

Yedeklenen bir 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'a bir gizli dizi veya gizli dizi 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 dizi/küme izni gerektirir.

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const result = await client.setSecret(secretName, "MySecretValue");
console.log("result: ", result);

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 dizi değeri.

options
SetSecretOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<KeyVaultSecret>

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

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

Örnek kullanım:

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

const credential = new DefaultAzureCredential();

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

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const result = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, result.properties.version, { enabled: false });

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

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>