Package com.azure.core.credential
Class AzureNamedKeyCredential
- java.lang.Object
-
- com.azure.core.credential.AzureNamedKeyCredential
-
public final class AzureNamedKeyCredential extends Object
Represents a credential with a key name and the key and uses the key to authenticate to an Azure Service.The named credential can be created for keys which have a name identifier associated with them.
Code Samples
Create a named credential for a service specific sas key.
AzureNamedKeyCredential azureNamedKeyCredential = new AzureNamedKeyCredential("AZURE-SERVICE-SAS-KEY-NAME", "AZURE-SERVICE-SAS-KEY");
-
-
Constructor Summary
Constructors Constructor Description AzureNamedKeyCredential(String name, String key)Creates a credential with specifiednamethat authorizes request with the givenkey.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AzureNamedKeygetAzureNamedKey()Retrieves theAzureNamedKeycontaining the name and key associated with this credential.AzureNamedKeyCredentialupdate(String name, String key)Rotates thenameandkeyassociated to this credential.
-
-
-
Constructor Detail
-
AzureNamedKeyCredential
public AzureNamedKeyCredential(String name, String key)
Creates a credential with specifiednamethat authorizes request with the givenkey.- Parameters:
name- The name of the key credential.key- The key used to authorize requests.- Throws:
NullPointerException- Ifkeyornameisnull.IllegalArgumentException- Ifkeyornameis an empty string.
-
-
Method Detail
-
getAzureNamedKey
public AzureNamedKey getAzureNamedKey()
Retrieves theAzureNamedKeycontaining the name and key associated with this credential.- Returns:
- The
AzureNamedKeycontaining the name and key .
-
update
public AzureNamedKeyCredential update(String name, String key)
Rotates thenameandkeyassociated to this credential.- Parameters:
name- The new name of the key credential.key- The new key to be associated with this credential.- Returns:
- The updated
AzureNamedKeyCredentialobject. - Throws:
NullPointerException- Ifkeyornameisnull.IllegalArgumentException- Ifkeyornameis an empty string.
-
-