Class KeyVaultSecretIdentifier

java.lang.Object
com.azure.security.keyvault.secrets.models.KeyVaultSecretIdentifier
public final class KeyVaultSecretIdentifier extends Object
Information about a KeyVaultSecret parsed from the secret URL. You can use this information when calling methods of SecretClient or SecretAsyncClient.

  • Constructor Details

    • KeyVaultSecretIdentifier

      public KeyVaultSecretIdentifier(String sourceId)
      Create a new KeyVaultSecretIdentifier from a given Key Vault identifier.

      Some examples:

      • https://{key-vault-name}.vault.azure.net/secrets/{secret-name}
      • https://{key-vault-name}.vault.azure.net/secrets/{secret-name}/pending
      • https://{key-vault-name}.vault.azure.net/secrets/{secret-name}/{unique-version-id}
      • https://{key-vault-name}.vault.azure.net/deletedsecrets/{deleted-secret-name}
      Parameters:
      sourceId - The identifier to extract information from.
      Throws:
      IllegalArgumentException - If sourceId is an invalid Key Vault Secret identifier.
      NullPointerException - If sourceId is null.

  • Method Details

    • getSourceId

      public String getSourceId()
      Gets the key identifier used to create this object
      Returns:
      The secret identifier.

    • getVaultUrl

      public String getVaultUrl()
      Gets the URL of the Key Vault.
      Returns:
      The Key Vault URL.

    • getName

      public String getName()
      Gets the name of the secret.
      Returns:
      The secret name.

    • getVersion

      public String getVersion()
      Gets the optional version of the secret.
      Returns:
      The secret version.