Remove-AzureEnvironment

  • Referência
Módulo:
Azure

Exclui um ambiente do Azure do Windows PowerShell.

Observação

Os cmdlets mencionados nesta documentação são para gerenciar recursos herdados do Azure que usam APIs do Azure Service Manager (ASM). Este módulo herdado do PowerShell não é recomendado ao criar novos recursos, já que o ASM está programado para desativação. Para obter mais informações, consulte Aposentadoria do Azure Service Manager.

O módulo Az PowerShell é o módulo do PowerShell recomendado para gerenciar recursos do Azure Resource Manager (ARM) com o PowerShell.

Sintaxe

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

Description

O cmdlet Remove-AzureEnvironment exclui um ambiente do Azure do seu perfil móvel para que o Windows PowerShell não possa encontrá-lo. Esse cmdlet não exclui o ambiente do Microsoft Azure nem altera o ambiente real de forma alguma.

Um ambiente do Azure uma implantação independente do Microsoft Azure, como o AzureCloud para Azure global e o AzureChinaCloud para Azure operado pela 21Vianet na China. Você também pode criar ambientes locais do Azure usando o Pacote do Azure e os cmdlets WAPack. Para obter mais informações, consulte Pacote do Azure.

Exemplos

Exemplo 1: Excluir um ambiente

PS C:\> Remove-AzureEnvironment -Name ContosoEnv

Esse comando exclui o ambiente ContosoEnv do Windows PowerShell.

Exemplo 2: Excluir vários ambientes

PS C:\> Get-AzureEnvironment | Where-Object EnvironmentName -like "Contoso*" | ForEach-Object {Remove-AzureEnvironment -Name $_.EnvironmentName }

Esse comando exclui ambientes cujos nomes começam com "Contoso" do Windows PowerShell.

Parâmetros

-Force

Suprime o prompt de confirmação.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Name

Especifica o nome do ambiente a ser removido. Este parâmetro é obrigatório. Esse valor de parâmetro diferencia maiúsculas de minúsculas. Caracteres curinga não são permitidos.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Profile

Especifica o perfil do Azure a partir do qual este cmdlet lê. Se você não especificar um perfil, esse cmdlet será lido a partir do perfil padrão local.

Tipo:AzureSMProfile
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

None

Você pode canalizar a entrada para esse cmdlet pelo nome da propriedade, mas não pelo valor.

Saídas

None or System.Boolean

Se você usar o parâmetro PassThru , esse cmdlet retornará um valor booleano. Caso contrário, ele não retorna nenhuma saída.