Remove-AzureSubscription

  • Referência
Módulo:
Azure

Exclui uma assinatura do Azure do Windows PowerShell.

Observação

Os cmdlets mostrados nesta documentação são usados para gerenciar recursos herdados do Azure que usam APIs de Gerenciamento de Serviços. Confira o módulo Az PowerShell para usar cmdlets a fim de gerenciar recursos do Azure Resource Manager.

Syntax

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 arquivo de dados de assinatura para que o Windows PowerShell não possa localizá-la. Esse 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 do 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: Excluir uma assinatura

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

Esse 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

Esse 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) {...}

Esse 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 sua confirmação antes de executar o cmdlet.

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

-Force

Suprime o prompt de confirmação.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

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

-SubscriptionId

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

-SubscriptionName

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

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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.