REST Resource: projects.locations.keyRings.cryptoKeys

Risorsa: CryptoKey

Un elemento CryptoKey rappresenta una chiave logica che può essere utilizzata per le operazioni crittografiche.

Un elemento CryptoKey è costituito da zero o più versions, che rappresentano l'effettivo materiale della chiave utilizzato nelle operazioni crittografiche.

Rappresentazione JSON 
{
  "name": string,
  "primary": {
    object (CryptoKeyVersion)
  },
  "purpose": enum (CryptoKeyPurpose),
  "createTime": string,
  "nextRotationTime": string,
  "versionTemplate": {
    object (CryptoKeyVersionTemplate)
  },
  "labels": {
    string: string,
    ...
  },
  "importOnly": boolean,
  "destroyScheduledDuration": string,
  "cryptoKeyBackend": string,

  // Union field rotation_schedule can be only one of the following:
  "rotationPeriod": string
  // End of list of possible types for union field rotation_schedule.
}
Campi
name

string

Solo output. Il nome della risorsa per CryptoKey nel formato projects/*/locations/*/keyRings/*/cryptoKeys/*.
primary

object (CryptoKeyVersion)

Solo output. Una copia del CryptoKeyVersion "principale" che verrà utilizzato da [Encrypt][KeyManagementService.Encrypt] quando questo CryptoKey verrà fornito in [EncryptRequest.name][].

La versione principale di CryptoKey può essere aggiornata tramite [UpdateCryptoKeyPrimaryVersion][KeyManagementService.UpdateCryptoKeyPRIMARYVersion].

Le chiavi con purpose ENCRYPT_DECRYPT potrebbero avere un token principale. Per le altre chiavi, questo campo verrà omesso.
purpose

enum (CryptoKeyPurpose)

Immutabile. Lo scopo immutabile di questo CryptoKey.
createTime

string (Timestamp format)

Solo output. L'ora in cui è stato creato questo CryptoKey.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
nextRotationTime

string (Timestamp format)

In nextRotationTime, Key Management Service eseguirà automaticamente quanto segue:

  1. Crea una nuova versione di questo CryptoKey.
  2. Contrassegna la nuova versione come principale.

Le rotazioni della chiave eseguite manualmente tramite [CreateCryptoKeyVersion][KeyManagementService.CreateCryptoKeyVersion] e [UpdateCryptoKeyPrimaryVersion][KeyManagementService.UpdateCryptoKeyPRIMARYVersion] non influiscono su nextRotationTime.

Le chiavi con purpose ENCRYPT_DECRYPT supportano la rotazione automatica. Per le altre chiavi, questo campo deve essere omesso.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
versionTemplate

object (CryptoKeyVersionTemplate)

Un modello che descrive le impostazioni per le nuove istanze CryptoKeyVersion. Le proprietà delle nuove istanze CryptoKeyVersion create da [CreateCryptoKeyVersion][KeyManagementService.CreateCryptoKeyVersion] o alla rotazione automatica sono controllate da questo modello.
labels

map (key: string, value: string)

Etichette con metadati definiti dall'utente. Per ulteriori informazioni, consulta la sezione Etichettatura chiavi.
importOnly

boolean

Immutabile. Indica se questa chiave può contenere solo versioni importate.
destroyScheduledDuration

string (Duration format)

Immutabile. Il periodo di tempo durante il quale le versioni di questa chiave vengono utilizzate nello stato DESTROY_SCHEDULED prima della transizione a DESTROYED. Se non specificata al momento della creazione, la durata predefinita è 24 ore.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
cryptoKeyBackend

string

Immutabile. Il nome della risorsa dell'ambiente di backend in cui risiede il materiale della chiave per tutti i CryptoKeyVersions associati a questo CryptoKey e dove vengono eseguite tutte le operazioni crittografiche correlate. Applicabile solo se CryptoKeyVersions ha un ProtectionLevel di [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], con il nome della risorsa nel formato projects/*/locations/*/ekmConnections/*. Tieni presente che questo elenco non è esaustivo e potrebbe applicarsi ad altri ProtectionLevels in futuro.
Campo di unione rotation_schedule. Controlla la velocità della rotazione automatica. rotation_schedule può essere solo uno dei seguenti:
rotationPeriod

string (Duration format)

nextRotationTime verrà avanzato entro questo periodo quando il servizio ruota automaticamente una chiave. Deve essere di almeno 24 ore e al massimo 876.000 ore.

Se il criterio rotationPeriod è impostato, è necessario impostare anche nextRotationTime.

Le chiavi con purpose ENCRYPT_DECRYPT supportano la rotazione automatica. Per le altre chiavi, questo campo deve essere omesso.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".

Metodi

getProtectedResourcesSummary

 Restituisce informazioni aggregate sulle risorse protette dall'elemento CryptoKey di Cloud KMS specificato.