Remove-AzureSubscription
從 Windows PowerShell 刪除 Azure 訂用帳戶。
注意
本文件中參考的 Cmdlet 用於管理使用 Azure Service Manager(ASM) API 的舊版 Azure 資源。 建立新的資源時,不建議使用此舊版 PowerShell 模組,因為 ASM 已排定淘汰。 如需詳細資訊,請參閱 Azure Service Manager 淘汰。
Az PowerShell 模組是使用 PowerShell 管理 Azure Resource Manager (ARM) 資源的建議 PowerShell 模組。
語法
Remove-AzureSubscription
-SubscriptionName <String>
[-Force]
[-PassThru]
[-Profile <AzureSMProfile>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzureSubscription
-SubscriptionId <String>
[-Force]
[-PassThru]
[-Profile <AzureSMProfile>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Remove-AzureSubscription Cmdlet 會從您的訂用帳戶數據檔中刪除 Azure 訂用帳戶,讓 Windows PowerShell 找不到它。 此 Cmdlet 不會從 Azure Microsoft 刪除訂用帳戶,或以任何方式變更實際的訂用帳戶。
本主題描述 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"):
此命令會從預設訂用帳戶數據檔中刪除 「Test」 訂用帳戶。
範例 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 會傳回布爾值。 否則,它不會傳回任何輸出。