Share via

BlobAudience Class

  • Reference
Package:
com.azure.storage.blob.models
Maven Artifact:
com.azure:azure-storage-blob:12.28.1

public class BlobAudience
extends ExpandableStringEnum<BlobAudience>

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 BlobAudience AZURE_PUBLIC_CLOUD

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

Constructor Summary

Constructor Description
BlobAudience()

Deprecated

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

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

Method Summary

Modifier and Type Method and Description
static BlobAudience createBlobServiceAccountAudience(String storageAccountName)

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

The Azure Active Directory audience to use when forming authorization scopes.
static Collection<BlobAudience> 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 BlobAudience 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

BlobAudience

@Deprecated
public BlobAudience()

Deprecated

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

Creates a new instance of BlobAudience without a #toString() value. This constructor shouldn't be called as it will produce a BlobAudience which doesn't have a String enum value.

Method Details

createBlobServiceAccountAudience

public static BlobAudience createBlobServiceAccountAudience(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 blob service endpoint.

fromString

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

values

public static Collection values()

Returns:

known BlobAudience values.

Applies to