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 Details

    • 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 - 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 AzureKeyCredential update(String key)
      Rotates the key associated to this credential.
      Parameters:
      key - The new key to associated with this credential.
      Returns:
      The updated AzureKeyCredential object.
      Throws:
      NullPointerException - If key is null.
      IllegalArgumentException - If key is an empty string.