Package com.azure.storage.file.share.models

Class ShareAudience

java.lang.Object
com.azure.core.util.ExpandableStringEnum<ShareAudience>
com.azure.storage.file.share.models.ShareAudience
All Implemented Interfaces:
com.azure.core.util.ExpandableEnum<String>
public class ShareAudience extends com.azure.core.util.ExpandableStringEnum<ShareAudience>
The audience to be used when requesting a token from Azure Active Directory (AAD). Note: This audience only has an effect when authenticating a TokenCredential.

  • Field Details

    • AZURE_PUBLIC_CLOUD

      public static final ShareAudience AZURE_PUBLIC_CLOUD
      Gets default Audience used to acquire a token for authorizing requests to any Azure Storage account. If no audience is specified, this resource ID is the default value: "https://storage.azure.com/".

  • Constructor Details

    • ShareAudience

      @Deprecated public ShareAudience()
      Deprecated.
      Use one of the constants or the fromString(String) factory method.
      Creates a new instance of ShareAudience without a ExpandableStringEnum.toString() value.

      This constructor shouldn't be called as it will produce a ShareAudience which doesn't have a String enum value.

  • Method Details

    • createShareServiceAccountAudience

      public static ShareAudience createShareServiceAccountAudience(String storageAccountName)
      The service endpoint for a given storage account. Use this method to acquire a token for authorizing requests to that specific Azure Storage account and service only.
      Parameters:
      storageAccountName - The storage account name used to populate the service endpoint.
      Returns:
      the audience with the file service endpoint.

    • fromString

      public static ShareAudience fromString(String audience)
      The Azure Active Directory audience to use when forming authorization scopes. For the Language service, this value corresponds to a URL that identifies the Azure cloud where the resource is located. For more information see Authorize access to Azure blobs using Azure Active Directory.
      Parameters:
      audience - The Azure Active Directory audience to use when forming authorization scopes.
      Returns:
      the corresponding ShareAudience.

    • values

      public static Collection<ShareAudience> values()
      Gets known ShareAudience values.
      Returns:
      known ShareAudience values.