你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Remove-AzureEnvironment

参考

模块:: Azure

从 Windows PowerShell 中删除 Azure 环境。

注意

本文档中引用的 cmdlet 用于管理使用 Azure Service Manager (ASM) API 的旧式 Azure 资源。创建新资源时，建议不要使用旧的 PowerShell 模块，因为计划将停用 ASM。有关详细信息，请参阅 Azure Service Manager 停用。

Az PowerShell 模块是建议用于管理 PowerShell 的 Azure 资源管理器 (ARM) 资源的 PowerShell 模块。

语法

Remove-AzureEnvironment
      -Name <String>
      [-Force]
      [-Profile <AzureSMProfile>]
      [<CommonParameters>]

说明

Remove-AzureEnvironment cmdlet 从漫游配置文件中删除 Azure 环境，以便 Windows PowerShell 找不到它。此 cmdlet 不会从 Azure Microsoft中删除环境，也不会以任何方式更改实际环境。

Azure 环境独立于 azure 部署Microsoft，例如 AzureCloud for global Azure，以及由世纪互联在中国运营的 AzureChinaCloud for Azure。还可以使用 Azure Pack 和 WAPack cmdlet 创建本地 Azure 环境。有关详细信息，请参阅 Azure Pack。

示例

示例 1：删除环境

PS C:\> Remove-AzureEnvironment -Name ContosoEnv

此命令从 Windows PowerShell 中删除 ContosoEnv 环境。

示例 2：删除多个环境

PS C:\> Get-AzureEnvironment | Where-Object EnvironmentName -like "Contoso*" | ForEach-Object {Remove-AzureEnvironment -Name $_.EnvironmentName }

此命令从 Windows PowerShell 删除名称以“Contoso”开头的环境。

参数

-Force

取消确认提示。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Name

指定要删除的环境的名称。此参数是必需的。此参数值区分大小写。不允许使用通配符。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-Profile

指定此 cmdlet 从中读取的 Azure 配置文件。如果未指定配置文件，此 cmdlet 将从本地默认配置文件中读取。

类型:	AzureSMProfile
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

输入

None

可以通过属性名称（而不是值）通过管道将输入传递给此 cmdlet。

输出

None or System.Boolean

如果使用 PassThru 参数，则此 cmdlet 返回布尔值。否则，将不返回任何输出。

通过