SecretProperties interface

Pacote:
@azure/keyvault-secrets

Uma interface que representa as propriedades de um KeyVaultSecret.

Propriedades

certificateKeyId

Se esse for um segredo que faz backup de um certificado KV, esse campo especifica o identificador da chave correspondente que faz backup do certificado KV. OBSERVAÇÃO: essa 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: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
enabled

Determina se o objeto está habilitado.
expiresOn

Data de expiração em UTC.
id

A ID secreta.
keyId

Se esse for um segredo que faz backup de um certificado KV, esse campo especifica a chave correspondente que faz backup do certificado KV. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
managed

True se o tempo de vida do segredo é gerenciado pelo cofre de chaves. Se esse for um segredo que faz backup de um certificado, o gerenciamento será verdadeiro. OBSERVAÇÃO: essa 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ó era preenchido quando o segredo era recuperado usando a versão da API 2025-07-01 ou posterior para um segredo com certificado. OBSERVAÇÃO: essa 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 habilitado. OBSERVAÇÃO: essa 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 ela contiver "Purgável", a chave poderá ser excluída permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá limpar a chave no final do intervalo de retenção. Os valores possíveis incluem: 'Purgável', 'Recuperável+Purgável', 'Recuperável', 'Recuperável+ProtectedSubscription' OBSERVAÇÃO: Essa 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

Hora da última atualização em UTC. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
vaultUrl

A URL base para o cofre.
version

A versão do segredo. Pode ser indefinido.

Detalhes da propriedade

certificateKeyId

Se esse for um segredo que faz backup de um certificado KV, esse campo especifica o identificador da chave correspondente que faz backup do certificado KV. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

certificateKeyId?: string

Valor da propriedade

string

contentType

O tipo de conteúdo do segredo.

contentType?: string

Valor da propriedade

string

createdOn

Hora de criação em UTC. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

createdOn?: Date

Valor da propriedade

Date

enabled

Determina se o objeto está habilitado.

enabled?: boolean

Valor da propriedade

boolean

expiresOn

Data de expiração em UTC.

expiresOn?: Date

Valor da propriedade

Date

id

A ID secreta.

id?: string

Valor da propriedade

string

keyId

Aviso

Essa API foi preterida.

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

Se esse for um segredo que faz backup de um certificado KV, esse campo especifica a chave correspondente que faz backup do certificado KV. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

keyId?: undefined

Valor da propriedade

undefined

managed

True se o tempo de vida do segredo é gerenciado pelo cofre de chaves. Se esse for um segredo que faz backup de um certificado, o gerenciamento será verdadeiro. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

managed?: boolean

Valor da propriedade

boolean

name

O nome do segredo.

name: string

Valor da propriedade

string

notBefore

Não antes da data em UTC.

notBefore?: Date

Valor da propriedade

Date

previousVersion

Identificador da versão secreta anterior. Só era preenchido quando o segredo era recuperado usando a versão da API 2025-07-01 ou posterior para um segredo com certificado. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

previousVersion?: string

Valor da propriedade

string

recoverableDays

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

recoverableDays?: number

Valor da propriedade

number

recoveryLevel

Reflete o nível de recuperação de exclusão atualmente em vigor para chaves no cofre atual. Se ela contiver "Purgável", a chave poderá ser excluída permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá limpar a chave no final do intervalo de retenção. Os valores possíveis incluem: 'Purgável', 'Recuperável+Purgável', 'Recuperável', 'Recuperável+ProtectedSubscription' OBSERVAÇÃO: Essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

recoveryLevel?: string

Valor da propriedade

string

tags

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

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

Valor da propriedade

{[propertyName: string]: string}

updatedOn

Hora da última atualização em UTC. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

updatedOn?: Date

Valor da propriedade

Date

vaultUrl

A URL base para o cofre.

vaultUrl: string

Valor da propriedade

string

version

A versão do segredo. Pode ser indefinido.

version?: string

Valor da propriedade

string