SecretProperties interface

Pacote:
@azure/keyvault-secrets

Uma interface que representa as propriedades de um KeyVaultSecret.

Propriedades

certificateKeyId

Se este for um segredo de apoio a um certificado KV, este campo especifica o identificador da chave correspondente que suporta o certificado KV. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
contentType

O tipo de conteúdo do segredo.
createdOn

Hora de criação em UTC. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
enabled

Determina se o objeto está habilitado.
expiresOn

Data de validade em UTC.
id

O id secreto.
keyId

Se este for um segredo que apoia um certificado KV, este campo especifica a chave correspondente que suporta o certificado KV. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
managed

True se o tempo de vida do segredo for gerenciado pelo cofre de chaves. Se este for um segredo de apoio a um certificado, então gerenciado será verdadeiro. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
name

O nome do segredo.
notBefore

Não antes da data em UTC.
previousVersion

Identificador da versão secreta anterior. Só é preenchido quando o segredo foi recuperado usando a versão API 2025-07-01 ou posterior para um segredo suportado por certificado. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
recoverableDays

As datas de retenção dos dados softDelete. O valor deve ser >=7 e <=90 quando softDelete ativado. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
recoveryLevel

Reflete o nível de recuperação de exclusão atualmente em vigor para chaves no cofre atual. Se contiver 'Purgeable', a chave pode ser permanentemente eliminada por um utilizador privilegiado; caso contrário, apenas o sistema pode limpar a chave, no final do intervalo de retenção. Os valores possíveis incluem: 'Purgeable', 'Recoverable+Purgeable', 'Recoverable', 'Recoverable+ProtectedSubscription' NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
tags

Metadados específicos do aplicativo na forma de pares chave-valor.
updatedOn

Última atualização em UTC. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
vaultUrl

O URL base para o cofre.
version

A versão do segredo. Pode ser indefinido.

Detalhes de Propriedade

certificateKeyId

Se este for um segredo de apoio a um certificado KV, este campo especifica o identificador da chave correspondente que suporta o certificado KV. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

certificateKeyId?: string

Valor de Propriedade

string

contentType

O tipo de conteúdo do segredo.

contentType?: string

Valor de Propriedade

string

createdOn

Hora de criação em UTC. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

createdOn?: Date

Valor de Propriedade

Date

enabled

Determina se o objeto está habilitado.

enabled?: boolean

Valor de Propriedade

boolean

expiresOn

Data de validade em UTC.

expiresOn?: Date

Valor de Propriedade

Date

id

O id secreto.

id?: string

Valor de Propriedade

string

keyId

Aviso

Esta API foi preterida.

Please use SecretProperties.certificateKeyId instead. keyId will always be undefined.

Se este for um segredo que apoia um certificado KV, este campo especifica a chave correspondente que suporta o certificado KV. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

keyId?: undefined

Valor de Propriedade

undefined

managed

True se o tempo de vida do segredo for gerenciado pelo cofre de chaves. Se este for um segredo de apoio a um certificado, então gerenciado será verdadeiro. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

managed?: boolean

Valor de Propriedade

boolean

name

O nome do segredo.

name: string

Valor de Propriedade

string

notBefore

Não antes da data em UTC.

notBefore?: Date

Valor de Propriedade

Date

previousVersion

Identificador da versão secreta anterior. Só é preenchido quando o segredo foi recuperado usando a versão API 2025-07-01 ou posterior para um segredo suportado por certificado. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

previousVersion?: string

Valor de Propriedade

string

recoverableDays

As datas de retenção dos dados softDelete. O valor deve ser >=7 e <=90 quando softDelete ativado. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

recoverableDays?: number

Valor de Propriedade

number

recoveryLevel

Reflete o nível de recuperação de exclusão atualmente em vigor para chaves no cofre atual. Se contiver 'Purgeable', a chave pode ser permanentemente eliminada por um utilizador privilegiado; caso contrário, apenas o sistema pode limpar a chave, no final do intervalo de retenção. Os valores possíveis incluem: 'Purgeable', 'Recoverable+Purgeable', 'Recoverable', 'Recoverable+ProtectedSubscription' NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

recoveryLevel?: string

Valor de Propriedade

string

tags

Metadados específicos do aplicativo na forma de pares chave-valor.

tags?: {[propertyName: string]: string}

Valor de Propriedade

{[propertyName: string]: string}

updatedOn

Última atualização em UTC. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

updatedOn?: Date

Valor de Propriedade

Date

vaultUrl

O URL base para o cofre.

vaultUrl: string

Valor de Propriedade

string

version

A versão do segredo. Pode ser indefinido.

version?: string

Valor de Propriedade

string