Merge Certificate - Merge Certificate

Servizio:: Key Vault

Versione API:: 7.4

Unisce un certificato o una catena di certificati con una coppia di chiavi esistente nel server.
L'operazione MergeCertificate esegue l'unione di un certificato o di una catena di certificati con una coppia di chiavi attualmente disponibile nel servizio. Questa operazione richiede l'autorizzazione certificates/create.

POST {vaultBaseUrl}/certificates/{certificate-name}/pending/merge?api-version=7.4

Parametri dell'URI

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

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
x5c	True	string[] (byte)	Certificato o catena di certificati da unire.
attributes		CertificateAttributes	Attributi del certificato (facoltativo).
tags		object	Metadati specifici dell'applicazione sotto forma di coppie chiave-valore.

Risposte

Nome	Tipo	Descrizione
201 Created	CertificateBundle	Bundle di certificati unito all'insieme di credenziali.
Other Status Codes	KeyVaultError	Risposta di errore di Key Vault che descrive il motivo per cui l'operazione non è riuscita.

Esempio

MergeCertificate

Esempio di richiesta

HTTP

POST https://myvault.vault.azure.net//certificates/testcert/pending/merge?api-version=7.4

{
  "x5c": [
    "MIICxTCCAb....trimmed for brevitiy...EPAQj8="
  ]
}

Risposta di esempio

Codice di stato:: 201

{
  "id": "https://myvault.vault.azure.net/certificates/mycert1/f366e1a9dd774288ad84a45a5f620352",
  "kid": "https:// mykeyvault.vault.azure.net/keys/mycert1/f366e1a9dd774288ad84a45a5f620352",
  "sid": " mykeyvault.vault.azure.net/secrets/mycert1/f366e1a9dd774288ad84a45a5f620352",
  "cer": "……de34534……",
  "x5t": "n14q2wbvyXr71Pcb58NivuiwJKk",
  "attributes": {
    "enabled": true,
    "exp": 1530394215,
    "nbf": 1435699215,
    "created": 1435699919,
    "updated": 1435699919
  },
  "policy": {
    "id": "https:// mykeyvault.vault.azure.net/certificates/mycert1/policy",
    "key_props": {
      "exportable": false,
      "kty": "RSA",
      "key_size": 2048,
      "reuse_key": false
    },
    "secret_props": {
      "contentType": "application/x-pkcs12"
    },
    "x509_props": {
      "subject": "CN=Mycert1",
      "ekus": [
        "1.3.6.1.5.5.7.3.1",
        "1.3.6.1.5.5.7.3.2"
      ],
      "validity_months": 12
    },
    "lifetime_actions": [
      {
        "trigger": {
          "lifetime_percentage": 80
        },
        "action": {
          "action_type": "EmailContacts"
        }
      }
    ],
    "issuer": {
      "name": "Unknown"
    },
    "attributes": {
      "enabled": true,
      "created": 1435699811,
      "updated": 1435699811
    }
  }
}

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.
CertificateMergeParameters	Parametri di merge del certificato
CertificatePolicy	Criteri di gestione per un certificato.
CertificatePolicyAction	Tipo dell'azione.
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ò ripulire 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 dell'oggetto di un oggetto X509.
Trigger	Condizione da soddisfare per l'esecuzione di un'azione.
X509CertificateProperties	Proprietà del componente X509 di un certificato.

Action

Object

Azione che verrà eseguita.

Nome	Tipo	Descrizione
action_type	CertificatePolicyAction	Tipo dell'azione.

CertificateAttributes

Object

Attributi di gestione dei certificati.

Nome	Tipo	Descrizione
created	integer (unixtime)	Ora di creazione in formato UTC.
enabled	boolean	Determina se l'oggetto è abilitato.
exp	integer (unixtime)	Data di scadenza in formato UTC.
nbf	integer (unixtime)	Non prima della data in formato UTC.
recoverableDays	integer (int32)	softDelete i giorni di conservazione dei dati. 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ò ripulire il certificato, alla fine dell'intervallo di conservazione.
updated	integer (unixtime)	Ora dell'ultimo aggiornamento in formato UTC.

CertificateBundle

Object

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

Nome	Tipo	Descrizione
attributes	CertificateAttributes	Attributi del certificato.
cer	string (byte)	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 (base64url)	Identificazione personale del certificato.

CertificateMergeParameters

Object

Parametri di merge del certificato

Nome	Tipo	Descrizione
attributes	CertificateAttributes	Attributi del certificato (facoltativo).
tags	object	Metadati specifici dell'applicazione sotto forma di coppie chiave-valore.
x5c	string[] (byte)	Certificato o catena di certificati da unire.

CertificatePolicy

Object

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

Enumerazione

Tipo dell'azione.

Valore	Descrizione
AutoRenew
EmailContacts

DeletionRecoveryLevel

Enumerazione

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ò ripulire il certificato, alla fine dell'intervallo di conservazione.

Valore	Descrizione
CustomizedRecoverable	Indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminazione immediata e permanente (ad esempio, ripulire 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	Indica un insieme di credenziali e uno stato della 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	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 ripulitura o che la sottoscrizione venga annullata.
Purgeable	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 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	Indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminazione immediata e permanente (ad esempio ripulitura). 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	Indica un insieme di credenziali e uno stato 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	Indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile e che consente anche l'eliminazione immediata e permanente (ad esempio ripulitura). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione (90 giorni), a meno che non venga richiesta un'operazione di ripulitura o che la sottoscrizione venga annullata. Il sistema lo elimini definitivamente dopo 90 giorni, se non ripristinato

Error

Object

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

Object

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 autorità emittente di riferimento o nomi riservati; ad esempio 'Self' o 'Unknown'.

JsonWebKeyCurveName

Enumerazione

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

Valore	Descrizione
P-256
P-256K
P-384
P-521

JsonWebKeyType

Enumerazione

Tipo di coppia di chiavi da usare per il certificato.

Valore	Descrizione
EC
EC-HSM
RSA
RSA-HSM
oct
oct-HSM

KeyProperties

Object

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 (int32)	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

Enumerazione

Definisce la modalità di utilizzo della chiave del certificato.

Valore	Descrizione
cRLSign
dataEncipherment
decipherOnly
digitalSignature
encipherOnly
keyAgreement
keyCertSign
keyEncipherment
nonRepudiation

KeyVaultError

Object

Eccezione di errore dell'insieme di credenziali delle chiavi.

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

LifetimeAction

Object

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

Object

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

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

SubjectAlternativeNames

Object

Nomi alternativi dell'oggetto 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

Object

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

Nome	Tipo	Descrizione
days_before_expiry	integer (int32)	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 (int32) minimum: 1 maximum: 99	Percentuale di durata in corrispondenza della quale attivare. Il valore deve essere compreso tra 1 e 99.

X509CertificateProperties

Object

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 soggetto. Deve essere un nome distinto X509 valido.
validity_months	integer (int32) minimum: 0	Durata del certificato valida in mesi.

Condividi tramite

Merge Certificate - Merge Certificate

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

MergeCertificate

Esempio di richiesta

Risposta di esempio

Definizioni

Action

CertificateAttributes

CertificateBundle

CertificateMergeParameters

CertificatePolicy

CertificatePolicyAction

DeletionRecoveryLevel

Error

IssuerParameters

JsonWebKeyCurveName

JsonWebKeyType

KeyProperties

KeyUsageType

KeyVaultError

LifetimeAction

SecretProperties

SubjectAlternativeNames

Trigger

X509CertificateProperties