PSAzureEnvironment Class

Definition

Namespace:

Microsoft.Azure.Commands.Profile.Models

Assembly:

Microsoft.Azure.PowerShell.Authentication.ResourceManager.dll

Settings and endpoints for management of Azure or Azure Stack services.

public class PSAzureEnvironment : Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureEnvironment

type PSAzureEnvironment = class
    interface IAzureEnvironment
    interface IExtensibleModel

Public Class PSAzureEnvironment
Implements IAzureEnvironment

Inheritance

Object

PSAzureEnvironment

Implements

IAzureEnvironment IExtensibleModel

Constructors

PSAzureEnvironment()	Initializes a new azure environment.
PSAzureEnvironment(IAzureEnvironment)	Initializes a new Azure environment from the given internal representation.
PSAzureEnvironment(PSObject)	For conversion from serialized PSObjects

Properties

ActiveDirectoryAuthority	Gets or sets the Uri of the Active Directory authentication endpoint.
ActiveDirectoryServiceEndpointResourceId	Gets or sets the expected token audience for authenticating management requests.
AdTenant	Gets or sets the default tenant Id.
AnalysisServicesEndpointResourceId	Gets or sets the resource Id to use for contacting the analysis services endpoint
AzureAnalysisServicesEndpointSuffix	The domain name suffix for Azure Analysis Services
AzureAttestationServiceEndpointResourceId	Gets or sets the resource Id to use for contacting the attestation services endpoint
AzureAttestationServiceEndpointSuffix	The domain name suffix for Azure Attestation Services
AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix	Gets or sets the domain name suffix for Data Lake Analytics job and catalog services.
AzureDataLakeStoreFileSystemEndpointSuffix	Gets or sets the domain name suffix for Data Lake store filesystem services.
AzureKeyVaultDnsSuffix	Gets or sets the domain name suffix for key vault services.
AzureKeyVaultServiceEndpointResourceId	Gets or sets the expected token audience for authenticating requests to the key vault service.
AzureOperationalInsightsEndpoint	The endpoint to use when communicating with the Azure Log Analytics query service in this environment
AzureOperationalInsightsEndpointResourceId	The token audience required for communicating with the Azure Log Analytics query service in this environment
AzureSynapseAnalyticsEndpointResourceId	Gets or sets the resource Id to use for contacting the Synapse Analyticss endpoint
AzureSynapseAnalyticsEndpointSuffix	The domain name suffix for Azure Synapse Analyticss
BatchEndpointResourceId	Gets or sets the Azure Batch AD resource ID.
ContainerRegistryEndpointSuffix	The domain name suffix for Azure Container Registry
DataLakeEndpointResourceId	Gets or sets the resource Id to use for contacting the Data Lake services endpoint
EnableAdfsAuthentication	Gets or sets a value indicating whether ADFS authentication should be allowed . Generally, this is only used in Azure Stack environments.
ExtendedProperties
GalleryUrl	Gets or sets the Uri of the Template Gallery service.
GraphEndpointResourceId	Gets or sets the resource Id to use for contacting the Graph endpoint
GraphUrl	Gets or sets the Uri of the Active Directory metadata (Graph) endpoint.
ManagementPortalUrl	Gets or sets the Uri of the management portal.
Name	Gets or sets the name of the environment.
OnPremise
PublishSettingsFileUrl	Gets or sets the endpoint of the publish settings download service.
ResourceManagerUrl	Gets or sets the Uri of the Azure Resource Manager (ARM) service.
ServiceManagementUrl	Get or sets the Uri of the service management (RDFE) service.
SqlDatabaseDnsSuffix	Gets or sets the Dns suffix used for Sql database servers.
StorageEndpointSuffix	Gets or sets the dns suffix of storage services.
TrafficManagerDnsSuffix	Gets or sets the domain name suffix for traffig manager services.
Type	Type of environment
VersionProfiles

Methods

Equals(Object)	Determine equality of two PSAzureEnvironment instances.
GetHashCode()
ToString()

Operators

Implicit(AzureEnvironment to PSAzureEnvironment)	Convert the internal representation of Azure libraries to a representation that is more readable for PowerShell.
Implicit(PSAzureEnvironment to AzureEnvironment)	Convert the PowerShell representation of environment to the internal representation.

Extension Methods

CopyFrom(IAzureEnvironment, IAzureEnvironment)
GetEndpoint(IAzureEnvironment, String)
GetEndpointAsUri(IAzureEnvironment, String)
GetEndpointSuffix(IAzureEnvironment, String)
GetManagementPortalUrlWithRealm(IAzureEnvironment, String)
GetPublishSettingsFileUrlWithRealm(IAzureEnvironment, String)
GetTokenAudience(IAzureEnvironment, String)
IsEndpointSet(IAzureEnvironment, String)
IsEndpointSetToValue(IAzureEnvironment, String, String)
SetEndpoint(IAzureEnvironment, String, String)
TryGetEndpointString(IAzureEnvironment, String, String)
TryGetEndpointUrl(IAzureEnvironment, String, Uri)
Update(IAzureEnvironment, IAzureEnvironment)
CopyPropertiesFrom(IExtensibleModel, IExtensibleModel)
GetProperty(IExtensibleModel, String)
GetPropertyAsArray(IExtensibleModel, String)
IsPropertySet(IExtensibleModel, String)
SetOrAppendProperty(IExtensibleModel, String, String[])
SetProperty(IExtensibleModel, String, String[])
UpdateProperties(IExtensibleModel, IExtensibleModel)
DeepCopy(IAzureEnvironment)
Merge(IAzureEnvironment, IAzureEnvironment)
PopulateExtensions(IExtensibleModel, PSObject)	Populate the model extensions from a PSObject
GetStorageBlobEndpoint(IAzureEnvironment, String, Boolean)
GetStorageFileEndpoint(IAzureEnvironment, String, Boolean)
GetStorageQueueEndpoint(IAzureEnvironment, String, Boolean)
GetStorageTableEndpoint(IAzureEnvironment, String, Boolean)