< Back
Set-AzureEnvironment
Post
NAME Set-AzureEnvironment
SYNOPSIS
Changes the properties of an Azure environment
SYNTAX
Set-AzureEnvironment [-Name] <String> [[-PublishSettingsFileUrl] <String>] [[-ServiceEndpoint] <String>] [[-ManagementPortalUrl] <String>]
[[-StorageEndpoint] <String>] [[-ActiveDirectoryEndpoint] <String>] [[-ResourceManagerEndpoint] <String>] [[-GalleryEndpoint] <String>]
[<CommonParameters>]
DESCRIPTION
The Set-AzureEnvironment cmdlet changes the properties of an Azure environment. It returns an object that represents the environment with its new
property values. Use the Name parameter to identify the environment and the other parameters to change property values. You cannot use
Set-AzureEnvironment to change the name of an Azure environment.
An Azure environment an independent deployment of Microsoft Azure, such as AzureCloud for global Azure and AzureChinaCloud for Azure operated by
21Vianet in China. You can also create on-premises Azure environments by using Azure Pack and the WAPack cmdlets. For more information, see Azure Pack
(http://www.microsoft.com/en-us/server-c ... fault.aspx).
NOTE: Do not change the properties of the AzureCloud or AzureChinaCloud environments. Use this cmdlet to change the values of private environments that
you create.
PARAMETERS
-ActiveDirectoryEndpoint <String>
Changes the endpoint for Azure Active Directory authentication to the specified value.
Required? false
Position? 6
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-GalleryEndpoint <String>
Changes the endpoint for the Azure Resource Manager gallery to the specified value. The gallery endpoint is the location for resource group gallery
templates.
Required? false
Position? 8
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ManagementPortalUrl <String>
Changes the URL of the Azure Management Portal to the specified value.
Required? false
Position? 4
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Identifies the environment that is being changed. This parameter is required. The parameter value is case-sensitive. Wildcard characters are not
permitted.
Required? true
Position? 1
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PublishSettingsFileUrl <String>
Changes the URL for publish settings files in the specified environment. An Azure publish settings file is an XML file that contains information
about your account and a management certificate that allows Windows PowerShell to sign into your Azure account on your behalf.
Required? false
Position? 2
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceManagerEndpoint <String>
Changes the endpoint for Azure Resource Manager data, including data about resource groups associated with the account. For more information about
Azure Resource Manager, see Azure Resource Manager Cmdlets (http://go.microsoft.com/fwlink/?LinkID=394765) and Using Windows PowerShell with
Resource Manager (http://go.microsoft.com/fwlink/?LinkID=394767).
Required? false
Position? 7
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServiceEndpoint <String>
Changes the URL of the Azure service endpoint in the specified environment. The Azure service endpoint determines whether your application is
managed by the global Azure platform, Azure operated by 21Vianet in China, or a private Azure installation.
Required? false
Position? 3
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-StorageEndpoint <String>
Changes the default endpoint of storage services in the specified environment.
Required? false
Position? 5
Default value
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
You can pipe input to this cmdlet by property name, but not by value.
OUTPUTS
Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment
NOTES
Keywords: azure, azuresm, servicemanagement, management, service, utilities
Example 1: Change environment properties
PS C:\\>Set-AzureEnvironment -Name ContosoEnv -PublishSettingsFileUrl "https://contoso.com" -StorageEndpoint "contoso.com"
This command changes the values of the PublishSettingsFileUrl and StorageEndpoint properties of the ContosoEnv environment.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkID=397629
Add-AzureEnvironment
Get-AzureEnvironment
Remove-AzureEnvironment
SYNOPSIS
Changes the properties of an Azure environment
SYNTAX
Set-AzureEnvironment [-Name] <String> [[-PublishSettingsFileUrl] <String>] [[-ServiceEndpoint] <String>] [[-ManagementPortalUrl] <String>]
[[-StorageEndpoint] <String>] [[-ActiveDirectoryEndpoint] <String>] [[-ResourceManagerEndpoint] <String>] [[-GalleryEndpoint] <String>]
[<CommonParameters>]
DESCRIPTION
The Set-AzureEnvironment cmdlet changes the properties of an Azure environment. It returns an object that represents the environment with its new
property values. Use the Name parameter to identify the environment and the other parameters to change property values. You cannot use
Set-AzureEnvironment to change the name of an Azure environment.
An Azure environment an independent deployment of Microsoft Azure, such as AzureCloud for global Azure and AzureChinaCloud for Azure operated by
21Vianet in China. You can also create on-premises Azure environments by using Azure Pack and the WAPack cmdlets. For more information, see Azure Pack
(http://www.microsoft.com/en-us/server-c ... fault.aspx).
NOTE: Do not change the properties of the AzureCloud or AzureChinaCloud environments. Use this cmdlet to change the values of private environments that
you create.
PARAMETERS
-ActiveDirectoryEndpoint <String>
Changes the endpoint for Azure Active Directory authentication to the specified value.
Required? false
Position? 6
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-GalleryEndpoint <String>
Changes the endpoint for the Azure Resource Manager gallery to the specified value. The gallery endpoint is the location for resource group gallery
templates.
Required? false
Position? 8
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ManagementPortalUrl <String>
Changes the URL of the Azure Management Portal to the specified value.
Required? false
Position? 4
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Identifies the environment that is being changed. This parameter is required. The parameter value is case-sensitive. Wildcard characters are not
permitted.
Required? true
Position? 1
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PublishSettingsFileUrl <String>
Changes the URL for publish settings files in the specified environment. An Azure publish settings file is an XML file that contains information
about your account and a management certificate that allows Windows PowerShell to sign into your Azure account on your behalf.
Required? false
Position? 2
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceManagerEndpoint <String>
Changes the endpoint for Azure Resource Manager data, including data about resource groups associated with the account. For more information about
Azure Resource Manager, see Azure Resource Manager Cmdlets (http://go.microsoft.com/fwlink/?LinkID=394765) and Using Windows PowerShell with
Resource Manager (http://go.microsoft.com/fwlink/?LinkID=394767).
Required? false
Position? 7
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServiceEndpoint <String>
Changes the URL of the Azure service endpoint in the specified environment. The Azure service endpoint determines whether your application is
managed by the global Azure platform, Azure operated by 21Vianet in China, or a private Azure installation.
Required? false
Position? 3
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-StorageEndpoint <String>
Changes the default endpoint of storage services in the specified environment.
Required? false
Position? 5
Default value
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
You can pipe input to this cmdlet by property name, but not by value.
OUTPUTS
Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment
NOTES
Keywords: azure, azuresm, servicemanagement, management, service, utilities
Example 1: Change environment properties
PS C:\\>Set-AzureEnvironment -Name ContosoEnv -PublishSettingsFileUrl "https://contoso.com" -StorageEndpoint "contoso.com"
This command changes the values of the PublishSettingsFileUrl and StorageEndpoint properties of the ContosoEnv environment.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkID=397629
Add-AzureEnvironment
Get-AzureEnvironment
Remove-AzureEnvironment