Get Certificate Policy - Get Certificate Policy

Szolgáltatás:

Key Vault

API-verzió:

2025-07-01

Felsorolja a tanúsítvány házirendjét.
A GetCertificatePolicy művelet a megadott tanúsítványházirend-erőforrásokat adja vissza a megadott kulcstartóban. Ehhez a művelethez tanúsítványokra/engedélyek beszerzésére van szükség.

GET {vaultBaseUrl}/certificates/{certificate-name}/policy?api-version=2025-07-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
certificate-name	path	True	string	Az adott kulcstartóban lévő tanúsítvány neve.
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	CertificatePolicy	A kérés sikeres volt.
Other Status Codes	KeyVaultError	Váratlan hibaválasz.

Biztonság

OAuth2Auth

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
https://vault.azure.net/.default

Példák

GetCertificatePolicy

Mintakérelem

HTTP

GET https://myvault.vault.azure.net//certificates/updateCert01/policy?api-version=2025-07-01

Mintaválasz

Állapotkód:

200

{
  "id": "https://myvault.vault.azure.net/certificates/updateCert01/policy",
  "key_props": {
    "exportable": true,
    "kty": "RSA",
    "key_size": 2048,
    "reuse_key": false
  },
  "secret_props": {
    "contentType": "application/x-pkcs12"
  },
  "x509_props": {
    "subject": "CN=KeyVaultTest",
    "ekus": [],
    "key_usage": [],
    "validity_months": 297
  },
  "lifetime_actions": [
    {
      "trigger": {
        "lifetime_percentage": 80
      },
      "action": {
        "action_type": "EmailContacts"
      }
    }
  ],
  "issuer": {
    "name": "Unknown"
  },
  "attributes": {
    "enabled": true,
    "created": 1482188947,
    "updated": 1482188947
  }
}

Definíciók

Name	Description
Action	A végrehajtandó művelet.
CertificateAttributes	A tanúsítványkezelési attribútumok.
CertificatePolicy	Tanúsítvány kezelési szabályzata.
CertificatePolicyAction	A művelet típusa.
DeletionRecoveryLevel	Az aktuális tárolóban lévő titkos kulcsok jelenleg érvényben lévő törlési helyreállítási szintjét tükrözi. Ha a "Tisztítható" értéket tartalmazza, a titkos kulcsot egy kiemelt felhasználó véglegesen törölheti; ellenkező esetben csak a rendszer tudja kiüríteni a titkos kulcsot a megőrzési időköz végén.
Error
IssuerParameters	A tanúsítvány X509 összetevőjének kibocsá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 támogató kulcspár tulajdonságai.
KeyUsageType	A tanúsítványkulcs támogatott használata.
KeyVaultError	A kulcstartó hibakivétele.
LifetimeAction	Művelet és annak eseményindítója, amelyet Key Vault hajt végre a tanúsítvány élettartama alatt.
SecretProperties	A tanúsítványt támogató kulcs tulajdonságai.
SubjectAlternativeNames	Az X509 objektum tárgyá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

Objektum

A végrehajtandó művelet.

Name	Típus	Description
action_type	CertificatePolicyAction	A művelet típusa.

CertificateAttributes

Objektum

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

Name	Típus	Description
created	integer (unixtime)	Létrehozás ideje UTC-ben.
enabled	boolean	Meghatározza, hogy az objektum engedélyezve van-e.
exp	integer (unixtime)	Lejárati dátum UTC-ben.
nbf	integer (unixtime)	Nem korábbi dátum UTC-ben.
recoverableDays	integer (int32)	softDelete adatmegőrzési napok. Az értéknek =7 és >=90-nek kell lennie<, ha a softDelete engedélyezve van, 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 "Tisztítható" értéket tartalmazza, a tanúsítványt egy kiemelt felhasználó véglegesen törölheti; ellenkező esetben csak a rendszer tudja kiüríteni a tanúsítványt a megőrzési időköz végén.
updated	integer (unixtime)	Utolsó frissítés időpontja UTC-ben.

CertificatePolicy

Objektum

Tanúsítvány kezelési szabályzata.

Name	Típus	Description
attributes	CertificateAttributes	A tanúsítvány attribútumai.
id	string	A tanúsítvány azonosítója.
issuer	IssuerParameters	A tanúsítvány X509 összetevőjének kibocsátójának paraméterei.
key_props	KeyProperties	A tanúsítványt támogató kulcs tulajdonságai.
lifetime_actions	LifetimeAction[]	A Key Vault által a tanúsítvány élettartama alatt végrehajtott műveletek.
secret_props	SecretProperties	A tanúsítványt alátámasztó titkos kulcs tulajdonságai.
x509_props	X509CertificateProperties	A tanúsítvány X509 összetevőjének tulajdonságai.

CertificatePolicyAction

Enumerálás

A művelet típusa.

Érték	Description
EmailContacts	Tanúsítvány-szabályzat, amely e-mailt küld a tanúsítvány kapcsolattartóinak.
AutoRenew	Tanúsítvány-házirend, amely automatikusan megújítja a tanúsítványt.

DeletionRecoveryLevel

Enumerálás

Az aktuális tárolóban lévő titkos kulcsok jelenleg érvényben lévő törlési helyreállítási szintjét tükrözi. Ha a "Tisztítható" értéket tartalmazza, a titkos kulcsot egy kiemelt felhasználó véglegesen törölheti; ellenkező esetben csak a rendszer tudja kiüríteni a titkos kulcsot a megőrzési időköz végén.

Érték	Description
Purgeable	Olyan tárolóállapotot jelöl, amelyben a törlés visszafordíthatatlan művelet, helyreállítás lehetősége nélkül. Ez a szint azt jelenti, hogy nincs védelem a törlési műveletekkel szemben; az adatok helyrehozhatatlanul elvesznek, ha elfogad egy törlési műveletet entitásszintű vagy magasabb szinten (tároló, erőforráscsoport, előfizetés stb.)
Recoverable+Purgeable	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 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őköz (90 nap) alatt, kivéve, ha a rendszer végleges törlési műveletet kér, vagy az előfizetést megszakítja. A rendszer 90 nap elteltével véglegesen törli, ha nem áll helyre
Recoverable	Olyan tárolóállapotot jelöl, amelyben a törlés helyreállítható azonnali és végleges törlés (pl. törlés) lehetősége nélkül. 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 még elérhető. A rendszer 90 nap elteltével véglegesen törli, ha nem áll helyre
Recoverable+ProtectedSubscription	Olyan tároló- és előfizetési állapotot jelöl, amelyben a törlés a megőrzési időközön belül (90 nap) helyreállítható, az azonnali és végleges törlés (azaz a 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 helyre
CustomizedRecoverable+Purgeable	Olyan tárolóállapotot jelöl, amelyben a törlés helyreállítható, és amely azonnali és végleges törlést is lehetővé tesz (azaz végleges 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, kivéve, ha a rendszer végleges törlési műveletet kér, vagy az előfizetést megszakítja.
CustomizedRecoverable	Olyan tárolóállapotot jelöl, amelyben a törlés helyreállítható az azonnali és végleges törlés lehetősége nélkül (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 még elérhető.
CustomizedRecoverable+ProtectedSubscription	Olyan tároló és előfizetési állapotot jelöl, amelyben a törlés helyreállítható, az azonnali és végleges törlés (azaz a 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őszak alatt, és azt is tükrözi, hogy maga az előfizetés nem mondható le.

Error

Objektum

Name	Típus	Description
code	string	A hibakód.
innererror	Error	A kulcstartó-kiszolgáló hibája.
message	string	A hibaüzenet.

IssuerParameters

Objektum

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

Name	Típus	Description
cert_transparency	boolean	Azt jelzi, hogy a szabályzat alapján létrehozott tanúsítványokat közzé kell-e tenni a tanúsítványok átlátható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ói objektum vagy fenntartott nevek neve; például "Én" vagy "Ismeretlen".

JsonWebKeyCurveName

Enumerálás

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

Érték	Description
P-256	A NIST P-256 elliptikus görbe, más néven SECG görbe SECP256R1.
P-384	A NIST P-384 elliptikus görbe, más néven SECG görbe SECP384R1.
P-521	A NIST P-521 elliptikus görbe, más néven SECG görbe SECP521R1.
P-256K	A SECG SECP256K1 elliptikus görbe.

JsonWebKeyType

Enumerálás

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

Érték	Description
EC	Elliptikus görbe.
EC-HSM	Elliptikus görbe egy privát kulccsal, amely nem exportálható a HSM-ből.
RSA	RSA (https://tools.ietf.org/html/rfc3447).
RSA-HSM	RSA olyan titkos kulccsal, amely nem exportálható a HSM-ből.
oct	Oktettsorozat (szimmetrikus kulcsok ábrázolására szolgál).
oct-HSM	Oktettsorozat egy privát kulccsal, amely nem exportálható a HSM-ből.

KeyProperties

Objektum

A tanúsítványt támogató 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 a titkos kulcs exportálható-e. Az exportálható kulcs első verziójának létrehozásakor meg kell adni a kiadási szabályzatot.
key_size	integer (int32)	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ány megújításakor.

KeyUsageType

Enumerálás

A tanúsítványkulcs támogatott használata.

Érték	Description
digitalSignature	Azt jelzi, hogy a tanúsítványkulcs digitális aláírásként használható.
nonRepudiation	Azt jelzi, hogy a tanúsítványkulcs használható hitelesítésre.
keyEncipherment	Azt jelzi, hogy a tanúsítványkulcs használható a kulcs titkosítására.
dataEncipherment	Azt jelzi, hogy a tanúsítványkulcs használható adattitkosításhoz.
keyAgreement	Azt jelzi, hogy a tanúsítványkulcs felhasználható a kulcsmegállapodás meghatározására, például a Diffie-Hellman kulcsmegállapodás algoritmusával létrehozott kulcsra.
keyCertSign	Azt jelzi, hogy a tanúsítványkulcs használható tanúsítványok aláírására.
cRLSign	Azt jelzi, hogy a tanúsítványkulccsal aláírható egy visszavont tanúsítvány listája.
encipherOnly	Azt jelzi, hogy a tanúsítványkulcs csak titkosításra használható.
decipherOnly	Azt jelzi, hogy a tanúsítványkulcs csak visszafejtésre használható.

KeyVaultError

Objektum

A kulcstartó hibakivétele.

Name	Típus	Description
error	Error	A kulcstartó-kiszolgáló hibája.

LifetimeAction

Objektum

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

Name	Típus	Description
action	Action	A végrehajtandó művelet.
trigger	Trigger	A műveletet végrehajtó feltétel.

SecretProperties

Objektum

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

Name	Típus	Description
contentType	string	A hordozó típusa (MIME típus).

SubjectAlternativeNames

Objektum

Az X509 objektum tárgyának alternatív nevei.

Name	Típus	Description
dns_names	string[]	Domain nevek.
emails	string[]	E-mail-címek.
ipAddresses	string[]	IP-címek; támogatja az IPv4-et és az IPv6-ot.
upns	string[]	Egyszerű felhasználónevek.
uris	string[]	Egységes erőforrás-azonosítók.

Trigger

Objektum

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

Name	Típus	Description
days_before_expiry	integer (int32)	Napokkal a lejárat előtt megkísérelheti a megújítást. Az értéknek 1 és validity_in_months között kell lennie, szorozva 27-tel. Ha validity_in_months 36, akkor az értéknek 1 és 972 között kell lennie (36 * 27).
lifetime_percentage	integer (int32) minimum: 1 maximum: 99	Az aktiválás élettartamának százalékos aránya. Az értéknek 1 és 99 között kell lennie.

X509CertificateProperties

Objektum

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, hogyan használható a tanúsítvány kulcsa.
sans	SubjectAlternativeNames	A tárgy alternatív nevei.
subject	string	A tárgy neve. Érvényes X509 megkülönböztető névnek kell lennie.
validity_months	integer (int32) minimum: 0	A tanúsítvány érvényességi ideje hónapokban.