Referência de cmdlet do PowerShell do Windows Azure

O módulo RemoteAccess que pode ser importado em seu serviço hospedado fornece um conjunto de cmdlets do PowerShell que você pode usar para executar as tarefas a seguir:

  • Recuperar valores do parâmetro de configuração

  • Examinar recursos locais

  • Exibir informações de topologia de serviço

  • Definir o status de uma instância de função como Ocupado ou Pronto para teste e depuração

Para obter mais informações sobre como importar o módulo RemoteAccess, consulte Defining the Settings for an Application.

Dica

Os cmdlets do PowerShell fornecidos pelo módulo RemoteAccess pretendem ser usados de uma sessão interativa. Para concluir estas tarefas programaticamente de uma instância de função em execução, consulte o RoleEnvironment.

Os cmdlets que são usados com o Windows Azure são empacotados como um snap-in do PowerShell. Este cmdlets também são instalados como parte dos componentes de integração do Windows Azure para uso em instâncias de função VM. Para obter mais informações sobre como usar o Windows PowerShell, consulte Windows PowerShell (página em inglês).

Para acrescentar o snap-in à sessão do Windows PowerShell

  1. Clique em Iniciar, Todos os Programas, Acessórios, clique na pasta Windows PowerShell, clique com o botão direito em Windows PowerShell e clique em Executar como administrador.

  2. Digite o comando a seguir no prompt de comando do Windows PowerShell:

    Add-PSSnapIn Microsoft.WindowsAzure.ServiceRuntime
    

    Dica

    Para as funções web e de trabalho, o sistema perguntará se você deseja executar software de um fornecedor não confiável. Digite R para adicionar o snap-in.

Os cmdlets listados na tabela a seguir estão disponíveis depois de importarem o módulo RemoteAccess.

Nome Descrição

Get-ConfigurationSetting

Recupera os valores dos parâmetros de configuração de serviço. Para obter mais informações sobre os parâmetros de configuração para um aplicativo do Windows Azure, consulte Configuring an Application.

Get-LocalResource

Recupera os recursos locais que estão definidos na definição de serviço. Para obter mais informações sobre como definir os parâmetros para um aplicativo do Windows Azure, consulte Defining the Settings for an Application.

Get-RoleInstance

Recupera informações sobre todas as instâncias de função que incluem pelo menos um ponto de extremidade. Para obter mais informações sobre pontos de extremidade, consulte Visão geral da comunicação da função.

Set-RoleInstanceStatus

Define o status de uma instância de função como Ocupado ou Pronto para teste e depuração. Quando uma instância de função está no estado Ocupado, ela não está disponível externamente.