Package com.azure.core.credential

Class KeyCredential

java.lang.Object

com.azure.core.credential.KeyCredential

Direct Known Subclasses:

AzureKeyCredential

public class KeyCredential
extends Object

Represents a credential that uses a key to authenticate.

Constructor Summary

Constructors

Constructor	Description
KeyCredential(String key)	Creates a credential that authorizes request with the given key.

Method Summary

Modifier and Type	Method	Description
String	getKey()	Retrieves the key associated to this credential.
KeyCredential	update(String key)	Rotates the 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

KeyCredential

public KeyCredential(String key)

Creates a credential that authorizes request with the given key.

Parameters:

key - The key used to authorize requests.

Throws:

NullPointerException - If key is null.

IllegalArgumentException - If key is an empty string.

Method Details

getKey

public String getKey()

Retrieves the key associated to this credential.

Returns:

The key being used to authorize requests.

update

public KeyCredential update(String key)

Rotates the key associated to this credential.

Parameters:

key - The new key to associated with this credential.

Returns:

The updated KeyCredential object.

Throws:

NullPointerException - If key is null.

IllegalArgumentException - If key is an empty string.