Package version:

Interface SecretProperties

An interface representing the properties of a KeyVaultSecret.

interface SecretProperties {
    certificateKeyId?: string;
    contentType?: string;
    createdOn?: any;
    enabled?: boolean;
    expiresOn?: any;
    id?: string;
    keyId?: undefined;
    managed?: boolean;
    name: string;
    notBefore?: any;
    recoverableDays?: number;
    recoveryLevel?: string;
    tags?: {
        [propertyName: string]: string;
    };
    updatedOn?: any;
    vaultUrl: string;
    version?: string;
}

Properties

certificateKeyId? contentType? createdOn? enabled? expiresOn? id? keyId? managed? name notBefore? recoverableDays? recoveryLevel? tags? updatedOn? vaultUrl version?

Properties

Optional ReadonlycertificateKeyId

certificateKeyId?: string

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.

OptionalcontentType

contentType?: string

The content type of the secret.

Optional ReadonlycreatedOn

createdOn?: any

Creation time in UTC. NOTE: This property will not be serialized. It can only be populated by the server.

Optionalenabled

enabled?: boolean

Determines whether the object is enabled.

Optional ReadonlyexpiresOn

expiresOn?: any

Expiry date in UTC.

Optionalid

id?: string

The secret id.

Optional ReadonlykeyId

keyId?: 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.

Deprecated

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

Optional Readonlymanaged

managed?: boolean

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

name: string

The name of the secret.

Optional ReadonlynotBefore

notBefore?: any

Not before date in UTC.

OptionalrecoverableDays

recoverableDays?: number

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.

Optional ReadonlyrecoveryLevel

recoveryLevel?: string

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.

Optionaltags

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

Application specific metadata in the form of key-value pairs.

Optional ReadonlyupdatedOn

updatedOn?: any

Last updated time in UTC. NOTE: This property will not be serialized. It can only be populated by the server.

vaultUrl

vaultUrl: string

The base URL to the vault.

Optionalversion

version?: string

The version of the secret. May be undefined.

Settings

Member Visibility