Update Certificate - Update Certificate

Referentie

Service:: Key Vault

API Version:: 7.4

Updates de opgegeven kenmerken die zijn gekoppeld aan het opgegeven certificaat.
Met de bewerking UpdateCertificate wordt de opgegeven update toegepast op het opgegeven certificaat; de enige elementen die zijn bijgewerkt, zijn de kenmerken van het certificaat. Voor deze bewerking is de machtiging certificaten/bijwerken vereist.

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

URI-parameters

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

Aanvraagbody

Name	Type	Description
attributes	CertificateAttributes	De kenmerken van het certificaat (optioneel).
policy	CertificatePolicy	Het beheerbeleid voor het certificaat.
tags	object	Toepassingsspecifieke metagegevens in de vorm van sleutel-waardeparen.

Antwoorden

Name	Type	Description
200 OK	CertificateBundle	Het bijgewerkte certificaat.
Other Status Codes	KeyVaultError	Key Vault foutbericht waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

UpdateCertificate

Sample Request

HTTP

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

{
  "attributes": {
    "enabled": true,
    "nbf": 1430344421,
    "exp": 2208988799
  },
  "tags": {
    "department": "KeyVaultTest"
  }
}

Sample Response

Status code:: 200

{
  "id": "https://myvault.vault.azure.net/certificates/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc",
  "kid": "https://myvault.vault.azure.net/keys/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc",
  "sid": "https://myvault.vault.azure.net/secrets/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc",
  "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
  "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=",
  "attributes": {
    "enabled": true,
    "nbf": 1430344421,
    "exp": 2208988799,
    "created": 1482188981,
    "updated": 1482188981
  },
  "tags": {
    "department": "KeyVaultTest"
  }
}

Definities

Name	Description
Action	De actie die wordt uitgevoerd.
CertificateAttributes	De certificaatbeheerkenmerken.
CertificateBundle	Een certificaatbundel bestaat uit een certificaat (X509) plus de bijbehorende kenmerken.
CertificatePolicy	Beheerbeleid voor een certificaat.
CertificatePolicyAction	Het type actie.
CertificateUpdateParameters	De parameters voor het bijwerken van het certificaat.
DeletionRecoveryLevel	Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor certificaten in de huidige kluis. Als het 'Opschonen' bevat, kan het certificaat permanent worden verwijderd door een bevoegde gebruiker; anders kan alleen het systeem het certificaat opschonen, aan het einde van het retentie-interval.
Error	De sleutelkluisserverfout.
IssuerParameters	Parameters voor de verlener van het X509-onderdeel van een certificaat.
JsonWebKeyCurveName	Naam van elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.
JsonWebKeyType	Het type sleutelpaar dat moet worden gebruikt voor het certificaat.
KeyProperties	Eigenschappen van het sleutelpaar dat als back-up van een certificaat wordt gebruikt.
KeyUsageType	Hiermee definieert u hoe de sleutel van het certificaat mag worden gebruikt.
KeyVaultError	De fout-uitzondering voor de sleutelkluis.
LifetimeAction	Actie en de bijbehorende trigger die worden uitgevoerd door Key Vault gedurende de levensduur van een certificaat.
SecretProperties	Eigenschappen van de sleutel die als back-up van een certificaat wordt uitgevoerd.
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

De actie die wordt uitgevoerd.

Name	Type	Description
action_type	CertificatePolicyAction	Het type actie.

CertificateAttributes

De certificaatbeheerkenmerken.

Name	Type	Description
created	integer	Aanmaaktijd in UTC.
enabled	boolean	Bepaalt of het object is ingeschakeld.
exp	integer	Vervaldatum in UTC.
nbf	integer	Niet vóór datum in UTC.
recoverableDays	integer	softDelete dagen voor gegevensretentie. De waarde moet =7 en <=90 zijn 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 'Opschonen' bevat, kan het certificaat permanent worden verwijderd door een bevoegde gebruiker; anders kan alleen het systeem het certificaat opschonen, aan het einde van het retentie-interval.
updated	integer	Tijdstip laatst bijgewerkt in UTC.

CertificateBundle

Een certificaatbundel bestaat uit een certificaat (X509) plus de bijbehorende kenmerken.

Name	Type	Description
attributes	CertificateAttributes	De certificaatkenmerken.
cer	string	CER-inhoud van x509-certificaat.
contentType	string	Het inhoudstype van het geheim. bijvoorbeeld 'application/x-pem-file' of 'application/x-pkcs12',
id	string	De certificaat-id.
kid	string	De sleutel-id.
policy	CertificatePolicy	Het beheerbeleid.
sid	string	De geheime id.
tags	object	Toepassingsspecifieke metagegevens in de vorm van sleutel-waardeparen
x5t	string	Vingerafdruk van het certificaat.

CertificatePolicy

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 als back-up van een certificaat wordt uitgevoerd.
lifetime_actions	LifetimeAction[]	Acties die door Key Vault worden uitgevoerd gedurende de levensduur van een certificaat.
secret_props	SecretProperties	Eigenschappen van het geheim dat als back-up van een certificaat wordt uitgevoerd.
x509_props	X509CertificateProperties	Eigenschappen van het X509-onderdeel van een certificaat.

CertificatePolicyAction

Het type actie.

Name	Type	Description
AutoRenew	string
EmailContacts	string

CertificateUpdateParameters

De parameters voor het bijwerken van het certificaat.

Name	Type	Description
attributes	CertificateAttributes	De kenmerken van het certificaat (optioneel).
policy	CertificatePolicy	Het beheerbeleid voor het certificaat.
tags	object	Toepassingsspecifieke metagegevens in de vorm van sleutel-waardeparen.

DeletionRecoveryLevel

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

Name	Type	Description
CustomizedRecoverable	string	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid voor onmiddellijke en permanente verwijdering (d.w.w. opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en zolang het abonnement nog beschikbaar is.
CustomizedRecoverable+ProtectedSubscription	string	Geeft een kluis- en abonnementstatus aan waarin verwijdering kan worden hersteld, directe en permanente verwijdering (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	string	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (d.w.w. opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval, tenzij een opschoonbewerking wordt aangevraagd of het abonnement wordt geannuleerd.
Purgeable	string	Geeft een kluisstatus aan waarin het verwijderen een onomkeerbare bewerking is, zonder de mogelijkheid tot herstel. Dit niveau komt overeen met het feit dat er geen bescherming beschikbaar is tegen een Delete-bewerking; de gegevens gaan onherroepelijk verloren bij het accepteren van een Verwijderbewerking op entiteitsniveau of hoger (kluis, resourcegroep, abonnement, enzovoort)
Recoverable	string	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid tot onmiddellijke en permanente verwijdering (d.w.w. opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval (90 dagen) en zolang het abonnement nog beschikbaar is. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld
Recoverable+ProtectedSubscription	string	Geeft een kluis- en abonnementsstatus aan waarin verwijdering kan worden hersteld binnen een bewaarperiode (90 dagen), directe en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet permanent kan worden geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld
Recoverable+Purgeable	string	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (d.w.w. opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval (90 dagen), tenzij een opschoonbewerking wordt aangevraagd of het abonnement wordt geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld

Error

De sleutelkluisserverfout.

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

IssuerParameters

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

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

JsonWebKeyCurveName

Naam van elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.

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

JsonWebKeyType

Het type sleutelpaar dat moet worden gebruikt voor het certificaat.

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

KeyProperties

Eigenschappen van het sleutelpaar dat als back-up van een certificaat wordt gebruikt.

Name	Type	Description
crv	JsonWebKeyCurveName	Naam van elliptische curve. 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 exporteerbare sleutel.
key_size	integer	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 bij het vernieuwen van certificaten.

KeyUsageType

Hiermee definieert u hoe de sleutel van het certificaat mag worden gebruikt.

Name	Type	Description
cRLSign	string
dataEncipherment	string
decipherOnly	string
digitalSignature	string
encipherOnly	string
keyAgreement	string
keyCertSign	string
keyEncipherment	string
nonRepudiation	string

KeyVaultError

De fout-uitzondering voor de sleutelkluis.

Name	Type	Description
error	Error	De sleutelkluisserverfout.

LifetimeAction

Actie en de bijbehorende trigger die worden uitgevoerd door Key Vault 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

Eigenschappen van de sleutel die als back-up van een certificaat wordt uitgevoerd.

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

SubjectAlternativeNames

De alternatieve onderwerpnamen van een X509-object.

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

Trigger

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

Name	Type	Description
days_before_expiry	integer	Dagen voor het verlopen om verlenging uit te proberen. 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	Percentage van de levensduur waarmee moet worden geactiveerd. De waarde moet tussen 1 en 99 zijn.

X509CertificateProperties

Eigenschappen van het X509-onderdeel van een certificaat.

Name	Type	Description
ekus	string[]	Het verbeterde sleutelgebruik.
key_usage	KeyUsageType[]	Hiermee definieert u hoe de sleutel van het certificaat mag worden gebruikt.
sans	SubjectAlternativeNames	De alternatieve namen van het onderwerp.
subject	string	De onderwerpnaam. Moet een geldige X509 DN-naam zijn.
validity_months	integer	De duur van het certificaat is in maanden geldig.

Share via