Secret Interface

Package:

com.azure.resourcemanager.keyvault.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-keyvault:2.47.0

Implements

HasId HasName HasInnerModel<SecretProperties> Indexable Updatable<Update>

public interface Secret
extends Indexable, HasInnerModel<SecretProperties>, HasId, HasName, Updatable<Update>

An immutable client-side representation of an Azure Key Vault secret.

Method Summary

Modifier and Type	Method and Description
abstract SecretProperties	attributes() Gets the secret management attributes.
abstract String	contentType() Gets type of the secret value such as a password.
abstract boolean	enabled() Checks whether secret is enabled.
abstract String	getValue() Gets the secret value when the secret is enabled.
abstract Mono<String>	getValueAsync() Gets the secret value when the secret is enabled.
abstract String	kid() Gets the corresponding key backing the KV certificate if this is a secret backing a KV certificate.
abstract PagedIterable<Secret>	listVersions() Gets a list of individual secret versions with the same secret name.
abstract PagedFlux<Secret>	listVersionsAsync() Gets a list of individual secret versions with the same secret name.
abstract boolean	managed() Checks whether the secret's lifetime is managed by key vault.
abstract Map<String,String>	tags() Gets application specific metadata in the form of key-value pairs.

Method Details

attributes

public abstract SecretProperties attributes()

Gets the secret management attributes.

Returns:

the secret management attributes

contentType

public abstract String contentType()

Gets type of the secret value such as a password.

Returns:

type of the secret value such as a password

enabled

public abstract boolean enabled()

Checks whether secret is enabled.

Returns:

whether secret is enabled.

getValue

public abstract String getValue()

Gets the secret value when the secret is enabled.

Returns:

the secret value when the secret is enabled

getValueAsync

public abstract Mono getValueAsync()

Gets the secret value when the secret is enabled.

Returns:

the secret value when the secret is enabled

kid

public abstract String kid()

Gets the corresponding key backing the KV certificate if this is a secret backing a KV certificate.

Returns:

the corresponding key backing the KV certificate if this is a secret backing a KV certificate

listVersions

public abstract PagedIterable listVersions()

Gets a list of individual secret versions with the same secret name.

Returns:

a list of individual secret versions with the same secret name

listVersionsAsync

public abstract PagedFlux listVersionsAsync()

Gets a list of individual secret versions with the same secret name.

Returns:

a list of individual secret versions with the same secret name

managed

public abstract boolean managed()

Checks whether the secret's lifetime is managed by key vault.

Returns:

true if the secret's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true

tags

public abstract Map tags()

Gets application specific metadata in the form of key-value pairs.

Returns:

application specific metadata in the form of key-value pairs