< Back
Add-AzureRmEnvironment
Post
NAME Add-AzureRmEnvironment
SYNOPSIS
Adds endpoints and metadata for an instance of Azure Resource Manager.
SYNTAX
Add-AzureRmEnvironment [-Name] <String> [[-PublishSettingsFileUrl] <String>] [[-AzureKeyVaultDnsSuffix] <String>]
[[-AzureKeyVaultServiceEndpointResourceId] <String>] [[-TrafficManagerDnsSuffix] <String>] [[-SqlDatabaseDnsSuffix] <String>]
[[-AzureDataLakeStoreFileSystemEndpointSuffix] <String>] [[-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix] <String>]
[[-EnableAdfsAuthentication]] [[-AdTenant] <String>] [[-GraphAudience] <String>] [[-DataLakeAudience] <String>] [[-ServiceEndpoint] <String>]
[[-BatchEndpointResourceId] <String>] [[-AzureOperationalInsightsEndpointResourceId] <String>] [[-AzureOperationalInsightsEndpoint] <String>]
[[-ManagementPortalUrl] <String>] [[-StorageEndpoint] <String>] [[-ActiveDirectoryEndpoint] <String>] [[-ResourceManagerEndpoint] <String>]
[[-GalleryEndpoint] <String>] [[-ActiveDirectoryServiceEndpointResourceId] <String>] [[-GraphEndpoint] <String>] [-DefaultProfile
<IAzureContextContainer>] [-Scope {Process | CurrentUser}] [-Confirm] [-WhatIf] [<CommonParameters>]
Add-AzureRmEnvironment [-Name] <String> [-ARMEndpoint] <String> [[-AzureKeyVaultDnsSuffix] <String>] [[-AzureKeyVaultServiceEndpointResourceId]
<String>] [[-DataLakeAudience] <String>] [[-BatchEndpointResourceId] <String>] [[-AzureOperationalInsightsEndpointResourceId] <String>]
[[-AzureOperationalInsightsEndpoint] <String>] [[-StorageEndpoint] <String>] [-DefaultProfile <IAzureContextContainer>] [-Scope {Process |
CurrentUser}] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Add-AzureRmEnvironment cmdlet adds endpoints and metadata to enable Azure Resource Manager cmdlets to connect with a new instance of Azure
Resource Manager. The built-in environments AzureCloud and AzureChinaCloud target existing public instances of Azure Resource Manager.
PARAMETERS
-ActiveDirectoryEndpoint <String>
Specifies the base authority for Azure Active Directory authentication.
Required? false
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ActiveDirectoryServiceEndpointResourceId <String>
Specifies the audience for tokens that authenticate requests to Azure Resource Manager or Service Management (RDFE) endpoints.
Required? false
Position? 8
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AdTenant <String>
Specifies the default Active Directory tenant.
Required? false
Position? 17
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ARMEndpoint <String>
The Azure Resource Manager endpoint
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix <String>
Dns Suffix of Azure Data Lake Analytics job and catalog services
Required? false
Position? 15
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AzureDataLakeStoreFileSystemEndpointSuffix <String>
Dns Suffix of Azure Data Lake Store FileSystem. Example: azuredatalake.net
Required? false
Position? 14
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AzureKeyVaultDnsSuffix <String>
Specifies the domain name suffix for Key Vault services.
Required? false
Position? 10
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AzureKeyVaultServiceEndpointResourceId <String>
Specifies the audience for access tokens that authorize requests for Key Vault services.
Required? false
Position? 11
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DataLakeAudience <String>
The audience for tokens authenticating with the AD Data Lake services Endpoint.
Required? false
Position? 19
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credeetnails, tenant and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-EnableAdfsAuthentication [<SwitchParameter>]
Indicates that Active Directory Federation Services (ADFS) on-premise authentication is allowed.
Required? false
Position? 16
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-GalleryEndpoint <String>
Specifies the endpoint for the Azure Resource Manager gallery of deployment templates.
Required? false
Position? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-GraphAudience <String>
The audience for tokens authenticating with the AD Graph Endpoint.
Required? false
Position? 18
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-GraphEndpoint <String>
Specifies the URL for Graph (Active Directory metadata) requests.
Required? false
Position? 9
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ManagementPortalUrl <String>
Specifies the URL for the Management Portal.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the environment to add.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PublishSettingsFileUrl <String>
Specifies the URL from which .publishsettings files can be downloaded.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceManagerEndpoint <String>
Specifies the URL for Azure Resource Manager requests.
Required? false
Position? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Scope <ContextModificationScope>
Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this
user.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServiceEndpoint <String>
Specifies the endpoint for Service Management (RDFE) requests.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SqlDatabaseDnsSuffix <String>
Specifies the domain-name suffix for Azure SQL Database servers.
Required? false
Position? 13
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-StorageEndpoint <String>
Specifies the endpoint for storage (blob, table, queue, and file) access.
Required? false
Position? 4
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TrafficManagerDnsSuffix <String>
Specifies the domain-name suffix for Azure Traffic Manager services.
Required? false
Position? 12
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-BatchEndpointResourceId <String>
The resource identifier of the Azure Batch service that is the recipient of the requested token
Required? false
Position? 20
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AzureOperationalInsightsEndpoint <String>
Specifies the endpoint for the Operational Insights query access.
Required? false
Position? 22
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AzureOperationalInsightsEndpointResourceId <String>
Specifies the audience for access tokens that authorize requests for Operational Insights services.
Required? false
Position? 21
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
PSAzureEnvironment
This cmdlet returns the set of endpoints and metadata needed to communicate with an instance of Azure.
NOTES
Example 1: Creating and modifying a new environment
PS C:\\> Add-AzureRmEnvironment -Name TestEnvironment `
-ActiveDirectoryEndpoint TestADEndpoint `
-ActiveDirectoryServiceEndpointResourceId TestADApplicationId `
-ResourceManagerEndpoint TestRMEndpoint `
-GalleryEndpoint TestGalleryEndpoint `
-GraphEndpoint TestGraphEndpoint
Name : TestEnvironment
EnableAdfsAuthentication : False
ActiveDirectoryServiceEndpointResourceId : TestADApplicationId
AdTenant :
GalleryUrl : TestGalleryEndpoint
ManagementPortalUrl :
ServiceManagementUrl :
PublishSettingsFileUrl :
ResourceManagerUrl : TestRMEndpoint
SqlDatabaseDnsSuffix :
StorageEndpointSuffix :
ActiveDirectoryAuthority : TestADEndpoint
GraphUrl : TestGraphEndpoint
GraphEndpointResourceId :
TrafficManagerDnsSuffix :
AzureKeyVaultDnsSuffix :
AzureDataLakeStoreFileSystemEndpointSuffix :
AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix :
AzureKeyVaultServiceEndpointResourceId :
PS C:\\> Set-AzureRmEnvironment -Name TestEnvironment
-ActiveDirectoryEndpoint NewTestADEndpoint
-GraphEndpoint NewTestGraphEndpoint
Name : TestEnvironment
EnableAdfsAuthentication : False
ActiveDirectoryServiceEndpointResourceId : TestADApplicationId
AdTenant :
GalleryUrl : TestGalleryEndpoint
ManagementPortalUrl :
ServiceManagementUrl :
PublishSettingsFileUrl :
ResourceManagerUrl : TestRMEndpoint
SqlDatabaseDnsSuffix :
StorageEndpointSuffix :
ActiveDirectoryAuthority : NewTestADEndpoint
GraphUrl : NewTestGraphEndpoint
GraphEndpointResourceId :
TrafficManagerDnsSuffix :
AzureKeyVaultDnsSuffix :
AzureDataLakeStoreFileSystemEndpointSuffix :
AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix :
AzureKeyVaultServiceEndpointResourceId :
In this example we are creating a new Azure environment with sample endpoints using Add-AzureRmEnvironment, and then we are changing the value of
the ActiveDirectoryEndpoint and GraphEndpoint attributes of the created environment using the cmdlet Set-AzureRmEnvironment.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... nvironment
Get-AzureRmEnvironment
Remove-AzureRmEnvironment
Set-AzureRMEnvironment
SYNOPSIS
Adds endpoints and metadata for an instance of Azure Resource Manager.
SYNTAX
Add-AzureRmEnvironment [-Name] <String> [[-PublishSettingsFileUrl] <String>] [[-AzureKeyVaultDnsSuffix] <String>]
[[-AzureKeyVaultServiceEndpointResourceId] <String>] [[-TrafficManagerDnsSuffix] <String>] [[-SqlDatabaseDnsSuffix] <String>]
[[-AzureDataLakeStoreFileSystemEndpointSuffix] <String>] [[-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix] <String>]
[[-EnableAdfsAuthentication]] [[-AdTenant] <String>] [[-GraphAudience] <String>] [[-DataLakeAudience] <String>] [[-ServiceEndpoint] <String>]
[[-BatchEndpointResourceId] <String>] [[-AzureOperationalInsightsEndpointResourceId] <String>] [[-AzureOperationalInsightsEndpoint] <String>]
[[-ManagementPortalUrl] <String>] [[-StorageEndpoint] <String>] [[-ActiveDirectoryEndpoint] <String>] [[-ResourceManagerEndpoint] <String>]
[[-GalleryEndpoint] <String>] [[-ActiveDirectoryServiceEndpointResourceId] <String>] [[-GraphEndpoint] <String>] [-DefaultProfile
<IAzureContextContainer>] [-Scope {Process | CurrentUser}] [-Confirm] [-WhatIf] [<CommonParameters>]
Add-AzureRmEnvironment [-Name] <String> [-ARMEndpoint] <String> [[-AzureKeyVaultDnsSuffix] <String>] [[-AzureKeyVaultServiceEndpointResourceId]
<String>] [[-DataLakeAudience] <String>] [[-BatchEndpointResourceId] <String>] [[-AzureOperationalInsightsEndpointResourceId] <String>]
[[-AzureOperationalInsightsEndpoint] <String>] [[-StorageEndpoint] <String>] [-DefaultProfile <IAzureContextContainer>] [-Scope {Process |
CurrentUser}] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Add-AzureRmEnvironment cmdlet adds endpoints and metadata to enable Azure Resource Manager cmdlets to connect with a new instance of Azure
Resource Manager. The built-in environments AzureCloud and AzureChinaCloud target existing public instances of Azure Resource Manager.
PARAMETERS
-ActiveDirectoryEndpoint <String>
Specifies the base authority for Azure Active Directory authentication.
Required? false
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ActiveDirectoryServiceEndpointResourceId <String>
Specifies the audience for tokens that authenticate requests to Azure Resource Manager or Service Management (RDFE) endpoints.
Required? false
Position? 8
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AdTenant <String>
Specifies the default Active Directory tenant.
Required? false
Position? 17
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ARMEndpoint <String>
The Azure Resource Manager endpoint
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix <String>
Dns Suffix of Azure Data Lake Analytics job and catalog services
Required? false
Position? 15
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AzureDataLakeStoreFileSystemEndpointSuffix <String>
Dns Suffix of Azure Data Lake Store FileSystem. Example: azuredatalake.net
Required? false
Position? 14
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AzureKeyVaultDnsSuffix <String>
Specifies the domain name suffix for Key Vault services.
Required? false
Position? 10
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AzureKeyVaultServiceEndpointResourceId <String>
Specifies the audience for access tokens that authorize requests for Key Vault services.
Required? false
Position? 11
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DataLakeAudience <String>
The audience for tokens authenticating with the AD Data Lake services Endpoint.
Required? false
Position? 19
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credeetnails, tenant and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-EnableAdfsAuthentication [<SwitchParameter>]
Indicates that Active Directory Federation Services (ADFS) on-premise authentication is allowed.
Required? false
Position? 16
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-GalleryEndpoint <String>
Specifies the endpoint for the Azure Resource Manager gallery of deployment templates.
Required? false
Position? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-GraphAudience <String>
The audience for tokens authenticating with the AD Graph Endpoint.
Required? false
Position? 18
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-GraphEndpoint <String>
Specifies the URL for Graph (Active Directory metadata) requests.
Required? false
Position? 9
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ManagementPortalUrl <String>
Specifies the URL for the Management Portal.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the environment to add.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PublishSettingsFileUrl <String>
Specifies the URL from which .publishsettings files can be downloaded.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceManagerEndpoint <String>
Specifies the URL for Azure Resource Manager requests.
Required? false
Position? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Scope <ContextModificationScope>
Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this
user.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServiceEndpoint <String>
Specifies the endpoint for Service Management (RDFE) requests.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SqlDatabaseDnsSuffix <String>
Specifies the domain-name suffix for Azure SQL Database servers.
Required? false
Position? 13
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-StorageEndpoint <String>
Specifies the endpoint for storage (blob, table, queue, and file) access.
Required? false
Position? 4
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TrafficManagerDnsSuffix <String>
Specifies the domain-name suffix for Azure Traffic Manager services.
Required? false
Position? 12
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-BatchEndpointResourceId <String>
The resource identifier of the Azure Batch service that is the recipient of the requested token
Required? false
Position? 20
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AzureOperationalInsightsEndpoint <String>
Specifies the endpoint for the Operational Insights query access.
Required? false
Position? 22
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AzureOperationalInsightsEndpointResourceId <String>
Specifies the audience for access tokens that authorize requests for Operational Insights services.
Required? false
Position? 21
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
PSAzureEnvironment
This cmdlet returns the set of endpoints and metadata needed to communicate with an instance of Azure.
NOTES
Example 1: Creating and modifying a new environment
PS C:\\> Add-AzureRmEnvironment -Name TestEnvironment `
-ActiveDirectoryEndpoint TestADEndpoint `
-ActiveDirectoryServiceEndpointResourceId TestADApplicationId `
-ResourceManagerEndpoint TestRMEndpoint `
-GalleryEndpoint TestGalleryEndpoint `
-GraphEndpoint TestGraphEndpoint
Name : TestEnvironment
EnableAdfsAuthentication : False
ActiveDirectoryServiceEndpointResourceId : TestADApplicationId
AdTenant :
GalleryUrl : TestGalleryEndpoint
ManagementPortalUrl :
ServiceManagementUrl :
PublishSettingsFileUrl :
ResourceManagerUrl : TestRMEndpoint
SqlDatabaseDnsSuffix :
StorageEndpointSuffix :
ActiveDirectoryAuthority : TestADEndpoint
GraphUrl : TestGraphEndpoint
GraphEndpointResourceId :
TrafficManagerDnsSuffix :
AzureKeyVaultDnsSuffix :
AzureDataLakeStoreFileSystemEndpointSuffix :
AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix :
AzureKeyVaultServiceEndpointResourceId :
PS C:\\> Set-AzureRmEnvironment -Name TestEnvironment
-ActiveDirectoryEndpoint NewTestADEndpoint
-GraphEndpoint NewTestGraphEndpoint
Name : TestEnvironment
EnableAdfsAuthentication : False
ActiveDirectoryServiceEndpointResourceId : TestADApplicationId
AdTenant :
GalleryUrl : TestGalleryEndpoint
ManagementPortalUrl :
ServiceManagementUrl :
PublishSettingsFileUrl :
ResourceManagerUrl : TestRMEndpoint
SqlDatabaseDnsSuffix :
StorageEndpointSuffix :
ActiveDirectoryAuthority : NewTestADEndpoint
GraphUrl : NewTestGraphEndpoint
GraphEndpointResourceId :
TrafficManagerDnsSuffix :
AzureKeyVaultDnsSuffix :
AzureDataLakeStoreFileSystemEndpointSuffix :
AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix :
AzureKeyVaultServiceEndpointResourceId :
In this example we are creating a new Azure environment with sample endpoints using Add-AzureRmEnvironment, and then we are changing the value of
the ActiveDirectoryEndpoint and GraphEndpoint attributes of the created environment using the cmdlet Set-AzureRmEnvironment.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... nvironment
Get-AzureRmEnvironment
Remove-AzureRmEnvironment
Set-AzureRMEnvironment