Share via

Remove-AzureEnvironment

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

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

注意

このドキュメントで参照されているコマンドレットは、Service Management API を使用するレガシ Azure リソースを管理するためのものです。 Azure Resource Manager リソースを管理するためのコマンドレットについては、Az 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

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Profile

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

Type:AzureSMProfile
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

None

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

出力

None or System.Boolean

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