Compartilhar via

Get-AzureSubscription

  • Referência
Módulo:
Azure

Obtém assinaturas do Azure na conta do Azure.

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

Get-AzureSubscription
   [-SubscriptionName <String>]
   [-ExtendedDetails]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]
Get-AzureSubscription
   [-SubscriptionId <String>]
   [-ExtendedDetails]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]
Get-AzureSubscription
   [-Default]
   [-ExtendedDetails]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]
Get-AzureSubscription
   [-Current]
   [-ExtendedDetails]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

O cmdlet Get-AzureSubscription obtém as assinaturas em sua conta do Azure. Você pode usar esse cmdlet para obter informações sobre a assinatura e canalizar a assinatura para outros cmdlets.

Get-AzureSubscription requer acesso às suas contas do Azure. Antes de executar Get-AzureSubscription, você deve executar o cmdlet Add-AzureAccount ou os cmdlets que baixam e instalam um arquivo de configurações de publicação (Get-AzurePublishSettingsFile, Import-AzurePublishSettingsFile.

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: Obter todas as assinaturas

C:\PS>Get-AzureSubscription

Esse comando obtém todas as assinaturas na conta.

Exemplo 2: Obter uma assinatura pelo nome

C:\PS>Get-AzureSubscription -SubscriptionName "MyProdSubscription"

Este comando obtém apenas a assinatura "MyProdSubsciption".

Exemplo 3: Obter a assinatura padrão

C:\PS>(Get-AzureSubscription -Default).SubscriptionName

Esse comando obtém apenas o nome da assinatura padrão. O comando primeiro obtém a assinatura e, em seguida, usa o método dot para obter a propriedade SubscriptionName da assinatura.

Exemplo 4: Obter propriedades de assinatura selecionadas

C:\PS>Get-AzureSubscription -Current | Format-List -Property SubscriptionName, Certificate

Esse comando retorna uma lista com o nome e o certificado da assinatura atual. Ele usa um comando Get-AzureSubscription para obter a assinatura atual. Em seguida, canaliza a assinatura para um comando Format-List que exibe as propriedades selecionadas em uma lista.

Exemplo 5: Usar um arquivo de dados de assinatura alternativo

C:\PS>Get-AzureSubscription -SubscriptionDataFile "C:\Temp\MySubscriptions.xml"

Esse comando obtém assinaturas do arquivo de dados de assinatura C:\Temp\MySubscriptions.xml. Use o parâmetro SubscriptionDataFile se você especificou um arquivo de dados de assinatura alternativo ao executar os cmdlets Add-AzureAccount ou Import-PublishSettingsFile .

Parâmetros

-Current

Obtém apenas a assinatura atual, ou seja, a assinatura designada como "atual". Por padrão, Get-AzureSubscription obtém todas as assinaturas em suas contas do Azure. Para designar uma assinatura como "atual", use o parâmetro Current do cmdlet Select-AzureSubscription .

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

-Default

Obtém apenas a assinatura padrão, ou seja, a assinatura designada como "padrão". Por padrão, Get-AzureSubscription obtém todas as assinaturas em suas contas do Azure. Para designar uma assinatura como "padrão", use o parâmetro Default do cmdlet Select-AzureSubscription .

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

-ExtendedDetails

Retorna informações de cota para a assinatura, além das configurações padrão.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
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

-SubscriptionId

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

-SubscriptionName

Obtém apenas a assinatura especificada. Insira o nome da assinatura. O valor diferencia maiúsculas de minúsculas. Não há suporte para caracteres curinga. Por padrão, Get-AzureSubscription obtém todas as assinaturas em suas contas do Azure.

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

Entradas

None

Você pode canalizar a entrada para a propriedade SubscriptionName por nome, mas não por valor.

Saídas

Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureSubscription

Observações

  • Get-AzureSubscription obtém dados do arquivo de dados de assinatura criados pelos cmdlets Add-AzureAccount e Import-PublishSettingsFile .