Update Certificate Policy - Update Certificate Policy
Aggiornamenti i criteri per un certificato.
Impostare i membri specificati nei criteri di certificato. Lasciare null altri come Null. Questa operazione richiede l'autorizzazione certificati/aggiornamento.
PATCH {vaultBaseUrl}/certificates/{certificate-name}/policy?api-version=7.4
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
certificate-name
|
path | True |
string |
Nome del certificato nell'insieme di credenziali specificato. |
vault
|
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 |
Attributi del certificato. |
|
issuer |
Parametri per l'autorità emittente del componente X509 di un certificato. |
|
key_props |
Proprietà del backup della chiave di un certificato. |
|
lifetime_actions |
Azioni che verranno eseguite da Key Vault durante la durata di un certificato. |
|
secret_props |
Proprietà del backup segreto di un certificato. |
|
x509_props |
Proprietà del componente X509 di un certificato. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Criteri di certificato |
|
Other Status Codes |
Key Vault risposta di errore che descrive perché l'operazione non è riuscita. |
Esempio
UpdateCertificatePolicy
Sample Request
PATCH https://myvault.vault.azure.net//certificates/updateCert01/policy?api-version=7.4
{
"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": "Self"
},
"attributes": {
"enabled": true
}
}
Sample Response
{
"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": "Self"
},
"attributes": {
"enabled": true,
"created": 1482188947,
"updated": 1482188948
}
}
Definizioni
Nome | Descrizione |
---|---|
Action |
Azione che verrà eseguita. |
Certificate |
Attributi di gestione dei certificati. |
Certificate |
Criteri di gestione per un certificato. |
Certificate |
Tipo dell'azione. |
Deletion |
Riflette il livello di ripristino di eliminazione attualmente effettivo 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. |
Issuer |
Parametri per l'autorità emittente del componente X509 di un certificato. |
Json |
Nome curva ellittica. Per valori validi, vedere JsonWebKeyCurveName. |
Json |
Tipo di coppia di chiavi da usare per il certificato. |
Key |
Proprietà della coppia di chiavi che esegue il backup di un certificato. |
Key |
Definisce il modo in cui può essere usata la chiave del certificato. |
Key |
Eccezione di errore dell'insieme di credenziali delle chiavi. |
Lifetime |
Azione e trigger che verranno eseguiti da Key Vault durante la durata di un certificato. |
Secret |
Proprietà del backup della chiave di un certificato. |
Subject |
Nomi alternativi del soggetto di un oggetto X509. |
Trigger |
Condizione da soddisfare per l'esecuzione di un'azione. |
X509Certificate |
Proprietà del componente X509 di un certificato. |
Action
Azione che verrà eseguita.
Nome | Tipo | Descrizione |
---|---|---|
action_type |
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 UTC. |
recoverableDays |
integer |
giorni di conservazione dei dati softDelete. Il valore deve essere >=7 e <=90 quando softDelete abilitato, in caso contrario 0. |
recoveryLevel |
Riflette il livello di ripristino di eliminazione attualmente effettivo 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 |
Ultima ora aggiornata in FORMATO UTC. |
CertificatePolicy
Criteri di gestione per un certificato.
Nome | Tipo | Descrizione |
---|---|---|
attributes |
Attributi del certificato. |
|
id |
string |
ID certificato. |
issuer |
Parametri per l'autorità emittente del componente X509 di un certificato. |
|
key_props |
Proprietà del backup della chiave di un certificato. |
|
lifetime_actions |
Azioni che verranno eseguite da Key Vault durante la durata di un certificato. |
|
secret_props |
Proprietà del backup segreto di un certificato. |
|
x509_props |
Proprietà del componente X509 di un certificato. |
CertificatePolicyAction
Tipo dell'azione.
Nome | Tipo | Descrizione |
---|---|---|
AutoRenew |
string |
|
EmailContacts |
string |
DeletionRecoveryLevel
Riflette il livello di ripristino di eliminazione attualmente effettivo 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 eliminare immediatamente e definitivamente (ad esempio, eliminare 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 uno stato di insieme di credenziali e sottoscrizione in cui l'eliminazione è recuperabile, l'eliminazione immediata e permanente (ovvero l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata definitivamente quando 7<= SoftDeleteRetentionInDays < 90. Questo livello garantisce la ripristinabilità 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, l'eliminazione quando 7<= SoftDeleteRetentionInDays < 90). Questo livello garantisce la ripristinabilità dell'entità eliminata durante l'intervallo di conservazione, a meno che non venga richiesta un'operazione di eliminazione o 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 corrisponde a nessuna protezione disponibile per un'operazione Di eliminazione; i dati sono irreperibili 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 ripristinabilità dell'entità eliminata durante l'intervallo di conservazione(90 giorni) e mentre la sottoscrizione è ancora disponibile. Il sistema lo elimina definitivamente dopo 90 giorni, se non ripristinato |
Recoverable+ProtectedSubscription |
string |
Indica uno stato di insieme di credenziali e sottoscrizione in cui l'eliminazione è recuperabile entro l'intervallo di conservazione (90 giorni), l'eliminazione immediata e permanente (ovvero l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata definitivamente. Il sistema lo elimina 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 ripristinabilità dell'entità eliminata durante l'intervallo di conservazione (90 giorni), a meno che non venga richiesta un'operazione di eliminazione o la sottoscrizione venga annullata. Il sistema lo elimina 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 |
Errore del server dell'insieme di credenziali delle chiavi. |
|
message |
string |
Messaggio di errore. |
IssuerParameters
Parametri per l'autorità 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 emittente a cui si fa riferimento o nomi riservati; Ad esempio, 'Self' o 'Unknown'. |
JsonWebKeyCurveName
Nome curva ellittica. Per 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 |
Nome curva ellittica. Per valori validi, vedere JsonWebKeyCurveName. |
|
exportable |
boolean |
Indica se la chiave privata può essere esportata. I criteri di rilascio devono essere forniti quando si crea la prima versione di una chiave esportabile. |
key_size |
integer |
Dimensione della chiave in bit. Ad esempio: 2048, 3072 o 4096 per RSA. |
kty |
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 il modo in cui può essere usata la 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 |
Errore del server dell'insieme di credenziali delle chiavi. |
LifetimeAction
Azione e trigger che verranno eseguiti da Key Vault durante la durata di un certificato.
Nome | Tipo | Descrizione |
---|---|---|
action |
Azione che verrà eseguita. |
|
trigger |
Condizione che eseguirà l'azione. |
SecretProperties
Proprietà del backup della chiave 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 dell'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 |
Definisce il modo in cui può essere usata la chiave del certificato. |
|
sans |
Nomi alternativi dell'oggetto. |
|
subject |
string |
Nome dell'oggetto. Deve essere un nome distinto X509 valido. |
validity_months |
integer |
Durata del certificato valida in mesi. |