Share via


AzureIdentityEnvVars Class

public final class AzureIdentityEnvVars
extends ExpandableStringEnum<AzureIdentityEnvVars>

Defines well-known Azure Identity environment variable names that can be used with DefaultAzureCredentialBuilder#requireEnvVars(AzureIdentityEnvVars...).

This expandable enum provides a type-safe way to reference common Azure Identity environment variables while still allowing for custom environment variable names.

Field Summary

Modifier and Type Field and Description
static final AzureIdentityEnvVars AZURE_AUTHORITY_HOST

The Azure authority host environment variable.

static final AzureIdentityEnvVars AZURE_CLIENT_CERTIFICATE_PASSWORD

The Azure client certificate password environment variable.

static final AzureIdentityEnvVars AZURE_CLIENT_CERTIFICATE_PATH

The Azure client certificate path environment variable.

static final AzureIdentityEnvVars AZURE_CLIENT_ID

The Azure client ID environment variable.

static final AzureIdentityEnvVars AZURE_CLIENT_SECRET

The Azure client secret environment variable.

static final AzureIdentityEnvVars AZURE_CLIENT_SEND_CERTIFICATE_CHAIN

The Azure client send certificate chain environment variable.

static final AzureIdentityEnvVars AZURE_TENANT_ID

The Azure tenant ID environment variable.

static final AzureIdentityEnvVars AZURE_TOKEN_CREDENTIALS

The Azure token credentials environment variable for selecting credential types.

Constructor Summary

Constructor Description
AzureIdentityEnvVars()

Deprecated

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

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

Method Summary

Modifier and Type Method and Description
static AzureIdentityEnvVars fromString(String name)

Creates or finds an AzureIdentityEnvVars from its string representation.

static Collection<AzureIdentityEnvVars> values()

Gets known AzureIdentityEnvVars values.

Methods inherited from ExpandableStringEnum

Methods inherited from java.lang.Object

Field Details

AZURE_AUTHORITY_HOST

public static final AzureIdentityEnvVars AZURE_AUTHORITY_HOST

The Azure authority host environment variable.

AZURE_CLIENT_CERTIFICATE_PASSWORD

public static final AzureIdentityEnvVars AZURE_CLIENT_CERTIFICATE_PASSWORD

The Azure client certificate password environment variable.

AZURE_CLIENT_CERTIFICATE_PATH

public static final AzureIdentityEnvVars AZURE_CLIENT_CERTIFICATE_PATH

The Azure client certificate path environment variable.

AZURE_CLIENT_ID

public static final AzureIdentityEnvVars AZURE_CLIENT_ID

The Azure client ID environment variable.

AZURE_CLIENT_SECRET

public static final AzureIdentityEnvVars AZURE_CLIENT_SECRET

The Azure client secret environment variable.

AZURE_CLIENT_SEND_CERTIFICATE_CHAIN

public static final AzureIdentityEnvVars AZURE_CLIENT_SEND_CERTIFICATE_CHAIN

The Azure client send certificate chain environment variable.

AZURE_TENANT_ID

public static final AzureIdentityEnvVars AZURE_TENANT_ID

The Azure tenant ID environment variable.

AZURE_TOKEN_CREDENTIALS

public static final AzureIdentityEnvVars AZURE_TOKEN_CREDENTIALS

The Azure token credentials environment variable for selecting credential types.

Constructor Details

AzureIdentityEnvVars

@Deprecated
public AzureIdentityEnvVars()

Deprecated

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

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

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

Method Details

fromString

public static AzureIdentityEnvVars fromString(String name)

Creates or finds an AzureIdentityEnvVars from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding AzureIdentityEnvVars.

values

public static Collection<AzureIdentityEnvVars> values()

Gets known AzureIdentityEnvVars values.

Returns:

known AzureIdentityEnvVars values.

Applies to