Package com.azure.security.keyvault.keys.models

Class KeyVaultKeyIdentifier

java.lang.Object
com.azure.security.keyvault.keys.models.KeyVaultKeyIdentifier
public final class KeyVaultKeyIdentifier extends Object
Information about a KeyVaultKey parsed from the key URL. You can use this information when calling methods of KeyClient or KeyAsyncClient.

  • Constructor Details

    • KeyVaultKeyIdentifier

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

      Some examples:

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

  • Method Details

    • getSourceId

      public String getSourceId()
      Gets the key identifier used to create this object.
      Returns:
      The key 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 key.
      Returns:
      The key name.

    • getVersion

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