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 specified name that authorizes request with the given key.

Method Summary

Modifier and Type	Method	Description
AzureNamedKey	getAzureNamedKey()	Retrieves the AzureNamedKey containing the name and key associated with this credential.
AzureNamedKeyCredential	update(String name, String key)	Rotates the name and key associated to this credential.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AzureNamedKeyCredential

public AzureNamedKeyCredential(String name,
 String key)

Creates a credential with specified name that authorizes request with the given key.

Parameters:

name - The name of the key credential.

key - The key used to authorize requests.

Throws:

NullPointerException - If key or name is null.

IllegalArgumentException - If key or name is an empty string.

Method Details

getAzureNamedKey

public AzureNamedKey getAzureNamedKey()

Retrieves the AzureNamedKey containing the name and key associated with this credential.

Returns:

The AzureNamedKey containing the name and key .

update

public AzureNamedKeyCredential update(String name,
 String key)

Rotates the name and key associated 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 AzureNamedKeyCredential object.

Throws:

NullPointerException - If key or name is null.

IllegalArgumentException - If key or name is an empty string.