@azure/keyvault-secrets package

클래스

SecretClient

SecretClient는 Azure Key Vault KeyVaultSecret을 관리하는 메서드를 제공합니다. 클라이언트는 KeyVaultSecrets 만들기, 검색, 업데이트, 삭제, 제거, 백업, 복원 및 나열을 지원합니다. 또한 클라이언트는 일시 삭제를 사용하도록 설정된 Azure Key Vault 대해 DeletedSecret 목록을 지원합니다.

인터페이스

BackupSecretOptions	에 대한 옵션입니다 <xref:backupSecretOptions>.
BeginDeleteSecretOptions	전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스 beginDeleteSecret(string, BeginDeleteSecretOptions)
BeginRecoverDeletedSecretOptions	전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스 beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)
DeletedSecret	삭제된 KeyVault 비밀을 나타내는 인터페이스입니다.
GetDeletedSecretOptions	에 대한 옵션입니다 getDeletedSecret(string, GetDeletedSecretOptions).
GetSecretOptions	에 대한 옵션입니다 getSecret(string, GetSecretOptions).
KeyVaultSecret	이름, 값 및 SecretProperties가 있는 KeyVault 비밀을 나타내는 인터페이스입니다.
KeyVaultSecretIdentifier	Key Vault 비밀 ID를 구성하는 세그먼트를 나타냅니다.
ListDeletedSecretsOptions	에 대한 옵션입니다 listDeletedSecrets(ListDeletedSecretsOptions).
ListPropertiesOfSecretVersionsOptions	에 대한 옵션입니다 listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).
ListPropertiesOfSecretsOptions	에 대한 옵션입니다 listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).
PageSettings	페이징된 반복에 대한 설정을 추적하는 인터페이스
PagedAsyncIterableIterator	완료 및 페이지별로 비동기 반복 가능한 반복을 허용하는 인터페이스입니다.
PollOperationState	PollOperationState에는 장기 실행 작업 폴러를 정의하는 데 필요한 가장 작은 속성 집합의 의견 목록이 포함되어 있습니다. Poller 클래스는 트리거를 시작하고, 대기하고, 잠재적으로 장기 실행 작업을 취소하는 로컬 제어 메커니즘으로 작동하지만 PollOperationState는 원격 장기 실행 작업의 상태를 문서화합니다. 작업이 시작될 때, 완료된 경우 및 취소될 때 적어도 업데이트해야 합니다. 하지만 구현에는 다른 이유로 업데이트할 수 있는 다른 수의 속성이 있을 수 있습니다.
PollerLike	사용자가 작업해야 하는 최소 API만 노출하기 위한 폴러의 추상 표현입니다.
PurgeDeletedSecretOptions	에 대한 옵션입니다 purgeDeletedSecret(string, PurgeDeletedSecretOptions).
RestoreSecretBackupOptions	에 대한 옵션입니다 restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).
SecretClientOptions	KeyVault의 KeyClient에서 허용하는 선택적 매개 변수
SecretPollerOptions	및 <xref:beginRecoverDeletedKey>에 전달할 수 있는 선택적 매개 변수를 beginDeleteSecret(string, BeginDeleteSecretOptions) 나타내는 인터페이스입니다.
SecretProperties	KeyVaultSecret의 속성을 나타내는 인터페이스입니다.
SetSecretOptions	에 대한 옵션입니다 setSecret(string, string, SetSecretOptions).
UpdateSecretPropertiesOptions	에 대한 옵션입니다 updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

형식 별칭

DeletionRecoveryLevel

DeletionRecoveryLevel에 대한 값을 정의합니다. KnownDeletionRecoveryLevel 은 DeletionRecoveryLevel과 서로 교환하여 사용할 수 있습니다. 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 제거 가능: 삭제가 복구할 가능성 없이 되돌릴 수 없는 작업인 자격 증명 모음 상태를 표시합니다. 이 수준은 삭제 작업에 대해 사용할 수 있는 보호가 없음에 해당합니다. 엔터티 수준 이상(자격 증명 모음, 리소스 그룹, 구독 등)에서 삭제 작업을 수락하면 데이터가 돌이킬 수 없을 정도로 손실됩니다. 복구 가능+제거 가능: 삭제를 복구할 수 있는 자격 증명 모음 상태를 표시하며 즉시 영구 삭제(즉, 제거)도 허용합니다. 이 수준은 제거 작업이 요청되거나 구독이 취소되지 않는 한 보존 간격(90일) 동안 삭제된 엔터티의 복구 가능성을 보장합니다. 시스템이 복구되지 않은 경우 90일 후에 영구적으로 삭제합니다. 복구 가능: 즉시 영구 삭제(즉, 제거)할 가능성 없이 삭제를 복구할 수 있는 자격 증명 모음 상태를 나타냅니다. 이 수준은 보존 간격(90일)과 구독을 계속 사용할 수 있는 동안 삭제된 엔터티의 복구 가능성을 보장합니다. 시스템이 복구되지 않은 경우 90일 후에 영구적으로 삭제합니다. Recoveryable+ProtectedSubscription: 보존 간격(90일) 내에 삭제를 복구할 수 있고, 즉시 및 영구 삭제(즉, 제거)가 허용되지 않으며 구독 자체를 영구적으로 취소할 수 없는 자격 증명 모음 및 구독 상태를 나타냅니다. 시스템이 복구되지 않은 경우 90일 후에 영구적으로 삭제합니다. CustomizedRecoverable+Purgeable: 삭제를 복구할 수 있는 자격 증명 모음 상태를 표시하며 즉시 영구 삭제를 허용합니다(즉, 7<= SoftDeleteRetentionInDays < 90일 때 제거). 이 수준은 제거 작업이 요청되거나 구독이 취소되지 않는 한 보존 간격 동안 삭제된 엔터티의 복구 가능성을 보장합니다. CustomizedRecoverable: 즉시 영구 삭제할 가능성 없이 삭제를 복구할 수 있는 자격 증명 모음 상태를 나타냅니다(예: 7<= SoftDeleteRetentionInDays < 90인 경우 제거). 이 수준은 보존 간격 동안 및 구독을 계속 사용할 수 있는 동안 삭제된 엔터티의 복구 가능성을 보장합니다. CustomizedRecoverable+ProtectedSubscription: 삭제가 복구 가능하고, 즉각적이고 영구적인 삭제(즉, 제거)가 허용되지 않으며, 7<= SoftDeleteRetentionInDays < 90일 때 구독 자체를 영구적으로 취소할 수 없는 자격 증명 모음 및 구독 상태를 나타냅니다. 이 수준은 보존 간격 동안 삭제된 엔터티의 복구 가능성을 보장하며 구독 자체를 취소할 수 없다는 사실도 반영합니다.

열거형

KnownDeletionRecoveryLevel

서비스에서 허용하는 DeletionRecoveryLevel 의 알려진 값입니다.

함수

parseKeyVaultSecretIdentifier(string)

지정된 Key Vault 비밀 ID를 구문 분석합니다. 예를 들면 다음과 같습니다. https://.vault.azure.net/secrets// 위의 ID를 구문 분석할 때 이 함수는 다음을 반환합니다. { 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>" }

함수 세부 정보

parseKeyVaultSecretIdentifier(string)

지정된 Key Vault 비밀 ID를 구문 분석합니다. 예를 들면 다음과 같습니다.

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

위의 ID를 구문 분석할 때 이 함수는 다음을 반환합니다.

  {
     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

매개 변수

id

string

Key Vault 비밀의 ID입니다.

반환

KeyVaultSecretIdentifier