Get Certificate Policy - Get Certificate Policy

Referentie

Service:: Key Vault

API-versie:: 7.4

Geeft het beleid voor een certificaat weer.
De bewerking GetCertificatePolicy retourneert de opgegeven certificaatbeleidsbronnen in de opgegeven sleutelkluis. Voor deze bewerking zijn de certificaten/machtigingen vereist.

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

URI-parameters

Name	In	Vereist	Type	Description
certificate-name	path	True	string	De naam van het certificaat in een bepaalde sleutelkluis.
vaultBaseUrl	path	True	string	De kluisnaam, bijvoorbeeld https://myvault.vault.azure.net.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	CertificatePolicy	Het certificaatbeleid.
Other Status Codes	KeyVaultError	Key Vault-foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

GetCertificatePolicy

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 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
  }
}

Definities

Name	Description
Action	De actie die wordt uitgevoerd.
CertificateAttributes	De certificaatbeheerkenmerken.
CertificatePolicy	Beheerbeleid voor een certificaat.
CertificatePolicyAction	Het type actie.
DeletionRecoveryLevel	Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor certificaten in de huidige kluis. Als het 'Leegmaken' bevat, kan het certificaat permanent worden verwijderd door een bevoegde gebruiker; anders kan alleen het systeem het certificaat opschonen, aan het einde van het bewaarinterval.
Error	De sleutelkluisserverfout.
IssuerParameters	Parameters voor de verlener van het X509-onderdeel van een certificaat.
JsonWebKeyCurveName	Elliptische curvenaam. Zie JsonWebKeyCurveName voor geldige waarden.
JsonWebKeyType	Het type sleutelpaar dat moet worden gebruikt voor het certificaat.
KeyProperties	Eigenschappen van het sleutelpaar dat een certificaat back-up heeft.
KeyUsageType	Definieert hoe de sleutel van het certificaat kan worden gebruikt.
KeyVaultError	De fout-uitzondering voor de sleutelkluis.
LifetimeAction	Actie en de trigger die door Key Vault worden uitgevoerd gedurende de levensduur van een certificaat.
SecretProperties	Eigenschappen van de sleutel die een certificaat maken.
SubjectAlternativeNames	De alternatieve onderwerpnamen van een X509-object.
Trigger	Een voorwaarde waaraan moet worden voldaan om een actie uit te voeren.
X509CertificateProperties	Eigenschappen van het X509-onderdeel van een certificaat.

Action

Object

De actie die wordt uitgevoerd.

Name	Type	Description
action_type	CertificatePolicyAction	Het type actie.

CertificateAttributes

Object

De certificaatbeheerkenmerken.

Name	Type	Description
created	integer (unixtime)	Aanmaaktijd in UTC.
enabled	boolean	Bepaalt of het object is ingeschakeld.
exp	integer (unixtime)	Vervaldatum in UTC.
nbf	integer (unixtime)	Niet vóór de datum in UTC.
recoverableDays	integer (int32)	softDelete-gegevensretentiedagen. De waarde moet worden >=7 en <=90 wanneer softDelete is ingeschakeld, anders 0.
recoveryLevel	DeletionRecoveryLevel	Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor certificaten in de huidige kluis. Als het 'Leegmaken' bevat, kan het certificaat permanent worden verwijderd door een bevoegde gebruiker; anders kan alleen het systeem het certificaat opschonen, aan het einde van het bewaarinterval.
updated	integer (unixtime)	Laatst bijgewerkt in UTC.

CertificatePolicy

Object

Beheerbeleid voor een certificaat.

Name	Type	Description
attributes	CertificateAttributes	De certificaatkenmerken.
id	string	De certificaat-id.
issuer	IssuerParameters	Parameters voor de verlener van het X509-onderdeel van een certificaat.
key_props	KeyProperties	Eigenschappen van de sleutel die een certificaat maken.
lifetime_actions	LifetimeAction[]	Acties die worden uitgevoerd door Key Vault gedurende de levensduur van een certificaat.
secret_props	SecretProperties	Eigenschappen van de geheime back-up van een certificaat.
x509_props	X509CertificateProperties	Eigenschappen van het X509-onderdeel van een certificaat.

CertificatePolicyAction

Inventarisatie

Het type actie.

Waarde	Description
AutoRenew
EmailContacts

DeletionRecoveryLevel

Inventarisatie

Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor certificaten in de huidige kluis. Als het 'Leegmaken' bevat, kan het certificaat permanent worden verwijderd door een bevoegde gebruiker; anders kan alleen het systeem het certificaat opschonen, aan het einde van het bewaarinterval.

Waarde	Description
CustomizedRecoverable	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid om onmiddellijk en permanent te worden verwijderd (bijvoorbeeld leegmaken wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en terwijl het abonnement nog steeds beschikbaar is.
CustomizedRecoverable+ProtectedSubscription	Geeft een kluis- en abonnementsstatus aan waarin verwijdering kan worden hersteld, onmiddellijk en permanent kan worden verwijderd (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet permanent kan worden geannuleerd wanneer 7<= SoftDeleteRetentionInDays < 90. Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en weerspiegelt ook het feit dat het abonnement zelf niet kan worden geannuleerd.
CustomizedRecoverable+Purgeable	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (bijvoorbeeld leegmaken wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval, tenzij er een opschoningsbewerking wordt aangevraagd of het abonnement wordt geannuleerd.
Purgeable	Geeft een kluisstatus aan waarin verwijdering een onherstelbare bewerking is, zonder de mogelijkheid voor herstel. Dit niveau komt overeen met geen beveiliging die beschikbaar is tegen een verwijderbewerking; de gegevens verloren gaan bij het accepteren van een verwijderbewerking op entiteitsniveau of hoger (kluis, resourcegroep, abonnement, enzovoort)
Recoverable	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid om onmiddellijk en permanent te verwijderen (dat wil bijvoorbeeld leegmaken). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval (90 dagen) en terwijl het abonnement nog steeds beschikbaar is. Het systeem wordt na 90 dagen definitief verwijderd, indien niet hersteld
Recoverable+ProtectedSubscription	Geeft een kluis- en abonnementsstatus aan waarin verwijdering kan worden hersteld binnen het bewaarinterval (90 dagen), onmiddellijke en permanente verwijdering (dat wil zeggen opschonen) is niet toegestaan en waarin het abonnement zelf niet permanent kan worden geannuleerd. Het systeem wordt na 90 dagen definitief verwijderd, indien niet hersteld
Recoverable+Purgeable	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld, en die ook onmiddellijke en permanente verwijdering toestaat (bijvoorbeeld opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval (90 dagen), tenzij er een opschoningsbewerking wordt aangevraagd of het abonnement wordt geannuleerd. Het systeem wordt na 90 dagen definitief verwijderd, indien niet hersteld

Error

Object

De sleutelkluisserverfout.

Name	Type	Description
code	string	De foutcode.
innererror	Error	De sleutelkluisserverfout.
message	string	Het foutbericht.

IssuerParameters

Object

Parameters voor de verlener van het X509-onderdeel van een certificaat.

Name	Type	Description
cert_transparency	boolean	Geeft aan of de certificaten die onder dit beleid worden gegenereerd, moeten worden gepubliceerd naar de transparantielogboeken van certificaten.
cty	string	Certificaattype zoals ondersteund door de provider (optioneel); bijvoorbeeld OV-SSL, EV-SSL
name	string	Naam van het object van de uitgever waarnaar wordt verwezen of gereserveerde namen; Bijvoorbeeld 'Zelf' of 'Onbekend'.

JsonWebKeyCurveName

Inventarisatie

Elliptische curvenaam. Zie JsonWebKeyCurveName voor geldige waarden.

Waarde	Description
P-256
P-256K
P-384
P-521

JsonWebKeyType

Inventarisatie

Het type sleutelpaar dat moet worden gebruikt voor het certificaat.

Waarde	Description
EC
EC-HSM
RSA
RSA-HSM
oct
oct-HSM

KeyProperties

Object

Eigenschappen van het sleutelpaar dat een certificaat back-up heeft.

Name	Type	Description
crv	JsonWebKeyCurveName	Elliptische curvenaam. Zie JsonWebKeyCurveName voor geldige waarden.
exportable	boolean	Geeft aan of de persoonlijke sleutel kan worden geëxporteerd. Releasebeleid moet worden opgegeven bij het maken van de eerste versie van een exportbare sleutel.
key_size	integer (int32)	De sleutelgrootte in bits. Bijvoorbeeld: 2048, 3072 of 4096 voor RSA.
kty	JsonWebKeyType	Het type sleutelpaar dat moet worden gebruikt voor het certificaat.
reuse_key	boolean	Geeft aan of hetzelfde sleutelpaar wordt gebruikt voor certificaatvernieuwing.

KeyUsageType

Inventarisatie

Definieert hoe de sleutel van het certificaat kan worden gebruikt.

Waarde	Description
cRLSign
dataEncipherment
decipherOnly
digitalSignature
encipherOnly
keyAgreement
keyCertSign
keyEncipherment
nonRepudiation

KeyVaultError

Object

De fout-uitzondering voor de sleutelkluis.

Name	Type	Description
error	Error	De sleutelkluisserverfout.

LifetimeAction

Object

Actie en de trigger die door Key Vault worden uitgevoerd gedurende de levensduur van een certificaat.

Name	Type	Description
action	Action	De actie die wordt uitgevoerd.
trigger	Trigger	De voorwaarde waarmee de actie wordt uitgevoerd.

SecretProperties

Object

Eigenschappen van de sleutel die een certificaat maken.

Name	Type	Description
contentType	string	Het mediatype (MIME-type).

SubjectAlternativeNames

Object

De alternatieve onderwerpnamen van een X509-object.

Name	Type	Description
dns_names	string[]	Domeinnamen.
emails	string[]	E-mailadressen.
upns	string[]	Principal-namen van gebruikers.

Trigger

Object

Een voorwaarde waaraan moet worden voldaan om een actie uit te voeren.

Name	Type	Description
days_before_expiry	integer (int32)	Dagen vóór de vervaldatum om te proberen te verlengen. De waarde moet tussen 1 en validity_in_months vermenigvuldigd met 27. Als validity_in_months 36 is, moet de waarde tussen 1 en 972 (36 * 27) zijn.
lifetime_percentage	integer (int32) minimum: 1 maximum: 99	Percentage levensduur waarop moet worden geactiveerd. De waarde moet tussen 1 en 99 zijn.

X509CertificateProperties

Object

Eigenschappen van het X509-onderdeel van een certificaat.

Name	Type	Description
ekus	string[]	Het verbeterde sleutelgebruik.
key_usage	KeyUsageType[]	Definieert hoe de sleutel van het certificaat kan worden gebruikt.
sans	SubjectAlternativeNames	De alternatieve namen van het onderwerp.
subject	string	De onderwerpnaam. Moet een geldige X509 DN-naam zijn.
validity_months	integer (int32) minimum: 0	De duur van het certificaat is in maanden geldig.

Delen via

Get Certificate Policy - Get Certificate Policy

URI-parameters

Antwoorden

Voorbeelden

GetCertificatePolicy

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Action

CertificateAttributes

CertificatePolicy

CertificatePolicyAction

DeletionRecoveryLevel

Error

IssuerParameters

JsonWebKeyCurveName

JsonWebKeyType

KeyProperties

KeyUsageType

KeyVaultError

LifetimeAction

SecretProperties

SubjectAlternativeNames

Trigger

X509CertificateProperties

Aanvullende resources