Get-AzureEnvironment

  • Referência
Módulo:
Azure

Obtém ambientes do Azure

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

Get-AzureEnvironment
   [-Name <String>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

O cmdlet Get-AzureEnvironment obtém os ambientes do Azure que estão disponíveis para o Windows PowerShell.

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

O cmdlet Get-AzureEnvironment obtém ambientes do seu arquivo de dados de assinatura, não do Azure. Se o arquivo de dados de assinatura estiver desatualizado, execute o cmdlet Add-AzureAccount ou Import-PublishSettingsFile para atualizá-lo.

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 todos os ambientes

PS C:\> Get-AzureEnvironment

EnvironmentName               ServiceEndpoint               ResourceManagerEndpoint       PublishSettingsFileUrl
---------------               ---------------               -----------------------       ----------------------

AzureCloud                    https://management.core.wi... https://management.azure.com/ https://go.microsoft.com/fw...
AzureChinaCloud               https://management.core.ch... https://not-supported-serv... https://go.microsoft.com/fw...

Este comando obtém todos os ambientes que estão disponíveis para o Windows PowerShell.

Exemplo 2: Obter um ambiente pelo nome

PS C:\> Get-AzureEnvironment -Name AzureCloud

Name                          : AzureCloud

PublishSettingsFileUrl        : https://go.microsoft.com/fwlink/?LinkID=301775

ServiceEndpoint               : https://management.core.windows.net/

ResourceManagerEndpoint       : https://management.azure.com/

ManagementPortalUrl           : https://go.microsoft.com/fwlink/?LinkId=254433

ActiveDirectoryEndpoint       : https://login.windows.net/

ActiveDirectoryCommonTenantId : common

StorageEndpointSuffix         : core.windows.net

StorageBlobEndpointFormat     : {0}://{1}.blob.core.windows.net/

StorageQueueEndpointFormat    : {0}://{1}.queue.core.windows.net/

StorageTableEndpointFormat    : {0}://{1}.table.core.windows.net/

GalleryEndpoint               : https://gallery.azure.com/

Este exemplo obtém o ambiente AzureCloud.

Exemplo 3: Obter todas as propriedades de todos os ambientes

PS C:\> Get-AzureEnvironment | ForEach-Object {Get-AzureEnvironment -Name $_.EnvironmentName}

Este comando obtém todas as propriedades de todos os ambientes.

O comando usa o cmdlet Get-AzureEnvironment para obter todos os ambientes do Azure para essa conta. Em seguida, ele usa o cmdlet Foreach-Object para executar um comando Get-AzureEnvironment com o parâmetro Name em cada ambiente. O valor do parâmetro Name é a propriedade EnvironmentName de cada ambiente.

Sem parâmetros, Get-AzureEnvironment obtém apenas propriedades selecionadas de um ambiente.

Parâmetros

-Name

Obtém apenas o ambiente especificado. Digite o nome do ambiente. O valor do parâmetro diferencia maiúsculas de minúsculas. Caracteres curinga não são permitidos.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
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

Entradas

None

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

Saídas

PSCustomObject

Por padrão, Get-AzureEnvironment retorna um objeto personalizado.

Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment

Quando você executa Get-AzureEnvironment com o parâmetro Name , ele retorna um objeto WindowsAzureEnvironment .