AzureEnvironment Class

Package:

com.azure.core.management

Maven Artifact:

com.azure:azure-core-management:1.15.5

• java.lang.Object
• • com.azure.core.management.AzureEnvironment

public final class AzureEnvironment

An instance of this class describes an environment in Azure.

Field Summary

Modifier and Type	Field and Description
static final AzureEnvironment	AZURE Provides the settings for authentication with Azure.
static final AzureEnvironment	AZURE_CHINA Provides the settings for authentication with Azure China.
static final AzureEnvironment	AZURE_GERMANY Deprecated Use GERMANY_WEST_CENTRAL or GERMANY_NORTH with AZURE. Provides the settings for authentication with Azure Germany.
static final AzureEnvironment	AZURE_US_GOVERNMENT Provides the settings for authentication with Azure US Government.

Constructor Summary

Constructor	Description
AzureEnvironment(Map<String,String> endpoints)	Initializes an instance of AzureEnvironment class.

Method Summary

Modifier and Type	Method and Description
String	getActiveDirectoryEndpoint() Gets the Active Directory login endpoint.
String	getActiveDirectoryGraphApiVersion() Gets the Active Directory api version.
String	getActiveDirectoryResourceId() Gets the resource ID to obtain AD tokens.
String	getApplicationInsightsEndpoint() Gets the log analytics endpoint.
String	getAzureDataLakeAnalyticsCatalogAndJobEndpointSuffix() Gets the data lake analytics job and catalog service dns suffix.
String	getAzureDataLakeStoreFileSystemEndpointSuffix() Gets the data lake store filesystem service dns suffix.
String	getDataLakeEndpointResourceId() Gets the Data Lake resource ID.
Map<String,String>	getEndpoints() Gets the entirety of the endpoints associated with the current environment.
String	getGalleryEndpoint() Gets the template gallery endpoint.
String	getGraphEndpoint() Gets the Active Directory resource ID.
String	getKeyVaultDnsSuffix() Gets the keyvault service dns suffix.
String	getLogAnalyticsEndpoint() Gets the log analytics endpoint.
String	getManagedHsmDnsSuffix() Gets the managed HSM DNS suffix.
String	getManagementEndpoint() Gets the management service endpoint.
String	getMicrosoftGraphEndpoint() Gets the Microsoft Graph resource ID.
String	getPortal() Gets the management portal URL.
String	getPublishingProfile() Gets the publishing settings file URL.
String	getResourceManagerEndpoint() Gets the resource management endpoint.
String	getSqlManagementEndpoint() Gets the sql server management endpoint for mobile commands.
String	getSqlServerHostnameSuffix() Gets the dns suffix for sql servers.
String	getStorageEndpointSuffix() Gets the endpoint suffix for storage accounts.
String	getUrlByEndpoint(AzureEnvironment.Endpoint endpoint) Gets the endpoint URL for the current environment.
static List<AzureEnvironment>	knownEnvironments() Gets the list of known environments to Azure SDK.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Details

AZURE

public static final AzureEnvironment AZURE

Provides the settings for authentication with Azure.

AZURE_CHINA

public static final AzureEnvironment AZURE_CHINA

Provides the settings for authentication with Azure China.

AZURE_GERMANY

@Deprecated
public static final AzureEnvironment AZURE_GERMANY

Deprecated

Use GERMANY_WEST_CENTRAL or GERMANY_NORTH with AZURE.

Provides the settings for authentication with Azure Germany.

Microsoft no longer be accepting new customers or deploying any new services from Microsoft Cloud Germany.

AZURE_US_GOVERNMENT

public static final AzureEnvironment AZURE_US_GOVERNMENT

Provides the settings for authentication with Azure US Government.

Constructor Details

AzureEnvironment

public AzureEnvironment(Map endpoints)

Initializes an instance of AzureEnvironment class.

Parameters:

endpoints - a map storing all the endpoint info

Method Details

getActiveDirectoryEndpoint

public String getActiveDirectoryEndpoint()

Gets the Active Directory login endpoint.

Returns:

the Active Directory login endpoint.

getActiveDirectoryGraphApiVersion

public String getActiveDirectoryGraphApiVersion()

Gets the Active Directory api version.

Returns:

the Active Directory api version.

getActiveDirectoryResourceId

public String getActiveDirectoryResourceId()

Gets the resource ID to obtain AD tokens.

Returns:

The resource ID to obtain AD tokens.

getApplicationInsightsEndpoint

public String getApplicationInsightsEndpoint()

Gets the log analytics endpoint.

Returns:

the log analytics endpoint.

getAzureDataLakeAnalyticsCatalogAndJobEndpointSuffix

public String getAzureDataLakeAnalyticsCatalogAndJobEndpointSuffix()

Gets the data lake analytics job and catalog service dns suffix.

Returns:

the data lake analytics job and catalog service dns suffix.

getAzureDataLakeStoreFileSystemEndpointSuffix

public String getAzureDataLakeStoreFileSystemEndpointSuffix()

Gets the data lake store filesystem service dns suffix.

Returns:

the data lake store filesystem service dns suffix.

getDataLakeEndpointResourceId

public String getDataLakeEndpointResourceId()

Gets the Data Lake resource ID.

Returns:

the Data Lake resource ID.

getEndpoints

public Map getEndpoints()

Gets the entirety of the endpoints associated with the current environment.

Returns:

the entirety of the endpoints associated with the current environment.

getGalleryEndpoint

public String getGalleryEndpoint()

Gets the template gallery endpoint.

Returns:

the template gallery endpoint.

getGraphEndpoint

public String getGraphEndpoint()

Gets the Active Directory resource ID.

Returns:

the Active Directory resource ID.

getKeyVaultDnsSuffix

public String getKeyVaultDnsSuffix()

Gets the keyvault service dns suffix.

Returns:

the keyvault service dns suffix.

getLogAnalyticsEndpoint

public String getLogAnalyticsEndpoint()

Gets the log analytics endpoint.

Returns:

the log analytics endpoint.

getManagedHsmDnsSuffix

public String getManagedHsmDnsSuffix()

Gets the managed HSM DNS suffix.

Returns:

the managed HSM DNS suffix.

getManagementEndpoint

public String getManagementEndpoint()

Gets the management service endpoint.

Returns:

the management service endpoint.

getMicrosoftGraphEndpoint

public String getMicrosoftGraphEndpoint()

Gets the Microsoft Graph resource ID.

Returns:

the Microsoft Graph resource ID.

getPortal

public String getPortal()

Gets the management portal URL.

Returns:

the management portal URL.

getPublishingProfile

public String getPublishingProfile()

Gets the publishing settings file URL.

Returns:

the publishing settings file URL.

getResourceManagerEndpoint

public String getResourceManagerEndpoint()

Gets the resource management endpoint.

Returns:

the resource management endpoint.

getSqlManagementEndpoint

public String getSqlManagementEndpoint()

Gets the sql server management endpoint for mobile commands.

Returns:

the sql server management endpoint for mobile commands.

getSqlServerHostnameSuffix

public String getSqlServerHostnameSuffix()

Gets the dns suffix for sql servers.

Returns:

the dns suffix for sql servers.

getStorageEndpointSuffix

public String getStorageEndpointSuffix()

Gets the endpoint suffix for storage accounts.

Returns:

the endpoint suffix for storage accounts.

getUrlByEndpoint

public String getUrlByEndpoint(AzureEnvironment.Endpoint endpoint)

Gets the endpoint URL for the current environment.

Parameters:

endpoint - the endpoint.

Returns:

the URL for the endpoint, null if no match.

knownEnvironments

public static List knownEnvironments()

Gets the list of known environments to Azure SDK.

Returns:

the list of known environments to Azure SDK.