Create Certificate - Create Certificate

Riferimento

Service:: Key Vault

API Version:: 7.4

Crea un nuovo certificato.
Se si tratta della prima versione, viene creata la risorsa del certificato. Questa operazione richiede l'autorizzazione di creazione certificati.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione

Nome	In	Necessario	Tipo	Descrizione
certificate-name	path	True	string	Nome del certificato. Il valore specificato può essere copiato a livello globale allo scopo di eseguire il servizio. Il valore specificato non deve includere informazioni personali o riservate. Regex pattern: `^[0-9a-zA-Z-]+$`
vaultBaseUrl	path	True	string	Nome dell'insieme di credenziali, ad esempio https://myvault.vault.azure.net.
api-version	query	True	string	Versione API client.

certificate-name

path

True

string

Nome del certificato. Il valore specificato può essere copiato a livello globale allo scopo di eseguire il servizio. Il valore specificato non deve includere informazioni personali o riservate.

Regex pattern: ^[0-9a-zA-Z-]+$

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
202 Accepted	CertificateOperation	Bundle di certificati creato.
Other Status Codes	KeyVaultError	Key Vault risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

CreateCertificate

Sample Request

HTTP

POST https://myvault.vault.azure.net//certificates/selfSignedCert01/create?api-version=7.4

{
  "policy": {
    "key_props": {
      "exportable": true,
      "kty": "RSA",
      "key_size": 2048,
      "reuse_key": false
    },
    "secret_props": {
      "contentType": "application/x-pkcs12"
    },
    "x509_props": {
      "subject": "CN=*.microsoft.com",
      "sans": {
        "dns_names": [
          "onedrive.microsoft.com",
          "xbox.microsoft.com"
        ]
      }
    },
    "issuer": {
      "name": "Self"
    }
  }
}

Sample Response

Status code:: 202

{
  "id": "https://myvault.vault.azure.net/certificates/selfSignedCert01/pending",
  "issuer": {
    "name": "Self"
  },
  "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqe8aINnShK+wQC8QU7fwsviQc9+yiOnqU3adXA6qNjn21HTdRBa7cyQIk1STxHIBLTT/GaEJwqsUi6UvZaPEHokOWsr1bP9M7xOPTicBcRyMrr6bOxsmGczYtu1z2TzzXDD7q7IEignE7/LowGEaIADCIU9iuWk7TiJ+1Q/VLh/B3xPsgVjY+n7zEQ53gBiDHSl7XfELfwmslOQ28TVNogUyXsxHcVxQQYJeI7HqqY448LeleK69Ld86lkBixLEm1pD7HSbEx3WI2lyUQAGR6hD3YFaiIWVpQeEyI7p1jmtQlnfZdEL4q9wdlEEcwd3h3PAZpEBhCixahF54fci3pwIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBACiLeghirF+yCuYGVUPDB3wKQJn2iLY1za9ncxCehIVqOkFK09AphzoxF6Yid90AKCaa/dT/Ohm7oTyVQ+YcZnT00LUNFVG48AOE8YDiw9tjAG9OORsAz80xnv2qaLw2TCVIQ6NjrI83LqAm1GJ8rAnpdD/ZTuWM7TvSO5g/jm/Q0oSuKpMgj3YxpwgB9Ac6YEfVzOnm76OkUcpvR5MS4BoTfRv4thdSnU+uwqxM+HtdSVTbHQeC2U/hM1cyzDMpl1rZRklmiEOoPUeDasEIBVTJhAxR8xAeKJJD7Wzj4mJPw4UMvF8zQZzW8EKYvB1hkVYY+HQ85L+XcXd8lco7hU4=",
  "cancellation_requested": false,
  "status": "inProgress",
  "status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.",
  "request_id": "6faacd568ab049a2803861e8dd3ae21f"
}

Definizioni

Nome	Descrizione
Action	Azione che verrà eseguita.
CertificateAttributes	Attributi di gestione dei certificati.
CertificateCreateParameters	Parametri di creazione del certificato.
CertificateOperation	Viene restituita un'operazione di certificato in caso di richieste asincrone.
CertificatePolicy	Criteri di gestione per un certificato.
CertificatePolicyAction	Tipo dell'azione.
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.
Error	Errore del server dell'insieme di credenziali delle chiavi.
IssuerParameters	Parametri per l'autorità emittente del componente X509 di un certificato.
JsonWebKeyCurveName	Nome curva ellittica. Per 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 il modo in cui può essere usata la chiave del certificato.
KeyVaultError	Eccezione di errore dell'insieme di credenziali delle chiavi.
LifetimeAction	Azione e trigger che verranno eseguiti da Key Vault durante la durata di un certificato.
SecretProperties	Proprietà del backup della chiave 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 UTC.
recoverableDays	integer	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 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.

CertificateCreateParameters

Parametri di creazione 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.

CertificateOperation

Viene restituita un'operazione di certificato in caso di richieste asincrone.

Nome	Tipo	Descrizione
cancellation_requested	boolean	Indica se l'annullamento è stato richiesto nell'operazione di certificato.
csr	string	Richiesta di firma del certificato (CSR) usata nell'operazione di certificato.
error	Error	Errore rilevato, se presente, durante l'operazione del certificato.
id	string	ID certificato.
issuer	IssuerParameters	Parametri per l'autorità emittente del componente X509 di un certificato.
request_id	string	Identificatore per l'operazione del certificato.
status	string	Stato dell'operazione del certificato.
status_details	string	Dettagli sullo stato dell'operazione del certificato.
target	string	Percorso che contiene il risultato dell'operazione 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'autorità emittente del componente X509 di un certificato.
key_props	KeyProperties	Proprietà del backup della chiave di un certificato.
lifetime_actions	LifetimeAction[]	Azioni che verranno eseguite da Key Vault durante la durata di un certificato.
secret_props	SecretProperties	Proprietà del backup segreto di un certificato.
x509_props	X509CertificateProperties	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	Error	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	JsonWebKeyCurveName	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	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 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	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	Action	Azione che verrà eseguita.
trigger	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	KeyUsageType[]	Definisce il modo in cui può essere usata la chiave del certificato.
sans	SubjectAlternativeNames	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.

Create Certificate - Create Certificate

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

CreateCertificate

Sample Request

Sample Response

Definizioni

Action

CertificateAttributes

CertificateCreateParameters

CertificateOperation

CertificatePolicy

CertificatePolicyAction

DeletionRecoveryLevel

Error

IssuerParameters

JsonWebKeyCurveName

JsonWebKeyType

KeyProperties

KeyUsageType

KeyVaultError

LifetimeAction

SecretProperties

SubjectAlternativeNames

Trigger

X509CertificateProperties

Risorse aggiuntive