你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Add-AzureEnvironment
创建 Azure 环境。
注意
本文档中引用的 cmdlet 用于管理使用 Azure Service Manager (ASM) API 的旧式 Azure 资源。 创建新资源时,建议不要使用旧的 PowerShell 模块,因为计划将停用 ASM。 有关详细信息,请参阅 Azure Service Manager 停用。
Az PowerShell 模块是建议用于管理 PowerShell 的 Azure 资源管理器 (ARM) 资源的 PowerShell 模块。
语法
Add-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>]
说明
Add-AzureEnvironment cmdlet 创建新的自定义 Azure 帐户环境,并将其保存在漫游用户配置文件中。 该 cmdlet 返回一个表示新环境的对象。 命令完成后,可以在 Windows PowerShell 中使用环境。
Azure 环境独立于 azure 部署Microsoft,例如 AzureCloud for global Azure,以及由世纪互联在中国运营的 AzureChinaCloud for Azure。 还可以使用 Azure Pack 和 WAPack cmdlet 创建本地 Azure 环境。 有关详细信息,请参阅 Azure Pack。
只有此 cmdlet 的 Name 参数是必需的。 如果省略参数,则其值为 null($Null),并且使用该终结点的服务可能无法正常工作。 若要添加或更改环境属性的值,请使用 Set-AzureEnvironment cmdlet。
注意:更改环境可能会导致帐户失败。 通常,仅添加用于测试或故障排除的环境。
本主题介绍 Microsoft Azure PowerShell 模块的 0.8.10 版本中的 cmdlet。
若要获取正在使用的模块版本,请在 Azure PowerShell 控制台中键入 (Get-Module -Name Azure).Version
。
示例
示例 1:添加 Azure 环境
PS C:\> Add-AzureEnvironment -Name ContosoEnv -PublishSettingsFileUrl https://contoso.com/fwlink/?LinkID=101 -ServiceEndpoint https://contoso.com/fwlink/?LinkID=102
Name : ContosoEnv
PublishSettingsFileUrl : https://contoso.com/fwlink/?LinkID=101
ServiceEndpoint : https://contoso.com/fwlink/?LinkID=102
ResourceManagerEndpoint :
ManagementPortalUrl :
ActiveDirectoryEndpoint :
ActiveDirectoryCommonTenantId :
StorageEndpointSuffix :
StorageBlobEndpointFormat :
StorageQueueEndpointFormat :
StorageTableEndpointFormat :
GalleryEndpoint :
此命令创建 ContosoEnv Azure 环境。
参数
-ActiveDirectoryEndpoint
在新环境中指定Microsoft Entra 身份验证的终结点。
类型: | String |
别名: | AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-ActiveDirectoryServiceEndpointResourceId
指定Microsoft Entra ID 管理其访问权限的管理 API 的资源 ID。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-AdTenant
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-AzureKeyVaultDnsSuffix
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-AzureKeyVaultServiceEndpointResourceId
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-EnableAdfsAuthentication
类型: | SwitchParameter |
别名: | OnPremise |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-GalleryEndpoint
指定存储资源组库模板的 Azure 资源管理器 库的终结点。 有关 Azure 资源组和库模板的详细信息,请参阅 Get-AzureResourceGroupGalleryTemplate 的帮助主题https://go.microsoft.com/fwlink/?LinkID=393052.
类型: | String |
别名: | Gallery, GalleryUrl |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-GraphEndpoint
类型: | String |
别名: | Graph, GraphUrl |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-ManagementPortalUrl
在新环境中指定 Azure 管理门户的 URL。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-Name
指定环境的名称。 此参数是必需的。 请勿使用默认环境、AzureCloud 和 AzureChinaCloud 的名称。
类型: | String |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-Profile
指定此 cmdlet 从中读取的 Azure 配置文件。 如果未指定配置文件,此 cmdlet 将从本地默认配置文件中读取。
类型: | AzureSMProfile |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-PublishSettingsFileUrl
指定帐户的发布设置文件的 URL。 Azure 发布设置文件是一个 XML 文件,其中包含有关帐户的信息和管理证书,允许 Windows PowerShell 代表你登录到 Azure 帐户。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-ResourceManagerEndpoint
指定 Azure 资源管理器数据的终结点,包括与帐户关联的资源组的相关数据。 有关 Azure 资源管理器的详细信息,请参阅 Azure 资源管理器 Cmdlet (https://go.microsoft.com/fwlink/?LinkID=394765) 和将 Windows PowerShell 与 资源管理器 配合使用(https://go.microsoft.com/fwlink/?LinkID=394767)。
类型: | String |
别名: | ResourceManager, ResourceManagerUrl |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-ServiceEndpoint
指定 Azure 服务终结点的 URL。 Azure 服务终结点确定应用程序是由全球 Azure 平台、中国世纪互联运营的 Azure 还是专用 Azure 安装进行管理。
类型: | String |
别名: | ServiceManagement, ServiceManagementUrl |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-SqlDatabaseDnsSuffix
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-StorageEndpoint
在新环境中指定存储服务的默认终结点。
类型: | String |
别名: | StorageEndpointSuffix |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-TrafficManagerDnsSuffix
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
输入
None
可以通过属性名称(而不是值)通过管道将输入传递给此 cmdlet。
输出
Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment