Share via

KeyCredential Class

  • Reference
Package:
com.azure.core.credential
Maven Artifact:
com.azure:azure-core:1.54.0
  • java.lang.Object
    • com.azure.core.credential.KeyCredential

public class KeyCredential

Represents a credential that uses a key to authenticate.

Constructor Summary

Constructor Description
KeyCredential(String key)

Creates a credential that authorizes request with the given key.

Method Summary

Modifier and Type Method and Description
String getKey()

Retrieves the key associated to this credential.
KeyCredential update(String key)

Rotates the key associated to this credential.

Methods inherited from 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.

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.

Applies to