@azure/keyvault-certificates package

클래스

CertificateClient

KeyVault 인증서 기능과 상호 작용하는 클라이언트

인터페이스

AdministratorContact	인증서 발급자의 조직 관리자에 대한 세부 정보입니다.
BackupCertificateResult	백업 Blob을 포함하는 백업 인증서 결과입니다.
BeginCreateCertificateOptions	에 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스 beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)
CertificateClientOptions	KeyVault의 CertificateClient에서 허용하는 선택적 매개 변수
CertificateContactAll	자격 증명 모음 인증서에 대한 연락처 정보의 모양입니다.
CertificateIssuer	발급자의 속성을 나타내는 인터페이스입니다.
CertificateOperation	비동기 요청의 경우 인증서 작업이 반환됩니다.
CertificateOperationError	키 자격 증명 모음 서버 오류입니다.
CertificateOperationState	CertificateOperationPoller 상태의 공개적으로 사용 가능한 속성을 나타내는 인터페이스입니다.
CertificatePolicyProperties	주체 속성이 없는 인증서의 정책을 나타내는 인터페이스입니다.
CertificatePollerOptions	및 beginDeleteCertificate(string, CertificatePollerOptions) 에 전달할 수 있는 선택적 매개 변수를 beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)나타내는 인터페이스입니다.beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CertificateProperties	인증서의 속성을 나타내는 인터페이스
CoreSubjectAlternativeNames	X509 개체의 주체 대체 이름입니다.
CreateCertificateOptions	에 대한 옵션입니다 <xref:createCertificate>.
CreateIssuerOptions	에 대한 옵션입니다 createIssuer(string, string, CreateIssuerOptions).
DeletedCertificate	삭제된 인증서를 나타내는 인터페이스입니다.
ErrorModel	키 자격 증명 모음 서버 오류 모델입니다.
ImportCertificateOptions	에 대한 옵션입니다 importCertificate(string, Uint8Array, ImportCertificateOptions).
IssuerAttributes	Key Vault 서비스에서 관리하는 발급자의 특성입니다.
IssuerCredentials	인증서 발급자에서 사용할 자격 증명입니다.
IssuerParameters	인증서의 X509 구성 요소 발급자 매개 변수입니다.
IssuerProperties	인증서 발급자의 속성을 나타내는 인터페이스
KeyVaultCertificate	인증서 정책 없이 인증서를 나타내는 인터페이스
KeyVaultCertificateIdentifier	Key Vault 인증서 ID를 구성하는 세그먼트를 나타냅니다.
KeyVaultCertificatePollOperationState	Key Vault 인증서 폴러 작업의 상태의 공용 모양을 나타내는 인터페이스입니다.
KeyVaultCertificateWithPolicy	정책이 있는 인증서를 나타내는 인터페이스
LifetimeAction	인증서 수명 동안 Key Vault 수행할 작업 및 트리거입니다.
ListDeletedCertificatesOptions	에 전달된 listDeletedCertificates(ListDeletedCertificatesOptions)CertificateClient 페이징 작업에 대한 선택적 매개 변수를 나타내는 인터페이스입니다.
ListPropertiesOfCertificatesOptions	에 전달된 listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)CertificateClient 페이징 작업에 대한 선택적 매개 변수를 나타내는 인터페이스입니다.
PolicySubjectProperties	인증서 정책의 가능한 주체 속성을 나타내는 인터페이스입니다. 최종 형식에는 이러한 속성 중 하나 이상이 있어야 합니다.
PollerLike	사용자가 작업해야 하는 최소 API만 노출하기 위한 폴러의 추상 표현입니다.
SubjectAlternativeNamesAll	인증서 정책 주체의 대체 이름을 나타내는 인터페이스입니다.
UpdateCertificateOptions	에 대한 옵션입니다 <xref:updateCertificate>.
UpdateIssuerOptions	에 대한 옵션입니다 updateIssuer(string, UpdateIssuerOptions).
X509CertificateProperties	인증서의 X509 구성 요소 속성입니다.

형식 별칭

ActionType	ActionType에 대한 값을 정의합니다.
ArrayOneOrMore	적어도 하나의 속성이 있는 배열입니다.
BackupCertificateOptions	에 대한 옵션입니다 backupCertificate(string, OperationOptions).
BeginDeleteCertificateOptions	에 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스 beginDeleteCertificate(string, CertificatePollerOptions)
BeginRecoverDeletedCertificateOptions	에 전달할 수 있는 선택적 매개 변수를 나타내는 인터페이스 beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CancelCertificateOperationOptions	에 대한 옵션입니다 <xref:cancelCertificateOperation>.
CertificateContact	자격 증명 모음 인증서에 대한 연락처 정보입니다. 각 연락처에는 EmailAddress, 이름 또는 전화와 같은 CertificateContactAll 속성 중 하나 이상이 있습니다.
CertificateContentType	contentType에 대한 값을 정의합니다. 가능한 값은 'application/x-pem-file', 'application/x-pkcs12'입니다.
CertificateKeyCurveName	JsonWebKeyCurveName에 대한 값을 정의합니다. <xref:KnownJsonWebKeyCurveName> 는 JsonWebKeyCurveName과 서로 교환하여 사용할 수 있습니다. 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 P-256 P-384 P-521 P-256K
CertificateKeyType	JsonWebKeyType에 대한 값을 정의합니다. <xref:KnownJsonWebKeyType> 는 JsonWebKeyType과 교환하여 사용할 수 있습니다. 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 EC EC-HSM RSA RSA-HSM oct oct-HSM
CertificatePolicy	주체 속성 중 하나 이상이 있는 인증서의 정책을 나타내는 형식입니다.
CertificatePolicyAction	실행할 작업입니다.
CertificateTags	인증서 태그의 모양을 나타내는 인터페이스입니다. 태그는 문자열 키-값 쌍일 뿐입니다.
CreateCertificateState	CreateCertificatePoller 작업 상태의 공용 표현입니다.
DeleteCertificateOperationOptions	에 대한 옵션입니다 deleteCertificateOperation(string, OperationOptions).
DeleteCertificateState	DeleteCertificatePoller 작업 상태의 공용 표현입니다.
DeleteContactsOptions	에 대한 옵션입니다 deleteContacts(OperationOptions).
DeleteIssuerOptions	에 대한 옵션입니다 deleteIssuer(string, OperationOptions).
DeletionRecoveryLevel	DeletionRecoveryLevel에 대한 값을 정의합니다. <xref:KnownDeletionRecoveryLevel> DeletionRecoveryLevel과 서로 교환하여 사용할 수 있습니다. 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 제거 가능: 삭제가 복구 가능성 없이 되돌릴 수 없는 작업인 자격 증명 모음 상태를 표시합니다. 이 수준은 삭제 작업에 대해 사용할 수 있는 보호가 없음에 해당합니다. 엔터티 수준 이상(자격 증명 모음, 리소스 그룹, 구독 등)에서 삭제 작업을 수락하면 데이터가 돌이킬 수 없이 손실됩니다. 복구 가능+제거 가능: 삭제를 복구할 수 있고 즉시 영구 삭제(즉, 제거)도 허용하는 자격 증명 모음 상태를 나타냅니다. 이 수준은 제거 작업이 요청되거나 구독이 취소되지 않는 한 보존 간격(90일) 동안 삭제된 엔터티의 복구 가능성을 보장합니다. 복구되지 않은 경우 시스템은 90일 후에 영구적으로 삭제합니다. 복구 가능: 즉시 영구 삭제(즉, 제거)할 가능성 없이 삭제를 복구할 수 있는 자격 증명 모음 상태를 나타냅니다. 이 수준은 보존 간격(90일) 동안 및 구독을 계속 사용할 수 있는 동안 삭제된 엔터티의 복구 가능성을 보장합니다. 복구되지 않은 경우 시스템은 90일 후에 영구적으로 삭제합니다. Recoveryable+ProtectedSubscription: 보존 간격(90일) 내에 삭제를 복구할 수 있고, 즉시 영구 삭제(즉, 제거)가 허용되지 않으며, 구독 자체를 영구적으로 취소할 수 없는 자격 증명 모음 및 구독 상태를 나타냅니다. 복구되지 않은 경우 시스템은 90일 후에 영구적으로 삭제합니다. CustomizedRecoverable+Purgeable: 삭제를 복구할 수 있고 즉시 영구 삭제를 허용하는 자격 증명 모음 상태를 나타냅니다(즉, 7<= SoftDeleteRetentionInDays < 90일 때 제거). 이 수준은 제거 작업이 요청되거나 구독이 취소되지 않는 한 보존 간격 동안 삭제된 엔터티의 복구 가능성을 보장합니다. CustomizedRecoverable: 즉시 영구 삭제할 가능성 없이 삭제를 복구할 수 있는 자격 증명 모음 상태를 나타냅니다(예: 7<= SoftDeleteRetentionInDays < 90일 때 제거). 이 수준은 보존 간격 동안 및 구독을 계속 사용할 수 있는 동안 삭제된 엔터티의 복구 가능성을 보장합니다. CustomizedRecoverable+ProtectedSubscription: 삭제가 복구 가능하고, 즉각적이고 영구적인 삭제(즉, 제거)가 허용되지 않으며, 7<= SoftDeleteRetentionInDays < 90일 때 구독 자체를 영구적으로 취소할 수 없는 자격 증명 모음 및 구독 상태를 나타냅니다. 이 수준은 보존 간격 동안 삭제된 엔터티의 복구 가능성을 보장하며 구독 자체를 취소할 수 없다는 사실도 반영합니다.
GetCertificateOperationOptions	에 대한 옵션입니다 getCertificateOperation(string, CertificatePollerOptions).
GetCertificateOptions	에 대한 옵션입니다 getCertificate(string, OperationOptions).
GetCertificatePolicyOptions	에 대한 옵션입니다 getCertificatePolicy(string, OperationOptions).
GetCertificateVersionOptions	에 대한 옵션입니다 getCertificateVersion(string, string, OperationOptions).
GetContactsOptions	에 대한 옵션입니다 getContacts(OperationOptions).
GetDeletedCertificateOptions	에 대한 옵션입니다 getDeletedCertificate(string, OperationOptions).
GetIssuerOptions	에 대한 옵션입니다 getIssuer(string, OperationOptions).
GetPlainCertificateOperationOptions	에 대한 옵션입니다 <xref:getPlainCertificateOperation>.
ImportCertificatePolicy	SAN 또는 주체가 필요하지 않은 가져오기에 대한 인증서의 정책을 나타내는 형식입니다.
KVPollerLike	core-lro의 PollerLike의 사용되지 않는 KeyVault 복사본입니다.
KeyUsageType	KeyUsageType에 대한 값을 정의합니다. <xref:KnownKeyUsageType> KeyUsageType과 교환하여 사용할 수 있습니다. 이 열거형에는 서비스에서 지원하는 알려진 값이 포함됩니다. 서비스에서 지원하는 알려진 값 digitalSignature nonRepudiation keyEncipherment dataEncipherment keyAgreement keyCertSign cRLSign encipherOnly decipherOnly
ListPropertiesOfCertificateVersionsOptions	에 전달된 listPropertiesOfCertificateVersions(string, OperationOptions)CertificateClient 페이징 작업에 대한 선택적 매개 변수를 나타내는 인터페이스입니다.
ListPropertiesOfIssuersOptions	에 전달된 listPropertiesOfIssuers(OperationOptions)CertificateClient 페이징 작업에 대한 선택적 매개 변수를 나타내는 인터페이스입니다.
MergeCertificateOptions	에 대한 선택적 매개 변수를 나타내는 인터페이스입니다 mergeCertificate(string, Uint8Array[], OperationOptions).
PurgeDeletedCertificateOptions	에 대한 옵션입니다 purgeDeletedCertificate(string, OperationOptions).
RecoverDeletedCertificateState	사용되지 않음: 삭제된 인증서 폴링 작업의 복구에 대한 공개 표현
RequireAtLeastOne	RequireAtLeastOne은 인터페이스의 속성 중 하나 이상(모든 속성일 수 있음)이 있어야 하는 형식을 만드는 데 도움이 됩니다. 이는 TypeScript의 유틸리티 형식 https://www.typescriptlang.org/docs/handbook/utility-types.html 으로 인해 작동합니다. 살펴보겠습니다. [K in keyof T]-? 이 속성(K)은 T의 속성과 이름이 같은 경우에만 유효합니다. Required<Pick<T, K>> 는 반복에서 현재 속성만 사용하여 T에서 새 형식을 만들고 필요에 따라 표시합니다. Partial<Pick<T, Exclude<keyof T, K>>> 는 속성 K를 제외하고 T의 모든 속성을 사용하여 새 형식을 만듭니다. &는 의 모든 선택적 Partial<...>속성과 에서 Required<...> 하나의 필수 속성만 사용하여 형식을 결합하는 것입니다. [keyof T] 는 T의 속성만 허용되도록 합니다.
RestoreCertificateBackupOptions	에 대한 선택적 매개 변수를 나타내는 인터페이스입니다 restoreCertificateBackup(Uint8Array, OperationOptions).
SetContactsOptions	에 대한 옵션입니다 setContacts(CertificateContact[], OperationOptions).
SubjectAlternativeNames	주체 속성에 대한 대안입니다. 있는 경우 SubjectAlternativeNamesAll의 속성 중 하나 이상이 있어야 합니다.
UpdateCertificatePolicyOptions	에 대한 옵션입니다 updateCertificatePolicy(string, CertificatePolicy, OperationOptions).

열거형

KnownCertificateKeyCurveNames	서비스에서 허용하는 CertificateKeyCurveName 의 알려진 값입니다.
KnownCertificateKeyTypes	서비스에서 허용하는 CertificateKeyType 의 알려진 값입니다.
KnownDeletionRecoveryLevels	서비스에서 허용하는 DeletionRecoveryLevel 의 알려진 값입니다.
KnownKeyUsageTypes	서비스에서 허용하는 KeyUsageType 의 알려진 값입니다.
WellKnownIssuer	기본값을 선택하는 데 잘 알려진 발급자

함수

parseKeyVaultCertificateIdentifier(string)

지정된 Key Vault 인증서 ID를 구문 분석합니다. 예를 들면 다음과 같습니다. https://.vault.azure.net/certificates// 위의 ID를 구문 분석할 때 이 함수는 다음을 반환합니다. { sourceId: "https://<keyvault-name>.vault.azure.net/certificates/<certificate-name>/<unique-version-id>", vaultUrl: "https://<keyvault-name>.vault.azure.net", version: "<unique-version-id>", name: "<certificate-name>" }

함수 세부 정보

parseKeyVaultCertificateIdentifier(string)

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

https://.vault.azure.net/certificates//

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

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

function parseKeyVaultCertificateIdentifier(id: string): KeyVaultCertificateIdentifier

매개 변수

id

string

Key Vault 인증서의 ID입니다.

반환

KeyVaultCertificateIdentifier