Update Certificate - Update Certificate

Riferimento

Servizio:: Key Vault

Versione API:: 7.4

Aggiornamenti gli attributi specificati associati al certificato specificato.
L'operazione UpdateCertificate applica l'aggiornamento specificato nel certificato specificato; gli unici elementi aggiornati sono gli attributi del certificato. Questa operazione richiede l'autorizzazione certificati/aggiornamento.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
certificate-name	path	True	string	Nome del certificato nell'insieme di credenziali delle chiavi specificato.
certificate-version	path	True	string	Versione del certificato.
vaultBaseUrl	path	True	string	Nome dell'insieme di credenziali, ad esempio https://myvault.vault.azure.net.
api-version	query	True	string	Versione API client.

Corpo della richiesta

Nome	Tipo	Descrizione
attributes	CertificateAttributes	Attributi del certificato (facoltativo).
policy	CertificatePolicy	Criteri di gestione per il certificato.
tags	object	Metadati specifici dell'applicazione sotto forma di coppie chiave-valore.

Risposte

Nome	Tipo	Descrizione
200 OK	CertificateBundle	Certificato aggiornato.
Other Status Codes	KeyVaultError	Key Vault risposta di errore che descrive perché l'operazione non è riuscita.

Esempio

UpdateCertificate

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Definizioni

Nome	Descrizione
Action	Azione che verrà eseguita.
CertificateAttributes	Attributi di gestione dei certificati.
CertificateBundle	Un bundle di certificati è costituito da un certificato (X509) più i relativi attributi.
CertificatePolicy	Criteri di gestione per un certificato.
CertificatePolicyAction	Tipo dell'azione.
CertificateUpdateParameters	Parametri di aggiornamento del certificato.
DeletionRecoveryLevel	Riflette il livello di ripristino di eliminazione attualmente attivo per i certificati nell'insieme di credenziali corrente. Se contiene "Purgeable", il certificato può essere eliminato definitivamente da un utente con privilegi; in caso contrario, solo il sistema può eliminare il certificato, alla fine dell'intervallo di conservazione.
Error	Errore del server dell'insieme di credenziali delle chiavi.
IssuerParameters	Parametri per l'emittente del componente X509 di un certificato.
JsonWebKeyCurveName	Nome curva ellittica. Per i valori validi, vedere JsonWebKeyCurveName.
JsonWebKeyType	Tipo di coppia di chiavi da usare per il certificato.
KeyProperties	Proprietà della coppia di chiavi che esegue il backup di un certificato.
KeyUsageType	Definisce la modalità di utilizzo della chiave del certificato.
KeyVaultError	Eccezione di errore dell'insieme di credenziali delle chiavi.
LifetimeAction	Azione e trigger che verranno eseguiti da Key Vault per tutta la durata di un certificato.
SecretProperties	Proprietà della chiave che esegue il backup di un certificato.
SubjectAlternativeNames	Nomi alternativi del soggetto di un oggetto X509.
Trigger	Condizione da soddisfare per l'esecuzione di un'azione.
X509CertificateProperties	Proprietà del componente X509 di un certificato.

Action

Azione che verrà eseguita.

Nome	Tipo	Descrizione
action_type	CertificatePolicyAction	Tipo dell'azione.

CertificateAttributes

Attributi di gestione dei certificati.

Nome	Tipo	Descrizione
created	integer	Ora di creazione in formato UTC.
enabled	boolean	Determina se l'oggetto è abilitato.
exp	integer	Data di scadenza in formato UTC.
nbf	integer	Non prima della data in formato UTC.
recoverableDays	integer	softDelete data retention days (Giorni di conservazione dei dati softDelete). Il valore deve essere >=7 e <=90 quando softDelete è abilitato; in caso contrario, 0.
recoveryLevel	DeletionRecoveryLevel	Riflette il livello di ripristino di eliminazione attualmente attivo per i certificati nell'insieme di credenziali corrente. Se contiene "Purgeable", il certificato può essere eliminato definitivamente da un utente con privilegi; in caso contrario, solo il sistema può eliminare il certificato, alla fine dell'intervallo di conservazione.
updated	integer	Ora dell'ultimo aggiornamento in formato UTC.

CertificateBundle

Un bundle di certificati è costituito da un certificato (X509) più i relativi attributi.

Nome	Tipo	Descrizione
attributes	CertificateAttributes	Attributi del certificato.
cer	string	Contenuto cer del certificato x509.
contentType	string	Tipo di contenuto del segreto. Ad esempio: 'application/x-pem-file' o 'application/x-pkcs12',
id	string	ID certificato.
kid	string	ID chiave.
policy	CertificatePolicy	Criteri di gestione.
sid	string	ID segreto.
tags	object	Metadati specifici dell'applicazione sotto forma di coppie chiave-valore
x5t	string	Identificazione personale del certificato.

CertificatePolicy

Criteri di gestione per un certificato.

Nome	Tipo	Descrizione
attributes	CertificateAttributes	Attributi del certificato.
id	string	ID certificato.
issuer	IssuerParameters	Parametri per l'emittente del componente X509 di un certificato.
key_props	KeyProperties	Proprietà della chiave che esegue il backup di un certificato.
lifetime_actions	LifetimeAction[]	Azioni che verranno eseguite da Key Vault per tutta la durata di un certificato.
secret_props	SecretProperties	Proprietà del segreto che esegue il backup di un certificato.
x509_props	X509CertificateProperties	Proprietà del componente X509 di un certificato.

CertificatePolicyAction

Tipo dell'azione.

Nome	Tipo	Descrizione
AutoRenew	string
EmailContacts	string

CertificateUpdateParameters

Parametri di aggiornamento del certificato.

Nome	Tipo	Descrizione
attributes	CertificateAttributes	Attributi del certificato (facoltativo).
policy	CertificatePolicy	Criteri di gestione per il certificato.
tags	object	Metadati specifici dell'applicazione sotto forma di coppie chiave-valore.

DeletionRecoveryLevel

Riflette il livello di ripristino di eliminazione attualmente attivo per i certificati nell'insieme di credenziali corrente. Se contiene "Purgeable", il certificato può essere eliminato definitivamente da un utente con privilegi; in caso contrario, solo il sistema può eliminare il certificato, alla fine dell'intervallo di conservazione.

Nome	Tipo	Descrizione
CustomizedRecoverable	string	Indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminazione immediata e permanente (ad esempio, l'eliminazione quando 7<= SoftDeleteRetentionInDays < 90). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione e mentre la sottoscrizione è ancora disponibile.
CustomizedRecoverable+ProtectedSubscription	string	Indica un insieme di credenziali e uno stato di sottoscrizione in cui l'eliminazione è recuperabile, l'eliminazione immediata e permanente (ad esempio, l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata in modo permanente quando 7<= SoftDeleteRetentionInDays < 90. Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione e riflette anche il fatto che la sottoscrizione stessa non può essere annullata.
CustomizedRecoverable+Purgeable	string	Indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile e che consente anche l'eliminazione immediata e permanente ,ad esempio quando 7<= SoftDeleteRetentionInDays < 90. Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione, a meno che non venga richiesta un'operazione di eliminazione o che la sottoscrizione venga annullata.
Purgeable	string	Indica uno stato dell'insieme di credenziali in cui l'eliminazione è un'operazione irreversibile, senza la possibilità di ripristino. Questo livello non corrisponde a alcuna protezione disponibile per un'operazione di eliminazione; i dati vengono persi in modo irreversibile quando si accetta un'operazione di eliminazione a livello di entità o superiore (insieme di credenziali, gruppo di risorse, sottoscrizione e così via)
Recoverable	string	Indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminazione immediata e permanente (ad esempio, l'eliminazione). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione (90 giorni) e mentre la sottoscrizione è ancora disponibile. Il sistema lo elimini definitivamente dopo 90 giorni, se non ripristinato
Recoverable+ProtectedSubscription	string	Indica uno stato dell'insieme di credenziali e della sottoscrizione in cui l'eliminazione è recuperabile entro l'intervallo di conservazione (90 giorni), l'eliminazione immediata e permanente (ad esempio l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata definitivamente. Il sistema lo elimini definitivamente dopo 90 giorni, se non ripristinato
Recoverable+Purgeable	string	Indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile e che consente anche l'eliminazione immediata e permanente (ad esempio, l'eliminazione). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione (90 giorni), a meno che non venga richiesta un'operazione di eliminazione o che la sottoscrizione venga annullata. Il sistema lo elimini definitivamente dopo 90 giorni, se non ripristinato

Error

Errore del server dell'insieme di credenziali delle chiavi.

Nome	Tipo	Descrizione
code	string	Codice di errore.
innererror	Error	Errore del server dell'insieme di credenziali delle chiavi.
message	string	Messaggio di errore.

IssuerParameters

Parametri per l'emittente del componente X509 di un certificato.

Nome	Tipo	Descrizione
cert_transparency	boolean	Indica se i certificati generati in questo criterio devono essere pubblicati nei log di trasparenza dei certificati.
cty	string	Tipo di certificato supportato dal provider (facoltativo); ad esempio 'OV-SSL', 'EV-SSL'
name	string	Nome dell'oggetto o dei nomi riservati dell'autorità emittente a cui si fa riferimento; ad esempio "Self" o "Unknown".

JsonWebKeyCurveName

Nome curva ellittica. Per i valori validi, vedere JsonWebKeyCurveName.

Nome	Tipo	Descrizione
P-256	string
P-256K	string
P-384	string
P-521	string

JsonWebKeyType

Tipo di coppia di chiavi da usare per il certificato.

Nome	Tipo	Descrizione
EC	string
EC-HSM	string
RSA	string
RSA-HSM	string
oct	string
oct-HSM	string

KeyProperties

Proprietà della coppia di chiavi che esegue il backup di un certificato.

Nome	Tipo	Descrizione
crv	JsonWebKeyCurveName	Nome curva ellittica. Per i valori validi, vedere JsonWebKeyCurveName.
exportable	boolean	Indica se la chiave privata può essere esportata. Quando si crea la prima versione di una chiave esportabile, è necessario specificare i criteri di rilascio.
key_size	integer	Dimensione della chiave in bit. Ad esempio: 2048, 3072 o 4096 per RSA.
kty	JsonWebKeyType	Tipo di coppia di chiavi da usare per il certificato.
reuse_key	boolean	Indica se la stessa coppia di chiavi verrà usata per il rinnovo del certificato.

KeyUsageType

Definisce la modalità di utilizzo della chiave del certificato.

Nome	Tipo	Descrizione
cRLSign	string
dataEncipherment	string
decipherOnly	string
digitalSignature	string
encipherOnly	string
keyAgreement	string
keyCertSign	string
keyEncipherment	string
nonRepudiation	string

KeyVaultError

Eccezione di errore dell'insieme di credenziali delle chiavi.

Nome	Tipo	Descrizione
error	Error	Errore del server dell'insieme di credenziali delle chiavi.

LifetimeAction

Azione e trigger che verranno eseguiti da Key Vault per tutta la durata di un certificato.

Nome	Tipo	Descrizione
action	Action	Azione che verrà eseguita.
trigger	Trigger	Condizione che eseguirà l'azione.

SecretProperties

Proprietà della chiave che esegue il backup di un certificato.

Nome	Tipo	Descrizione
contentType	string	Tipo di supporto (tipo MIME).

SubjectAlternativeNames

Nomi alternativi del soggetto di un oggetto X509.

Nome	Tipo	Descrizione
dns_names	string[]	Nomi di dominio.
emails	string[]	Indirizzi di posta elettronica.
upns	string[]	Nomi di entità utente.

Trigger

Condizione da soddisfare per l'esecuzione di un'azione.

Nome	Tipo	Descrizione
days_before_expiry	integer	Giorni prima della scadenza per tentare il rinnovo. Il valore deve essere compreso tra 1 e validity_in_months moltiplicato per 27. Se validity_in_months è 36, il valore deve essere compreso tra 1 e 972 (36 * 27).
lifetime_percentage	integer	Percentuale di durata in corrispondenza della quale attivare. Il valore deve essere compreso tra 1 e 99.

X509CertificateProperties

Proprietà del componente X509 di un certificato.

Nome	Tipo	Descrizione
ekus	string[]	Utilizzo avanzato delle chiavi.
key_usage	KeyUsageType[]	Definisce la modalità di utilizzo della chiave del certificato.
sans	SubjectAlternativeNames	Nomi alternativi del soggetto.
subject	string	Nome dell'oggetto. Deve essere un nome distinto X509 valido.
validity_months	integer	Durata del certificato valida in mesi.

Condividi tramite