Get-AzurePublishSettingsFile

  • Referência
Módulo:
Azure

Baixa o arquivo de configurações de publicação de uma assinatura 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-AzurePublishSettingsFile
   [-Environment <String>]
   [-Realm <String>]
   [-PassThru]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

O cmdlet Get-AzurePublishSettingsFile baixa um arquivo de configurações de publicação para uma assinatura em sua conta. Quando o comando for concluído, você poderá usar o cmdlet Import-PublishSettingsFile para disponibilizar as configurações no arquivo para o Windows PowerShell.

Para disponibilizar sua conta do Azure para o Windows PowerShell, você pode usar um arquivo de configurações de publicação ou o cmdlet Add-AzureAccount . Os arquivos de configurações de publicação permitem preparar a sessão com antecedência para que você possa executar scripts e trabalhos em segundo plano de forma autônoma. No entanto, nem todos os serviços oferecem suporte a arquivos de configurações de publicação. Por exemplo, o módulo AzureResourceManager não oferece suporte a arquivos de configurações de publicação.

Quando você executa Get-AzurePublishSettingsFile, ele abre seu navegador padrão e solicita que você entre em sua conta do Azure, selecione uma assinatura e selecione um local do sistema de arquivos para o arquivo de configurações de publicação. Em seguida, ele baixa o arquivo de configurações de publicação da sua assinatura no arquivo selecionado.

Um "arquivo de configurações de publicação" é um arquivo XML com uma extensão de nome de arquivo .publishsettings. O arquivo contém um certificado codificado que fornece credenciais de gerenciamento para suas assinaturas do Azure.

Observação de segurança: os arquivos de configurações de publicação contêm credenciais que são usadas para administrar suas assinaturas e serviços do Azure. Se usuários mal-intencionados acessarem seu arquivo de configurações de publicação, eles poderão editar, criar e excluir seus serviços do Azure. Como prática recomendada de segurança, salve o arquivo em um local na pasta Downloads ou Documentos e exclua-o depois de usar o cmdlet Import-AzurePublishSettingsFile para importar as configurações.

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: Baixar um arquivo de configurações de publicação

PS C:\> Get-AzurePublishSettingsFile

Esse comando abre o navegador padrão, conecta-se à sua conta do Windows Azure e baixa o arquivo .publishsettings para sua conta.

Exemplo 2: Especificar um território

PS C:\> Get-AzurePublishSettingsFile -Realm contoso.com -Passthru

Esse comando baixa o arquivo de configurações de publicação de uma conta no domínio contoso.com. Use um comando com o parâmetro Realm ao entrar no Azure com uma conta organizacional, em vez de uma conta da Microsoft.

Parâmetros

-Environment

Especifica um ambiente do Azure.

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.

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

-Realm

Especifica a organização em uma ID organizacional. Por exemplo, se você entrar no Azure como admin@contoso.com, o valor do parâmetro Realm será contoso.com. Use esse parâmetro ao usar uma ID organizacional para entrar no portal do Azure. Esse parâmetro não é necessário quando você usa uma conta da Microsoft, como uma conta outlook.com ou live.com.

Tipo:String
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 esse cmdlet pelo nome da propriedade, mas não pelo valor.

Saídas

None or System.Boolean

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