DataLakeAudience Class

  • Reference
Package:
com.azure.storage.file.datalake.models
Maven Artifact:
com.azure:azure-storage-file-datalake:12.21.0

public class DataLakeAudience
extends ExpandableStringEnum<DataLakeAudience>

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 Summary

Modifier and Type Field and Description
static final DataLakeAudience AZURE_PUBLIC_CLOUD

Gets default Audience used to acquire a token for authorizing requests to any Azure Storage account.

Constructor Summary

Constructor Description
DataLakeAudience()

Deprecated

Use one of the constants or the fromString(String audience) factory method.

Creates a new instance of DataLakeAudience without a #toString() value.

Method Summary

Modifier and Type Method and Description
static DataLakeAudience createDataLakeServiceAccountAudience(String storageAccountName)

The service endpoint for a given storage account.
static DataLakeAudience fromString(String audience)

The Azure Active Directory audience to use when forming authorization scopes.
static Collection<DataLakeAudience> values()

Methods inherited from ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

AZURE_PUBLIC_CLOUD

public static final DataLakeAudience 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

DataLakeAudience

@Deprecated
public DataLakeAudience()

Deprecated

Use one of the constants or the fromString(String audience) factory method.

Creates a new instance of DataLakeAudience without a #toString() value.

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

Method Details

createDataLakeServiceAccountAudience

public static DataLakeAudience createDataLakeServiceAccountAudience(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 datalake service endpoint.

fromString

public static DataLakeAudience 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 DataLakeAudience.

values

public static Collection values()

Returns:

known DataLakeAudience values.

Applies to