SecretClient class

  • Referensi
Paket:
@azure/keyvault-secrets

SecretClient menyediakan metode untuk mengelola KeyVaultSecret di Key Vault Azure. Klien mendukung pembuatan, pengambilan, pembaruan, penghapusan, pembersihan, pencadangan, pemulihan, dan daftar KeyVaultSecrets. Klien juga mendukung daftar DeletedSecret untuk Key Vault Azure yang diaktifkan penghapusan sementara.

Konstruktor

SecretClient(string, TokenCredential, SecretClientOptions)

Membuat instans SecretClient.

Contoh penggunaan:

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

Properti

vaultUrl

URL dasar ke vault

Metode

backupSecret(string, BackupSecretOptions)

Meminta agar cadangan rahasia yang ditentukan diunduh ke klien. Semua versi rahasia akan diunduh. Operasi ini memerlukan izin rahasia/cadangan.

Contoh penggunaan:

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

Mencadangkan rahasia yang ditentukan.
beginDeleteSecret(string, BeginDeleteSecretOptions)

Menghapus rahasia yang disimpan di Azure Key Vault. Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda menunggu tanpa batas waktu hingga rahasia dihapus.

Operasi ini memerlukan izin rahasia/hapus.

Contoh penggunaan:

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

Menghapus rahasia dari brankas kunci tertentu.
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Memulihkan rahasia yang dihapus di vault yang ditentukan. Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda menunggu tanpa batas waktu hingga rahasia dipulihkan.

Operasi ini memerlukan izin rahasia/pemulihan.

Contoh penggunaan:

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

Memulihkan rahasia yang dihapus ke versi terbaru.
getDeletedSecret(string, GetDeletedSecretOptions)

Metode getDeletedSecret mengembalikan rahasia yang dihapus yang ditentukan bersama dengan atributnya. Operasi ini memerlukan izin rahasia/dapatkan.

Contoh penggunaan:

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

Mendapatkan rahasia yang dihapus yang ditentukan.
getSecret(string, GetSecretOptions)

Metode getSecret berlaku untuk rahasia apa pun yang disimpan di Azure Key Vault. Operasi ini memerlukan izin rahasia/dapatkan.

Contoh penggunaan:

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

Dapatkan rahasia tertentu dari brankas kunci tertentu.
listDeletedSecrets(ListDeletedSecretsOptions)

Melakukan iterasi rahasia yang dihapus di vault. Pengidentifikasi dan atribut rahasia lengkap disediakan dalam respons. Tidak ada nilai yang dikembalikan untuk rahasia. Operasi ini memerlukan izin rahasia/daftar.

Contoh penggunaan:

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

Cantumkan semua rahasia di vault.
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Melakukan iterasi versi terbaru dari semua rahasia di vault. Pengidentifikasi dan atribut rahasia lengkap disediakan dalam respons. Tidak ada nilai yang dikembalikan untuk rahasia. Operasi ini memerlukan izin rahasia/daftar.

Contoh penggunaan:

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

Cantumkan semua rahasia di vault.
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Melakukan iterasi semua versi rahasia yang diberikan di brankas. Pengidentifikasi dan atribut rahasia lengkap disediakan dalam respons. Tidak ada nilai yang dikembalikan untuk rahasia. Operasi ini memerlukan izin rahasia/daftar.

Contoh penggunaan:

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)

Operasi rahasia penghapusan menyeluruh menghapus rahasia secara permanen, tanpa kemungkinan pemulihan. Operasi ini hanya dapat diaktifkan pada vault yang diaktifkan penghapusan sementara. Operasi ini memerlukan izin rahasia/hapus menyeluruh.

Contoh penggunaan:

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

Menghapus rahasia yang ditentukan secara permanen.
restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Memulihkan rahasia yang dicadangkan, dan semua versinya, ke vault. Operasi ini memerlukan izin rahasia/pemulihan.

Contoh penggunaan:

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

Memulihkan rahasia yang dicadangkan ke vault.
setSecret(string, string, SetSecretOptions)

Metode setSecret menambahkan versi rahasia atau rahasia ke Key Vault Azure. Jika rahasia bernama sudah ada, Azure Key Vault membuat versi baru rahasia tersebut. Operasi ini memerlukan izin rahasia/set.

Contoh penggunaan:

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

Menambahkan rahasia dalam brankas kunci tertentu.
updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

Metode updateSecret mengubah atribut tertentu dari rahasia tersimpan yang ada. Properti yang tidak ditentukan dalam permintaan dibiarkan tidak berubah. Nilai rahasia itu sendiri tidak dapat diubah. Operasi ini memerlukan izin rahasia/set.

Contoh penggunaan:

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

Updates atribut yang terkait dengan rahasia tertentu dalam brankas kunci tertentu.

Detail Konstruktor

SecretClient(string, TokenCredential, SecretClientOptions)

Membuat instans SecretClient.

Contoh penggunaan:

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)

Parameter

vaultUrl

string

URL dasar ke vault. Anda harus memvalidasi bahwa URL ini mereferensikan sumber daya Key Vault yang valid. Lihat https://aka.ms/azsdk/blog/vault-uri untuk detailnya.

credential
TokenCredential

Objek yang mengimplementasikan antarmuka yang TokenCredential digunakan untuk mengautentikasi permintaan ke layanan. @azure/identity Gunakan paket untuk membuat kredensial yang sesuai dengan kebutuhan Anda.

pipelineOptions
SecretClientOptions

Opsi alur yang digunakan untuk mengonfigurasi permintaan API Key Vault. Hilangkan parameter ini untuk menggunakan konfigurasi alur default.

Detail Properti

vaultUrl

URL dasar ke vault

vaultUrl: string

Nilai Properti

string

Detail Metode

backupSecret(string, BackupSecretOptions)

Meminta agar cadangan rahasia yang ditentukan diunduh ke klien. Semua versi rahasia akan diunduh. Operasi ini memerlukan izin rahasia/cadangan.

Contoh penggunaan:

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

Mencadangkan rahasia yang ditentukan.

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

Parameter

secretName

string

Nama rahasianya.

options
BackupSecretOptions

Parameter opsional.

Mengembalikan

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

Menghapus rahasia yang disimpan di Azure Key Vault. Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda menunggu tanpa batas waktu hingga rahasia dihapus.

Operasi ini memerlukan izin rahasia/hapus.

Contoh penggunaan:

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

Menghapus rahasia dari brankas kunci tertentu.

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

Parameter

name

string

options
BeginDeleteSecretOptions

Parameter opsional.

Mengembalikan

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

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Memulihkan rahasia yang dihapus di vault yang ditentukan. Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda menunggu tanpa batas waktu hingga rahasia dipulihkan.

Operasi ini memerlukan izin rahasia/pemulihan.

Contoh penggunaan:

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

Memulihkan rahasia yang dihapus ke versi terbaru.

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

Parameter

name

string

options
BeginRecoverDeletedSecretOptions

Parameter opsional.

Mengembalikan

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

getDeletedSecret(string, GetDeletedSecretOptions)

Metode getDeletedSecret mengembalikan rahasia yang dihapus yang ditentukan bersama dengan atributnya. Operasi ini memerlukan izin rahasia/dapatkan.

Contoh penggunaan:

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

Mendapatkan rahasia yang dihapus yang ditentukan.

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

Parameter

secretName

string

Nama rahasianya.

options
GetDeletedSecretOptions

Parameter opsional.

Mengembalikan

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

Metode getSecret berlaku untuk rahasia apa pun yang disimpan di Azure Key Vault. Operasi ini memerlukan izin rahasia/dapatkan.

Contoh penggunaan:

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

Dapatkan rahasia tertentu dari brankas kunci tertentu.

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

Parameter

secretName

string

Nama rahasianya.

options
GetSecretOptions

Parameter opsional.

Mengembalikan

Promise<KeyVaultSecret>

listDeletedSecrets(ListDeletedSecretsOptions)

Melakukan iterasi rahasia yang dihapus di vault. Pengidentifikasi dan atribut rahasia lengkap disediakan dalam respons. Tidak ada nilai yang dikembalikan untuk rahasia. Operasi ini memerlukan izin rahasia/daftar.

Contoh penggunaan:

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

Cantumkan semua rahasia di vault.

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

Parameter

options
ListDeletedSecretsOptions

Parameter opsional.

Mengembalikan

PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Melakukan iterasi versi terbaru dari semua rahasia di vault. Pengidentifikasi dan atribut rahasia lengkap disediakan dalam respons. Tidak ada nilai yang dikembalikan untuk rahasia. Operasi ini memerlukan izin rahasia/daftar.

Contoh penggunaan:

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

Cantumkan semua rahasia di vault.

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

Parameter

options
ListPropertiesOfSecretsOptions

Parameter opsional.

Mengembalikan

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Melakukan iterasi semua versi rahasia yang diberikan di brankas. Pengidentifikasi dan atribut rahasia lengkap disediakan dalam respons. Tidak ada nilai yang dikembalikan untuk rahasia. Operasi ini memerlukan izin rahasia/daftar.

Contoh penggunaan:

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>

Parameter

secretName

string

Nama rahasia untuk mengambil versi.

options
ListPropertiesOfSecretVersionsOptions

Parameter opsional.

Mengembalikan

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

Operasi rahasia penghapusan menyeluruh menghapus rahasia secara permanen, tanpa kemungkinan pemulihan. Operasi ini hanya dapat diaktifkan pada vault yang diaktifkan penghapusan sementara. Operasi ini memerlukan izin rahasia/hapus menyeluruh.

Contoh penggunaan:

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

Menghapus rahasia yang ditentukan secara permanen.

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

Parameter

secretName

string

Nama rahasianya.

options
PurgeDeletedSecretOptions

Parameter opsional.

Mengembalikan

Promise<void>

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Memulihkan rahasia yang dicadangkan, dan semua versinya, ke vault. Operasi ini memerlukan izin rahasia/pemulihan.

Contoh penggunaan:

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

Memulihkan rahasia yang dicadangkan ke vault.

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

Parameter

secretBundleBackup

Uint8Array

Blob cadangan yang terkait dengan bundel rahasia.

options
RestoreSecretBackupOptions

Parameter opsional.

Mengembalikan

Promise<SecretProperties>

setSecret(string, string, SetSecretOptions)

Metode setSecret menambahkan versi rahasia atau rahasia ke Key Vault Azure. Jika rahasia bernama sudah ada, Azure Key Vault membuat versi baru rahasia tersebut. Operasi ini memerlukan izin rahasia/set.

Contoh penggunaan:

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

Menambahkan rahasia dalam brankas kunci tertentu.

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

Parameter

secretName

string

Nama rahasianya.

value

string

Nilai rahasia.

options
SetSecretOptions

Parameter opsional.

Mengembalikan

Promise<KeyVaultSecret>

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

Metode updateSecret mengubah atribut tertentu dari rahasia tersimpan yang ada. Properti yang tidak ditentukan dalam permintaan dibiarkan tidak berubah. Nilai rahasia itu sendiri tidak dapat diubah. Operasi ini memerlukan izin rahasia/set.

Contoh penggunaan:

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

Updates atribut yang terkait dengan rahasia tertentu dalam brankas kunci tertentu.

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

Parameter

secretName

string

Nama rahasianya.

secretVersion

string

Versi rahasia.

options
UpdateSecretPropertiesOptions

Parameter opsional.

Mengembalikan

Promise<SecretProperties>