Share via

Environment class

  • Reference
Package:
@azure/ms-rest-azure-env

Constructors

Environment(EnvironmentParameters)

Properties

activeDirectoryEndpointUrl

The Active Directory login endpoint.
activeDirectoryGraphApiVersion

The Active Directory api version.
activeDirectoryGraphResourceId

The Active Directory resource ID.
activeDirectoryResourceId

The resource ID to obtain AD tokens for (token audience).
AzureCloud
azureDataLakeAnalyticsCatalogAndJobEndpointSuffix

The data lake analytics job and catalog service dns suffix.
azureDataLakeStoreFileSystemEndpointSuffix

The data lake store filesystem service dns suffix.
batchResourceId

The batch resource ID.
ChinaCloud
galleryEndpointUrl

The template gallery endpoint.
GermanCloud
keyVaultDnsSuffix

The keyvault service dns suffix.
managementEndpointUrl

The management service endpoint.
name

The Environment name.
portalUrl

The management portal URL.
publishingProfileUrl

The publish settings file URL.
resourceManagerEndpointUrl

The resource management endpoint.
sqlManagementEndpointUrl

The sql server management endpoint for mobile commands.
sqlServerHostnameSuffix

The dns suffix for sql servers.
storageEndpointSuffix

The endpoint suffix for storage accounts.
USGovernment
validateAuthority

Determines whether the authentication endpoint should be validated with Azure AD. Default value is true.

Methods

add(EnvironmentParameters)
get(string)

Constructor Details

Environment(EnvironmentParameters) 

new Environment(parameters: EnvironmentParameters)

Parameters

parameters
EnvironmentParameters

Property Details

activeDirectoryEndpointUrl

The Active Directory login endpoint.

activeDirectoryEndpointUrl: string

Property Value

string

activeDirectoryGraphApiVersion

The Active Directory api version.

activeDirectoryGraphApiVersion?: string

Property Value

string

activeDirectoryGraphResourceId

The Active Directory resource ID.

activeDirectoryGraphResourceId?: string

Property Value

string

activeDirectoryResourceId

The resource ID to obtain AD tokens for (token audience).

activeDirectoryResourceId: string

Property Value

string

AzureCloud 

static AzureCloud: { activeDirectoryEndpointUrl: string, activeDirectoryGraphApiVersion: string, activeDirectoryGraphResourceId: string, activeDirectoryResourceId: string, azureDataLakeAnalyticsCatalogAndJobEndpointSuffix: string, azureDataLakeStoreFileSystemEndpointSuffix: string, batchResourceId: string, galleryEndpointUrl: string, keyVaultDnsSuffix: string, managementEndpointUrl: string, name: string, portalUrl: string, publishingProfileUrl: string, resourceManagerEndpointUrl: string, sqlManagementEndpointUrl: string, sqlServerHostnameSuffix: string, storageEndpointSuffix: string, validateAuthority: boolean }

Property Value

{ activeDirectoryEndpointUrl: string, activeDirectoryGraphApiVersion: string, activeDirectoryGraphResourceId: string, activeDirectoryResourceId: string, azureDataLakeAnalyticsCatalogAndJobEndpointSuffix: string, azureDataLakeStoreFileSystemEndpointSuffix: string, batchResourceId: string, galleryEndpointUrl: string, keyVaultDnsSuffix: string, managementEndpointUrl: string, name: string, portalUrl: string, publishingProfileUrl: string, resourceManagerEndpointUrl: string, sqlManagementEndpointUrl: string, sqlServerHostnameSuffix: string, storageEndpointSuffix: string, validateAuthority: boolean }

azureDataLakeAnalyticsCatalogAndJobEndpointSuffix

The data lake analytics job and catalog service dns suffix.

azureDataLakeAnalyticsCatalogAndJobEndpointSuffix?: string

Property Value

string

azureDataLakeStoreFileSystemEndpointSuffix

The data lake store filesystem service dns suffix.

azureDataLakeStoreFileSystemEndpointSuffix?: string

Property Value

string

batchResourceId

The batch resource ID.

batchResourceId?: string

Property Value

string

ChinaCloud 

static ChinaCloud: { activeDirectoryEndpointUrl: string, activeDirectoryGraphApiVersion: string, activeDirectoryGraphResourceId: string, activeDirectoryResourceId: string, azureDataLakeAnalyticsCatalogAndJobEndpointSuffix: string, azureDataLakeStoreFileSystemEndpointSuffix: string, batchResourceId: string, galleryEndpointUrl: string, keyVaultDnsSuffix: string, managementEndpointUrl: string, name: string, portalUrl: string, publishingProfileUrl: string, resourceManagerEndpointUrl: string, sqlManagementEndpointUrl: string, sqlServerHostnameSuffix: string, storageEndpointSuffix: string, validateAuthority: boolean }

Property Value

{ activeDirectoryEndpointUrl: string, activeDirectoryGraphApiVersion: string, activeDirectoryGraphResourceId: string, activeDirectoryResourceId: string, azureDataLakeAnalyticsCatalogAndJobEndpointSuffix: string, azureDataLakeStoreFileSystemEndpointSuffix: string, batchResourceId: string, galleryEndpointUrl: string, keyVaultDnsSuffix: string, managementEndpointUrl: string, name: string, portalUrl: string, publishingProfileUrl: string, resourceManagerEndpointUrl: string, sqlManagementEndpointUrl: string, sqlServerHostnameSuffix: string, storageEndpointSuffix: string, validateAuthority: boolean }

galleryEndpointUrl

The template gallery endpoint.

galleryEndpointUrl?: string

Property Value

string

GermanCloud 

static GermanCloud: { activeDirectoryEndpointUrl: string, activeDirectoryGraphApiVersion: string, activeDirectoryGraphResourceId: string, activeDirectoryResourceId: string, azureDataLakeAnalyticsCatalogAndJobEndpointSuffix: string, azureDataLakeStoreFileSystemEndpointSuffix: string, batchResourceId: string, galleryEndpointUrl: string, keyVaultDnsSuffix: string, managementEndpointUrl: string, name: string, portalUrl: string, publishingProfileUrl: string, resourceManagerEndpointUrl: string, sqlManagementEndpointUrl: string, sqlServerHostnameSuffix: string, storageEndpointSuffix: string, validateAuthority: boolean }

Property Value

{ activeDirectoryEndpointUrl: string, activeDirectoryGraphApiVersion: string, activeDirectoryGraphResourceId: string, activeDirectoryResourceId: string, azureDataLakeAnalyticsCatalogAndJobEndpointSuffix: string, azureDataLakeStoreFileSystemEndpointSuffix: string, batchResourceId: string, galleryEndpointUrl: string, keyVaultDnsSuffix: string, managementEndpointUrl: string, name: string, portalUrl: string, publishingProfileUrl: string, resourceManagerEndpointUrl: string, sqlManagementEndpointUrl: string, sqlServerHostnameSuffix: string, storageEndpointSuffix: string, validateAuthority: boolean }

keyVaultDnsSuffix

The keyvault service dns suffix.

keyVaultDnsSuffix?: string

Property Value

string

managementEndpointUrl

The management service endpoint.

managementEndpointUrl: string

Property Value

string

name

The Environment name.

name: string

Property Value

string

portalUrl

The management portal URL.

portalUrl: string

Property Value

string

publishingProfileUrl

The publish settings file URL.

publishingProfileUrl?: string

Property Value

string

resourceManagerEndpointUrl

The resource management endpoint.

resourceManagerEndpointUrl: string

Property Value

string

sqlManagementEndpointUrl

The sql server management endpoint for mobile commands.

sqlManagementEndpointUrl?: string

Property Value

string

sqlServerHostnameSuffix

The dns suffix for sql servers.

sqlServerHostnameSuffix?: string

Property Value

string

storageEndpointSuffix

The endpoint suffix for storage accounts.

storageEndpointSuffix?: string

Property Value

string

USGovernment 

static USGovernment: { activeDirectoryEndpointUrl: string, activeDirectoryGraphApiVersion: string, activeDirectoryGraphResourceId: string, activeDirectoryResourceId: string, azureDataLakeAnalyticsCatalogAndJobEndpointSuffix: string, azureDataLakeStoreFileSystemEndpointSuffix: string, batchResourceId: string, galleryEndpointUrl: string, keyVaultDnsSuffix: string, managementEndpointUrl: string, name: string, portalUrl: string, publishingProfileUrl: string, resourceManagerEndpointUrl: string, sqlManagementEndpointUrl: string, sqlServerHostnameSuffix: string, storageEndpointSuffix: string, validateAuthority: boolean }

Property Value

{ activeDirectoryEndpointUrl: string, activeDirectoryGraphApiVersion: string, activeDirectoryGraphResourceId: string, activeDirectoryResourceId: string, azureDataLakeAnalyticsCatalogAndJobEndpointSuffix: string, azureDataLakeStoreFileSystemEndpointSuffix: string, batchResourceId: string, galleryEndpointUrl: string, keyVaultDnsSuffix: string, managementEndpointUrl: string, name: string, portalUrl: string, publishingProfileUrl: string, resourceManagerEndpointUrl: string, sqlManagementEndpointUrl: string, sqlServerHostnameSuffix: string, storageEndpointSuffix: string, validateAuthority: boolean }

validateAuthority

Determines whether the authentication endpoint should be validated with Azure AD. Default value is true.

validateAuthority: boolean

Property Value

boolean

Method Details

add(EnvironmentParameters) 

static function add(parameters: EnvironmentParameters)

Parameters

parameters
EnvironmentParameters

get(string) 

static function get(name: string): Environment

Parameters

name

string

Returns

Environment