Create Key - Create Key

Service:: Key Vault

API-versie:: 2025-07-01

Maakt een nieuwe sleutel, slaat deze op en retourneert vervolgens belangrijke parameters en attributen aan de client.
De bewerking voor het maken van een sleutel kan worden gebruikt om elk sleuteltype te maken in Azure Key Vault. Als de benoemde sleutel al bestaat, maakt Azure Key Vault een nieuwe versie van de sleutel. Hiervoor zijn de sleutels/machtigingen voor maken vereist.

POST {vaultBaseUrl}/keys/{key-name}/create?api-version=2025-07-01

URI-parameters

Name	In	Vereist	Type	Description
key-name	path	True	string pattern: ^[0-9a-zA-Z-]+$	De naam voor de nieuwe sleutel. Het systeem genereert de versienaam voor de nieuwe sleutel. De waarde die u levert, kan wereldwijd worden gekopieerd met het oog op het uitvoeren van de service. De verstrekte waarde mag geen persoonlijk identificeerbare of gevoelige informatie bevatten.
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
kty	True	JsonWebKeyType	Het type sleutel dat moet worden gemaakt. Zie JsonWebKeyType voor geldige waarden.
attributes		KeyAttributes	De kenmerken van een sleutel die wordt beheerd door de sleutelkluisservice.
crv		JsonWebKeyCurveName	Naam van de elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.
key_ops		JsonWebKeyOperation[]	Json web key operaties. Zie JsonWebKeyOperation voor meer informatie over mogelijke sleutelbewerkingen.
key_size		integer (int32)	De sleutelgrootte in bits. Bijvoorbeeld: 2048, 3072 of 4096 voor RSA.
public_exponent		integer (int32)	De publieke exponent voor een RSA-sleutel.
release_policy		KeyReleasePolicy	De beleidsregels op grond waarvan de sleutel kan worden geëxporteerd.
tags		object	Applicatiespecifieke metadata in de vorm van sleutel-waardeparen.

Antwoorden

Name	Type	Description
200 OK	KeyBundle	De aanvraag is voltooid.
Other Status Codes	KeyVaultError	Een onverwachte foutreactie.

Beveiliging

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
https://vault.azure.net/.default

Voorbeelden

Create key

Voorbeeldaanvraag

HTTP

POST https://myvault.vault.azure.net//keys/CreateSoftKeyTest/create?api-version=2025-07-01

{
  "kty": "RSA",
  "key_size": 2048,
  "key_ops": [
    "encrypt",
    "decrypt",
    "sign",
    "verify",
    "wrapKey",
    "unwrapKey"
  ],
  "attributes": {},
  "tags": {
    "purpose": "unit test",
    "test name ": "CreateGetDeleteKeyTest"
  }
}

Voorbeeldrespons

Statuscode:: 200

{
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71",
    "kty": "RSA",
    "key_ops": [
      "encrypt",
      "decrypt",
      "sign",
      "verify",
      "wrapKey",
      "unwrapKey"
    ],
    "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": true,
    "created": 1493942451,
    "updated": 1493942451,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "tags": {
    "purpose": "unit test",
    "test name ": "CreateGetDeleteKeyTest"
  }
}

Definities

Name	Description
DeletionRecoveryLevel	Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor certificaten in de huidige kluis. Als het 'Purgeable' bevat, kan het certificaat permanent worden verwijderd door een geprivilegieerde gebruiker; Anders kan alleen het systeem het certificaat opschonen aan het einde van het bewaarinterval.
Error
JsonWebKey	Vanaf http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	Naam van de elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.
JsonWebKeyOperation	JSON-websleutelbewerkingen. Zie JsonWebKeyOperation voor meer informatie.
JsonWebKeyType	JsonWebKey Key Key Type (kty), zoals gedefinieerd in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KeyAttestation	De belangrijkste attestinformatie.
KeyAttributes	De kenmerken van een sleutel die wordt beheerd door de sleutelkluisservice.
KeyBundle	Een KeyBundle bestaande uit een WebKey plus de attributen ervan.
KeyCreateParameters	De sleutel maakt parameters.
KeyReleasePolicy	De beleidsregels op grond waarvan de sleutel kan worden geëxporteerd.
KeyVaultError	De uitzondering voor de sleutelkluisfout.

DeletionRecoveryLevel

Inventarisatie

Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor certificaten in de huidige kluis. Als het 'Purgeable' bevat, kan het certificaat permanent worden verwijderd door een geprivilegieerde gebruiker; Anders kan alleen het systeem het certificaat opschonen aan het einde van het bewaarinterval.

Waarde	Description
Purgeable	Geeft een kluisstatus aan waarin verwijdering een onomkeerbare bewerking is, zonder de mogelijkheid tot herstel. Dit niveau komt overeen met het feit dat er geen beveiliging beschikbaar is tegen een Delete-bewerking; de gegevens zijn onherstelbaar verloren gegaan bij het accepteren van een verwijderbewerking op entiteitsniveau of hoger (kluis, resourcegroep, abonnement enz.)
Recoverable+Purgeable	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering (d.w.z. opschonen) toestaat. Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval (90 dagen), tenzij een opschoningsbewerking wordt aangevraagd of het abonnement wordt geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, als het niet wordt hersteld
Recoverable	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid van onmiddellijke en permanente verwijdering (d.w.z. opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval (90 dagen) en terwijl het abonnement nog beschikbaar is. Het systeem zal het na 90 dagen permanent verwijderen, als het niet wordt hersteld
Recoverable+ProtectedSubscription	Geeft een kluis- en abonnementsstatus aan waarin verwijdering kan worden hersteld binnen het bewaarinterval (90 dagen), onmiddellijke en permanente verwijdering (d.w.z. opschonen) niet is toegestaan en waarin het abonnement zelf niet permanent kan worden geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, als het niet wordt hersteld
CustomizedRecoverable+Purgeable	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (d.w.z. opschonen wanneer 7 <= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval, tenzij een opschoningsbewerking wordt aangevraagd of het abonnement wordt geannuleerd.
CustomizedRecoverable	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid van onmiddellijke en permanente verwijdering (d.w.z. opschonen wanneer 7 <= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval en terwijl het abonnement nog beschikbaar is.
CustomizedRecoverable+ProtectedSubscription	Geeft een kluis- en abonnementsstatus aan waarin verwijdering kan worden hersteld, onmiddellijke en permanente verwijdering (d.w.z. 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 bewaarinterval en weerspiegelt ook het feit dat het abonnement zelf niet kan worden geannuleerd.

Error

Object

Name	Type	Description
code	string	De foutcode.
innererror	Error	De fout van de sleutelkluisserver.
message	string	Het foutbericht.

JsonWebKey

Object

Vanaf http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Name	Type	Description
crv	JsonWebKeyCurveName	Naam van de elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.
d	string (base64url)	RSA private exponent, of de D-component van een EC-private sleutel.
dp	string (base64url)	RSA-parameter voor privésleutels.
dq	string (base64url)	RSA-parameter voor privésleutels.
e	string (base64url)	RSA publieke exponent.
k	string (base64url)	Symmetrische toets.
key_hsm	string (base64url)	Beschermde sleutel, gebruikt met 'Bring Your Own Key'.
key_ops	string[]	Json web key operaties. Zie JsonWebKeyOperation voor meer informatie over mogelijke sleutelbewerkingen.
kid	string	Sleutel-ID.
kty	JsonWebKeyType	JsonWebKey Key Key Type (kty), zoals gedefinieerd in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n	string (base64url)	RSA-modulus.
p	string (base64url)	RSA geheime prime.
q	string (base64url)	RSA geheime prime, met p < q.
qi	string (base64url)	RSA-parameter voor privésleutels.
x	string (base64url)	X-component van een publieke EG-sleutel.
y	string (base64url)	Y component van een publieke EG-sleutel.

JsonWebKeyCurveName

Inventarisatie

Naam van de elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.

Waarde	Description
P-256	De NIST P-256 elliptische curve, ook bekend als SECG-curve SECP256R1.
P-384	De NIST P-384 elliptische curve, ook bekend als SECG-curve SECP384R1.
P-521	De NIST P-521 elliptische curve, ook bekend als SECG-curve SECP521R1.
P-256K	De SECG SECP256K1 elliptische curve.

JsonWebKeyOperation

Inventarisatie

JSON-websleutelbewerkingen. Zie JsonWebKeyOperation voor meer informatie.

Waarde	Description
encrypt	Geeft aan dat de sleutel kan worden gebruikt om te versleutelen.
decrypt	Geeft aan dat de sleutel kan worden gebruikt om te ontcijferen.
sign	Geeft aan dat de sleutel kan worden gebruikt om te ondertekenen.
verify	Geeft aan dat de sleutel kan worden gebruikt om te verifiëren.
wrapKey	Geeft aan dat de sleutel kan worden gebruikt om een andere sleutel in te pakken.
unwrapKey	Geeft aan dat de sleutel kan worden gebruikt om een andere sleutel uit te pakken.
import	Geeft aan dat de sleutel kan worden geïmporteerd tijdens het maken.
export	Geeft aan dat het persoonlijke onderdeel van de sleutel kan worden geëxporteerd.

JsonWebKeyType

Inventarisatie

JsonWebKey Key Key Type (kty), zoals gedefinieerd in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

Waarde	Description
EC	Elliptische curve.
EC-HSM	Elliptische curve met een privésleutel die wordt opgeslagen in de HSM.
RSA	RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM	RSA met een private key die wordt opgeslagen in de HSM.
oct	Octetreeks (gebruikt om symmetrische toetsen weer te geven)
oct-HSM	Octet-sequentie (gebruikt om symmetrische toetsen weer te geven) die wordt opgeslagen in de HSM.

KeyAttestation

Object

De belangrijkste attestinformatie.

Name	Type	Description
certificatePemFile	string (base64url)	Een base64url-gecodeerde tekenreeks met certificaten in PEM-indeling, die wordt gebruikt voor attestvalidatie.
privateKeyAttestation	string (base64url)	De attest-blobbytes die zijn gecodeerd als base64url-tekenreeks die overeenkomt met een persoonlijke sleutel.
publicKeyAttestation	string (base64url)	De attest-blobbytes die zijn gecodeerd als base64url-tekenreeks die overeenkomt met een openbare sleutel in het geval van een asymmetrische sleutel.
version	string	De versie van het attest.

KeyAttributes

Object

De kenmerken van een sleutel die wordt beheerd door de sleutelkluisservice.

Name	Type	Description
attestation	KeyAttestation	De informatie over het attest van de sleutel of de sleutelversie.
created	integer (unixtime)	Aanmaaktijd in UTC.
enabled	boolean	Bepaalt of het object is ingeschakeld.
exp	integer (unixtime)	Vervaldatum in UTC.
exportable	boolean	Geeft aan of de persoonlijke sleutel kan worden geëxporteerd. Er moet een releasebeleid worden opgegeven bij het maken van de eerste versie van een exporteerbare sleutel.
hsmPlatform	string	Het onderliggende HSM Platform.
nbf	integer (unixtime)	Niet voor datum in UTC.
recoverableDays	integer (int32)	softDelete-gegevensretentiedagen. 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 sleutels in de huidige kluis. Als het 'Purgeable' bevat, kan de sleutel permanent worden verwijderd door een geprivilegieerde gebruiker; Anders kan alleen het systeem de sleutel aan het einde van het bewaarinterval ongedaan maken.
updated	integer (unixtime)	Laatst bijgewerkte tijd in UTC.

KeyBundle

Object

Een KeyBundle bestaande uit een WebKey plus de attributen ervan.

Name	Type	Description
attributes	KeyAttributes	De belangrijkste managementattributen.
key	JsonWebKey	De Json-websleutel.
managed	boolean	Dat is waar als de levensduur van de sleutel wordt beheerd door de sleutelkluis. Als dit een sleutel is die een certificaat ondersteunt, dan is managed true waar.
release_policy	KeyReleasePolicy	De beleidsregels op grond waarvan de sleutel kan worden geëxporteerd.
tags	object	Applicatiespecifieke metadata in de vorm van sleutel-waardeparen.

KeyCreateParameters

Object

De sleutel maakt parameters.

Name	Type	Description
attributes	KeyAttributes	De kenmerken van een sleutel die wordt beheerd door de sleutelkluisservice.
crv	JsonWebKeyCurveName	Naam van de elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.
key_ops	JsonWebKeyOperation[]	Json web key operaties. Zie JsonWebKeyOperation voor meer informatie over mogelijke sleutelbewerkingen.
key_size	integer (int32)	De sleutelgrootte in bits. Bijvoorbeeld: 2048, 3072 of 4096 voor RSA.
kty	JsonWebKeyType	Het type sleutel dat moet worden gemaakt. Zie JsonWebKeyType voor geldige waarden.
public_exponent	integer (int32)	De publieke exponent voor een RSA-sleutel.
release_policy	KeyReleasePolicy	De beleidsregels op grond waarvan de sleutel kan worden geëxporteerd.
tags	object	Applicatiespecifieke metadata in de vorm van sleutel-waardeparen.

KeyReleasePolicy

Object

De beleidsregels op grond waarvan de sleutel kan worden geëxporteerd.

Name	Type	Default value	Description
contentType	string	application/json; charset=utf-8	Inhoudstype en versie van beleid voor sleutelrelease
data	string (base64url)		Blob-codering van de beleidsregels waaronder de sleutel kan worden vrijgegeven. Blob moet base64 URL-gecodeerd zijn.
immutable	boolean		Definieert de veranderlijkheidstoestand van het beleid. Zodra deze vlag is gemarkeerd als onveranderbaar, kan deze vlag niet opnieuw worden ingesteld en kan het beleid in geen geval worden gewijzigd.

KeyVaultError

Object

De uitzondering voor de sleutelkluisfout.

Name	Type	Description
error	Error	De fout van de sleutelkluisserver.

Delen via

Create Key - Create Key

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

OAuth2Auth

Bereiken

Voorbeelden

Create key

Voorbeeldaanvraag

Voorbeeldrespons

Definities

DeletionRecoveryLevel

Error

JsonWebKey

JsonWebKeyCurveName

JsonWebKeyOperation

JsonWebKeyType

KeyAttestation

KeyAttributes

KeyBundle

KeyCreateParameters

KeyReleasePolicy

KeyVaultError