次の方法で共有

Remove-AzureEnvironment

  • リファレンス
モジュール:
Azure

Windows PowerShell から Azure 環境を削除します。

Note

このドキュメントで参照されているコマンドレットは、Azure Service Manager (ASM) API を使用する従来の Azure リソースを管理するためのものです。 ASM の提供終了が予定されているため、新しいリソースを作成する場合、このレガシ PowerShell モジュールは推奨されません。 詳細については、Azure Service Manager の提供終了に関するページを参照してください。

Az PowerShell モジュールは、PowerShell を使用して Azure Resource Manager (ARM) リソースを管理するために推奨される PowerShell モジュールです。

構文

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

説明

Remove-AzureEnvironment コマンドレットは、ローミング プロファイルから Azure 環境を削除して、Windows PowerShell で見つけることができないようにします。 このコマンドレットは、Microsoft Azure から環境を削除したり、実際の環境を変更したりすることはありません。

Azure 環境は、グローバル Azure 用の AzureCloud や、中国の 21Vianet によって運用される AzureChinaCloud for Azure など、Microsoft Azure の独立したデプロイです。 また、Azure Pack と WAPack コマンドレットを使用して、オンプレミスの 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 }

このコマンドは、名前が "Contoso" で始まる環境を Windows PowerShell から削除します。

パラメーター

-Force

確認プロンプトを非表示にします。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Name

削除する環境の名前を指定します。 このパラメーターは必須です。 このパラメーター値では、大文字と小文字が区別されます。 ワイルドカード文字は使用できません。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Profile

このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。

型:AzureSMProfile
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

None

このコマンドレットへの入力はプロパティ名でパイプできますが、値によるパイプ処理は行いません。

出力

None or System.Boolean

PassThru パラメーターを使用すると、このコマンドレットはブール値を返します。 それ以外の場合、出力は返しません。