Delen via

@azure/keyvault-secrets package

  • Referentie

Klassen

SecretClient

SecretClient biedt methoden voor het beheren van KeyVaultSecret in de 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 Azure-Key Vault waarvoor voorlopig verwijderen is ingeschakeld.

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 waaruit een Key Vault geheime id bestaat.
ListDeletedSecretsOptions

Opties voor listDeletedSecrets(ListDeletedSecretsOptions).
ListPropertiesOfSecretVersionsOptions

Opties voor listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).
ListPropertiesOfSecretsOptions

Opties voor listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).
PageSettings

Een interface die de instellingen voor pagina-iteratie bijhoudt
PagedAsyncIterableIterator

Een interface waarmee asynchrone iteratie zowel naar voltooiing als per pagina kan worden uitgevoerd.
PollOperationState

PollOperationState bevat een eigen gemaakte lijst met de kleinste set eigenschappen die nodig zijn om een poller voor langdurige bewerkingen te definiëren.

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

De bewerking moet ten minste worden bijgewerkt wanneer de bewerking wordt gestart, voltooid en geannuleerd. Implementaties kunnen echter een ander aantal eigenschappen hebben dat om andere redenen kan worden bijgewerkt.
PollerLike

Abstracte weergave van een poller, bedoeld om alleen de minimale API beschikbaar te maken 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 de KeyClient van KeyVault
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 KeyVaultSecret vertegenwoordigt.
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. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Opschoonbaar: geeft een kluisstatus aan waarin het verwijderen een onomkeerbare bewerking is, zonder de mogelijkheid tot herstel. Dit niveau komt overeen met het feit dat er geen bescherming beschikbaar is tegen een Verwijderbewerking; de gegevens gaan onherroepelijk verloren bij het accepteren van een verwijderbewerking op entiteitsniveau of hoger (kluis, resourcegroep, abonnement, enzovoort)
Herstelbaar+opschoonbaar: geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (dat wil zeggen opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval (90 dagen), tenzij een opschoonbewerking wordt aangevraagd of het abonnement wordt geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld
Herstelbaar: geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid tot onmiddellijke en permanente verwijdering (dat wil zeggen opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval (90 dagen) en zolang het abonnement nog beschikbaar is. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld
Recoverable+ProtectedSubscription: geeft een kluis- en abonnementsstatus aan waarin verwijdering kan worden hersteld binnen een retentieperiode (90 dagen), directe en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet permanent kan worden geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld
CustomizedRecoverable+Purgeable: geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (dat wil zeggen opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval, tenzij een opschoningsbewerking wordt aangevraagd of het abonnement wordt geannuleerd.
CustomizedRecoverable: geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid tot onmiddellijke en permanente verwijdering (dat wil zeggen opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en zolang het abonnement nog beschikbaar is.
CustomizedRecoverable+ProtectedSubscription: geeft een kluis- en abonnementsstatus aan waarin verwijdering herstelbaar is, onmiddellijke en permanente verwijdering (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 Key Vault geheime id. Een voorbeeld 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 Key Vault geheime id. Een voorbeeld 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 Key Vault Geheim.

Retouren

KeyVaultSecretIdentifier