Create Key - Create Key

Referentie

Service:: Key Vault

API Version:: 7.4

Maakt een nieuwe sleutel, slaat deze op en retourneert vervolgens sleutelparameters en -kenmerken naar de client.
De bewerking Sleutel maken 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 is de machtiging sleutels/maken vereist.

POST {vaultBaseUrl}/keys/{key-name}/create?api-version=7.4

URI-parameters

Name In Vereist Type Description

Name	In	Vereist	Type	Description
key-name	path	True	string	De naam voor de nieuwe sleutel. Het systeem genereert de versienaam voor de nieuwe sleutel. De waarde die u opgeeft, kan wereldwijd worden gekopieerd om de service uit te voeren. De opgegeven waarde mag geen persoonsgegevens of gevoelige informatie bevatten. Regex pattern: `^[0-9a-zA-Z-]+$`
vaultBaseUrl	path	True	string	De kluisnaam, bijvoorbeeld https://myvault.vault.azure.net.
api-version	query	True	string	Client-API-versie.

key-name

path

True

string

De naam voor de nieuwe sleutel. Het systeem genereert de versienaam voor de nieuwe sleutel. De waarde die u opgeeft, kan wereldwijd worden gekopieerd om de service uit te voeren. De opgegeven waarde mag geen persoonsgegevens of gevoelige informatie bevatten.

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

vaultBaseUrl

path

True

string

De kluisnaam, bijvoorbeeld https://myvault.vault.azure.net.

api-version

query

True

string

Client-API-versie.

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 elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.
key_ops		JsonWebKeyOperation[]	Bewerkingen voor JSON-websleutels. Zie JsonWebKeyOperation voor meer informatie.
key_size		integer	De sleutelgrootte in bits. Bijvoorbeeld: 2048, 3072 of 4096 voor RSA.
public_exponent		integer	De openbare exponent voor een RSA-sleutel.
release_policy		KeyReleasePolicy	De beleidsregels waaronder de sleutel kan worden geëxporteerd.
tags		object	Toepassingsspecifieke metagegevens in de vorm van sleutel-waardeparen.

Antwoorden

Name	Type	Description
200 OK	KeyBundle	Een sleutelbundel met het resultaat van de aanvraag voor het maken van de sleutel.
Other Status Codes	KeyVaultError	Key Vault foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

Create key

Sample Request

HTTP

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

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

Sample Response

Status code:: 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 sleutels in de huidige kluis. Als deze 'Opschoonbaar' bevat, kan de sleutel permanent worden verwijderd door een bevoegde gebruiker; Anders kan alleen het systeem de sleutel aan het einde van het retentie-interval leegmaken.
Error	De sleutelkluisserverfout.
JsonWebKey	Vanaf http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	Naam van elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.
JsonWebKeyOperation
JsonWebKeyType	JsonWebKey Key Type (kty), zoals gedefinieerd in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KeyAttributes	De kenmerken van een sleutel die wordt beheerd door de sleutelkluisservice.
KeyBundle	Een KeyBundle die bestaat uit een WebKey plus de bijbehorende kenmerken.
KeyCreateParameters	De parameters voor het maken van de sleutel.
KeyReleasePolicy	De beleidsregels waaronder de sleutel kan worden geëxporteerd.
KeyVaultError	De foutuitzondering voor de sleutelkluis.

DeletionRecoveryLevel

Geeft het herstelniveau voor verwijdering weer dat momenteel van kracht is voor sleutels in de huidige kluis. Als deze 'Opschoonbaar' bevat, kan de sleutel permanent worden verwijderd door een bevoegde gebruiker; Anders kan alleen het systeem de sleutel aan het einde van het retentie-interval leegmaken.

Name	Type	Description
CustomizedRecoverable	string	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid tot onmiddellijke en permanente verwijdering (dat wil zeggen opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en zolang het abonnement nog beschikbaar is.
CustomizedRecoverable+ProtectedSubscription	string	Geeft een kluis- en abonnementstatus aan waarin verwijdering kan worden hersteld, onmiddellijke en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet definitief kan worden geannuleerd wanneer 7<= SoftDeleteRetentionInDays < 90. Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en weerspiegelt ook het feit dat het abonnement zelf niet kan worden geannuleerd.
CustomizedRecoverable+Purgeable	string	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (dat wil zeggen opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval, tenzij een opschoningsbewerking wordt aangevraagd of het abonnement wordt geannuleerd.
Purgeable	string	Geeft een kluisstatus aan waarin het verwijderen een onomkeerbare bewerking is, zonder de mogelijkheid voor herstel. Dit niveau komt overeen met het feit dat er geen bescherming beschikbaar is tegen een Verwijderbewerking; de gegevens gaan onherroepelijk verloren bij het accepteren van een verwijderbewerking op entiteitsniveau of hoger (kluis, resourcegroep, abonnement, enzovoort)
Recoverable	string	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid tot onmiddellijke en permanente verwijdering (dat wil zeggen opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval (90 dagen) en zolang het abonnement nog beschikbaar is. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld
Recoverable+ProtectedSubscription	string	Geeft een kluis- en abonnementsstatus aan waarin verwijdering kan worden hersteld binnen een retentieperiode (90 dagen), directe en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet definitief kan worden geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld
Recoverable+Purgeable	string	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (dat wil zeggen leegmaken). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval (90 dagen), tenzij een opschoonbewerking wordt aangevraagd of het abonnement wordt geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld

Error

De sleutelkluisserverfout.

Name	Type	Description
code	string	De foutcode.
innererror	Error	De sleutelkluisserverfout.
message	string	Het foutbericht.

JsonWebKey

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

Name	Type	Description
crv	JsonWebKeyCurveName	Naam van elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.
d	string	RSA private exponent, of het D-onderdeel van een persoonlijke EC-sleutel.
dp	string	Parameter voor persoonlijke RSA-sleutel.
dq	string	Parameter voor persoonlijke RSA-sleutel.
e	string	RSA openbare exponent.
k	string	Symmetrische sleutel.
key_hsm	string	Beveiligde sleutel, gebruikt met 'Bring Your Own Key'.
key_ops	string[]	Ondersteunde sleutelbewerkingen.
kid	string	Sleutel-id.
kty	JsonWebKeyType	JsonWebKey Key Type (kty), zoals gedefinieerd in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n	string	RSA-modulus.
p	string	RSA geheime prime.
q	string	RSA secret prime, met p < q.
qi	string	Parameter voor persoonlijke RSA-sleutel.
x	string	X-onderdeel van een openbare EC-sleutel.
y	string	Y-onderdeel van een openbare EC-sleutel.

JsonWebKeyCurveName

Naam van elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.

Name	Type	Description
P-256	string	De NIST P-256 elliptische curve, AKA SECG-curve SECP256R1.
P-256K	string	De SECG SECP256K1 elliptische curve.
P-384	string	De NIST P-384 elliptische curve, aka SECG-curve SECP384R1.
P-521	string	De NIST P-521 elliptische curve, AKA SECG-curve SECP521R1.

JsonWebKeyOperation

Name	Type	Description
decrypt	string
encrypt	string
export	string
import	string
sign	string
unwrapKey	string
verify	string
wrapKey	string

JsonWebKeyType

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

Name	Type	Description
EC	string	Elliptische curve.
EC-HSM	string	Elliptische curve met een persoonlijke sleutel die is opgeslagen in de HSM.
RSA	string	RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM	string	RSA met een persoonlijke sleutel die is opgeslagen in de HSM.
oct	string	Octetreeks (gebruikt om symmetrische sleutels weer te geven)
oct-HSM	string	Octetreeks (gebruikt om symmetrische sleutels weer te geven) die de HSM wordt opgeslagen.

KeyAttributes

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

Name	Type	Description
created	integer	Aanmaaktijd in UTC.
enabled	boolean	Bepaalt of het object is ingeschakeld.
exp	integer	Vervaldatum in UTC.
exportable	boolean	Geeft aan of de persoonlijke sleutel kan worden geëxporteerd. Releasebeleid moet worden opgegeven bij het maken van de eerste versie van een exporteerbare sleutel.
nbf	integer	Niet vóór datum in UTC.
recoverableDays	integer	softDelete dagen voor gegevensretentie. 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 deze 'Opschoonbaar' bevat, kan de sleutel permanent worden verwijderd door een bevoegde gebruiker; Anders kan alleen het systeem de sleutel aan het einde van het retentie-interval leegmaken.
updated	integer	Tijdstip laatst bijgewerkt in UTC.

KeyBundle

Een KeyBundle die bestaat uit een WebKey plus de bijbehorende kenmerken.

Name	Type	Description
attributes	KeyAttributes	De kenmerken van sleutelbeheer.
key	JsonWebKey	De Json-websleutel.
managed	boolean	Is waar als de levensduur van de sleutel wordt beheerd door de sleutelkluis. Als dit een sleutel is die een back-up vormt van een certificaat, is beheerd true.
release_policy	KeyReleasePolicy	De beleidsregels waaronder de sleutel kan worden geëxporteerd.
tags	object	Toepassingsspecifieke metagegevens in de vorm van sleutel-waardeparen.

KeyCreateParameters

De parameters voor het maken van de sleutel.

Name	Type	Description
attributes	KeyAttributes	De kenmerken van een sleutel die wordt beheerd door de sleutelkluisservice.
crv	JsonWebKeyCurveName	Naam van elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden.
key_ops	JsonWebKeyOperation[]	Bewerkingen voor JSON-websleutels. Zie JsonWebKeyOperation voor meer informatie.
key_size	integer	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	De openbare exponent voor een RSA-sleutel.
release_policy	KeyReleasePolicy	De beleidsregels waaronder de sleutel kan worden geëxporteerd.
tags	object	Toepassingsspecifieke metagegevens in de vorm van sleutel-waardeparen.

KeyReleasePolicy

De beleidsregels waaronder de sleutel kan worden geëxporteerd.

Name	Type	Standaardwaarde	Description
contentType	string	application/json; charset=utf-8	Inhoudstype en versie van sleutelreleasebeleid
data	string		Blob-codering van de beleidsregels waaronder de sleutel kan worden vrijgegeven. Blob moet base64-URL gecodeerd zijn.
immutable	boolean		Hiermee definieert u de mutabiliteitsstatus van het beleid. Nadat deze vlag is gemarkeerd als onveranderbaar, kan deze vlag niet opnieuw worden ingesteld en kan het beleid in geen geval worden gewijzigd.

KeyVaultError

De foutuitzondering voor de sleutelkluis.

Name	Type	Description
error	Error	De sleutelkluisserverfout.

Create Key - Create Key

URI-parameters

Aanvraagbody

Antwoorden

Voorbeelden

Create key

Sample Request

Sample Response

Definities

DeletionRecoveryLevel

Error

JsonWebKey

JsonWebKeyCurveName

JsonWebKeyOperation

JsonWebKeyType

KeyAttributes

KeyBundle

KeyCreateParameters

KeyReleasePolicy

KeyVaultError

Aanvullende resources