Create Certificate - Create Certificate

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

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

Parametry identyfikatora URI

Name In Required Type Description
certificate-name
path True
  • string

Nazwa certyfikatu.

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

Name Type Description
attributes

Atrybuty certyfikatu (opcjonalnie).

policy

Zasady zarządzania dla certyfikatu.

tags
  • object

Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

Odpowiedzi

Name Type Description
202 Accepted

Utworzono pakiet certyfikatów.

Other Status Codes

Key Vault błąd opisujący, dlaczego operacja nie powiodła się.

Przykłady

CreateCertificate

Sample Request

POST https://myvault.vault.azure.net//certificates/selfSignedCert01/create?api-version=7.2
{
  "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

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

Action

Akcja, która zostanie wykonana.

ActionType

Typ akcji.

CertificateAttributes

Atrybuty zarządzania certyfikatami.

CertificateCreateParameters

Certyfikat tworzy parametry.

CertificateOperation

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

CertificatePolicy

Zasady zarządzania dla certyfikatu.

DeletionRecoveryLevel

Odzwierciedla poziom odzyskiwania usuwania obecnie obowiązujący 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 koniec okresu przechowywania.

Error

Błąd serwera magazynu kluczy.

IssuerParameters

Parametry wystawcy składnika X509 certyfikatu.

JsonWebKeyCurveName

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

JsonWebKeyType

Typ pary kluczy, która ma być używana dla certyfikatu.

KeyProperties

Właściwości pary kluczy, która stanowi kopię zapasową certyfikatu.

KeyVaultError

Wyjątek błędu magazynu kluczy.

LifetimeAction

Akcja i jej wyzwalacz, które będą wykonywane przez Key Vault przez okres istnienia certyfikatu.

SecretProperties

Właściwości klucza, który stanowi kopię zapasową certyfikatu.

SubjectAlternativeNames

Alternatywne nazwy podmiotu obiektu X509.

Trigger

Warunek do zrealizowania dla akcji do wykonania.

X509CertificateProperties

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

Action

Akcja, która zostanie wykonana.

Name Type Description
action_type

Typ akcji.

ActionType

Typ akcji.

Name Type Description
AutoRenew
  • string
EmailContacts
  • string

CertificateAttributes

Atrybuty zarządzania certyfikatami.

Name Type Description
created
  • integer

Godzina utworzenia w czasie UTC.

enabled
  • boolean

Określa, czy obiekt jest włączony.

exp
  • integer

Data wygaśnięcia w czasie UTC.

nbf
  • integer

Nie przed datą w czasie UTC.

recoverableDays
  • integer

softDelete data retention days (softDelete data retention days). Wartość powinna być >=7, a <= 90, gdy softDelete włączone, w przeciwnym razie 0.

recoveryLevel

Odzwierciedla poziom odzyskiwania usuwania obecnie obowiązujący 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 koniec okresu przechowywania.

updated
  • integer

Godzina ostatniej aktualizacji w czasie UTC.

CertificateCreateParameters

Certyfikat tworzy parametry.

Name Type Description
attributes

Atrybuty certyfikatu (opcjonalnie).

policy

Zasady zarządzania dla certyfikatu.

tags
  • object

Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

CertificateOperation

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

Name Type Description
cancellation_requested
  • boolean

Wskazuje, czy zażądano anulowania w operacji certyfikatu.

csr
  • string

Żądanie podpisania certyfikatu (CSR), które jest używane w operacji certyfikatu.

error

Błąd napotkany, jeśli wystąpił, podczas operacji certyfikatu.

id
  • string

Identyfikator certyfikatu.

issuer

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.

Name Type Description
attributes

Atrybuty certyfikatu.

id
  • string

Identyfikator certyfikatu.

issuer

Parametry wystawcy składnika X509 certyfikatu.

key_props

Właściwości klucza, który stanowi kopię zapasową certyfikatu.

lifetime_actions

Akcje, które będą wykonywane przez Key Vault w okresie istnienia certyfikatu.

secret_props

Właściwości tajnego certyfikatu zapasowego.

x509_props

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

DeletionRecoveryLevel

Odzwierciedla poziom odzyskiwania usuwania obecnie obowiązujący 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 koniec okresu przechowywania.

Name Type Description
CustomizedRecoverable
  • string

Wskazuje stan magazynu, w którym usunięcie można odzyskać bez możliwości natychmiastowego i trwałego usunięcia (tj. przeczyszczania, gdy 7<= SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwości odzyskania usuniętej jednostki w okresie przechowywania i gdy subskrypcja jest nadal dostępna.

CustomizedRecoverable+ProtectedSubscription
  • string

Wskazuje stan magazynu i subskrypcji, w którym usunięcie jest możliwe do odzyskania, natychmiastowe i trwałe usunięcie (tj. przeczyszczanie) 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 nie można anulować samej subskrypcji.

CustomizedRecoverable+Purgeable
  • string

Wskazuje stan magazynu, w którym można odzyskać usunięcie, a także umożliwia natychmiastowe i trwałe usunięcie (tj. przeczyszczanie, gdy 7<= SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwości odzyskania usuniętej jednostki w okresie przechowywania, chyba że zażądano operacji przeczyszczania lub subskrypcja została anulowana.

Purgeable
  • string

Wskazuje stan magazynu, w którym usunięcie jest operacją nieodwracalną, bez możliwości odzyskiwania. Ten poziom odpowiada brakowi dostępnej ochrony przed operacją usuwania. dane są nieodwracalnie utracone po zaakceptowaniu operacji Usuwania na poziomie jednostki lub wyższym (magazyn, grupa zasobów, subskrypcja itp.)

Recoverable
  • string

Wskazuje stan magazynu, w którym usunięcie można odzyskać bez możliwości natychmiastowego i trwałego usunięcia (np. przeczyszczania). Ten poziom gwarantuje możliwości odzyskania usuniętej jednostki w okresie przechowywania (90 dni) i gdy subskrypcja jest nadal dostępna. System trwale go usuwa po 90 dniach, jeśli nie został odzyskany

Recoverable+ProtectedSubscription
  • string

Wskazuje stan magazynu i subskrypcji, w którym usunięcie można odzyskać w okresie przechowywania (90 dni), natychmiastowe i trwałe usunięcie (tj. przeczyszczanie) jest niedozwolone i w którym nie można trwale anulować subskrypcji. System trwale go usuwa po 90 dniach, jeśli nie został odzyskany

Recoverable+Purgeable
  • string

Wskazuje stan magazynu, w którym można odzyskać usunięcie, a także umożliwia natychmiastowe i trwałe usunięcie (np. przeczyszczanie). Ten poziom gwarantuje możliwości odzyskania usuniętej jednostki w okresie przechowywania (90 dni), chyba że zażądano operacji przeczyszczania lub subskrypcja została anulowana. System trwale go usuwa po 90 dniach, jeśli nie został odzyskany

Error

Błąd serwera magazynu kluczy.

Name Type Description
code
  • string

Kod błędu.

innererror

Błąd serwera magazynu kluczy.

message
  • string

Komunikat o błędzie.

IssuerParameters

Parametry wystawcy składnika X509 certyfikatu.

Name Type Description
cert_transparency
  • boolean

Wskazuje, czy certyfikaty wygenerowane w ramach tych zasad powinny być publikowane w dziennikach przezroczystości certyfikatów.

cty
  • string

Typ certyfikatu obsługiwany przez dostawcę (opcjonalnie); na przykład "OV-SSL", "EV-SSL"

name
  • string

Nazwa obiektu wystawcy lub nazw zarezerwowanych, do których się odwołujesz; na przykład "Self" lub "Unknown".

JsonWebKeyCurveName

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

Name Type Description
P-256
  • string
P-256K
  • string
P-384
  • string
P-521
  • string

JsonWebKeyType

Typ pary kluczy, która ma być używana dla certyfikatu.

Name Type Description
EC
  • string
EC-HSM
  • string
RSA
  • string
RSA-HSM
  • string
oct
  • string
oct-HSM
  • string

KeyProperties

Właściwości pary kluczy, która stanowi kopię zapasową certyfikatu.

Name Type Description
crv

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

exportable
  • boolean

Ta wersja nie jest obsługiwana. Wskazuje, czy można wyeksportować klucz prywatny.

key_size
  • integer

Rozmiar klucza w bitach. Na przykład: 2048, 3072 lub 4096 dla RSA.

kty

Typ pary kluczy, która ma być używana dla certyfikatu.

reuse_key
  • boolean

Wskazuje, czy ta sama para kluczy będzie używana podczas odnawiania certyfikatu.

KeyVaultError

Wyjątek błędu magazynu kluczy.

Name Type Description
error

Błąd serwera magazynu kluczy.

LifetimeAction

Akcja i jej wyzwalacz, które będą wykonywane przez Key Vault przez okres istnienia certyfikatu.

Name Type Description
action

Akcja, która zostanie wykonana.

trigger

Warunek, który spowoduje wykonanie akcji.

SecretProperties

Właściwości klucza, który stanowi kopię zapasową certyfikatu.

Name Type Description
contentType
  • string

Typ nośnika (typ MIME).

SubjectAlternativeNames

Alternatywne nazwy podmiotu obiektu X509.

Name Type Description
dns_names
  • string[]

Nazwy domen.

emails
  • string[]

Adresy e-mail.

upns
  • string[]

Główne nazwy użytkowników.

Trigger

Warunek do zrealizowania dla akcji do wykonania.

Name Type Description
days_before_expiry
  • integer

Dni przed wygaśnięciem, aby spróbować odnowić. Wartość powinna być z wartości od 1 do validity_in_months pomnożona przez 27. Jeśli validity_in_months jest 36, wartość powinna być z wartości od 1 do 972 (36 * 27).

lifetime_percentage
  • integer

Procent okresu istnienia, w którym ma być wyzwalany. Wartość powinna być z wartości od 1 do 99.

X509CertificateProperties

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

Name Type Description
ekus
  • string[]

Ulepszone użycie klucza.

key_usage
  • string[]

Lista użycia kluczy.

sans

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.