Create Certificate - Create Certificate

Odwołanie

Service:: Key Vault

API Version:: 7.4

Tworzy nowy certyfikat.
Jeśli jest to pierwsza wersja, zostanie utworzony zasób certyfikatu. Ta operacja wymaga uprawnień do certyfikatów/tworzenia.

POST {vaultBaseUrl}/certificates/{certificate-name}/create?api-version=7.4

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis

Nazwa	W	Wymagane	Typ	Opis
certificate-name	path	True	string	Nazwa certyfikatu. Wartość, którą podajesz, może zostać skopiowana globalnie na potrzeby uruchamiania usługi. Podana wartość nie powinna zawierać danych osobowych ani poufnych. Regex pattern: `^[0-9a-zA-Z-]+$`
vaultBaseUrl	path	True	string	Nazwa magazynu, na przykład https://myvault.vault.azure.net.
api-version	query	True	string	Wersja interfejsu API klienta.

certificate-name

path

True

string

Nazwa certyfikatu. Wartość, którą podajesz, może zostać skopiowana globalnie na potrzeby uruchamiania usługi. Podana wartość nie powinna zawierać danych osobowych ani poufnych.

Regex pattern: ^[0-9a-zA-Z-]+$

vaultBaseUrl

path

True

string

Nazwa magazynu, na przykład https://myvault.vault.azure.net.

api-version

query

True

string

Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
attributes	CertificateAttributes	Atrybuty certyfikatu (opcjonalnie).
policy	CertificatePolicy	Zasady zarządzania certyfikatu.
tags	object	Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted	CertificateOperation	Utworzono pakiet certyfikatów.
Other Status Codes	KeyVaultError	Key Vault odpowiedzi na błąd opisujący, dlaczego operacja nie powiodła się.

Przykłady

CreateCertificate

Sample Request

HTTP

POST https://myvault.vault.azure.net//certificates/selfSignedCert01/create?api-version=7.4

{
  "policy": {
    "key_props": {
      "exportable": true,
      "kty": "RSA",
      "key_size": 2048,
      "reuse_key": false
    },
    "secret_props": {
      "contentType": "application/x-pkcs12"
    },
    "x509_props": {
      "subject": "CN=*.microsoft.com",
      "sans": {
        "dns_names": [
          "onedrive.microsoft.com",
          "xbox.microsoft.com"
        ]
      }
    },
    "issuer": {
      "name": "Self"
    }
  }
}

Sample Response

Status code:: 202

{
  "id": "https://myvault.vault.azure.net/certificates/selfSignedCert01/pending",
  "issuer": {
    "name": "Self"
  },
  "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqe8aINnShK+wQC8QU7fwsviQc9+yiOnqU3adXA6qNjn21HTdRBa7cyQIk1STxHIBLTT/GaEJwqsUi6UvZaPEHokOWsr1bP9M7xOPTicBcRyMrr6bOxsmGczYtu1z2TzzXDD7q7IEignE7/LowGEaIADCIU9iuWk7TiJ+1Q/VLh/B3xPsgVjY+n7zEQ53gBiDHSl7XfELfwmslOQ28TVNogUyXsxHcVxQQYJeI7HqqY448LeleK69Ld86lkBixLEm1pD7HSbEx3WI2lyUQAGR6hD3YFaiIWVpQeEyI7p1jmtQlnfZdEL4q9wdlEEcwd3h3PAZpEBhCixahF54fci3pwIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBACiLeghirF+yCuYGVUPDB3wKQJn2iLY1za9ncxCehIVqOkFK09AphzoxF6Yid90AKCaa/dT/Ohm7oTyVQ+YcZnT00LUNFVG48AOE8YDiw9tjAG9OORsAz80xnv2qaLw2TCVIQ6NjrI83LqAm1GJ8rAnpdD/ZTuWM7TvSO5g/jm/Q0oSuKpMgj3YxpwgB9Ac6YEfVzOnm76OkUcpvR5MS4BoTfRv4thdSnU+uwqxM+HtdSVTbHQeC2U/hM1cyzDMpl1rZRklmiEOoPUeDasEIBVTJhAxR8xAeKJJD7Wzj4mJPw4UMvF8zQZzW8EKYvB1hkVYY+HQ85L+XcXd8lco7hU4=",
  "cancellation_requested": false,
  "status": "inProgress",
  "status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.",
  "request_id": "6faacd568ab049a2803861e8dd3ae21f"
}

Definicje

Nazwa	Opis
Action	Akcja, która zostanie wykonana.
CertificateAttributes	Atrybuty zarządzania certyfikatami.
CertificateCreateParameters	Certyfikat tworzy parametry.
CertificateOperation	Operacja certyfikatu jest zwracana w przypadku żądań asynchronicznych.
CertificatePolicy	Zasady zarządzania dla certyfikatu.
CertificatePolicyAction	Typ akcji.
DeletionRecoveryLevel	Odzwierciedla obecnie poziom odzyskiwania usuwania dla certyfikatów w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", certyfikat może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić certyfikat na końcu interwału przechowywania.
Error	Błąd serwera magazynu kluczy.
IssuerParameters	Parametry wystawcy składnika X509 certyfikatu.
JsonWebKeyCurveName	Nazwa krzywej eliptycznej. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyCurveName.
JsonWebKeyType	Typ pary kluczy do użycia dla certyfikatu.
KeyProperties	Właściwości pary kluczy kopii zapasowej certyfikatu.
KeyUsageType	Określa sposób użycia klucza certyfikatu.
KeyVaultError	Wyjątek błędu magazynu kluczy.
LifetimeAction	Akcja i jego wyzwalacz, który zostanie wykonany przez Key Vault w okresie istnienia certyfikatu.
SecretProperties	Właściwości klucza kopii zapasowej certyfikatu.
SubjectAlternativeNames	Alternatywne nazwy podmiotu obiektu X509.
Trigger	Warunek, który ma zostać spełniony, aby wykonać akcję.
X509CertificateProperties	Właściwości składnika X509 certyfikatu.

Action

Akcja, która zostanie wykonana.

Nazwa	Typ	Opis
action_type	CertificatePolicyAction	Typ akcji.

CertificateAttributes

Atrybuty zarządzania certyfikatami.

Nazwa	Typ	Opis
created	integer	Czas tworzenia w formacie UTC.
enabled	boolean	Określa, czy obiekt jest włączony.
exp	integer	Data wygaśnięcia w formacie UTC.
nbf	integer	Nie wcześniej niż data w formacie UTC.
recoverableDays	integer	softDelete data retention days (dni przechowywania danych softDelete). Wartość powinna mieć wartość >=7 i <=90, gdy funkcja softDelete jest włączona, w przeciwnym razie wartość 0.
recoveryLevel	DeletionRecoveryLevel	Odzwierciedla obecnie poziom odzyskiwania usuwania dla certyfikatów w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", certyfikat może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić certyfikat na końcu interwału przechowywania.
updated	integer	Czas ostatniej aktualizacji w formacie UTC.

CertificateCreateParameters

Certyfikat tworzy parametry.

Nazwa	Typ	Opis
attributes	CertificateAttributes	Atrybuty certyfikatu (opcjonalnie).
policy	CertificatePolicy	Zasady zarządzania certyfikatu.
tags	object	Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

CertificateOperation

Operacja certyfikatu jest zwracana w przypadku żądań asynchronicznych.

Nazwa	Typ	Opis
cancellation_requested	boolean	Wskazuje, czy w operacji certyfikatu zażądano anulowania.
csr	string	Żądanie podpisania certyfikatu (CSR), które jest używane w operacji certyfikatu.
error	Error	Wystąpił błąd, jeśli istnieje, podczas operacji certyfikatu.
id	string	Identyfikator certyfikatu.
issuer	IssuerParameters	Parametry wystawcy składnika X509 certyfikatu.
request_id	string	Identyfikator operacji certyfikatu.
status	string	Stan operacji certyfikatu.
status_details	string	Szczegóły stanu operacji certyfikatu.
target	string	Lokalizacja zawierająca wynik operacji certyfikatu.

CertificatePolicy

Zasady zarządzania dla certyfikatu.

Nazwa	Typ	Opis
attributes	CertificateAttributes	Atrybuty certyfikatu.
id	string	Identyfikator certyfikatu.
issuer	IssuerParameters	Parametry wystawcy składnika X509 certyfikatu.
key_props	KeyProperties	Właściwości klucza kopii zapasowej certyfikatu.
lifetime_actions	LifetimeAction[]	Akcje, które będą wykonywane przez Key Vault w okresie istnienia certyfikatu.
secret_props	SecretProperties	Właściwości wpisu tajnego do tworzenia kopii zapasowej certyfikatu.
x509_props	X509CertificateProperties	Właściwości składnika X509 certyfikatu.

CertificatePolicyAction

Typ akcji.

Nazwa	Typ	Opis
AutoRenew	string
EmailContacts	string

DeletionRecoveryLevel

Odzwierciedla obecnie poziom odzyskiwania usuwania dla certyfikatów w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", certyfikat może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić certyfikat na końcu interwału przechowywania.

Nazwa	Typ	Opis
CustomizedRecoverable	string	Określa stan magazynu, w którym można odzyskać usunięcie bez możliwości natychmiastowego i trwałego usunięcia (tj. przeczyszczania, gdy 7<= SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania i gdy subskrypcja jest nadal dostępna.
CustomizedRecoverable+ProtectedSubscription	string	Określa magazyn i stan subskrypcji, w którym usunięcie jest możliwe do odzyskania, natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) jest niedozwolone i w którym sama subskrypcja nie może zostać trwale anulowana, gdy 7<= SoftDeleteRetentionInDays < 90. Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania, a także odzwierciedla fakt, że sama subskrypcja nie może zostać anulowana.
CustomizedRecoverable+Purgeable	string	Określa stan magazynu, w którym można odzyskać usunięcie, a także zezwala na natychmiastowe i trwałe usunięcie (tj. przeczyszczanie, gdy 7<= SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania, chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana.
Purgeable	string	Określa stan magazynu, w którym usunięcie jest nieodwracalną operacją bez możliwości odzyskiwania. Ten poziom nie odpowiada działaniu ochrony przed operacją Usuwania; dane są nieodwracalnie utracone po zaakceptowaniu operacji Usuń na poziomie jednostki lub wyższym (magazyn, grupa zasobów, subskrypcja itp.)
Recoverable	string	Określa stan magazynu, w którym można odzyskać usunięcie bez możliwości natychmiastowego i trwałego usunięcia (tj. przeczyszczania). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania (90 dni) i gdy subskrypcja jest nadal dostępna. System spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane
Recoverable+ProtectedSubscription	string	Określa magazyn i stan subskrypcji, w którym usunięcie można odzyskać w interwale przechowywania (90 dni), natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) nie jest dozwolone i w którym sama subskrypcja nie może zostać trwale anulowana. System spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane
Recoverable+Purgeable	string	Określa stan magazynu, w którym można odzyskać usunięcie, a także zezwala na natychmiastowe i trwałe usunięcie (tj. przeczyszczanie). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania (90 dni), chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana. System spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane

Error

Błąd serwera magazynu kluczy.

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	Error	Błąd serwera magazynu kluczy.
message	string	Komunikat o błędzie.

IssuerParameters

Parametry wystawcy składnika X509 certyfikatu.

Nazwa	Typ	Opis
cert_transparency	boolean	Wskazuje, czy certyfikaty wygenerowane w ramach tych zasad powinny być publikowane w dziennikach przejrzystości certyfikatów.
cty	string	Typ certyfikatu obsługiwany przez dostawcę (opcjonalnie); na przykład "OV-SSL", "EV-SSL"
name	string	Nazwa przywoływana nazwa obiektu wystawcy lub nazw zarezerwowanych; na przykład "Self" lub "Unknown".

JsonWebKeyCurveName

Nazwa krzywej eliptycznej. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyCurveName.

Nazwa	Typ	Opis
P-256	string
P-256K	string
P-384	string
P-521	string

JsonWebKeyType

Typ pary kluczy do użycia dla certyfikatu.

Nazwa	Typ	Opis
EC	string
EC-HSM	string
RSA	string
RSA-HSM	string
oct	string
oct-HSM	string

KeyProperties

Właściwości pary kluczy kopii zapasowej certyfikatu.

Nazwa	Typ	Opis
crv	JsonWebKeyCurveName	Nazwa krzywej eliptycznej. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyCurveName.
exportable	boolean	Wskazuje, czy klucz prywatny można wyeksportować. Zasady wydania należy podać podczas tworzenia pierwszej wersji klucza możliwego do wyeksportowania.
key_size	integer	Rozmiar klucza w bitach. Na przykład: 2048, 3072 lub 4096 dla RSA.
kty	JsonWebKeyType	Typ pary kluczy do użycia dla certyfikatu.
reuse_key	boolean	Wskazuje, czy ta sama para kluczy zostanie użyta podczas odnawiania certyfikatu.

KeyUsageType

Określa sposób użycia klucza certyfikatu.

Nazwa	Typ	Opis
cRLSign	string
dataEncipherment	string
decipherOnly	string
digitalSignature	string
encipherOnly	string
keyAgreement	string
keyCertSign	string
keyEncipherment	string
nonRepudiation	string

KeyVaultError

Wyjątek błędu magazynu kluczy.

Nazwa	Typ	Opis
error	Error	Błąd serwera magazynu kluczy.

LifetimeAction

Akcja i jego wyzwalacz, który zostanie wykonany przez Key Vault w okresie istnienia certyfikatu.

Nazwa	Typ	Opis
action	Action	Akcja, która zostanie wykonana.
trigger	Trigger	Warunek, który wykona akcję.

SecretProperties

Właściwości klucza kopii zapasowej certyfikatu.

Nazwa	Typ	Opis
contentType	string	Typ nośnika (typ MIME).

SubjectAlternativeNames

Alternatywne nazwy podmiotu obiektu X509.

Nazwa	Typ	Opis
dns_names	string[]	Nazwy domen.
emails	string[]	Email adresy.
upns	string[]	Główne nazwy użytkownika.

Trigger

Warunek, który ma zostać spełniony, aby wykonać akcję.

Nazwa	Typ	Opis
days_before_expiry	integer	Dni przed wygaśnięciem próby odnowienia. Wartość powinna należeć do przedziału od 1 do validity_in_months pomnożona przez 27. Jeśli validity_in_months wynosi 36, wartość powinna należeć do zakresu od 1 do 972 (36 * 27).
lifetime_percentage	integer	Procent okresu istnienia, w którym ma być wyzwalany. Wartość powinna należeć do zakresu od 1 do 99.

X509CertificateProperties

Właściwości składnika X509 certyfikatu.

Nazwa	Typ	Opis
ekus	string[]	Rozszerzone użycie klucza.
key_usage	KeyUsageType[]	Określa sposób użycia klucza certyfikatu.
sans	SubjectAlternativeNames	Alternatywne nazwy podmiotu.
subject	string	Nazwa podmiotu. Powinna być prawidłową nazwą wyróżniającą X509.
validity_months	integer	Czas trwania certyfikatu jest ważny w miesiącach.

Create Certificate - Create Certificate

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Przykłady

CreateCertificate

Sample Request

Sample Response

Definicje

Action

CertificateAttributes

CertificateCreateParameters

CertificateOperation

CertificatePolicy

CertificatePolicyAction

DeletionRecoveryLevel

Error

IssuerParameters

JsonWebKeyCurveName

JsonWebKeyType

KeyProperties

KeyUsageType

KeyVaultError

LifetimeAction

SecretProperties

SubjectAlternativeNames

Trigger

X509CertificateProperties

Dodatkowe zasoby