Package com.azure.core.credential
Class AzureKeyCredential
- java.lang.Object
-
- com.azure.core.credential.AzureKeyCredential
-
public final class AzureKeyCredential extends Object
Represents a credential that uses a key to authenticate to an Azure Service.
-
-
Constructor Summary
Constructors Constructor Description AzureKeyCredential(String key)Creates a credential that authorizes request with the given key.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetKey()Retrieves the key associated to this credential.AzureKeyCredentialupdate(String key)Rotates the key associated to this credential.
-
-
-
Constructor Detail
-
AzureKeyCredential
public AzureKeyCredential(String key)
Creates a credential that authorizes request with the given key.- Parameters:
key- The key used to authorize requests.- Throws:
NullPointerException- Ifkeyisnull.IllegalArgumentException- Ifkeyis an empty string.
-
-
Method Detail
-
getKey
public String getKey()
Retrieves the key associated to this credential.- Returns:
- The key being used to authorize requests.
-
update
public AzureKeyCredential update(String key)
Rotates the key associated to this credential.- Parameters:
key- The new key to associated with this credential.- Returns:
- The updated
AzureKeyCredentialobject. - Throws:
NullPointerException- Ifkeyisnull.IllegalArgumentException- Ifkeyis an empty string.
-
-