你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Remove-AzureSubscription
从 Windows PowerShell 中删除 Azure 订阅。
注意
本文档中引用的 cmdlet 用于管理使用 Azure Service Manager (ASM) API 的旧 Azure 资源。 创建新的资源时,不建议使用此旧版 PowerShell 模块,因为 ASM 计划停用。 有关详细信息,请参阅 Azure Service Manager 停用。
Az PowerShell 模块是推荐的 PowerShell 模块,用于使用 PowerShell 管理 Azure 资源管理器 (ARM) 资源。
语法
Remove-AzureSubscription
-SubscriptionName <String>
[-Force]
[-PassThru]
[-Profile <AzureSMProfile>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzureSubscription
-SubscriptionId <String>
[-Force]
[-PassThru]
[-Profile <AzureSMProfile>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
Remove-AzureSubscription cmdlet 从订阅数据文件中删除 Azure 订阅,以便 Windows PowerShell 找不到它。 此 cmdlet 不会从 Microsoft Azure 中删除订阅,也不会以任何方式更改实际订阅。
本主题介绍 Microsoft Azure PowerShell 模块的 0.8.10 版本中的 cmdlet。
若要获取正在使用的模块版本,请在 Azure PowerShell 控制台中键入 (Get-Module -Name Azure).Version
。
示例
示例 1:删除订阅
C:\PS> Remove-AzureSubscription -SubscriptionName Test
Confirm
Are you sure you want to perform this action?
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
此命令从默认订阅数据文件中删除“测试”订阅。
示例 2:从备用订阅数据文件中删除
C:\PS> Remove-AzureSubscription -SubscriptionName Test -SubscriptionDataFile C:\Subs\MySubscriptions.xml -Force
此命令从MySubscriptions.xml订阅数据文件中删除测试订阅。 该命令使用 Force 参数取消确认提示。
示例 3:删除脚本中的订阅
C:\PS> ...if (Remove-AzureSubscription -SubscriptionName Test -PassThru) {...}
此命令在 If 语句中使用 Remove-AzureSubscription 命令。 它使用返回布尔值的 PassThru 参数来确定是否执行 If 语句中的脚本块。
参数
-Confirm
提示你在运行 cmdlet 之前进行确认。
类型: | SwitchParameter |
别名: | cf |
Position: | Named |
默认值: | False |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Force
取消确认提示。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-PassThru
如果命令成功,$False失败,则返回$True。 默认情况下,此 cmdlet 不返回任何输出。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Profile
指定此 cmdlet 从中读取的 Azure 配置文件。 如果未指定配置文件,此 cmdlet 将从本地默认配置文件中读取。
类型: | AzureSMProfile |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-SubscriptionId
类型: | String |
别名: | Id |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-SubscriptionName
类型: | String |
别名: | Name |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-WhatIf
显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。
类型: | SwitchParameter |
别名: | wi |
Position: | Named |
默认值: | False |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
输入
None
可以通过属性名称(而不是值)通过管道将输入传递给此 cmdlet。
输出
None or System.Boolean
如果使用 PassThru 参数,则此 cmdlet 返回布尔值。 否则,将不返回任何输出。