Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-AzureEnvironment

Set-AzureEnvironment

microsoft.windowsazure.commands.profile.dll, microsoft.windowsazure.commands.dll

Synopsis

Changes the properties of an Azure environment

Syntax

Set-AzureEnvironment [-Name] [-PublishSettingsFileUrl] [-ServiceEndpoint] [-ManagementPortalUrl] [-StorageEndpoint] [-ActiveDirectoryEndpoint] [-ResourceManagerEndpoint] [-GalleryEndpoint] [-ActiveDirectoryServiceEndpointResourceId] [-GraphEndpoint] [-SubscriptionDataFile] [<CommonParameters>]

Detailed 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-cloud/products/windows-azure-pack/default.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

-Name <String>

Identifies the environment that is being changed. This parameter is required. The parameter value is case-sensitive. Wildcard characters are not permitted.

Aliases

None

Required?

true

Position

0

Default value

None

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.

Aliases

None

Required?

false

Position

1

Default value

None

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.

Aliases

None

Required?

false

Position

2

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-ManagementPortalUrl <String>

Changes the URL of the Azure Management Portal to the specified value.

Aliases

None

Required?

false

Position

3

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-StorageEndpoint <String>

Changes the default endpoint of storage services in the specified environment.

Aliases

None

Required?

false

Position

4

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ActiveDirectoryEndpoint <String>

Changes the endpoint for Azure Active Directory authentication to the specified value.

Aliases

None

Required?

false

Position

5

Default value

None

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).

Aliases

None

Required?

false

Position

6

Default value

None

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. For more information about Azure resource groups and gallery templates, see the help topic for Get-AzureResourceGroupGalleryTemplate.

Aliases

None

Required?

false

Position

7

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-ActiveDirectoryServiceEndpointResourceId <String>

Specifies the resource ID of a management API whose access is managed by Azure Active Directory.

Aliases

None

Required?

false

Position

8

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-GraphEndpoint <String>

Changes the endpoint for Azure Active Directory Graph API to the specified value.

Aliases

None

Required?

false

Position

9

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-SubscriptionDataFile <String>

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment

Notes

Examples

-------------------------- Example 1: Change environment properties --------------------------

This command changes the values of the PublishSettingsFileUrl, StorageEndpoint, and GraphEndpoint properties of the ContosoEnv environment.

PS C:\>Set-AzureEnvironment -Name ContosoEnv -PublishSettingsFileUrl "https://contoso.com" -StorageEndpoint "contoso.com" -GraphEndpoint "https://contoso.com/fwlink/?LinkID=104"

Online Version
Add-AzureEnvironment
Get-AzureEnvironment
Remove-AzureEnvironment