Il est possible qu'une partie ou l'ensemble des informations de cette page ne s'appliquent pas au Cloud de confiance S3NS.
REST Resource: projects.locations.keyRings.cryptoKeys
Ressource : CryptoKey
Un CryptoKey
représente une clé logique pouvant être utilisée pour les opérations de chiffrement.
Une CryptoKey
est composée de zéro, un ou plusieurs versions
, qui représentent le matériel de clé réel utilisé dans les opérations de chiffrement.
Représentation 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 .
} |
Champs |
name |
string
Uniquement en sortie. Nom de ressource de cet élément CryptoKey au format projects/*/locations/*/keyRings/*/cryptoKeys/* .
|
primary |
object (CryptoKeyVersion )
Uniquement en sortie. Copie du CryptoKeyVersion "principal" qui sera utilisé par [Encrypt][KeyManagementService.Encrypt] lorsque cet élément CryptoKey est fourni dans [EncryptRequest.name][]. La version principale de CryptoKey peut être mise à jour via [UpdateCryptoKeyPrimaryVersion][KeyManagementService.UpdateCryptoKeyPrimaryVersion]. Les clés avec purpose ENCRYPT_DECRYPT peuvent avoir une instance principale. Pour les autres clés, ce champ est omis.
|
purpose |
enum (CryptoKeyPurpose )
Immuable. Objectif immuable de ce CryptoKey .
|
createTime |
string (Timestamp format)
Uniquement en sortie. Date et heure de création de ce CryptoKey . Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z" .
|
nextRotationTime |
string (Timestamp format)
À nextRotationTime , Key Management Service effectue automatiquement les opérations suivantes:
- Créez une nouvelle version de ce
CryptoKey .
- Il désigne cette nouvelle version comme version principale.
Les rotations de clé effectuées manuellement via [CreateCryptoKey][KeyManagementService.CreateCryptoKey] et [UpdateCryptoKeyPrimaryVersion][KeyManagementService.UpdateCryptoKeyPrimaryVersion] n'affectent pas nextRotationTime . Les clés avec purpose ENCRYPT_DECRYPT acceptent la rotation automatique. Pour les autres clés, ce champ doit être omis. Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z" .
|
versionTemplate |
object (CryptoKeyVersionTemplate )
Modèle décrivant les paramètres des nouvelles instances CryptoKeyVersion . Les propriétés des nouvelles instances CryptoKeyVersion créées par [CreateCryptoKey][KeyManagementService.CreateCryptoKey] ou par rotation automatique sont contrôlées par ce modèle.
|
labels |
map (key: string, value: string)
Libellés avec des métadonnées définies par l'utilisateur. Pour en savoir plus, consultez la page Ajouter des libellés à des clés.
|
importOnly |
boolean
Immuable. Indique si cette clé ne peut contenir que des versions importées.
|
destroyScheduledDuration |
string (Duration format)
Immuable. Durée pendant laquelle les versions de cette clé passent à l'état DESTROY_SCHEDULED avant de passer à DESTROYED . Si aucune valeur n'est spécifiée au moment de la création, la durée par défaut est de 24 heures. Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s ". Exemple : "3.5s"
|
cryptoKeyBackend |
string
Immuable. Nom de ressource de l'environnement de backend où se trouve le matériel de clé pour tous les CryptoKeyVersions associés à ce CryptoKey et où toutes les opérations cryptographiques associées sont effectuées. Ne s'applique que si CryptoKeyVersions possède un ProtectionLevel de type [EXTERNAL_VPC][CryptoKey.ProtectionLevel.EXTERNAL_VPC], avec le nom de ressource au format projects/*/locations/*/ekmConnections/* . Notez que cette liste n'est pas exhaustive et qu'elle pourrait s'appliquer à d'autres ProtectionLevels à l'avenir.
|
Champ d'union rotation_schedule . Contrôle la vitesse de rotation automatique. rotation_schedule ne peut être qu'un des éléments suivants : |
rotationPeriod |
string (Duration format)
nextRotationTime sera avancée de cette période lorsqu'une clé sera automatiquement alternée par le service. La durée doit être comprise entre 24 heures et 876 000 heures.
Si rotationPeriod est défini, nextRotationTime doit également être défini. Les clés avec purpose ENCRYPT_DECRYPT acceptent la rotation automatique. Pour les autres clés, ce champ doit être omis. Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s ". Exemple : "3.5s"
|
Méthodes |
|
Renvoie des informations agrégées sur les ressources protégées par le CryptoKey Cloud KMS donné. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2024/06/25 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Il n'y a pas l'information dont j'ai besoin","missingTheInformationINeed","thumb-down"],["Trop compliqué/Trop d'étapes","tooComplicatedTooManySteps","thumb-down"],["Obsolète","outOfDate","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Mauvais exemple/Erreur de code","samplesCodeIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2024/06/25 (UTC)."],[],[],null,["# REST Resource: projects.locations.keyRings.cryptoKeys\n\n- [Resource: CryptoKey](#CryptoKey)\n - [JSON representation](#CryptoKey.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: CryptoKey\n-------------------\n\nA [CryptoKey](/kms/docs/reference/inventory/rest/v1/projects.cryptoKeys#CryptoKey) represents a logical key that can be used for cryptographic operations.\n\nA [CryptoKey](/kms/docs/reference/inventory/rest/v1/projects.cryptoKeys#CryptoKey) is made up of zero or more [versions](/kms/docs/reference/inventory/rest/v1/projects.cryptoKeys#CryptoKey.CryptoKeyVersion), which represent the actual key material used in cryptographic operations."]]