Package com.azure.resourcemanager.keyvault.models

Interface Secret

All Superinterfaces:
HasId, HasInnerModel<com.azure.security.keyvault.secrets.models.SecretProperties>, HasName, Indexable, Updatable<Secret.Update>
public interface Secret extends Indexable, HasInnerModel<com.azure.security.keyvault.secrets.models.SecretProperties>, HasId, HasName, Updatable<Secret.Update>
An immutable client-side representation of an Azure Key Vault secret.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Secret.Definition
    Container interface for all the definitions.
    static interface 
    Secret.DefinitionStages
    Grouping of secret definition stages.
    static interface 
    Secret.Update
    The template for a secret update operation, containing all the settings that can be modified.
    static interface 
    Secret.UpdateStages
    Grouping of secret update stages.

  • Method Summary

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

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasId

    id

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

    innerModel

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName

    name

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

    key

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable

    update

  • Method Details

    • getValue

      String getValue()
      Gets the secret value when the secret is enabled.
      Returns:
      the secret value when the secret is enabled

    • getValueAsync

      Mono<String> getValueAsync()
      Gets the secret value when the secret is enabled.
      Returns:
      the secret value when the secret is enabled

    • attributes

      com.azure.security.keyvault.secrets.models.SecretProperties attributes()
      Gets the secret management attributes.
      Returns:
      the secret management attributes

    • tags

      Map<String,String> tags()
      Gets application specific metadata in the form of key-value pairs.
      Returns:
      application specific metadata in the form of key-value pairs

    • contentType

      String contentType()
      Gets type of the secret value such as a password.
      Returns:
      type of the secret value such as a password

    • kid

      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

    • managed

      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

    • enabled

      boolean enabled()
      Checks whether secret is enabled.
      Returns:
      whether secret is enabled.

    • listVersions

      com.azure.core.http.rest.PagedIterable<Secret> 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

      com.azure.core.http.rest.PagedFlux<Secret> 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