Rotate Key - Rotate Key

Referentie

Service:: Key Vault

API Version:: 7.4

Maakt een nieuwe sleutelversie, slaat deze op en retourneert vervolgens sleutelparameters, kenmerken en beleid naar de client.
Met de bewerking wordt de sleutel geroteerd op basis van het sleutelbeleid. Hiervoor is de machtiging sleutels/roteren vereist.

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

URI-parameters

Name In Vereist Type Description

Name	In	Vereist	Type	Description
key-name	path	True	string	De naam van de sleutel die moet worden geroteerd. Het systeem genereert een nieuwe versie in de opgegeven sleutel. 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 van de sleutel die moet worden geroteerd. Het systeem genereert een nieuwe versie in de opgegeven sleutel.

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.

Antwoorden

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

Voorbeelden

Rotate key

Sample Request

HTTP

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

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 bewaarinterval opschonen.
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.
JsonWebKeyType	JsonWebKey-sleuteltype (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.
KeyReleasePolicy	De beleidsregels waaronder de sleutel kan worden geëxporteerd.
KeyVaultError	De fout-uitzondering 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 bewaarinterval opschonen.

Name	Type	Description
CustomizedRecoverable	string	Geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid voor onmiddellijke en permanente verwijdering (d.w.w. 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, directe en permanente verwijdering (dat wil zeggen 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 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 (d.w.w. opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval, tenzij een opschoonbewerking wordt aangevraagd of het abonnement wordt geannuleerd.
Purgeable	string	Geeft een kluisstatus aan waarin het verwijderen een onomkeerbare bewerking is, zonder de mogelijkheid tot herstel. Dit niveau komt overeen met het feit dat er geen bescherming beschikbaar is tegen een Delete-bewerking; 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 (d.w.w. opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval (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 bewaarperiode (90 dagen), directe en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet permanent 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 (d.w.w. opschonen). 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	Persoonlijke RSA-sleutelparameter.
dq	string	Persoonlijke RSA-sleutelparameter.
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-sleuteltype (kty), zoals gedefinieerd in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n	string	RSA-modulus.
p	string	RSA secret prime.
q	string	RSA secret prime, met p < q.
qi	string	Persoonlijke RSA-sleutelparameter.
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.

JsonWebKeyType

JsonWebKey-sleuteltype (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 bewaarinterval opschonen.
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 sleutelbeheerkenmerken.
key	JsonWebKey	De Json-websleutel.
managed	boolean	Waar als de levensduur van de sleutel wordt beheerd door de sleutelkluis. Als dit een sleutel is die een back-up van een certificaat is, wordt beheerd waar.
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 beleid voor sleutelrelease
data	string		Blobcodering 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 fout-uitzondering voor de sleutelkluis.

Name	Type	Description
error	Error	De sleutelkluisserverfout.

Rotate Key - Rotate Key

URI-parameters

Antwoorden

Voorbeelden

Rotate key

Sample Request

Sample Response

Definities

DeletionRecoveryLevel

Error

JsonWebKey

JsonWebKeyCurveName

JsonWebKeyType

KeyAttributes

KeyBundle

KeyReleasePolicy

KeyVaultError

Aanvullende resources