共用方式為

Remove-AzureEnvironment

  • 參考
模組:
Azure

從 Windows PowerShell 刪除 Azure 環境。

注意

本文件中參考的 Cmdlet 用於管理使用 Azure Service Manager（ASM） API 的舊版 Azure 資源。 建立新的資源時，不建議使用此舊版 PowerShell 模組，因為 ASM 已排定淘汰。 如需詳細資訊，請參閱 Azure Service Manager 淘汰。

Az PowerShell 模組是使用 PowerShell 管理 Azure Resource Manager （ARM） 資源的建議 PowerShell 模組。

語法

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

Description

Remove-AzureEnvironment Cmdlet 會從漫遊配置檔中刪除 Azure 環境，讓 Windows PowerShell 找不到它。 此 Cmdlet 不會從 azure Microsoft 中刪除環境，或以任何方式變更實際環境。

Azure 環境是獨立部署Microsoft Azure，例如適用於全球 Azure 的 Azure 雲端，以及由中國 21Vianet 營運的 AzureChinaCloud。 您也可以使用 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 會傳回布爾值。 否則，它不會傳回任何輸出。