Package com.azure.spring.cloud.core.properties.profile

Class AzureEnvironmentProperties

java.lang.Object

com.azure.spring.cloud.core.properties.profile.AzureEnvironmentProperties

All Implemented Interfaces:

AzureProfileOptionsProvider.AzureEnvironmentOptions

public class AzureEnvironmentProperties
extends Object
implements AzureProfileOptionsProvider.AzureEnvironmentOptions

The AzureEnvironment defines all properties to Azure services, such as endpoints, resource ids, etc.

Field Summary

Fields

Modifier and Type	Field	Description
static final AzureEnvironmentProperties	AZURE	Provides the environment instance for the public Azure.
static final AzureEnvironmentProperties	AZURE_CHINA	Provides the environment instance for Azure China.
static final AzureEnvironmentProperties	AZURE_GERMANY	Deprecated. AZURE_GERMANY is deprecated.
static final AzureEnvironmentProperties	AZURE_US_GOVERNMENT	Provides the environment instance for Azure US Government.

Constructor Summary

Constructors

Constructor	Description
AzureEnvironmentProperties()	Create an AzureEnvironmentProperties instance with default value.

Method Summary

Modifier and Type	Method	Description
AzureEnvironmentProperties	fromAzureManagementEnvironment(com.azure.core.management.AzureEnvironment environment)	Get the AzureEnvironment from AzureEnvironment.
String	getActiveDirectoryEndpoint()
String	getActiveDirectoryGraphApiVersion()
String	getActiveDirectoryGraphEndpoint()
String	getActiveDirectoryResourceId()
String	getAzureApplicationInsightsEndpoint()
String	getAzureDataLakeAnalyticsCatalogAndJobEndpointSuffix()
String	getAzureDataLakeStoreFileSystemEndpointSuffix()
String	getAzureLogAnalyticsEndpoint()
String	getDataLakeEndpointResourceId()
String	getGalleryEndpoint()
String	getKeyVaultDnsSuffix()
String	getManagementEndpoint()
String	getMicrosoftGraphEndpoint()
String	getPortal()
String	getPublishingProfile()
String	getResourceManagerEndpoint()
String	getServiceBusDomainName()
String	getSqlManagementEndpoint()
String	getSqlServerHostnameSuffix()
String	getStorageEndpointSuffix()	The endpoint suffix for storage accounts.
void	setActiveDirectoryEndpoint(String activeDirectoryEndpoint)	Set the Active Directory login endpoint.
void	setActiveDirectoryGraphApiVersion(String activeDirectoryGraphApiVersion)	Set the Active Directory api version.
void	setActiveDirectoryGraphEndpoint(String activeDirectoryGraphEndpoint)	Set the Active Directory Graph endpoint.
void	setActiveDirectoryResourceId(String activeDirectoryResourceId)	Set the resource ID to obtain AD tokens for.
void	setAzureApplicationInsightsEndpoint(String azureApplicationInsightsEndpoint)	Set the application insights endpoint.
void	setAzureDataLakeAnalyticsCatalogAndJobEndpointSuffix(String azureDataLakeAnalyticsCatalogAndJobEndpointSuffix)	Set the data lake analytics job and catalog service dns suffix.
void	setAzureDataLakeStoreFileSystemEndpointSuffix(String azureDataLakeStoreFileSystemEndpointSuffix)	Set the data lake store filesystem service dns suffix.
void	setAzureLogAnalyticsEndpoint(String azureLogAnalyticsEndpoint)	Set the log analytics endpoint.
void	setDataLakeEndpointResourceId(String dataLakeEndpointResourceId)	Set the Data Lake resource ID.
void	setGalleryEndpoint(String galleryEndpoint)	Set the template gallery endpoint.
void	setKeyVaultDnsSuffix(String keyVaultDnsSuffix)	Set the key vault service dns suffix.
void	setManagementEndpoint(String managementEndpoint)	Set the management service endpoint.
void	setMicrosoftGraphEndpoint(String microsoftGraphEndpoint)	Set the Microsoft Graph endpoint.
void	setPortal(String portal)	Set the management portal URL.
void	setPublishingProfile(String publishingProfile)	Set the publishing settings file URL.
void	setResourceManagerEndpoint(String resourceManagerEndpoint)	Set the resource management endpoint.
void	setServiceBusDomainName(String serviceBusDomainName)	Set the domain name of Service Bus.
void	setSqlManagementEndpoint(String sqlManagementEndpoint)	Set the sql server management endpoint for mobile commands.
void	setSqlServerHostnameSuffix(String sqlServerHostnameSuffix)	Set the dns suffix for sql servers.
void	setStorageEndpointSuffix(String storageEndpointSuffix)	Set the endpoint suffix for storage accounts.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.spring.cloud.core.provider.AzureProfileOptionsProvider.AzureEnvironmentOptions

toAzureManagementEnvironment

Field Details

AZURE

public static final AzureEnvironmentProperties AZURE

Provides the environment instance for the public Azure.

AZURE_CHINA

public static final AzureEnvironmentProperties AZURE_CHINA

Provides the environment instance for Azure China.

AZURE_GERMANY

@Deprecated
public static final AzureEnvironmentProperties AZURE_GERMANY

Deprecated.

AZURE_GERMANY is deprecated. Please use other environment instances.

Provides the environment instance for Azure Germany.

AZURE_US_GOVERNMENT

public static final AzureEnvironmentProperties AZURE_US_GOVERNMENT

Provides the environment instance for Azure US Government.

Constructor Details

AzureEnvironmentProperties

public AzureEnvironmentProperties()

Create an AzureEnvironmentProperties instance with default value.

Method Details

fromAzureManagementEnvironment

public AzureEnvironmentProperties fromAzureManagementEnvironment(com.azure.core.management.AzureEnvironment environment)

Description copied from interface: AzureProfileOptionsProvider.AzureEnvironmentOptions

Get the AzureEnvironment from AzureEnvironment.

Specified by:

fromAzureManagementEnvironment in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Parameters:

environment - the azure core AzureEnvironment.

Returns:

the AzureEnvironment implementation.

getPortal

public String getPortal()

Specified by:

getPortal in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

The management portal URL.

setPortal

public void setPortal(String portal)

Set the management portal URL.

Parameters:

portal - The management portal URL.

getPublishingProfile

public String getPublishingProfile()

Specified by:

getPublishingProfile in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the publishing settings file URL.

setPublishingProfile

public void setPublishingProfile(String publishingProfile)

Set the publishing settings file URL.

Parameters:

publishingProfile - the publishing settings file URL.

getManagementEndpoint

public String getManagementEndpoint()

Specified by:

getManagementEndpoint in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the management service endpoint.

setManagementEndpoint

public void setManagementEndpoint(String managementEndpoint)

Set the management service endpoint.

Parameters:

managementEndpoint - the management service endpoint.

getResourceManagerEndpoint

public String getResourceManagerEndpoint()

Specified by:

getResourceManagerEndpoint in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the resource management endpoint.

setResourceManagerEndpoint

public void setResourceManagerEndpoint(String resourceManagerEndpoint)

Set the resource management endpoint.

Parameters:

resourceManagerEndpoint - the resource management endpoint.

getSqlManagementEndpoint

public String getSqlManagementEndpoint()

Specified by:

getSqlManagementEndpoint in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the sql server management endpoint for mobile commands.

setSqlManagementEndpoint

public void setSqlManagementEndpoint(String sqlManagementEndpoint)

Set the sql server management endpoint for mobile commands.

Parameters:

sqlManagementEndpoint - the sql server management endpoint for mobile commands.

getSqlServerHostnameSuffix

public String getSqlServerHostnameSuffix()

Specified by:

getSqlServerHostnameSuffix in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the dns suffix for sql servers.

setSqlServerHostnameSuffix

public void setSqlServerHostnameSuffix(String sqlServerHostnameSuffix)

Set the dns suffix for sql servers.

Parameters:

sqlServerHostnameSuffix - the dns suffix for sql servers.

getGalleryEndpoint

public String getGalleryEndpoint()

Specified by:

getGalleryEndpoint in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the template gallery endpoint.

setGalleryEndpoint

public void setGalleryEndpoint(String galleryEndpoint)

Set the template gallery endpoint.

Parameters:

galleryEndpoint - the template gallery endpoint.

getActiveDirectoryEndpoint

public String getActiveDirectoryEndpoint()

Specified by:

getActiveDirectoryEndpoint in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the Active Directory login endpoint.

setActiveDirectoryEndpoint

public void setActiveDirectoryEndpoint(String activeDirectoryEndpoint)

Set the Active Directory login endpoint.

Parameters:

activeDirectoryEndpoint - the Active Directory login endpoint.

getActiveDirectoryResourceId

public String getActiveDirectoryResourceId()

Specified by:

getActiveDirectoryResourceId in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

The resource ID to obtain AD tokens for.

setActiveDirectoryResourceId

public void setActiveDirectoryResourceId(String activeDirectoryResourceId)

Set the resource ID to obtain AD tokens for.

Parameters:

activeDirectoryResourceId - The resource ID to obtain AD tokens for.

getActiveDirectoryGraphEndpoint

public String getActiveDirectoryGraphEndpoint()

Specified by:

getActiveDirectoryGraphEndpoint in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the Active Directory Graph endpoint.

setActiveDirectoryGraphEndpoint

public void setActiveDirectoryGraphEndpoint(String activeDirectoryGraphEndpoint)

Set the Active Directory Graph endpoint.

Parameters:

activeDirectoryGraphEndpoint - the Active Directory Graph endpoint.

getMicrosoftGraphEndpoint

public String getMicrosoftGraphEndpoint()

Specified by:

getMicrosoftGraphEndpoint in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the Microsoft Graph endpoint.

setMicrosoftGraphEndpoint

public void setMicrosoftGraphEndpoint(String microsoftGraphEndpoint)

Set the Microsoft Graph endpoint.

Parameters:

microsoftGraphEndpoint - the Microsoft Graph endpoint.

getDataLakeEndpointResourceId

public String getDataLakeEndpointResourceId()

Specified by:

getDataLakeEndpointResourceId in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the Data Lake resource ID.

setDataLakeEndpointResourceId

public void setDataLakeEndpointResourceId(String dataLakeEndpointResourceId)

Set the Data Lake resource ID.

Parameters:

dataLakeEndpointResourceId - the Data Lake resource ID.

getActiveDirectoryGraphApiVersion

public String getActiveDirectoryGraphApiVersion()

Specified by:

getActiveDirectoryGraphApiVersion in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the Active Directory api version.

setActiveDirectoryGraphApiVersion

public void setActiveDirectoryGraphApiVersion(String activeDirectoryGraphApiVersion)

Set the Active Directory api version.

Parameters:

activeDirectoryGraphApiVersion - the Active Directory api version.

getStorageEndpointSuffix

public String getStorageEndpointSuffix()

Description copied from interface: AzureProfileOptionsProvider.AzureEnvironmentOptions

The endpoint suffix for storage accounts.

Specified by:

getStorageEndpointSuffix in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the endpoint suffix for storage accounts.

setStorageEndpointSuffix

public void setStorageEndpointSuffix(String storageEndpointSuffix)

Set the endpoint suffix for storage accounts.

Parameters:

storageEndpointSuffix - the endpoint suffix for storage accounts.

getKeyVaultDnsSuffix

public String getKeyVaultDnsSuffix()

Specified by:

getKeyVaultDnsSuffix in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the key vault service dns suffix.

setKeyVaultDnsSuffix

public void setKeyVaultDnsSuffix(String keyVaultDnsSuffix)

Set the key vault service dns suffix.

Parameters:

keyVaultDnsSuffix - the key vault service dns suffix.

getAzureDataLakeStoreFileSystemEndpointSuffix

public String getAzureDataLakeStoreFileSystemEndpointSuffix()

Specified by:

getAzureDataLakeStoreFileSystemEndpointSuffix in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the data lake store filesystem service dns suffix.

setAzureDataLakeStoreFileSystemEndpointSuffix

public void setAzureDataLakeStoreFileSystemEndpointSuffix(String azureDataLakeStoreFileSystemEndpointSuffix)

Set the data lake store filesystem service dns suffix.

Parameters:

azureDataLakeStoreFileSystemEndpointSuffix - the data lake store filesystem service dns suffix.

getAzureDataLakeAnalyticsCatalogAndJobEndpointSuffix

public String getAzureDataLakeAnalyticsCatalogAndJobEndpointSuffix()

Specified by:

getAzureDataLakeAnalyticsCatalogAndJobEndpointSuffix in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the data lake analytics job and catalog service dns suffix.

setAzureDataLakeAnalyticsCatalogAndJobEndpointSuffix

public void setAzureDataLakeAnalyticsCatalogAndJobEndpointSuffix(String azureDataLakeAnalyticsCatalogAndJobEndpointSuffix)

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

Parameters:

azureDataLakeAnalyticsCatalogAndJobEndpointSuffix - the data lake analytics job and catalog service dns suffix.

getAzureLogAnalyticsEndpoint

public String getAzureLogAnalyticsEndpoint()

Specified by:

getAzureLogAnalyticsEndpoint in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the log analytics endpoint.

setAzureLogAnalyticsEndpoint

public void setAzureLogAnalyticsEndpoint(String azureLogAnalyticsEndpoint)

Set the log analytics endpoint.

Parameters:

azureLogAnalyticsEndpoint - the log analytics endpoint.

getAzureApplicationInsightsEndpoint

public String getAzureApplicationInsightsEndpoint()

Specified by:

getAzureApplicationInsightsEndpoint in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the application insights endpoint.

setAzureApplicationInsightsEndpoint

public void setAzureApplicationInsightsEndpoint(String azureApplicationInsightsEndpoint)

Set the application insights endpoint.

Parameters:

azureApplicationInsightsEndpoint - the application insights endpoint.

getServiceBusDomainName

public String getServiceBusDomainName()

Specified by:

getServiceBusDomainName in interface AzureProfileOptionsProvider.AzureEnvironmentOptions

Returns:

the domain name of Service Bus.

setServiceBusDomainName

public void setServiceBusDomainName(String serviceBusDomainName)

Set the domain name of Service Bus.

Parameters:

serviceBusDomainName - the Service Bus domain name.