Get-AzurePublishSettingsFile

  • Referência
Módulo:
Azure

Baixa o arquivo de configurações de publicação para uma assinatura 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-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 que você prepare a sessão com antecedência para que você possa executar scripts e trabalhos em segundo plano sem supervisão. No entanto, nem todos os serviços suportam 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, transfere o ficheiro de definições de publicação da sua subscrição para o ficheiro que selecionou.

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.

Nota de segurança: Os ficheiros de definições de publicação contêm credenciais que são utilizadas para administrar as suas subscrições 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 seu navegador padrão, se conecta à sua conta do Windows Azure e baixa o arquivo .publishsettings da sua conta.

Exemplo 2: Especificar um território

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

Este 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 quando 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 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.

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

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

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