Algumas ou todas as informações nesta página podem não se aplicar à nuvem confiável da S3NS.
REST Resource: projects.locations.keyRings.cryptoKeys
Recurso: CryptoKey
Um CryptoKey
representa uma chave lógica que pode ser usada em operações criptográficas.
Uma CryptoKey
é composta por zero ou mais versions
, que representam o material de chave real usado em operações criptográficas.
Representação 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 .
} |
Campos |
name |
string
Apenas saída. O nome do recurso para CryptoKey no formato projects/*/locations/*/keyRings/*/cryptoKeys/* .
|
primary |
object (CryptoKeyVersion )
Apenas saída. Uma cópia do CryptoKeyVersion "principal" que será usado por [Encrypt][KeyManagementService.Encrypt] quando esse CryptoKey for fornecido em [EncryptRequest.name][]. A versão principal do CryptoKey pode ser atualizada via [UpdateCryptoKeyPrimaryVersion][KeyManagementService.UpdateCryptoKeyPrimaryVersion]. As chaves com purpose ENCRYPT_DECRYPT podem ter uma primária. Para outras chaves, esse campo será omitido.
|
purpose |
enum (CryptoKeyPurpose )
Imutável. O propósito imutável desse CryptoKey .
|
createTime |
string (Timestamp format)
Apenas saída. A hora em que este CryptoKey foi criado. Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z" .
|
nextRotationTime |
string (Timestamp format)
Em nextRotationTime , o serviço de gerenciamento de chaves automaticamente:
- Crie uma nova versão desta
CryptoKey .
- Marcar uma nova versão como principal.
As rotações de chaves realizadas manualmente via [Createxliff][KeyManagementService.Createxliff] e [UpdateCryptoKeyPrimaryVersion][KeyManagementService.UpdateCryptoKeyPrimaryVersion] não afetam o nextRotationTime . As chaves com purpose ENCRYPT_DECRYPT oferecem suporte à rotação automática. Para outras chaves, esse campo precisa ser omitido. Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z" .
|
versionTemplate |
object (CryptoKeyVersionTemplate )
Um modelo que descreve as configurações para novas instâncias de CryptoKeyVersion . As propriedades de novas instâncias do CryptoKeyVersion criadas por [CreateCryptoKey][KeyManagementService.Create particular] ou pela rotação automática são controladas por esse modelo.
|
labels |
map (key: string, value: string)
Rótulos com metadados definidos pelo usuário. Para mais informações, consulte Como rotular chaves.
|
importOnly |
boolean
Imutável. Indica se esta chave pode conter apenas versões importadas.
|
destroyScheduledDuration |
string (Duration format)
Imutável. O período em que as versões dessa chave ficam no estado DESTROY_SCHEDULED antes da transição para DESTROYED . Se não for especificada no momento da criação, a duração padrão será de 24 horas. Duração em segundos com até nove dígitos fracionários, terminando em "s ". Exemplo: "3.5s" .
|
cryptoKeyBackend |
string
Imutável. O nome do recurso do ambiente de back-end onde reside o material da chave de todos os CryptoKeyVersions associados a este CryptoKey e onde todas as operações criptográficas relacionadas são realizadas. Aplicável somente se CryptoKeyVersions tiver um ProtectionLevel de [EXTERNAL_VPC][CryptoKey.ProtectionLevel.EXTERNAL_VPC], com o nome do recurso no formato projects/*/locations/*/ekmConnections/* . Essa lista não é completa e pode se aplicar a outros ProtectionLevels no futuro.
|
Campo de união rotation_schedule . Controla a taxa de rotação automática. rotation_schedule só pode ser de um dos seguintes tipos: |
rotationPeriod |
string (Duration format)
O nextRotationTime será adiantado por este período quando o serviço fizer a rotação de uma chave automaticamente. Precisa ser pelo menos 24 horas e no máximo 876.000 horas. Se rotationPeriod for definido, nextRotationTime também vai precisar ser. As chaves com purpose ENCRYPT_DECRYPT oferecem suporte à rotação automática. Para outras chaves, esse campo precisa ser omitido. Duração em segundos com até nove dígitos fracionários, terminando em "s ". Exemplo: "3.5s" .
|
Métodos |
|
Retorna informações agregadas sobre os recursos protegidos pelo CryptoKey do Cloud KMS fornecido. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2024-06-27 UTC.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Não contém as informações de que eu preciso","missingTheInformationINeed","thumb-down"],["Muito complicado / etapas demais","tooComplicatedTooManySteps","thumb-down"],["Desatualizado","outOfDate","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Problema com as amostras / o código","samplesCodeIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2024-06-27 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."]]