Share via

KeyVaultKeyIdentifier Class

  • Reference
Package:
com.azure.security.keyvault.keys.models
Maven Artifact:
com.azure:azure-security-keyvault-keys:4.9.0
  • java.lang.Object
    • com.azure.security.keyvault.keys.models.KeyVaultKeyIdentifier

public final class KeyVaultKeyIdentifier

Information about a KeyVaultKey parsed from the key URL. You can use this information when calling methods of KeyClient or KeyAsyncClient.

Constructor Summary

Constructor Description
KeyVaultKeyIdentifier(String sourceId)

Create a new KeyVaultKeyIdentifier from a given Key Vault identifier.

Method Summary

Modifier and Type Method and Description
String getName()

Gets the name of the key.
String getSourceId()

Gets the key identifier used to create this object.
String getVaultUrl()

Gets the URL of the Key Vault.
String getVersion()

Gets the optional version of the key.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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.

Method Details

getName

public String getName()

Gets the name of the key.

Returns:

The key name.

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.

getVersion

public String getVersion()

Gets the optional version of the key.

Returns:

The key version.

Applies to