Get Key Rotation Policy - Get Key Rotation Policy
Elenchi i criteri per una chiave.
L'operazione GetKeyRotationPolicy restituisce le risorse dei criteri chiave specificate nell'insieme di credenziali delle chiavi specificato. Questa operazione richiede l'autorizzazione keys/get.
GET {vaultBaseUrl}/keys/{key-name}/rotationpolicy?api-version=7.4
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
key-name
|
path | True |
string |
Nome della chiave in un determinato insieme di credenziali delle chiavi. |
vault
|
path | True |
string |
Nome dell'insieme di credenziali, ad esempio https://myvault.vault.azure.net. |
api-version
|
query | True |
string |
Versione API client. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Criteri di rotazione delle chiavi. |
|
Other Status Codes |
Key Vault risposta di errore che descrive il motivo per cui l'operazione non è riuscita. |
Esempio
GetKeyRotationPolicy
Sample Request
GET https://myvault.vault.azure.net//keys/key01/rotationpolicy?api-version=7.4
Sample Response
{
"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
}
}
Definizioni
Nome | Descrizione |
---|---|
Action |
Tipo dell'azione. Il valore deve essere confrontato senza distinzione tra maiuscole e minuscole. |
Error |
Errore del server dell'insieme di credenziali delle chiavi. |
Key |
Criteri di gestione per una chiave. |
Key |
Attributi dei criteri di rotazione delle chiavi. |
Key |
Eccezione di errore dell'insieme di credenziali delle chiavi. |
Lifetime |
Azione e trigger che verranno eseguiti da Key Vault per tutta la durata di una chiave. |
Lifetime |
Condizione da soddisfare per l'esecuzione di un'azione. |
Lifetime |
Azione che verrà eseguita. |
ActionType
Tipo dell'azione. Il valore deve essere confrontato senza distinzione tra maiuscole e minuscole.
Nome | Tipo | Descrizione |
---|---|---|
Notify |
string |
Attivare eventi di Griglia di eventi. Il valore predefinito è 30 giorni prima della scadenza. solo Key Vault. |
Rotate |
string |
Ruotare la chiave in base ai criteri della chiave. |
Error
Errore del server dell'insieme di credenziali delle chiavi.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore. |
innererror |
Errore del server dell'insieme di credenziali delle chiavi. |
|
message |
string |
Messaggio di errore. |
KeyRotationPolicy
Criteri di gestione per una chiave.
Nome | Tipo | Descrizione |
---|---|---|
attributes |
Attributi dei criteri di rotazione delle chiavi. |
|
id |
string |
ID criterio chiave. |
lifetimeActions |
Azioni che verranno eseguite da Key Vault per tutta la durata di una chiave. Per l'anteprima, lifetimeActions può avere al massimo due elementi: uno per la rotazione, uno per la notifica. Per impostazione predefinita, il tempo di notifica è 30 giorni prima della scadenza e non è configurabile. |
KeyRotationPolicyAttributes
Attributi dei criteri di rotazione delle chiavi.
Nome | Tipo | Descrizione |
---|---|---|
created |
integer |
Il criterio di rotazione delle chiavi ha creato l'ora in formato UTC. |
expiryTime |
string |
Il valore expiryTime verrà applicato alla nuova versione della chiave. Dovrebbe essere di almeno 28 giorni. Sarà in formato ISO 8601. Esempi: 90 giorni: P90D, 3 mesi: P3M, 48 ore: PT48H, 1 anno e 10 giorni: P1Y10D |
updated |
integer |
Ora dell'ultimo aggiornamento dei criteri di rotazione delle chiavi in formato UTC. |
KeyVaultError
Eccezione di errore dell'insieme di credenziali delle chiavi.
Nome | Tipo | Descrizione |
---|---|---|
error |
Errore del server dell'insieme di credenziali delle chiavi. |
LifetimeActions
Azione e trigger che verranno eseguiti da Key Vault per tutta la durata di una chiave.
Nome | Tipo | Descrizione |
---|---|---|
action |
Azione che verrà eseguita. |
|
trigger |
Condizione che eseguirà l'azione. |
LifetimeActionsTrigger
Condizione da soddisfare per l'esecuzione di un'azione.
Nome | Tipo | Descrizione |
---|---|---|
timeAfterCreate |
string |
Tempo dopo la creazione per tentare di ruotare. Si applica solo alla rotazione. Sarà in formato di durata ISO 8601. Esempio: 90 giorni: "P90D" |
timeBeforeExpiry |
string |
Tempo prima della scadenza per tentare di ruotare o notificare. Sarà in formato di durata ISO 8601. Esempio: 90 giorni: "P90D" |
LifetimeActionsType
Azione che verrà eseguita.
Nome | Tipo | Descrizione |
---|---|---|
type |
Tipo dell'azione. Il valore deve essere confrontato senza distinzione tra maiuscole e minuscole. |