SecretProperties interface
An interface representing the properties of a KeyVaultSecret.
Properties
certificate |
If this is a secret backing a KV certificate, then this field specifies the identifier of the corresponding key backing the KV certificate. NOTE: This property will not be serialized. It can only be populated by the server. |
content |
The content type of the secret. |
created |
Creation time in UTC. NOTE: This property will not be serialized. It can only be populated by the server. |
enabled | Determines whether the object is enabled. |
expires |
Expiry date in UTC. |
id | The secret id. |
key |
If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate. NOTE: This property will not be serialized. It can only be populated by the server. |
managed | True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true. NOTE: This property will not be serialized. It can only be populated by the server. |
name | The name of the secret. |
not |
Not before date in UTC. |
recoverable |
The retention dates of the softDelete data.
The value should be |
recovery |
Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the end of the retention interval. Possible values include: 'Purgeable', 'Recoverable+Purgeable', 'Recoverable', 'Recoverable+ProtectedSubscription' NOTE: This property will not be serialized. It can only be populated by the server. |
tags | Application specific metadata in the form of key-value pairs. |
updated |
Last updated time in UTC. NOTE: This property will not be serialized. It can only be populated by the server. |
vault |
The base URL to the vault. |
version | The version of the secret. May be undefined. |
Property Details
certificateKeyId
If this is a secret backing a KV certificate, then this field specifies the identifier of the corresponding key backing the KV certificate. NOTE: This property will not be serialized. It can only be populated by the server.
certificateKeyId?: string
Property Value
string
contentType
The content type of the secret.
contentType?: string
Property Value
string
createdOn
Creation time in UTC. NOTE: This property will not be serialized. It can only be populated by the server.
createdOn?: Date
Property Value
Date
enabled
Determines whether the object is enabled.
enabled?: boolean
Property Value
boolean
expiresOn
Expiry date in UTC.
expiresOn?: Date
Property Value
Date
id
The secret id.
id?: string
Property Value
string
keyId
Warning
This API is now deprecated.
Please use certificateKeyId instead. keyId
will always be undefined.
If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate. NOTE: This property will not be serialized. It can only be populated by the server.
keyId?: undefined
Property Value
undefined
managed
True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true. NOTE: This property will not be serialized. It can only be populated by the server.
managed?: boolean
Property Value
boolean
name
The name of the secret.
name: string
Property Value
string
notBefore
Not before date in UTC.
notBefore?: Date
Property Value
Date
recoverableDays
The retention dates of the softDelete data.
The value should be >=7
and <=90
when softDelete enabled.
NOTE: This property will not be serialized. It can only be populated by the server.
recoverableDays?: number
Property Value
number
recoveryLevel
Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the end of the retention interval. Possible values include: 'Purgeable', 'Recoverable+Purgeable', 'Recoverable', 'Recoverable+ProtectedSubscription' NOTE: This property will not be serialized. It can only be populated by the server.
recoveryLevel?: string
Property Value
string
tags
Application specific metadata in the form of key-value pairs.
tags?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
updatedOn
Last updated time in UTC. NOTE: This property will not be serialized. It can only be populated by the server.
updatedOn?: Date
Property Value
Date
vaultUrl
The base URL to the vault.
vaultUrl: string
Property Value
string
version
The version of the secret. May be undefined.
version?: string
Property Value
string