Class KeyVaultSecretIdentifier
- java.lang.Object
-
- com.azure.security.keyvault.secrets.models.KeyVaultSecretIdentifier
-
public final class KeyVaultSecretIdentifier extends Object
Information about aKeyVaultSecret
parsed from the secret URL. You can use this information when calling methods ofSecretClient
orSecretAsyncClient
.
-
-
Constructor Summary
Constructors Constructor Description KeyVaultSecretIdentifier(String sourceId)
Create a newKeyVaultSecretIdentifier
from a given Key Vault identifier.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getName()
Gets the name of the secret.String
getSourceId()
Gets the key identifier used to create this objectString
getVaultUrl()
Gets the URL of the Key Vault.String
getVersion()
Gets the optional version of the secret.
-
-
-
Constructor Detail
-
KeyVaultSecretIdentifier
public KeyVaultSecretIdentifier(String sourceId)
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 Detail
-
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.
-
-