Remove-AzureSubscription

  • Referência
Módulo:
Azure

Exclui uma assinatura do Azure do Windows PowerShell.

Nota

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 do PowerShell herdado não é recomendado ao criar novos recursos, uma vez que o ASM está agendado para desativação. Para obter mais informações, consulte Aposentadoria do Azure Service Manager.

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

Sintaxe

Remove-AzureSubscription
      -SubscriptionName <String>
      [-Force]
      [-PassThru]
      [-Profile <AzureSMProfile>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureSubscription
      -SubscriptionId <String>
      [-Force]
      [-PassThru]
      [-Profile <AzureSMProfile>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O cmdlet Remove-AzureSubscription exclui uma assinatura do Azure do seu arquivo de dados de assinatura para que o Windows PowerShell não possa encontrá-la. Este cmdlet não exclui a assinatura do Microsoft Azure nem altera a assinatura real de forma alguma.

Este tópico descreve o cmdlet na versão 0.8.10 do módulo PowerShell do Microsoft Azure. Para obter a versão do módulo que você está usando, no console do Azure PowerShell, digite (Get-Module -Name Azure).Version.

Exemplos

Exemplo 1: Eliminar uma subscrição

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"):

Este comando exclui a assinatura "Test" do arquivo de dados de assinatura padrão.

Exemplo 2: Excluir de um arquivo de dados de assinatura alternativo

C:\PS> Remove-AzureSubscription -SubscriptionName Test -SubscriptionDataFile C:\Subs\MySubscriptions.xml -Force

Este comando exclui a assinatura de teste do arquivo de dados de assinatura MySubscriptions.xml. O comando usa o parâmetro Force para suprimir o prompt de confirmação.

Exemplo 3: Excluir uma assinatura em um script

C:\PS> ...if (Remove-AzureSubscription -SubscriptionName Test -PassThru) {...}

Este comando usa o comando Remove-AzureSubscription em uma instrução If . Ele usa o parâmetro PassThru , que retorna um valor booleano, para determinar se o bloco de script na instrução If é executado.

Parâmetros

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Force

Suprime o prompt de confirmação.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-PassThru

Retorna $True se o comando for bem-sucedido e $False se falhar. Por padrão, esse cmdlet não retorna nenhuma saída.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Profile

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

Tipo:AzureSMProfile
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-SubscriptionId

Tipo:String
Aliases:Id
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-SubscriptionName

Tipo:String
Aliases:Name
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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.