Dela via

@azure/keyvault-secrets package

  • Referens

Klasser

SecretClient

SecretClient innehåller metoder för att hantera KeyVaultSecret- i Azure Key Vault. Klienten har stöd för att skapa, hämta, uppdatera, ta bort, rensa, säkerhetskopiera, återställa och lista KeyVaultSecrets. Klienten har också stöd för DeletedSecret- för ett aktiverat Azure Key Vault med mjuk borttagning.

Gränssnitt

BackupSecretOptions

Alternativ för <xref:backupSecretOptions>.
BeginDeleteSecretOptions

Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginDeleteSecret(string, BeginDeleteSecretOptions)
BeginRecoverDeletedSecretOptions

Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)
DeletedSecret

Ett gränssnitt som representerar en borttagen KeyVault-hemlighet.
GetDeletedSecretOptions

Alternativ för getDeletedSecret(string, GetDeletedSecretOptions).
GetSecretOptions

Alternativ för getSecret(string, GetSecretOptions).
KeyVaultSecret

Ett gränssnitt som representerar en KeyVault-hemlighet med dess namn, värde och SecretProperties.
KeyVaultSecretIdentifier

Representerar de segment som utgör ett Hemligt Nyckelvalvs-ID.
ListDeletedSecretsOptions

Alternativ för listDeletedSecrets(ListDeletedSecretsOptions).
ListPropertiesOfSecretVersionsOptions

Alternativ för listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).
ListPropertiesOfSecretsOptions

Alternativ för listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).
PageSettings

Ett gränssnitt som spårar inställningarna för sidsidig iteration
PagedAsyncIterableIterator

Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida.
PollOperationState

PollOperationState innehåller en åsiktslista över den minsta uppsättning egenskaper som behövs för att definiera en tidskrävande åtgärdsbestämning.

Medan Klassen Poller fungerar som den lokala kontrollmekanismen för att börja utlösa, vänta på och eventuellt avbryta en tidskrävande åtgärd, dokumenterar PollOperationState statusen för fjärråtgärden som körs länge.

Den bör uppdateras åtminstone när åtgärden startas, när den är klar och när den avbryts. Implementeringar kan dock ha valfritt annat antal egenskaper som kan uppdateras av andra orsaker.
PollerLike

Abstrakt representation av en poller, avsedd att exponera bara det minimala API som användaren behöver arbeta med.
PurgeDeletedSecretOptions

Alternativ för purgeDeletedSecret(string, PurgeDeletedSecretOptions).
RestoreSecretBackupOptions

Alternativ för restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).
SecretClientOptions

De valfria parametrar som godkänts av KeyVaults KeyClient
SecretPollerOptions

Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginDeleteSecret(string, BeginDeleteSecretOptions) och <xref:beginRecoverDeletedKey>.
SecretProperties

Ett gränssnitt som representerar egenskaperna för en KeyVaultSecret.
SetSecretOptions

Alternativ för setSecret(string, string, SetSecretOptions).
UpdateSecretPropertiesOptions

Alternativ för updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

Typalias

DeletionRecoveryLevel

Definierar värden för DeletionRecoveryLevel.
KnownDeletionRecoveryLevel kan användas omväxlande med DeletionRecoveryLevel innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Purgeable: Anger ett valvtillstånd där borttagning är en oåterkallelig åtgärd, utan möjlighet till återställning. Den här nivån motsvarar att inget skydd är tillgängligt mot en borttagningsåtgärd. data går oåterkalleligen förlorade när en borttagningsåtgärd godkänns på entitetsnivå eller högre (valv, resursgrupp, prenumeration osv.)
Recoverable+Purgeable: Anger ett valvtillstånd där borttagningen kan återställas och som också tillåter omedelbar och permanent borttagning (d.v.s. rensning). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet (90 dagar), såvida inte en rensningsåtgärd begärs eller prenumerationen avbryts. Systemet tar bort det permanent efter 90 dagar, om det inte återställs
Återställningsbar: Anger ett valvtillstånd där borttagningen kan återställas utan möjlighet till omedelbar och permanent borttagning (dvs. rensning). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet (90 dagar) och medan prenumerationen fortfarande är tillgänglig. Systemet tar bort det permanent efter 90 dagar, om det inte återställs
Recoverable+ProtectedSubscription: Anger ett valv- och prenumerationstillstånd där borttagningen kan återställas inom kvarhållningsintervallet (90 dagar), omedelbar och permanent borttagning (d.v.s. rensning) är inte tillåten och där själva prenumerationen inte kan avbrytas permanent. Systemet tar bort det permanent efter 90 dagar, om det inte återställs
CustomdRecoverable+Purgeable: Anger ett valvtillstånd där borttagning kan återställas och som också tillåter omedelbar och permanent borttagning (dvs. rensa när 7<= SoftDeleteRetentionInDays < 90). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet, såvida inte en rensningsåtgärd begärs eller prenumerationen avbryts.
CustomdRecoverable: Anger ett valvtillstånd där borttagning kan återställas utan möjlighet till omedelbar och permanent borttagning (dvs. rensa när 7<= SoftDeleteRetentionInDays < 90). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet och medan prenumerationen fortfarande är tillgänglig.
CustomdRecoverable+ProtectedSubscription: Anger ett valv- och prenumerationstillstånd där borttagning kan återställas, omedelbar och permanent borttagning (dvs. rensning) tillåts inte och där själva prenumerationen inte kan avbrytas permanent när 7<= SoftDeleteRetentionInDays < 90. Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet och återspeglar även det faktum att själva prenumerationen inte kan avbrytas.

Uppräkningar

KnownDeletionRecoveryLevel

Kända värden för DeletionRecoveryLevel som tjänsten accepterar.

Funktioner

parseKeyVaultSecretIdentifier(string)

Parsar det angivna nyckelvalvets hemliga ID. Ett exempel är:

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

Vid parsning av ovanstående ID returnerar den här funktionen:

  {
     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>"
  }

Funktionsinformation

parseKeyVaultSecretIdentifier(string)

Parsar det angivna nyckelvalvets hemliga ID. Ett exempel är:

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

Vid parsning av ovanstående ID returnerar den här funktionen:

  {
     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

Parametrar

id

string

ID:t för Key Vault-hemligheten.

Returer

KeyVaultSecretIdentifier