Create Certificate - Create Certificate

Új tanúsítványt hoz létre.
Ha ez az első verzió, létrejön a tanúsítványerőforrás. Ehhez a művelethez a tanúsítványokra/létrehozásra vonatkozó engedély szükséges.

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

URI-paraméterek

Name In Kötelező Típus Description
certificate-name
path True

string

A tanúsítvány neve. A megadott érték globálisan másolható a szolgáltatás futtatása céljából. A megadott érték nem tartalmazhat személyazonosításra alkalmas vagy bizalmas adatokat.

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

vaultBaseUrl
path True

string

A tároló neve, például https://myvault.vault.azure.net.

api-version
query True

string

Ügyfél API-verziója.

Kérelem törzse

Name Típus Description
attributes

CertificateAttributes

A tanúsítvány attribútumai (nem kötelező).

policy

CertificatePolicy

A tanúsítvány felügyeleti szabályzata.

tags

object

Alkalmazásspecifikus metaadatok kulcs-érték párok formájában.

Válaszok

Name Típus Description
202 Accepted

CertificateOperation

Létrehozott tanúsítványcsomag.

Other Status Codes

KeyVaultError

Key Vault hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Példák

CreateCertificate

Sample Request

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

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

Definíciók

Name Description
Action

A végrehajtandó művelet.

CertificateAttributes

A tanúsítványkezelési attribútumok.

CertificateCreateParameters

A tanúsítvány paramétereket hoz létre.

CertificateOperation

A rendszer egy tanúsítványműveletet ad vissza aszinkron kérések esetén.

CertificatePolicy

Tanúsítvány felügyeleti szabályzata.

CertificatePolicyAction

A művelet típusa.

DeletionRecoveryLevel

Az aktuális tárolóban lévő tanúsítványok törlési helyreállítási szintjét tükrözi. Ha a "Helyreállítható" értéket tartalmazza, a tanúsítványt véglegesen törölheti egy kiemelt felhasználó; ellenkező esetben csak a rendszer törölheti a tanúsítványt a megőrzési időköz végén.

Error

A Key Vault-kiszolgáló hibája.

IssuerParameters

A tanúsítvány X509-összetevőjének kiállítójának paraméterei.

JsonWebKeyCurveName

Elliptikus görbe neve. Érvényes értékekért lásd: JsonWebKeyCurveName.

JsonWebKeyType

A tanúsítványhoz használandó kulcspár típusa.

KeyProperties

A tanúsítványt alátámasztó kulcspár tulajdonságai.

KeyUsageType

Meghatározza a tanúsítvány kulcsának használatát.

KeyVaultError

A key vault hibakivétele.

LifetimeAction

Művelet és annak eseményindítója, amelyet Key Vault hajt végre egy tanúsítvány élettartama során.

SecretProperties

A tanúsítványt alátámasztó kulcs tulajdonságai.

SubjectAlternativeNames

Egy X509-objektum tulajdonosának alternatív nevei.

Trigger

A művelet végrehajtásához teljesítendő feltétel.

X509CertificateProperties

A tanúsítvány X509-összetevőjének tulajdonságai.

Action

A végrehajtandó művelet.

Name Típus Description
action_type

CertificatePolicyAction

A művelet típusa.

CertificateAttributes

A tanúsítványkezelési attribútumok.

Name Típus Description
created

integer

Létrehozás időpontja UTC-ben.

enabled

boolean

Meghatározza, hogy az objektum engedélyezve van-e.

exp

integer

Lejárati dátum UTC-ben.

nbf

integer

Dátum előtt nem UTC-ben.

recoverableDays

integer

softDelete adatmegőrzési napok. Ha a softDelete engedélyezve van >, akkor az érték =7 és <=90 lehet, ellenkező esetben 0.

recoveryLevel

DeletionRecoveryLevel

Az aktuális tárolóban lévő tanúsítványok törlési helyreállítási szintjét tükrözi. Ha a "Helyreállítható" értéket tartalmazza, a tanúsítványt véglegesen törölheti egy kiemelt felhasználó; ellenkező esetben csak a rendszer törölheti a tanúsítványt a megőrzési időköz végén.

updated

integer

Utolsó frissítés időpontja UTC-ben.

CertificateCreateParameters

A tanúsítvány paramétereket hoz létre.

Name Típus Description
attributes

CertificateAttributes

A tanúsítvány attribútumai (nem kötelező).

policy

CertificatePolicy

A tanúsítvány felügyeleti szabályzata.

tags

object

Alkalmazásspecifikus metaadatok kulcs-érték párok formájában.

CertificateOperation

A rendszer egy tanúsítványműveletet ad vissza aszinkron kérések esetén.

Name Típus Description
cancellation_requested

boolean

Azt jelzi, hogy a tanúsítványműveleten igényelték-e a lemondást.

csr

string

A tanúsítványműveletben használt tanúsítvány-aláírási kérelem (CSR).

error

Error

Hiba történt a tanúsítványművelet során, ha van ilyen.

id

string

A tanúsítvány azonosítója.

issuer

IssuerParameters

A tanúsítvány X509-összetevőjének kiállítójának paraméterei.

request_id

string

A tanúsítványművelet azonosítója.

status

string

A tanúsítványművelet állapota.

status_details

string

A tanúsítványművelet állapotadatai.

target

string

A tanúsítványművelet eredményét tartalmazó hely.

CertificatePolicy

Tanúsítvány felügyeleti szabályzata.

Name Típus Description
attributes

CertificateAttributes

A tanúsítványattribútumok.

id

string

A tanúsítvány azonosítója.

issuer

IssuerParameters

A tanúsítvány X509-összetevőjének kiállítójának paraméterei.

key_props

KeyProperties

A tanúsítványt alátámasztó kulcs tulajdonságai.

lifetime_actions

LifetimeAction[]

A Key Vault által a tanúsítvány élettartama során végrehajtandó műveletek.

secret_props

SecretProperties

A tanúsítványt tartalmazó titkos kód tulajdonságai.

x509_props

X509CertificateProperties

A tanúsítvány X509-összetevőjének tulajdonságai.

CertificatePolicyAction

A művelet típusa.

Name Típus Description
AutoRenew

string

EmailContacts

string

DeletionRecoveryLevel

Az aktuális tárolóban lévő tanúsítványok törlési helyreállítási szintjét tükrözi. Ha a "Helyreállítható" értéket tartalmazza, a tanúsítványt véglegesen törölheti egy kiemelt felhasználó; ellenkező esetben csak a rendszer törölheti a tanúsítványt a megőrzési időköz végén.

Name Típus Description
CustomizedRecoverable

string

Olyan tárolóállapotot jelöl, amelyben a törlés helyreállítható anélkül, hogy azonnali és végleges törlésre van lehetőség (azaz törlés, ha 7< = SoftDeleteRetentionInDays < 90). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időköz alatt, és amíg az előfizetés továbbra is elérhető.

CustomizedRecoverable+ProtectedSubscription

string

Azt a tárolót és előfizetési állapotot jelöli, amelyben a törlés helyreállítható, az azonnali és végleges törlés (azaz a végleges törlés) nem engedélyezett, és amelyben maga az előfizetés nem mondható le véglegesen, ha 7<= SoftDeleteRetentionInDays < 90. Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időköz alatt, és azt is tükrözi, hogy maga az előfizetés nem mondható le.

CustomizedRecoverable+Purgeable

string

Azt a tárolóállapotot jelöli, amelyben a törlés helyreállítható, és amely lehetővé teszi az azonnali és végleges törlést is (azaz a törlést, amikor 7< = SoftDeleteRetentionInDays < 90). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időtartam alatt, kivéve, ha törlési műveletet kérnek, vagy az előfizetést lemondják.

Purgeable

string

Olyan tárolóállapotot jelöl, amelyben a törlés visszafordíthatatlan művelet, a helyreállítás lehetősége nélkül. Ez a szint nem felel meg a Törlés művelet elleni védelemnek; az adatok helyrehozhatatlanul elvesznek egy törlési művelet entitásszinten vagy magasabb szinten (tároló, erőforráscsoport, előfizetés stb.) elfogadásakor.

Recoverable

string

Olyan tárolóállapotot jelöl, amelyben a törlés helyreállítható anélkül, hogy azonnali és végleges törlésre (azaz végleges törlésre) van lehetőség. Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időköz (90 nap) alatt, és amíg az előfizetés továbbra is elérhető. A rendszer 90 nap elteltével véglegesen törli, ha nem állítható helyre

Recoverable+ProtectedSubscription

string

Azt a tárolót és előfizetési állapotot jelöli, amelyben a törlés helyreállítható a megőrzési időtartamon belül (90 nap), az azonnali és végleges törlés (azaz végleges törlés) nem engedélyezett, és amelyben maga az előfizetés nem mondható le véglegesen. A rendszer 90 nap elteltével véglegesen törli, ha nem állítható helyre

Recoverable+Purgeable

string

Olyan tárolóállapotot jelöl, amelyben a törlés helyreállítható, és amely lehetővé teszi az azonnali és végleges törlést (azaz a végleges törlést). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időtartam alatt (90 nap), kivéve, ha törlési műveletet kérnek, vagy az előfizetést lemondják. A rendszer 90 nap elteltével véglegesen törli, ha nem állítható helyre

Error

A Key Vault-kiszolgáló hibája.

Name Típus Description
code

string

A hibakód.

innererror

Error

A Key Vault-kiszolgáló hibája.

message

string

A hibaüzenet.

IssuerParameters

A tanúsítvány X509-összetevőjének kiállítójának paraméterei.

Name Típus Description
cert_transparency

boolean

Azt jelzi, hogy az ebben a szabályzatban létrehozott tanúsítványokat közzé kell-e tenni a tanúsítvány áttetszőségi naplóiban.

cty

string

A szolgáltató által támogatott tanúsítványtípus (nem kötelező); például "OV-SSL", "EV-SSL"

name

string

A hivatkozott kiállítóobjektum vagy fenntartott nevek neve; például az "Ön" vagy az "Ismeretlen".

JsonWebKeyCurveName

Elliptikus görbe neve. Érvényes értékekért lásd: JsonWebKeyCurveName.

Name Típus Description
P-256

string

P-256K

string

P-384

string

P-521

string

JsonWebKeyType

A tanúsítványhoz használandó kulcspár típusa.

Name Típus Description
EC

string

EC-HSM

string

RSA

string

RSA-HSM

string

oct

string

oct-HSM

string

KeyProperties

A tanúsítványt alátámasztó kulcspár tulajdonságai.

Name Típus Description
crv

JsonWebKeyCurveName

Elliptikus görbe neve. Érvényes értékekért lásd: JsonWebKeyCurveName.

exportable

boolean

Azt jelzi, hogy exportálható-e a titkos kulcs. Az exportálható kulcs első verziójának létrehozásakor kiadási szabályzatot kell megadni.

key_size

integer

A kulcs mérete bitekben. Például: 2048, 3072 vagy 4096 RSA esetén.

kty

JsonWebKeyType

A tanúsítványhoz használandó kulcspár típusa.

reuse_key

boolean

Azt jelzi, hogy ugyanazt a kulcspárt használja-e a rendszer a tanúsítványmegújításhoz.

KeyUsageType

Meghatározza a tanúsítvány kulcsának használatát.

Name Típus Description
cRLSign

string

dataEncipherment

string

decipherOnly

string

digitalSignature

string

encipherOnly

string

keyAgreement

string

keyCertSign

string

keyEncipherment

string

nonRepudiation

string

KeyVaultError

A key vault hibakivétele.

Name Típus Description
error

Error

A Key Vault-kiszolgáló hibája.

LifetimeAction

Művelet és annak eseményindítója, amelyet Key Vault hajt végre egy tanúsítvány élettartama során.

Name Típus Description
action

Action

A végrehajtandó művelet.

trigger

Trigger

A műveletet végrehajtó feltétel.

SecretProperties

A tanúsítványt alátámasztó kulcs tulajdonságai.

Name Típus Description
contentType

string

Az adathordozó típusa (MIME-típus).

SubjectAlternativeNames

Egy X509-objektum tulajdonosának alternatív nevei.

Name Típus Description
dns_names

string[]

Tartománynevek.

emails

string[]

Email címeket.

upns

string[]

Egyszerű felhasználónevek.

Trigger

A művelet végrehajtásához teljesítendő feltétel.

Name Típus Description
days_before_expiry

integer

A megújítás megkísérléséhez a lejárat előtt napokat kell elvégezni. Az értéknek 1 és validity_in_months között kell lennie, 27-sel megszorozva. Ha validity_in_months 36, akkor az értéknek 1 és 972 között kell lennie (36 * 27).

lifetime_percentage

integer

Az aktiválandó élettartam százalékos aránya. Az értéknek 1 és 99 között kell lennie.

X509CertificateProperties

A tanúsítvány X509-összetevőjének tulajdonságai.

Name Típus Description
ekus

string[]

A továbbfejlesztett kulcshasználat.

key_usage

KeyUsageType[]

Meghatározza a tanúsítvány kulcsának használatát.

sans

SubjectAlternativeNames

A tulajdonos alternatív nevei.

subject

string

A tulajdonos neve. Érvényes X509 megkülönböztető névnek kell lennie.

validity_months

integer

A tanúsítvány hónapokban érvényes időtartama.