Udostępnij za pośrednictwem

CertificateClient class

  • Odwołanie
Pakiet:
@azure/keyvault-certificates

Klient korzystający z funkcji certyfikatów usługi KeyVault

Konstruktory

CertificateClient(string, TokenCredential, CertificateClientOptions)

Tworzy wystąpienie klasy CertificateClient.

Właściwości

vaultUrl

Podstawowy adres URL magazynu

Metody

backupCertificate(string, OperationOptions)

Żąda pobrania kopii zapasowej określonego certyfikatu do klienta. Zostaną pobrane wszystkie wersje certyfikatu. Ta operacja wymaga uprawnień certyfikatów/kopii zapasowej.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const backup = await client.backupCertificate("MyCertificate");

Generuje kopię zapasową certyfikatu
beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Tworzy nowy certyfikat. Jeśli jest to pierwsza wersja, zostanie utworzony zasób certyfikatu. Ta funkcja zwraca poller operacji długotrwałej, która umożliwia oczekiwanie na czas nieokreślony, aż certyfikat zostanie w pełni odzyskany.

Uwaga: Wysłanie Self jako issuerName zasad certyfikatu spowoduje utworzenie certyfikatu z podpisem własnym.

Ta operacja wymaga uprawnień do certyfikatów/tworzenia.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
const certificatePolicy = {
  issuerName: "Self",
  subject: "cn=MyCert"
};
const createPoller = await client.beginCreateCertificate("MyCertificate", certificatePolicy);

// The pending certificate can be obtained by calling the following method:
const pendingCertificate = createPoller.getResult();

// Serializing the poller
const serialized = createPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginCreateCertificate("MyCertificate", certificatePolicy, { resumeFrom: serialized });

// Waiting until it's done
const certificate = await createPoller.pollUntilDone();
console.log(certificate);

Tworzy certyfikat
beginDeleteCertificate(string, CertificatePollerOptions)

Operacja DELETE ma zastosowanie do dowolnego certyfikatu przechowywanego w usłudze Azure Key Vault. Nie można zastosować usuwania do pojedynczej wersji certyfikatu. Ta funkcja zwraca poller operacji długotrwałej, która umożliwia oczekiwanie na czas nieokreślony, aż certyfikat zostanie w pełni odzyskany.

Ta operacja wymaga uprawnienia do certyfikatów/usuwania.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
const createPoller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await createPoller.pollUntilDone();

const deletePoller = await client.beginDeleteCertificate("MyCertificate");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteCertificate("MyCertificate", { resumeFrom: serialized });

// Waiting until it's done
const deletedCertificate = await deletePoller.pollUntilDone();
console.log(deletedCertificate);

Usuwa certyfikat z określonego magazynu kluczy.
beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Odzyskuje usunięty certyfikat w określonym magazynie. Tę operację można wykonać tylko w magazynie z włączoną obsługą usuwania nietrwałego. Ta operacja Ta funkcja zwraca poller operacji długotrwałej, która umożliwia oczekiwanie na czas nieokreślony do całkowitego odzyskania certyfikatu.

Ta operacja wymaga uprawnień certyfikatów/odzyskiwania.

Przykład użycia: 

const client = new CertificateClient(url, credentials);

const deletePoller = await client.beginDeleteCertificate("MyCertificate");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedCertificate("MyCertificate");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedCertificate("MyCertificate", { resumeFrom: serialized });

// Waiting until it's done
const certificate = await recoverPoller.pollUntilDone();
console.log(certificate);

Odzyskuje usunięty certyfikat
createIssuer(string, string, CreateIssuerOptions)

Operacja createIssuer dodaje lub aktualizuje określonego wystawcę certyfikatu. Ta operacja wymaga uprawnień certyfikatów/setisuers.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");

Ustawia określonego wystawcę certyfikatu.
deleteCertificateOperation(string, OperationOptions)

Usuwa operację tworzenia dla określonego certyfikatu, który jest w trakcie tworzenia. Certyfikat nie jest już tworzony. Ta operacja wymaga uprawnień do certyfikatów/aktualizacji.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await client.deleteCertificateOperation("MyCertificate");
await client.getCertificateOperation("MyCertificate"); // Throws error: Pending certificate not found: "MyCertificate"

Usuwanie operacji certyfikatu
deleteContacts(OperationOptions)

Usuwa wszystkie kontakty certyfikatów. Ta operacja wymaga uprawnień certificates/managecontacts.

Przykład użycia: 

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);
await client.deleteContacts();

Usuwa wszystkie kontakty certyfikatów
deleteIssuer(string, OperationOptions)

Operacja deleteIssuer trwale usuwa określonego wystawcę certyfikatu z magazynu. Ta operacja wymaga uprawnień certificates/manageissuers/deleteissuers.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Provider");
await client.deleteIssuer("IssuerName");

Usuwa określonego wystawcę certyfikatu.
getCertificate(string, OperationOptions)

Pobiera najnowsze informacje dostępne z określonego certyfikatu, w tym zasady certyfikatu. Ta operacja wymaga uprawnień do certyfikatów/pobierania.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
const poller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await poller.pollUntilDone();
const certificate = await client.getCertificate("MyCertificate");
console.log(certificate);

Pobiera certyfikat z nazwy certyfikatu (łącznie z zasadami certyfikatu)
getCertificateOperation(string, CertificatePollerOptions)

Pobiera operację tworzenia skojarzona z określonym certyfikatem. Ta operacja wymaga uprawnień do certyfikatów/pobierania. Ta funkcja zwraca poller operacji długotrwałej, która umożliwia oczekiwanie na czas nieokreślony, aż certyfikat zostanie w pełni odzyskany.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
const createPoller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});

const poller = await client.getCertificateOperation("MyCertificate");
const pendingCertificate = poller.getResult();

const certificateOperation = poller.getOperationState().certificateOperation;
console.log(certificateOperation);

Pobiera operację poller certyfikatu
getCertificatePolicy(string, OperationOptions)

Operacja getCertificatePolicy zwraca określone zasoby zasad certyfikatu w określonym magazynie kluczy. Ta operacja wymaga uprawnień do certyfikatów/pobierania.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const policy = await client.getCertificatePolicy("MyCertificate");
console.log(policy);

Pobiera zasady certyfikatu
getCertificateVersion(string, string, OperationOptions)

Pobiera informacje o określonym certyfikacie w określonej wersji. Nie zwróci zasad certyfikatu. Ta operacja wymaga uprawnień do certyfikatów/pobierania.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
const poller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await poller.pollUntilDone();
const certificateWithPolicy = await client.getCertificate("MyCertificate");
const certificate = await client.getCertificateVersion("MyCertificate", certificateWithPolicy.properties.version!);
console.log(certificate);

Pobiera certyfikat z nazwy certyfikatu i określonej wersji
getContacts(OperationOptions)

Zwraca zestaw zasobów kontaktowych certyfikatu w określonym magazynie kluczy. Ta operacja wymaga uprawnień certificates/managecontacts.

Przykład użycia: 

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);
const contacts = await client.getContacts();
console.log(contacts);

Ustawia kontakty certyfikatów.
getDeletedCertificate(string, OperationOptions)

pobiera usunięte informacje o certyfikacie oraz jego atrybuty, takie jak interwał przechowywania, zaplanowane trwałe usunięcie i bieżący poziom odzyskiwania usuwania. Ta operacja wymaga uprawnień do certyfikatów/pobierania.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
const deletedCertificate = await client.getDeletedCertificate("MyDeletedCertificate");
console.log("Deleted certificate:", deletedCertificate);

Pobiera usunięty certyfikat
getIssuer(string, OperationOptions)

Operacja getIssuer zwraca określone zasoby wystawcy certyfikatów w określonym magazynie kluczy. Ta operacja wymaga uprawnień certificates/manageissuers/getissuers.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
const certificateIssuer = await client.getIssuer("IssuerName");
console.log(certificateIssuer);

Pobiera określonego wystawcę certyfikatu.
importCertificate(string, Uint8Array, ImportCertificateOptions)

Importuje istniejący prawidłowy certyfikat zawierający klucz prywatny do usługi Azure Key Vault. Certyfikat do zaimportowania może być w formacie PFX lub PEM. Jeśli certyfikat jest w formacie PEM, plik PEM musi zawierać klucz, a także certyfikaty x509. Ta operacja wymaga uprawnień do certyfikatów/importu.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
// See: @azure/keyvault-secrets
const certificateSecret = await secretClient.getSecret("MyCertificate");
const base64EncodedCertificate = certificateSecret.value!;
let buffer: Uint8Array;

if (isNode) {
  buffer = Buffer.from(base64EncodedCertificate, "base64");
} else {
  buffer = Uint8Array.from(atob(base64EncodedCertificate), (c) => c.charCodeAt(0));
}

await client.importCertificate("MyCertificate", buffer);

Importuje certyfikat z wartości wpisu tajnego certyfikatu
listDeletedCertificates(ListDeletedCertificatesOptions)

Pobiera certyfikaty w bieżącym magazynie, które są w stanie usuniętym i są gotowe do odzyskiwania lub przeczyszczania. Ta operacja obejmuje informacje specyficzne dla usuwania. Ta operacja wymaga uprawnień certyfikatów/get/list. Tę operację można włączyć tylko w magazynach z włączoną obsługą usuwania nietrwałego.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
for await (const deletedCertificate of client.listDeletedCertificates()) {
  console.log(deletedCertificate);
}
for await (const page of client.listDeletedCertificates().byPage()) {
  for (const deletedCertificate of page) {
    console.log(deletedCertificate);
  }
}

Wyświetla listę usuniętych certyfikatów
listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Iteruje najnowszą wersję wszystkich certyfikatów w magazynie. Pełny identyfikator certyfikatu i atrybuty są podane w odpowiedzi. Nie są zwracane żadne wartości dla certyfikatów. Ta operacja wymaga uprawnień do certyfikatów/listy.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
// All in one call
for await (const certificateProperties of client.listPropertiesOfCertificates()) {
  console.log(certificateProperties);
}
// By pages
for await (const page of client.listPropertiesOfCertificates().byPage()) {
  for (const certificateProperties of page) {
    console.log(certificateProperties);
  }
}

Wyświetl listę wszystkich wersji określonego certyfikatu.
listPropertiesOfCertificateVersions(string, OperationOptions)

Zwraca wersje certyfikatu w określonym magazynie kluczy. Ta operacja wymaga uprawnień certyfikatów/listy.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
for await (const certificateProperties of client.listPropertiesOfCertificateVersions("MyCertificate")) {
  console.log(certificateProperties.version!);
}

Wyświetl listę wersji certyfikatu.
listPropertiesOfIssuers(OperationOptions)

Zwraca zestaw zasobów wystawcy certyfikatów w określonym magazynie kluczy. Ta operacja wymaga uprawnień certificates/manageissuers/getissuers.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
// All in one call
for await (const issuerProperties of client.listPropertiesOfIssuers()) {
  console.log(issuerProperties);
}
// By pages
for await (const page of client.listPropertiesOfIssuers().byPage()) {
  for (const issuerProperties of page) {
    console.log(issuerProperties);
  }
}

Wyświetl listę wystawców certyfikatów.
mergeCertificate(string, Uint8Array[], OperationOptions)

Wykonuje scalanie certyfikatu lub łańcucha certyfikatów z parą kluczy obecnie dostępną w usłudze. Ta operacja wymaga uprawnień do certyfikatów/tworzenia.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Unknown",
  subject: "cn=MyCert"
});
const poller = await client.getCertificateOperation("MyCertificate");
const { csr } = poller.getOperationState().certificateOperation!;
const base64Csr = Buffer.from(csr!).toString("base64");
const wrappedCsr = ["-----BEGIN CERTIFICATE REQUEST-----", base64Csr, "-----END CERTIFICATE REQUEST-----"].join("\n");

const fs = require("fs");
fs.writeFileSync("test.csr", wrappedCsr);

// Certificate available locally made using:
//   openssl genrsa -out ca.key 2048
//   openssl req -new -x509 -key ca.key -out ca.crt
// You can read more about how to create a fake certificate authority here: https://gist.github.com/Soarez/9688998

const childProcess = require("child_process");
childProcess.execSync("openssl x509 -req -in test.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out test.crt");
const base64Crt = fs.readFileSync("test.crt").toString().split("\n").slice(1, -1).join("");

await client.mergeCertificate("MyCertificate", [Buffer.from(base64Crt)]);

Scala podpisane żądanie certyfikatu z oczekującym certyfikatem
purgeDeletedCertificate(string, OperationOptions)

Wykonuje nieodwracalne usunięcie określonego certyfikatu bez możliwości odzyskania. Operacja jest niedostępna, jeśli poziom odzyskiwania nie określa wartości "Przeczyszczalne". Ta operacja wymaga uprawnienia certyfikatu/przeczyszczania.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
const deletePoller = await client.beginDeleteCertificate("MyCertificate");
await deletePoller.pollUntilDone();
// Deleting a certificate takes time, make sure to wait before purging it
client.purgeDeletedCertificate("MyCertificate");

Pobiera usunięty certyfikat
restoreCertificateBackup(Uint8Array, OperationOptions)

Przywraca kopię zapasową certyfikatu i wszystkie jego wersje do magazynu. Ta operacja wymaga uprawnień do certyfikatów/przywracania.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const backup = await client.backupCertificate("MyCertificate");
const poller = await client.beginDeleteCertificate("MyCertificate");
await poller.pollUntilDone();
// Some time is required before we're able to restore the certificate
await client.restoreCertificateBackup(backup!);

Przywraca certyfikat z kopii zapasowej
setContacts(CertificateContact[], OperationOptions)

Ustawia kontakty certyfikatów dla magazynu kluczy. Ta operacja wymaga uprawnień certificates/managecontacts.

Przykład użycia: 

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);

Ustawia kontakty certyfikatów.
updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Aktualizacje zasady certyfikatu dla określonego certyfikatu. Ta operacja wymaga uprawnień do certyfikatów/aktualizacji. Pobiera zasady certyfikatu
updateCertificateProperties(string, string, UpdateCertificateOptions)

Stosuje określoną aktualizację danego certyfikatu; jedynymi zaktualizowanymi elementami są atrybuty certyfikatu. Ta operacja wymaga uprawnień do certyfikatów/aktualizacji.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});

// You may pass an empty string for version which will update
// the latest version of the certificate
await client.updateCertificateProperties("MyCertificate", "", {
  tags: {
    customTag: "value"
  }
});

Aktualizacje certyfikatu
updateIssuer(string, UpdateIssuerOptions)

Operacja updateIssuer wykonuje aktualizację dla określonej jednostki wystawcy certyfikatu. Ta operacja wymaga uprawnień certyfikatów/setisuers.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
await client.updateIssuer("IssuerName", {
  provider: "Provider2"
});

Aktualizacje określonego wystawcy certyfikatu.

Szczegóły konstruktora

CertificateClient(string, TokenCredential, CertificateClientOptions)

Tworzy wystąpienie klasy CertificateClient.

new CertificateClient(vaultUrl: string, credential: TokenCredential, clientOptions?: CertificateClientOptions)

Parametry

vaultUrl

string

podstawowy adres URL magazynu. Należy sprawdzić, czy ten adres URL odwołuje się do prawidłowego zasobu Key Vault. Aby uzyskać szczegółowe informacje, zobacz opis funkcji https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Obiekt, który implementuje TokenCredential interfejs używany do uwierzytelniania żądań w usłudze. @azure/identity Użyj pakietu, aby utworzyć poświadczenia odpowiadające Twoim potrzebom.

clientOptions
CertificateClientOptions

Opcje potoku używane do konfigurowania żądań interfejsu API Key Vault. Pomiń ten parametr, aby użyć domyślnej konfiguracji potoku.

Szczegóły właściwości

vaultUrl

Podstawowy adres URL magazynu

vaultUrl: string

Wartość właściwości

string

Szczegóły metody

backupCertificate(string, OperationOptions)

Żąda pobrania kopii zapasowej określonego certyfikatu do klienta. Zostaną pobrane wszystkie wersje certyfikatu. Ta operacja wymaga uprawnień certyfikatów/kopii zapasowej.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const backup = await client.backupCertificate("MyCertificate");

Generuje kopię zapasową certyfikatu

function backupCertificate(certificateName: string, options?: OperationOptions): Promise<undefined | Uint8Array>

Parametry

certificateName

string

Nazwa certyfikatu

options
OperationOptions

Parametry opcjonalne

Zwraca

Promise<undefined | Uint8Array>

beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Tworzy nowy certyfikat. Jeśli jest to pierwsza wersja, zostanie utworzony zasób certyfikatu. Ta funkcja zwraca poller operacji długotrwałej, która umożliwia oczekiwanie na czas nieokreślony, aż certyfikat zostanie w pełni odzyskany.

Uwaga: Wysłanie Self jako issuerName zasad certyfikatu spowoduje utworzenie certyfikatu z podpisem własnym.

Ta operacja wymaga uprawnień do certyfikatów/tworzenia.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
const certificatePolicy = {
  issuerName: "Self",
  subject: "cn=MyCert"
};
const createPoller = await client.beginCreateCertificate("MyCertificate", certificatePolicy);

// The pending certificate can be obtained by calling the following method:
const pendingCertificate = createPoller.getResult();

// Serializing the poller
const serialized = createPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginCreateCertificate("MyCertificate", certificatePolicy, { resumeFrom: serialized });

// Waiting until it's done
const certificate = await createPoller.pollUntilDone();
console.log(certificate);

Tworzy certyfikat

function beginCreateCertificate(certificateName: string, policy: CertificatePolicy, options?: BeginCreateCertificateOptions): Promise<PollerLikeWithCancellation<CreateCertificateState, KeyVaultCertificateWithPolicy>>

Parametry

certificateName

string

Nazwa certyfikatu

policy
CertificatePolicy
options
BeginCreateCertificateOptions

Parametry opcjonalne

Zwraca

Promise<PollerLikeWithCancellation<CreateCertificateState, KeyVaultCertificateWithPolicy>>

beginDeleteCertificate(string, CertificatePollerOptions)

Operacja DELETE ma zastosowanie do dowolnego certyfikatu przechowywanego w usłudze Azure Key Vault. Nie można zastosować usuwania do pojedynczej wersji certyfikatu. Ta funkcja zwraca poller operacji długotrwałej, która umożliwia oczekiwanie na czas nieokreślony, aż certyfikat zostanie w pełni odzyskany.

Ta operacja wymaga uprawnienia do certyfikatów/usuwania.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
const createPoller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await createPoller.pollUntilDone();

const deletePoller = await client.beginDeleteCertificate("MyCertificate");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteCertificate("MyCertificate", { resumeFrom: serialized });

// Waiting until it's done
const deletedCertificate = await deletePoller.pollUntilDone();
console.log(deletedCertificate);

Usuwa certyfikat z określonego magazynu kluczy.

function beginDeleteCertificate(certificateName: string, options?: CertificatePollerOptions): Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

Parametry

certificateName

string

Nazwa certyfikatu.

options
CertificatePollerOptions

Parametry opcjonalne

Zwraca

Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Odzyskuje usunięty certyfikat w określonym magazynie. Tę operację można wykonać tylko w magazynie z włączoną obsługą usuwania nietrwałego. Ta operacja Ta funkcja zwraca poller operacji długotrwałej, która umożliwia oczekiwanie na czas nieokreślony do całkowitego odzyskania certyfikatu.

Ta operacja wymaga uprawnień certyfikatów/odzyskiwania.

Przykład użycia: 

const client = new CertificateClient(url, credentials);

const deletePoller = await client.beginDeleteCertificate("MyCertificate");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedCertificate("MyCertificate");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedCertificate("MyCertificate", { resumeFrom: serialized });

// Waiting until it's done
const certificate = await recoverPoller.pollUntilDone();
console.log(certificate);

Odzyskuje usunięty certyfikat

function beginRecoverDeletedCertificate(certificateName: string, options?: CertificatePollerOptions): Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

Parametry

certificateName

string

Nazwa usuniętego certyfikatu

options
CertificatePollerOptions

Parametry opcjonalne

Zwraca

Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

createIssuer(string, string, CreateIssuerOptions)

Operacja createIssuer dodaje lub aktualizuje określonego wystawcę certyfikatu. Ta operacja wymaga uprawnień certyfikatów/setisuers.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");

Ustawia określonego wystawcę certyfikatu.

function createIssuer(issuerName: string, provider: string, options?: CreateIssuerOptions): Promise<CertificateIssuer>

Parametry

issuerName

string

Nazwa wystawcy.

provider

string

Dostawca wystawcy.

options
CreateIssuerOptions

Parametry opcjonalne

Zwraca

Promise<CertificateIssuer>

deleteCertificateOperation(string, OperationOptions)

Usuwa operację tworzenia dla określonego certyfikatu, który jest w trakcie tworzenia. Certyfikat nie jest już tworzony. Ta operacja wymaga uprawnień do certyfikatów/aktualizacji.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await client.deleteCertificateOperation("MyCertificate");
await client.getCertificateOperation("MyCertificate"); // Throws error: Pending certificate not found: "MyCertificate"

Usuwanie operacji certyfikatu

function deleteCertificateOperation(certificateName: string, options?: OperationOptions): Promise<CertificateOperation>

Parametry

certificateName

string

Nazwa certyfikatu

options
OperationOptions

Parametry opcjonalne

Zwraca

Promise<CertificateOperation>

deleteContacts(OperationOptions)

Usuwa wszystkie kontakty certyfikatów. Ta operacja wymaga uprawnień certificates/managecontacts.

Przykład użycia: 

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);
await client.deleteContacts();

Usuwa wszystkie kontakty certyfikatów

function deleteContacts(options?: OperationOptions): Promise<undefined | CertificateContact[]>

Parametry

options
OperationOptions

Parametry opcjonalne

Zwraca

Promise<undefined | CertificateContact[]>

deleteIssuer(string, OperationOptions)

Operacja deleteIssuer trwale usuwa określonego wystawcę certyfikatu z magazynu. Ta operacja wymaga uprawnień certificates/manageissuers/deleteissuers.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Provider");
await client.deleteIssuer("IssuerName");

Usuwa określonego wystawcę certyfikatu.

function deleteIssuer(issuerName: string, options?: OperationOptions): Promise<CertificateIssuer>

Parametry

issuerName

string

Nazwa wystawcy.

options
OperationOptions

Parametry opcjonalne

Zwraca

Promise<CertificateIssuer>

getCertificate(string, OperationOptions)

Pobiera najnowsze informacje dostępne z określonego certyfikatu, w tym zasady certyfikatu. Ta operacja wymaga uprawnień do certyfikatów/pobierania.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
const poller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await poller.pollUntilDone();
const certificate = await client.getCertificate("MyCertificate");
console.log(certificate);

Pobiera certyfikat z nazwy certyfikatu (łącznie z zasadami certyfikatu)

function getCertificate(certificateName: string, options?: OperationOptions): Promise<KeyVaultCertificateWithPolicy>

Parametry

certificateName

string

Nazwa certyfikatu

options
OperationOptions

Parametry opcjonalne

Zwraca

Promise<KeyVaultCertificateWithPolicy>

getCertificateOperation(string, CertificatePollerOptions)

Pobiera operację tworzenia skojarzona z określonym certyfikatem. Ta operacja wymaga uprawnień do certyfikatów/pobierania. Ta funkcja zwraca poller operacji długotrwałej, która umożliwia oczekiwanie na czas nieokreślony, aż certyfikat zostanie w pełni odzyskany.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
const createPoller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});

const poller = await client.getCertificateOperation("MyCertificate");
const pendingCertificate = poller.getResult();

const certificateOperation = poller.getOperationState().certificateOperation;
console.log(certificateOperation);

Pobiera operację poller certyfikatu

function getCertificateOperation(certificateName: string, options?: CertificatePollerOptions): Promise<PollerLikeWithCancellation<CertificateOperationState, KeyVaultCertificateWithPolicy>>

Parametry

certificateName

string

Nazwa certyfikatu

options
CertificatePollerOptions

Parametry opcjonalne

Zwraca

Promise<PollerLikeWithCancellation<CertificateOperationState, KeyVaultCertificateWithPolicy>>

getCertificatePolicy(string, OperationOptions)

Operacja getCertificatePolicy zwraca określone zasoby zasad certyfikatu w określonym magazynie kluczy. Ta operacja wymaga uprawnień do certyfikatów/pobierania.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const policy = await client.getCertificatePolicy("MyCertificate");
console.log(policy);

Pobiera zasady certyfikatu

function getCertificatePolicy(certificateName: string, options?: OperationOptions): Promise<CertificatePolicy>

Parametry

certificateName

string

Nazwa certyfikatu

options
OperationOptions

Parametry opcjonalne

Zwraca

Promise<CertificatePolicy>

getCertificateVersion(string, string, OperationOptions)

Pobiera informacje o określonym certyfikacie w określonej wersji. Nie zwróci zasad certyfikatu. Ta operacja wymaga uprawnień do certyfikatów/pobierania.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
const poller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await poller.pollUntilDone();
const certificateWithPolicy = await client.getCertificate("MyCertificate");
const certificate = await client.getCertificateVersion("MyCertificate", certificateWithPolicy.properties.version!);
console.log(certificate);

Pobiera certyfikat z nazwy certyfikatu i określonej wersji

function getCertificateVersion(certificateName: string, version: string, options?: OperationOptions): Promise<KeyVaultCertificate>

Parametry

certificateName

string

Nazwa certyfikatu

version

string

Określona wersja certyfikatu

options
OperationOptions

Parametry opcjonalne

Zwraca

Promise<KeyVaultCertificate>

getContacts(OperationOptions)

Zwraca zestaw zasobów kontaktowych certyfikatu w określonym magazynie kluczy. Ta operacja wymaga uprawnień certificates/managecontacts.

Przykład użycia: 

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);
const contacts = await client.getContacts();
console.log(contacts);

Ustawia kontakty certyfikatów.

function getContacts(options?: OperationOptions): Promise<undefined | CertificateContact[]>

Parametry

options
OperationOptions

Parametry opcjonalne

Zwraca

Promise<undefined | CertificateContact[]>

getDeletedCertificate(string, OperationOptions)

pobiera usunięte informacje o certyfikacie oraz jego atrybuty, takie jak interwał przechowywania, zaplanowane trwałe usunięcie i bieżący poziom odzyskiwania usuwania. Ta operacja wymaga uprawnień do certyfikatów/pobierania.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
const deletedCertificate = await client.getDeletedCertificate("MyDeletedCertificate");
console.log("Deleted certificate:", deletedCertificate);

Pobiera usunięty certyfikat

function getDeletedCertificate(certificateName: string, options?: OperationOptions): Promise<DeletedCertificate>

Parametry

certificateName

string

Nazwa certyfikatu

options
OperationOptions

Parametry opcjonalne

Zwraca

Promise<DeletedCertificate>

getIssuer(string, OperationOptions)

Operacja getIssuer zwraca określone zasoby wystawcy certyfikatów w określonym magazynie kluczy. Ta operacja wymaga uprawnień certificates/manageissuers/getissuers.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
const certificateIssuer = await client.getIssuer("IssuerName");
console.log(certificateIssuer);

Pobiera określonego wystawcę certyfikatu.

function getIssuer(issuerName: string, options?: OperationOptions): Promise<CertificateIssuer>

Parametry

issuerName

string

Nazwa wystawcy.

options
OperationOptions

Parametry opcjonalne

Zwraca

Promise<CertificateIssuer>

importCertificate(string, Uint8Array, ImportCertificateOptions)

Importuje istniejący prawidłowy certyfikat zawierający klucz prywatny do usługi Azure Key Vault. Certyfikat do zaimportowania może być w formacie PFX lub PEM. Jeśli certyfikat jest w formacie PEM, plik PEM musi zawierać klucz, a także certyfikaty x509. Ta operacja wymaga uprawnień do certyfikatów/importu.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
// See: @azure/keyvault-secrets
const certificateSecret = await secretClient.getSecret("MyCertificate");
const base64EncodedCertificate = certificateSecret.value!;
let buffer: Uint8Array;

if (isNode) {
  buffer = Buffer.from(base64EncodedCertificate, "base64");
} else {
  buffer = Uint8Array.from(atob(base64EncodedCertificate), (c) => c.charCodeAt(0));
}

await client.importCertificate("MyCertificate", buffer);

Importuje certyfikat z wartości wpisu tajnego certyfikatu

function importCertificate(certificateName: string, certificateBytes: Uint8Array, options?: ImportCertificateOptions): Promise<KeyVaultCertificateWithPolicy>

Parametry

certificateName

string

Nazwa certyfikatu

certificateBytes

Uint8Array

Formatowana wartość PEM PFX lub ASCII certyfikatu zawierającego zarówno certyfikaty X.509, jak i klucz prywatny

options
ImportCertificateOptions

Parametry opcjonalne

Zwraca

Promise<KeyVaultCertificateWithPolicy>

listDeletedCertificates(ListDeletedCertificatesOptions)

Pobiera certyfikaty w bieżącym magazynie, które są w stanie usuniętym i są gotowe do odzyskiwania lub przeczyszczania. Ta operacja obejmuje informacje specyficzne dla usuwania. Ta operacja wymaga uprawnień certyfikatów/get/list. Tę operację można włączyć tylko w magazynach z włączoną obsługą usuwania nietrwałego.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
for await (const deletedCertificate of client.listDeletedCertificates()) {
  console.log(deletedCertificate);
}
for await (const page of client.listDeletedCertificates().byPage()) {
  for (const deletedCertificate of page) {
    console.log(deletedCertificate);
  }
}

Wyświetla listę usuniętych certyfikatów

function listDeletedCertificates(options?: ListDeletedCertificatesOptions): PagedAsyncIterableIterator<DeletedCertificate, DeletedCertificate[], PageSettings>

Parametry

options
ListDeletedCertificatesOptions

Parametry opcjonalne

Zwraca

PagedAsyncIterableIterator<DeletedCertificate, DeletedCertificate[], PageSettings>

listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Iteruje najnowszą wersję wszystkich certyfikatów w magazynie. Pełny identyfikator certyfikatu i atrybuty są podane w odpowiedzi. Nie są zwracane żadne wartości dla certyfikatów. Ta operacja wymaga uprawnień do certyfikatów/listy.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
// All in one call
for await (const certificateProperties of client.listPropertiesOfCertificates()) {
  console.log(certificateProperties);
}
// By pages
for await (const page of client.listPropertiesOfCertificates().byPage()) {
  for (const certificateProperties of page) {
    console.log(certificateProperties);
  }
}

Wyświetl listę wszystkich wersji określonego certyfikatu.

function listPropertiesOfCertificates(options?: ListPropertiesOfCertificatesOptions): PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

Parametry

options
ListPropertiesOfCertificatesOptions

Parametry opcjonalne

Zwraca

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfCertificateVersions(string, OperationOptions)

Zwraca wersje certyfikatu w określonym magazynie kluczy. Ta operacja wymaga uprawnień certyfikatów/listy.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
for await (const certificateProperties of client.listPropertiesOfCertificateVersions("MyCertificate")) {
  console.log(certificateProperties.version!);
}

Wyświetl listę wersji certyfikatu.

function listPropertiesOfCertificateVersions(certificateName: string, options?: OperationOptions): PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

Parametry

certificateName

string

Nazwa certyfikatu.

options
OperationOptions

Parametry opcjonalne

Zwraca

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfIssuers(OperationOptions)

Zwraca zestaw zasobów wystawcy certyfikatów w określonym magazynie kluczy. Ta operacja wymaga uprawnień certificates/manageissuers/getissuers.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
// All in one call
for await (const issuerProperties of client.listPropertiesOfIssuers()) {
  console.log(issuerProperties);
}
// By pages
for await (const page of client.listPropertiesOfIssuers().byPage()) {
  for (const issuerProperties of page) {
    console.log(issuerProperties);
  }
}

Wyświetl listę wystawców certyfikatów.

function listPropertiesOfIssuers(options?: OperationOptions): PagedAsyncIterableIterator<IssuerProperties, IssuerProperties[], PageSettings>

Parametry

options
OperationOptions

Parametry opcjonalne

Zwraca

PagedAsyncIterableIterator<IssuerProperties, IssuerProperties[], PageSettings>

mergeCertificate(string, Uint8Array[], OperationOptions)

Wykonuje scalanie certyfikatu lub łańcucha certyfikatów z parą kluczy obecnie dostępną w usłudze. Ta operacja wymaga uprawnień do certyfikatów/tworzenia.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Unknown",
  subject: "cn=MyCert"
});
const poller = await client.getCertificateOperation("MyCertificate");
const { csr } = poller.getOperationState().certificateOperation!;
const base64Csr = Buffer.from(csr!).toString("base64");
const wrappedCsr = ["-----BEGIN CERTIFICATE REQUEST-----", base64Csr, "-----END CERTIFICATE REQUEST-----"].join("\n");

const fs = require("fs");
fs.writeFileSync("test.csr", wrappedCsr);

// Certificate available locally made using:
//   openssl genrsa -out ca.key 2048
//   openssl req -new -x509 -key ca.key -out ca.crt
// You can read more about how to create a fake certificate authority here: https://gist.github.com/Soarez/9688998

const childProcess = require("child_process");
childProcess.execSync("openssl x509 -req -in test.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out test.crt");
const base64Crt = fs.readFileSync("test.crt").toString().split("\n").slice(1, -1).join("");

await client.mergeCertificate("MyCertificate", [Buffer.from(base64Crt)]);

Scala podpisane żądanie certyfikatu z oczekującym certyfikatem

function mergeCertificate(certificateName: string, x509Certificates: Uint8Array[], options?: OperationOptions): Promise<KeyVaultCertificateWithPolicy>

Parametry

certificateName

string

Nazwa certyfikatu

x509Certificates

Uint8Array[]

Certyfikaty do scalenia

options
OperationOptions

Parametry opcjonalne

Zwraca

Promise<KeyVaultCertificateWithPolicy>

purgeDeletedCertificate(string, OperationOptions)

Wykonuje nieodwracalne usunięcie określonego certyfikatu bez możliwości odzyskania. Operacja jest niedostępna, jeśli poziom odzyskiwania nie określa wartości "Przeczyszczalne". Ta operacja wymaga uprawnienia certyfikatu/przeczyszczania.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
const deletePoller = await client.beginDeleteCertificate("MyCertificate");
await deletePoller.pollUntilDone();
// Deleting a certificate takes time, make sure to wait before purging it
client.purgeDeletedCertificate("MyCertificate");

Pobiera usunięty certyfikat

function purgeDeletedCertificate(certificateName: string, options?: OperationOptions): Promise<null>

Parametry

certificateName

string

Nazwa usuniętego certyfikatu do przeczyszczenia

options
OperationOptions

Parametry opcjonalne

Zwraca

Promise<null>

restoreCertificateBackup(Uint8Array, OperationOptions)

Przywraca kopię zapasową certyfikatu i wszystkie jego wersje do magazynu. Ta operacja wymaga uprawnień do certyfikatów/przywracania.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const backup = await client.backupCertificate("MyCertificate");
const poller = await client.beginDeleteCertificate("MyCertificate");
await poller.pollUntilDone();
// Some time is required before we're able to restore the certificate
await client.restoreCertificateBackup(backup!);

Przywraca certyfikat z kopii zapasowej

function restoreCertificateBackup(backup: Uint8Array, options?: OperationOptions): Promise<KeyVaultCertificateWithPolicy>

Parametry

backup

Uint8Array

Certyfikat kopii zapasowej do przywrócenia z

options
OperationOptions

Parametry opcjonalne

Zwraca

Promise<KeyVaultCertificateWithPolicy>

setContacts(CertificateContact[], OperationOptions)

Ustawia kontakty certyfikatów dla magazynu kluczy. Ta operacja wymaga uprawnień certificates/managecontacts.

Przykład użycia: 

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);

Ustawia kontakty certyfikatów.

function setContacts(contacts: CertificateContact[], options?: OperationOptions): Promise<undefined | CertificateContact[]>

Parametry

contacts

CertificateContact[]

Kontakty do użycia

options
OperationOptions

Parametry opcjonalne

Zwraca

Promise<undefined | CertificateContact[]>

updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Aktualizacje zasady certyfikatu dla określonego certyfikatu. Ta operacja wymaga uprawnień do certyfikatów/aktualizacji. Pobiera zasady certyfikatu

function updateCertificatePolicy(certificateName: string, policy: CertificatePolicy, options?: OperationOptions): Promise<CertificatePolicy>

Parametry

certificateName

string

Nazwa certyfikatu

policy
CertificatePolicy

Zasady certyfikatu

options
OperationOptions

Parametry opcjonalne

Zwraca

Promise<CertificatePolicy>

updateCertificateProperties(string, string, UpdateCertificateOptions)

Stosuje określoną aktualizację danego certyfikatu; jedynymi zaktualizowanymi elementami są atrybuty certyfikatu. Ta operacja wymaga uprawnień do certyfikatów/aktualizacji.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});

// You may pass an empty string for version which will update
// the latest version of the certificate
await client.updateCertificateProperties("MyCertificate", "", {
  tags: {
    customTag: "value"
  }
});

Aktualizacje certyfikatu

function updateCertificateProperties(certificateName: string, version: string, options?: UpdateCertificateOptions): Promise<KeyVaultCertificate>

Parametry

certificateName

string

Nazwa certyfikatu

version

string

Wersja certyfikatu do zaktualizowania (pusty ciąg zaktualizuje najnowszą wersję)

options
UpdateCertificateOptions

Opcje, w tym informacje o aktualizacjach

Zwraca

Promise<KeyVaultCertificate>

updateIssuer(string, UpdateIssuerOptions)

Operacja updateIssuer wykonuje aktualizację dla określonej jednostki wystawcy certyfikatu. Ta operacja wymaga uprawnień certyfikatów/setisuers.

Przykład użycia: 

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
await client.updateIssuer("IssuerName", {
  provider: "Provider2"
});

Aktualizacje określonego wystawcy certyfikatu.

function updateIssuer(issuerName: string, options?: UpdateIssuerOptions): Promise<CertificateIssuer>

Parametry

issuerName

string

Nazwa wystawcy.

options
UpdateIssuerOptions

Parametry opcjonalne

Zwraca

Promise<CertificateIssuer>