你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Set-AzureEnvironment
更改 Azure 环境的属性。
注意
本文档中引用的 cmdlet 用于管理使用服务管理 API 的旧式 Azure 资源。 若要了解用于管理 Azure 资源管理器资源的 cmdlet,请参阅 Az PowerShell 模块。
语法
Set-AzureEnvironment
-Name <String>
[-PublishSettingsFileUrl <String>]
[-ServiceEndpoint <String>]
[-ManagementPortalUrl <String>]
[-StorageEndpoint <String>]
[-ActiveDirectoryEndpoint <String>]
[-ResourceManagerEndpoint <String>]
[-GalleryEndpoint <String>]
[-ActiveDirectoryServiceEndpointResourceId <String>]
[-GraphEndpoint <String>]
[-AzureKeyVaultDnsSuffix <String>]
[-AzureKeyVaultServiceEndpointResourceId <String>]
[-TrafficManagerDnsSuffix <String>]
[-SqlDatabaseDnsSuffix <String>]
[-EnableAdfsAuthentication]
[-AdTenant <String>]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
说明
Set-AzureEnvironment cmdlet 更改 Azure 环境的属性。 它返回一个对象,该对象代表具有其新属性值的环境。 使用 Name 参数标识环境和其他参数以更改属性值。 不能使用 Set-AzureEnvironment 更改 Azure 环境的名称。
Azure 环境是 Microsoft Azure 的独立部署,例如 AzureCloud for global Azure,以及由世纪互联在中国运营的 AzureChinaCloud for Azure。 还可以使用 Azure Pack 和 WAPack cmdlet 创建本地 Azure 环境。 有关详细信息,请参阅 Azure Pack。
注意:不要更改 AzureCloud 或 AzureChinaCloud 环境的属性。 使用此 cmdlet 更改创建的专用环境的值。
示例
示例 1:更改环境属性
PS C:\> Set-AzureEnvironment -Name ContosoEnv -PublishSettingsFileUrl "https://contoso.com" -StorageEndpoint "contoso.com"
此命令更改 ContosoEnv 环境的 Publish设置FileUrl 和 存储Endpoint 属性的值。
参数
-ActiveDirectoryEndpoint
将 Microsoft Entra 身份验证的终结点更改为指定值。
Type: | String |
Aliases: | AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ActiveDirectoryServiceEndpointResourceId
指定由 Microsoft Entra ID 管理其访问权限的管理 API 的资源 ID。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-AdTenant
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-AzureKeyVaultDnsSuffix
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-AzureKeyVaultServiceEndpointResourceId
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-EnableAdfsAuthentication
Type: | SwitchParameter |
Aliases: | OnPremise |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-GalleryEndpoint
将 Azure 资源管理器 库的终结点更改为指定值。 库终结点是资源组库模板的位置。 有关 Azure 资源组和库模板的详细信息,请参阅 Get-AzureResourceGroupGalleryTemplate 的帮助主题。
Type: | String |
Aliases: | Gallery, GalleryUrl |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-GraphEndpoint
Type: | String |
Aliases: | Graph, GraphUrl |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ManagementPortalUrl
将 Azure 管理门户的 URL 更改为指定值。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
标识正在更改的环境。 此参数是必需的。 参数值区分大小写。 不允许使用通配符。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Profile
指定此 cmdlet 从中读取的 Azure 配置文件。 如果未指定配置文件,此 cmdlet 将从本地默认配置文件中读取。
Type: | AzureSMProfile |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PublishSettingsFileUrl
更改指定环境中的发布设置文件的 URL。 Azure 发布设置文件是一个 XML 文件,其中包含有关帐户的信息和管理证书,允许 Windows PowerShell 代表你登录到 Azure 帐户。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceManagerEndpoint
更改 Azure 资源管理器数据的终结点,包括与帐户关联的资源组的相关数据。 有关 Azure 资源管理器的详细信息,请参阅 Azure 资源管理器 Cmdlet (https://go.microsoft.com/fwlink/?LinkID=394765) 和将 Windows PowerShell 与 资源管理器 配合使用(https://go.microsoft.com/fwlink/?LinkID=394767)。
Type: | String |
Aliases: | ResourceManager, ResourceManagerUrl |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ServiceEndpoint
更改指定环境中的 Azure 服务终结点的 URL。 Azure 服务终结点确定应用程序是由全球 Azure 平台、中国世纪互联运营的 Azure 还是专用 Azure 安装进行管理。
Type: | String |
Aliases: | ServiceManagement, ServiceManagementUrl |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SqlDatabaseDnsSuffix
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-StorageEndpoint
更改指定环境中的存储服务的默认终结点。
Type: | String |
Aliases: | StorageEndpointSuffix |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TrafficManagerDnsSuffix
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
输入
None
可以通过属性名称(而不是值)通过管道将输入传递给此 cmdlet。
输出
Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment