Share via

Get Key - Get Key

  • Riferimento
Service:
Key Vault
API Version:
7.4

Ottiene la parte pubblica di una chiave archiviata.
L'operazione get key è applicabile a tutti i tipi di chiavi. Se la chiave richiesta è simmetrica, non viene rilasciato alcun materiale chiave nella risposta. Questa operazione richiede le chiavi/ottenere l'autorizzazione.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
key-name
 path True

string

Nome della chiave da ottenere.
key-version
 path True

string

L'aggiunta del parametro versione recupera una versione specifica di una chiave. Questo frammento URI è facoltativo. Se non specificato, viene restituita la versione più recente della chiave.
vaultBaseUrl
 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

KeyBundle

Bundle di chiavi contenente la chiave e i relativi attributi.
Other Status Codes

KeyVaultError

Key Vault risposta di errore che descrive perché l'operazione non è riuscita.

Esempio

Get key

Sample Request

GET https://myvault.vault.azure.net//keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71?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"
  }
}

Definizioni

Nome Descrizione
DeletionRecoveryLevel

Riflette il livello di ripristino di eliminazione attualmente effettivo per le chiavi nell'insieme di credenziali corrente. Se contiene "Eliminabile" la chiave può essere eliminata definitivamente da un utente con privilegi; in caso contrario, solo il sistema può eliminare la chiave, alla fine dell'intervallo di conservazione.
Error

Errore del server dell'insieme di credenziali delle chiavi.
JsonWebKey

A partire da http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName

Nome curva ellittica. Per valori validi, vedere JsonWebKeyCurveName.
JsonWebKeyType

Tipo di chiave JsonWebKey (kty), come definito in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KeyAttributes

Attributi di una chiave gestita dal servizio dell'insieme di credenziali delle chiavi.
KeyBundle

KeyBundle costituito da un WebKey più i relativi attributi.
KeyReleasePolicy

Regole dei criteri in cui è possibile esportare la chiave.
KeyVaultError

Eccezione di errore dell'insieme di credenziali delle chiavi.

DeletionRecoveryLevel

Riflette il livello di ripristino di eliminazione attualmente effettivo per le chiavi nell'insieme di credenziali corrente. Se contiene "Eliminabile" la chiave può essere eliminata definitivamente da un utente con privilegi; in caso contrario, solo il sistema può eliminare la chiave, alla fine dell'intervallo di conservazione.

Nome Tipo Descrizione
CustomizedRecoverable

string

Indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminare immediatamente e definitivamente (ad esempio, eliminare quando 7<= SoftDeleteRetentionInDays < 90). Questo livello garantisce la recuperabilità dell'entità eliminata durante l'intervallo di conservazione e mentre la sottoscrizione è ancora disponibile.
CustomizedRecoverable+ProtectedSubscription

string

Indica uno stato di insieme di credenziali e sottoscrizione in cui l'eliminazione è recuperabile, l'eliminazione immediata e permanente (ovvero l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata definitivamente quando 7<= SoftDeleteRetentionInDays < 90. Questo livello garantisce la ripristinabilità dell'entità eliminata durante l'intervallo di conservazione e riflette anche il fatto che la sottoscrizione stessa non può essere annullata.
CustomizedRecoverable+Purgeable

string

Indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile e che consente anche l'eliminazione immediata e permanente (ad esempio, l'eliminazione quando 7<= SoftDeleteRetentionInDays < 90). Questo livello garantisce la ripristinabilità dell'entità eliminata durante l'intervallo di conservazione, a meno che non venga richiesta un'operazione di eliminazione o la sottoscrizione venga annullata.
Purgeable

string

Indica uno stato dell'insieme di credenziali in cui l'eliminazione è un'operazione irreversibile, senza la possibilità di ripristino. Questo livello corrisponde a nessuna protezione disponibile per un'operazione Di eliminazione; i dati sono irreperibili quando si accetta un'operazione Di eliminazione a livello di entità o superiore (insieme di credenziali, gruppo di risorse, sottoscrizione e così via)
Recoverable

string

Indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile senza la possibilità di eliminazione immediata e permanente ,ad esempio l'eliminazione. Questo livello garantisce la ripristinabilità dell'entità eliminata durante l'intervallo di conservazione(90 giorni) e mentre la sottoscrizione è ancora disponibile. Il sistema lo elimina definitivamente dopo 90 giorni, se non ripristinato
Recoverable+ProtectedSubscription

string

Indica uno stato di insieme di credenziali e sottoscrizione in cui l'eliminazione è recuperabile entro l'intervallo di conservazione (90 giorni), l'eliminazione immediata e permanente (ovvero l'eliminazione) non è consentita e in cui la sottoscrizione stessa non può essere annullata definitivamente. Il sistema lo elimina definitivamente dopo 90 giorni, se non ripristinato
Recoverable+Purgeable

string

Indica uno stato dell'insieme di credenziali in cui l'eliminazione è recuperabile e che consente anche l'eliminazione immediata e permanente ,ad esempio l'eliminazione. Questo livello garantisce la ripristinabilità dell'entità eliminata durante l'intervallo di conservazione (90 giorni), a meno che non venga richiesta un'operazione di eliminazione o la sottoscrizione venga annullata. Il sistema lo elimina definitivamente dopo 90 giorni, se non ripristinato

Error

Errore del server dell'insieme di credenziali delle chiavi.

Nome Tipo Descrizione
code

string

Codice di errore.
innererror

Error

Errore del server dell'insieme di credenziali delle chiavi.
message

string

Messaggio di errore.

JsonWebKey

A partire da http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Nome Tipo Descrizione
crv

JsonWebKeyCurveName

Nome curva ellittica. Per valori validi, vedere JsonWebKeyCurveName.
d

string

Esponente privato RSA o componente D di una chiave privata EC.
dp

string

Parametro chiave privata RSA.
dq

string

Parametro chiave privata RSA.
e

string

Esponente pubblico RSA.
k

string

Chiave simmetrica.
key_hsm

string

Chiave protetta, usata con "Bring Your Own Key".
key_ops

string[]

Operazioni chiave supportate.
kid

string

Identificatore della chiave.
kty

JsonWebKeyType

Tipo di chiave JsonWebKey (kty), come definito in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n

string

Modulo RSA.
p

string

RSA secret prime.
q

string

RSA secret prime, con p < q.
qi

string

Parametro chiave privata RSA.
x

string

Componente X di una chiave pubblica EC.
y

string

Componente Y di una chiave pubblica EC.

JsonWebKeyCurveName

Nome curva ellittica. Per valori validi, vedere JsonWebKeyCurveName.

Nome Tipo Descrizione
P-256

string

Curva NIST P-256 ellittica, curva AKA SECG SECP256R1.
P-256K

string

La curva seCG SECP256K1 ellittica.
P-384

string

Curva ellittica NIST P-384, curva AKA SECG SECP384R1.
P-521

string

Curva NIST P-521 ellittica, curva AKA SECG SECP521R1.

JsonWebKeyType

Tipo di chiave JsonWebKey (kty), come definito in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

Nome Tipo Descrizione
EC

string

Curva ellittica.
EC-HSM

string

Curva ellittica con una chiave privata archiviata nel modulo di protezione hardware.
RSA

string

RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM

string

RSA con una chiave privata archiviata nel modulo di protezione hardware.
oct

string

Sequenza di ottet (usata per rappresentare chiavi simmetriche)
oct-HSM

string

Sequenza di ottet (usata per rappresentare chiavi simmetriche) archiviata nel modulo di protezione hardware.

KeyAttributes

Attributi di una chiave gestita dal servizio dell'insieme di credenziali delle chiavi.

Nome Tipo Descrizione
created

integer

Ora di creazione in formato UTC.
enabled

boolean

Determina se l'oggetto è abilitato.
exp

integer

Data di scadenza in FORMATO UTC.
exportable

boolean

Indica se la chiave privata può essere esportata. I criteri di rilascio devono essere forniti quando si crea la prima versione di una chiave esportabile.
nbf

integer

Non prima della data UTC.
recoverableDays

integer

giorni di conservazione dei dati softDelete. Il valore deve essere >=7 e <=90 quando softDelete abilitato, in caso contrario 0.
recoveryLevel

DeletionRecoveryLevel

Riflette il livello di ripristino di eliminazione attualmente effettivo per le chiavi nell'insieme di credenziali corrente. Se contiene "Eliminabile" la chiave può essere eliminata definitivamente da un utente con privilegi; in caso contrario, solo il sistema può eliminare la chiave, alla fine dell'intervallo di conservazione.
updated

integer

Ultima ora aggiornata in FORMATO UTC.

KeyBundle

KeyBundle costituito da un WebKey più i relativi attributi.

Nome Tipo Descrizione
attributes

KeyAttributes

Attributi di gestione delle chiavi.
key

JsonWebKey

Chiave Web Json.
managed

boolean

True se la durata della chiave viene gestita dall'insieme di credenziali delle chiavi. Se si tratta di un backup di una chiave di un certificato, sarà true.
release_policy

KeyReleasePolicy

Regole dei criteri in cui è possibile esportare la chiave.
tags

object

Metadati specifici dell'applicazione sotto forma di coppie chiave-valore.

KeyReleasePolicy

Regole dei criteri in cui è possibile esportare la chiave.

Nome Tipo Valore predefinito Descrizione
contentType

string

application/json; charset=utf-8

Tipo di contenuto e versione dei criteri di rilascio della chiave
data

string

Codifica BLOB delle regole dei criteri in cui è possibile rilasciare la chiave. Il BLOB deve essere codificato con URL base64.
immutable

boolean

Definisce lo stato di mutabilità del criterio. Dopo aver contrassegnato l'immutabile, questo flag non può essere reimpostato e i criteri non possono essere modificati in qualsiasi circostanza.

KeyVaultError

Eccezione di errore dell'insieme di credenziali delle chiavi.

Nome Tipo Descrizione
error

Error

Errore del server dell'insieme di credenziali delle chiavi.