Class KeyVaultSecretIdentifier
java.lang.Object
com.azure.security.keyvault.secrets.models.KeyVaultSecretIdentifier
Information about a
KeyVaultSecret
parsed from the secret URL. You can use this information when calling
methods of SecretClient
or SecretAsyncClient
.-
Constructor Summary
ConstructorDescriptionKeyVaultSecretIdentifier
(String sourceId) Create a newKeyVaultSecretIdentifier
from a given Key Vault identifier. -
Method Summary
Modifier and TypeMethodDescriptiongetName()
Gets the name of the secret.Gets the key identifier used to create this objectGets the URL of the Key Vault.Gets the optional version of the secret.
-
Constructor Details
-
KeyVaultSecretIdentifier
Create a newKeyVaultSecretIdentifier
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
- IfsourceId
is an invalid Key Vault Secret identifier.NullPointerException
- IfsourceId
isnull
.
-
-
Method Details
-
getSourceId
Gets the key identifier used to create this object- Returns:
- The secret identifier.
-
getVaultUrl
Gets the URL of the Key Vault.- Returns:
- The Key Vault URL.
-
getName
Gets the name of the secret.- Returns:
- The secret name.
-
getVersion
Gets the optional version of the secret.- Returns:
- The secret version.
-