Share via

Get Certificate Policy - Get Certificate Policy

  • Referenz
Service:
Key Vault
API Version:
7.4

Listen die Richtlinie für ein Zertifikat.
Der Vorgang GetCertificatePolicy gibt die angegebenen Zertifikatrichtlinienressourcen im angegebenen Schlüsseltresor zurück. Für diesen Vorgang sind die Zertifikate/Die Berechtigung abrufen erforderlich.

GET {vaultBaseUrl}/certificates/{certificate-name}/policy?api-version=7.4

URI-Parameter

Name In Erforderlich Typ Beschreibung
certificate-name
 path True

string

Der Name des Zertifikats in einem bestimmten Schlüsseltresor.
vaultBaseUrl
 path True

string

Der Tresorname, z. B https://myvault.vault.azure.net. .
api-version
 query True

string

Client-API-Version.

Antworten

Name Typ Beschreibung
200 OK

CertificatePolicy

Die Zertifikatrichtlinie.
Other Status Codes

KeyVaultError

Key Vault Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

GetCertificatePolicy

Sample Request

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

Sample Response

Status code:
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
  }
}

Definitionen

Name Beschreibung
Action

Die Aktion, die ausgeführt wird.
CertificateAttributes

Die Zertifikatverwaltungsattribute.
CertificatePolicy

Verwaltungsrichtlinie für ein Zertifikat.
CertificatePolicyAction

Der Typ der Aktion.
DeletionRecoveryLevel

Gibt die Löschwiederherstellungsebene an, die derzeit für Zertifikate im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann das Zertifikat von einem privilegierten Benutzer endgültig gelöscht werden. andernfalls kann nur das System das Zertifikat am Ende des Aufbewahrungsintervalls bereinigen.
Error

Der Schlüsseltresorserverfehler.
IssuerParameters

Parameter für den Aussteller der X509-Komponente eines Zertifikats.
JsonWebKeyCurveName

Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName.
JsonWebKeyType

Der Typ des Schlüsselpaars, das für das Zertifikat verwendet werden soll.
KeyProperties

Eigenschaften des Schlüsselpaars, das ein Zertifikat sichert.
KeyUsageType

Definiert, wie der Schlüssel des Zertifikats verwendet werden kann.
KeyVaultError

Die Schlüsseltresorfehler-Ausnahme.
LifetimeAction

Aktion und zugehörigen Trigger, die von Key Vault während der Lebensdauer eines Zertifikats ausgeführt werden.
SecretProperties

Eigenschaften des Schlüssels, der ein Zertifikat sichert.
SubjectAlternativeNames

Die alternativen Antragstellernamen eines X509-Objekts.
Trigger

Eine Bedingung, die erfüllt werden muss, damit eine Aktion ausgeführt wird.
X509CertificateProperties

Eigenschaften der X509-Komponente eines Zertifikats.

Action

Die Aktion, die ausgeführt wird.

Name Typ Beschreibung
action_type

CertificatePolicyAction

Der Typ der Aktion.

CertificateAttributes

Die Zertifikatverwaltungsattribute.

Name Typ Beschreibung
created

integer

Erstellungszeit in UTC.
enabled

boolean

Bestimmt, ob das Objekt aktiviert ist.
exp

integer

Ablaufdatum in UTC.
nbf

integer

Nicht vor Datum in UTC.
recoverableDays

integer

softDelete Datenaufbewahrungstage. Der Wert sollte =7 und <=90 sein>, wenn softDelete aktiviert ist, andernfalls 0.
recoveryLevel

DeletionRecoveryLevel

Gibt die Löschwiederherstellungsebene an, die derzeit für Zertifikate im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann das Zertifikat von einem privilegierten Benutzer endgültig gelöscht werden. andernfalls kann nur das System das Zertifikat am Ende des Aufbewahrungsintervalls bereinigen.
updated

integer

Uhrzeit der letzten Aktualisierung in UTC.

CertificatePolicy

Verwaltungsrichtlinie für ein Zertifikat.

Name Typ Beschreibung
attributes

CertificateAttributes

Die Zertifikatattribute.
id

string

Die Zertifikat-ID.
issuer

IssuerParameters

Parameter für den Aussteller der X509-Komponente eines Zertifikats.
key_props

KeyProperties

Eigenschaften des Schlüssels, der ein Zertifikat sichert.
lifetime_actions

LifetimeAction[]

Aktionen, die von Key Vault während der Lebensdauer eines Zertifikats ausgeführt werden.
secret_props

SecretProperties

Eigenschaften des Geheimnisses, das ein Zertifikat sichert.
x509_props

X509CertificateProperties

Eigenschaften der X509-Komponente eines Zertifikats.

CertificatePolicyAction

Der Typ der Aktion.

Name Typ Beschreibung
AutoRenew

string

EmailContacts

string

DeletionRecoveryLevel

Gibt die Löschwiederherstellungsebene an, die derzeit für Zertifikate im aktuellen Tresor wirksam ist. Wenn es "Löschbar" enthält, kann das Zertifikat von einem privilegierten Benutzer endgültig gelöscht werden. andernfalls kann nur das System das Zertifikat am Ende des Aufbewahrungsintervalls bereinigen.

Name Typ Beschreibung
CustomizedRecoverable

string

Gibt einen Tresorzustand an, in dem das Löschen ohne die Möglichkeit zum sofortigen und dauerhaften Löschen wiederhergestellt werden kann (d. h. löschen, wenn 7< = SoftDeleteRetentionInDays < 90). Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und solange das Abonnement noch verfügbar ist.
CustomizedRecoverable+ProtectedSubscription

string

Gibt einen Tresor- und Abonnementstatus an, in dem das Löschen wiederhergestellt werden kann, das sofortige und dauerhafte Löschen (d. h. löschen) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft gekündigt werden kann, wenn 7<= SoftDeleteRetentionInDays < 90. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und spiegelt auch die Tatsache wider, dass das Abonnement selbst nicht gekündigt werden kann.
CustomizedRecoverable+Purgeable

string

Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann und der auch eine sofortige und dauerhafte Löschung zulässt (d. h. löschen, wenn 7< = SoftDeleteRetentionInDays < 90). Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls, es sei denn, es wird ein Löschvorgang angefordert oder das Abonnement gekündigt.
Purgeable

string

Gibt einen Tresorzustand an, in dem das Löschen ein irreversibler Vorgang ist, ohne dass die Möglichkeit zur Wiederherstellung besteht. Diese Ebene entspricht keinem Schutz gegen einen Löschvorgang. Die Daten sind unwiederbringlich verloren, wenn sie einen Löschvorgang auf Entitätsebene oder höher (Tresor, Ressourcengruppe, Abonnement usw.) akzeptieren.
Recoverable

string

Gibt einen Tresorzustand an, in dem das Löschen ohne die Möglichkeit zum sofortigen und dauerhaften Löschen (d. h. löschen) wiederhergestellt werden kann. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungszeitraums (90 Tage) und solange das Abonnement noch verfügbar ist. Das System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wurde
Recoverable+ProtectedSubscription

string

Gibt einen Tresor- und Abonnementstatus an, in dem das Löschen innerhalb eines Aufbewahrungsintervalls (90 Tage) wiederhergestellt werden kann, das sofortige und dauerhafte Löschen (d. h. löschen) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft gekündigt werden kann. Das System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wurde
Recoverable+Purgeable

string

Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann und der auch das sofortige und dauerhafte Löschen (d. h. Löschen) zulässt. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage), es sei denn, es wird ein Löschvorgang angefordert oder das Abonnement gekündigt. Das System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wurde

Error

Der Schlüsseltresorserverfehler.

Name Typ Beschreibung
code

string

Der Fehlercode.
innererror

Error

Der Schlüsseltresorserverfehler.
message

string

Die Fehlermeldung.

IssuerParameters

Parameter für den Aussteller der X509-Komponente eines Zertifikats.

Name Typ Beschreibung
cert_transparency

boolean

Gibt an, ob die unter dieser Richtlinie generierten Zertifikate in Zertifikattransparenzprotokollen veröffentlicht werden sollen.
cty

string

Zertifikattyp, der vom Anbieter unterstützt wird (optional); z. B. "OV-SSL", "EV-SSL"
name

string

Name des Ausstellerobjekts oder des reservierten Namens; z. B. "Selbst" oder "Unbekannt".

JsonWebKeyCurveName

Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName.

Name Typ Beschreibung
P-256

string

P-256K

string

P-384

string

P-521

string

JsonWebKeyType

Der Typ des Schlüsselpaars, das für das Zertifikat verwendet werden soll.

Name Typ Beschreibung
EC

string

EC-HSM

string

RSA

string

RSA-HSM

string

oct

string

oct-HSM

string

KeyProperties

Eigenschaften des Schlüsselpaars, das ein Zertifikat sichert.

Name Typ Beschreibung
crv

JsonWebKeyCurveName

Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName.
exportable

boolean

Gibt an, ob der private Schlüssel exportiert werden kann. Die Releaserichtlinie muss beim Erstellen der ersten Version eines exportierbaren Schlüssels bereitgestellt werden.
key_size

integer

Die Schlüsselgröße in Bits. Beispiel: 2048, 3072 oder 4096 für RSA.
kty

JsonWebKeyType

Der Typ des Schlüsselpaars, das für das Zertifikat verwendet werden soll.
reuse_key

boolean

Gibt an, ob dasselbe Schlüsselpaar bei der Zertifikatverlängerung verwendet wird.

KeyUsageType

Definiert, wie der Schlüssel des Zertifikats verwendet werden kann.

Name Typ Beschreibung
cRLSign

string

dataEncipherment

string

decipherOnly

string

digitalSignature

string

encipherOnly

string

keyAgreement

string

keyCertSign

string

keyEncipherment

string

nonRepudiation

string

KeyVaultError

Die Schlüsseltresorfehler-Ausnahme.

Name Typ Beschreibung
error

Error

Der Schlüsseltresorserverfehler.

LifetimeAction

Aktion und zugehörigen Trigger, die von Key Vault während der Lebensdauer eines Zertifikats ausgeführt werden.

Name Typ Beschreibung
action

Action

Die Aktion, die ausgeführt wird.
trigger

Trigger

Die Bedingung, die die Aktion ausführt.

SecretProperties

Eigenschaften des Schlüssels, der ein Zertifikat sichert.

Name Typ Beschreibung
contentType

string

Der Medientyp (MIME-Typ).

SubjectAlternativeNames

Die alternativen Antragstellernamen eines X509-Objekts.

Name Typ Beschreibung
dns_names

string[]

Domänennamen.
emails

string[]

E-Mail-Adressen
upns

string[]

Benutzerprinzipalnamen.

Trigger

Eine Bedingung, die erfüllt werden muss, damit eine Aktion ausgeführt wird.

Name Typ Beschreibung
days_before_expiry

integer

Tage vor Ablauf, um eine Verlängerung zu versuchen. Der Wert sollte zwischen 1 und validity_in_months multipliziert mit 27 sein. Wenn validity_in_months 36 ist, sollte der Wert zwischen 1 und 972 (36 * 27) sein.
lifetime_percentage

integer

Prozentsatz der Lebensdauer, mit der ausgelöst werden soll. Der Wert sollte zwischen 1 und 99 sein.

X509CertificateProperties

Eigenschaften der X509-Komponente eines Zertifikats.

Name Typ Beschreibung
ekus

string[]

Die erweiterte Schlüsselverwendung.
key_usage

KeyUsageType[]

Definiert, wie der Schlüssel des Zertifikats verwendet werden kann.
sans

SubjectAlternativeNames

Alternative Antragstellernamen.
subject

string

Der Name des Subjekts. Sollte ein gültiger distinguished X509-Name sein.
validity_months

integer

Die Gültigkeitsdauer des Zertifikats in Monaten.