Delen via

@azure/keyvault-secrets package

  • Referentie

Klassen

SecretClient

SecretClient biedt methoden voor het beheren van KeyVaultSecret- in Azure Key Vault. De client ondersteunt het maken, ophalen, bijwerken, verwijderen, opschonen, back-ups maken, herstellen en vermelden van KeyVaultSecrets. De client biedt ook ondersteuning voor het weergeven van DeletedSecret- voor een voorlopig verwijderen ingeschakelde Azure Key Vault.

Interfaces

BackupSecretOptions

Opties voor <xref:backupSecretOptions>.
BeginDeleteSecretOptions

Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan beginDeleteSecret(string, BeginDeleteSecretOptions)
BeginRecoverDeletedSecretOptions

Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)
DeletedSecret

Een interface die een verwijderd KeyVault-geheim vertegenwoordigt.
GetDeletedSecretOptions

Opties voor getDeletedSecret(string, GetDeletedSecretOptions).
GetSecretOptions

Opties voor getSecret(string, GetSecretOptions).
KeyVaultSecret

Een interface die een KeyVault-geheim vertegenwoordigt, met de naam, waarde en SecretProperties.
KeyVaultSecretIdentifier

Vertegenwoordigt de segmenten die een Key Vault-geheim-id opstellen.
ListDeletedSecretsOptions

Opties voor listDeletedSecrets(ListDeletedSecretsOptions).
ListPropertiesOfSecretVersionsOptions

Opties voor listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).
ListPropertiesOfSecretsOptions

Opties voor listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).
PageSettings

Een interface waarmee de instellingen voor gepaginade iteratie worden bijgehouden
PagedAsyncIterableIterator

Een interface waarmee asynchrone iteratie zowel kan worden voltooid als per pagina.
PollOperationState

PollOperationState bevat een meningsopgave van de kleinste set eigenschappen die nodig zijn om een poller voor langdurige bewerkingen te definiëren.

Terwijl de Poller-klasse werkt als het lokale controlemechanisme om te beginnen met activeren, wachten op en mogelijk een langdurige bewerking annuleren, documenteert de PollOperationState de status van de externe langdurige bewerking.

Deze moet ten minste worden bijgewerkt wanneer de bewerking wordt gestart, wanneer deze is voltooid en wanneer deze wordt geannuleerd. Implementaties kunnen echter elk ander aantal eigenschappen hebben dat door andere redenen kan worden bijgewerkt.
PollerLike

Abstracte weergave van een poller, bedoeld om alleen de minimale API weer te geven waarmee de gebruiker moet werken.
PurgeDeletedSecretOptions

Opties voor purgeDeletedSecret(string, PurgeDeletedSecretOptions).
RestoreSecretBackupOptions

Opties voor restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).
SecretClientOptions

De optionele parameters die worden geaccepteerd door keyvault's KeyClient
SecretPollerOptions

Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan beginDeleteSecret(string, BeginDeleteSecretOptions) en <xref:beginRecoverDeletedKey>.
SecretProperties

Een interface die de eigenschappen van een KeyVaultSecretvertegenwoordigt.
SetSecretOptions

Opties voor setSecret(string, string, SetSecretOptions).
UpdateSecretPropertiesOptions

Opties voor updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

Type-aliassen

DeletionRecoveryLevel

Definieert waarden voor DeletionRecoveryLevel.
KnownDeletionRecoveryLevel kan door elkaar worden gebruikt met DeletionRecoveryLevel, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

verwijderbare: geeft een kluisstatus aan waarin verwijdering een ongedaanbare bewerking is, zonder de mogelijkheid voor herstel. Dit niveau komt overeen met geen beveiliging die beschikbaar is tegen een verwijderbewerking; de gegevens verloren gaan bij het accepteren van een verwijderbewerking op entiteitsniveau of hoger (kluis, resourcegroep, abonnement, enzovoort)
Recoverable+Purgeable: Geeft een kluisstatus aan waarin verwijdering kan worden hersteld, en die ook onmiddellijke en permanente verwijdering toestaat (d.w.w.v. opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval (90 dagen), tenzij er een opschoningsbewerking wordt aangevraagd of het abonnement wordt geannuleerd. Het systeem wordt na 90 dagen definitief verwijderd, indien niet hersteld
Herstelbare: Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid om onmiddellijk en permanent te worden verwijderd (bijvoorbeeld opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval (90 dagen) en terwijl het abonnement nog steeds beschikbaar is. Het systeem wordt na 90 dagen definitief verwijderd, indien niet hersteld
Recoverable+ProtectedSubscription: Geeft een kluis en abonnementsstatus aan waarin verwijdering kan worden hersteld binnen het retentieinterval (90 dagen), onmiddellijke en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet permanent kan worden geannuleerd. Het systeem wordt na 90 dagen definitief verwijderd, indien niet hersteld
CustomizedRecoverable+Purgeable: Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en waarmee ook onmiddellijke en permanente verwijdering wordt toegestaan (d.w.w.v. opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval, tenzij er een opschoningsbewerking wordt aangevraagd of het abonnement wordt geannuleerd.
CustomizedRecoverable: Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid om onmiddellijk en permanent te worden verwijderd (dat wil bijvoorbeeld verwijderen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en terwijl het abonnement nog steeds beschikbaar is.
CustomizedRecoverable+ProtectedSubscription: Geeft een kluis- en abonnementsstatus aan waarin verwijdering herstelbaar, onmiddellijk en permanent verwijderen (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet permanent kan worden geannuleerd wanneer 7<= SoftDeleteRetentionInDays < 90. Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en weerspiegelt ook het feit dat het abonnement zelf niet kan worden geannuleerd.

Enums

KnownDeletionRecoveryLevel

Bekende waarden van DeletionRecoveryLevel die de service accepteert.

Functies

parseKeyVaultSecretIdentifier(string)

Parseert de opgegeven sleutelkluisgeheim-id. Een voorbeeld hiervan is:

https://.vault.azure.net/secrets//

Bij het parseren van de bovenstaande id retourneert deze functie:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<secret-name>"
  }

Functiedetails

parseKeyVaultSecretIdentifier(string)

Parseert de opgegeven sleutelkluisgeheim-id. Een voorbeeld hiervan is:

https://.vault.azure.net/secrets//

Bij het parseren van de bovenstaande id retourneert deze functie:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<secret-name>"
  }

function parseKeyVaultSecretIdentifier(id: string): KeyVaultSecretIdentifier

Parameters

id

string

De id van het sleutelkluisgeheim.

Retouren

KeyVaultSecretIdentifier