Get Key Rotation Policy - Get Key Rotation Policy

Referentie

Service:: Key Vault

API Version:: 7.4

Lijsten het beleid voor een sleutel.
De bewerking GetKeyRotationPolicy retourneert de opgegeven sleutelbeleidsresources in de opgegeven sleutelkluis. Voor deze bewerking zijn de sleutels/machtigingen voor ophalen vereist.

GET {vaultBaseUrl}/keys/{key-name}/rotationpolicy?api-version=7.4

URI-parameters

Name	In	Vereist	Type	Description
key-name	path	True	string	De naam van de sleutel in een bepaalde sleutelkluis.
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	KeyRotationPolicy	Het beleid voor sleutelrotatie.
Other Status Codes	KeyVaultError	Key Vault foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

GetKeyRotationPolicy

Sample Request

HTTP

GET https://myvault.vault.azure.net//keys/key01/rotationpolicy?api-version=7.4

Sample Response

Status code:: 200

{
  "id": "https://myvault.vault.azure.net/keys/key01/rotationpolicy",
  "lifetimeActions": [
    {
      "trigger": {
        "timeAfterCreate": "P90D"
      },
      "action": {
        "type": "Rotate"
      }
    },
    {
      "trigger": {
        "timeBeforeExpiry": "P30D"
      },
      "action": {
        "type": "Notify"
      }
    }
  ],
  "attributes": {
    "expiryTime": "P2Y",
    "created": 1482188947,
    "updated": 1482188948
  }
}

Definities

Name	Description
ActionType	Het type actie. De waarde moet hoofdlettergevoelig worden vergeleken.
Error	De sleutelkluisserverfout.
KeyRotationPolicy	Beheerbeleid voor een sleutel.
KeyRotationPolicyAttributes	De beleidskenmerken voor sleutelrotatie.
KeyVaultError	De foutuitzondering voor de sleutelkluis.
LifetimeActions	Actie en de trigger die worden uitgevoerd door Key Vault gedurende de levensduur van een sleutel.
LifetimeActionsTrigger	Een voorwaarde waaraan moet worden voldaan om een actie uit te voeren.
LifetimeActionsType	De actie die wordt uitgevoerd.

ActionType

Het type actie. De waarde moet hoofdlettergevoelig worden vergeleken.

Name	Type	Description
Notify	string	Event Grid-gebeurtenissen activeren. De standaardwaarde is 30 dagen voor de vervaldatum. alleen Key Vault.
Rotate	string	Draai de sleutel op basis van het sleutelbeleid.

Error

De sleutelkluisserverfout.

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

KeyRotationPolicy

Beheerbeleid voor een sleutel.

Name	Type	Description
attributes	KeyRotationPolicyAttributes	De beleidskenmerken voor sleutelrotatie.
id	string	De sleutelbeleids-id.
lifetimeActions	LifetimeActions[]	Acties die worden uitgevoerd door Key Vault gedurende de levensduur van een sleutel. Voor preview kan lifetimeActions maximaal twee items hebben: één voor roteren en één voor melden. De meldingstijd is standaard 30 dagen voor de vervaldatum en kan niet worden geconfigureerd.

KeyRotationPolicyAttributes

De beleidskenmerken voor sleutelrotatie.

Name	Type	Description
created	integer	Het sleutelrotatiebeleid is gemaakt in UTC.
expiryTime	string	De expiryTime wordt toegepast op de nieuwe sleutelversie. Dit moet ten minste 28 dagen duren. Het heeft de ISO 8601-indeling. Voorbeelden: 90 dagen: P90D, 3 maanden: P3M, 48 uur: PT48H, 1 jaar en 10 dagen: P1Y10D
updated	integer	Het tijdstip waarop het sleutelrotatiebeleid voor het laatst is bijgewerkt in UTC.

KeyVaultError

De foutuitzondering voor de sleutelkluis.

Name	Type	Description
error	Error	De sleutelkluisserverfout.

LifetimeActions

Actie en de trigger die worden uitgevoerd door Key Vault gedurende de levensduur van een sleutel.

Name	Type	Description
action	LifetimeActionsType	De actie die wordt uitgevoerd.
trigger	LifetimeActionsTrigger	De voorwaarde waarmee de actie wordt uitgevoerd.

LifetimeActionsTrigger

Een voorwaarde waaraan moet worden voldaan om een actie uit te voeren.

Name	Type	Description
timeAfterCreate	string	Tijd na het maken om te proberen te draaien. Dit geldt alleen voor roteren. Het heeft de iso 8601-duurnotatie. Voorbeeld: 90 dagen: "P90D"
timeBeforeExpiry	string	Tijd voor het verlopen om te proberen te draaien of een melding te verzenden. Het heeft de iso 8601-duurnotatie. Voorbeeld: 90 dagen: "P90D"

LifetimeActionsType

De actie die wordt uitgevoerd.

Name	Type	Description
type	ActionType	Het type actie. De waarde moet hoofdlettergevoelig worden vergeleken.

Share via