Compartilhar via

Gerenciar recursos do Batch com a CLI do Azure

Você pode gerenciar suas contas e recursos do Lote do Azure usando a Interface de Command-Line do Azure (CLI do Azure). Há comandos para criar e atualizar recursos do Batch, como pools, trabalhos e tarefas. Você também pode criar scripts para muitas das mesmas tarefas que você realiza por meio de APIs do Lote, cmdlets do PowerShell e pelo portal do Azure.

Você pode executar a CLI do Azure no Azure Cloud Shell ou instalar a CLI do Azure localmente. As versões estão disponíveis para sistemas operacionais Windows, Mac e Linux (SO).

Este artigo explica como usar a CLI do Azure com contas e recursos do Batch.

Configurar a CLI do Azure

Escolha como você deseja configurar a CLI do Azure:

Se você não estiver familiarizado com o uso da CLI do Azure, consulte Introdução à CLI do Azure antes de continuar.

Se você já instalou a CLI do Azure localmente, atualize sua instalação para a versão mais recente.

Autenticar com a CLI do Azure

Para usar a CLI do Azure com o Batch, primeiro entre em sua conta do Azure e depois na sua conta do Batch.

Entrar na conta do Azure

Para usar a CLI do Azure, primeiro entre em sua conta do Azure. O logon no Azure fornece acesso a comandos do Azure Resource Manager, que incluem comandos do Serviço de Gerenciamento de Lotes. Em seguida, você pode executar comandos para gerenciar contas do Batch, chaves, pacotes de aplicativos e cotas.

Você pode autenticar sua conta do Azure na CLI do Azure) de duas maneiras. Para executar comandos sozinho, entre na CLI do Azure interativamente. A Azure CLI armazena suas credenciais em cache e pode usar essas mesmas credenciais para acessar sua conta do Batch depois. Faça logon na CLI do Azure com uma entidade de serviço para executar comandos de um script ou aplicativo.

Para entrar na CLI do Azure interativamente, execute az login:

az login

Fazer login na conta Batch

Em seguida, entre em sua conta do Batch na CLI do Azure usando o comando az batch account login. Esta etapa dá acesso aos comandos do serviço Batch. Em seguida, você pode gerenciar recursos do Batch, como pools, trabalhos e tarefas.

Você pode autenticar sua conta do Batch na CLI do Azure de duas maneiras. O método padrão é autenticar usando a ID do Microsoft Entra. É recomendável usar esse método na maioria dos cenários. Outra opção é usar a autenticação de Chave Compartilhada.

Se você estiver criando scripts da CLI do Azure para automatizar comandos do Batch, poderá usar qualquer um dos métodos de autenticação. Em alguns cenários, a autenticação de Chave Compartilhada pode ser mais simples do que criar uma entidade de serviço.

Autenticação com o Microsoft Entra ID

O método padrão para a autenticação com sua conta Batch é por meio da ID do Microsoft Entra. Ao entrar na CLI do Azure interativamente ou com uma entidade de serviço, é possível usar essas mesmas credenciais armazenadas em cache para entrar em sua conta do Lote com o Microsoft Entra ID. Esse método de autenticação também oferece o controle de acesso baseado em função (RBAC) do Azure. Com o RBAC do Azure, o acesso do usuário depende de sua função atribuída, não de chaves de conta. Você só precisa gerenciar as funções do Azure, não as chaves de conta. O Microsoft Entra ID gerencia o acesso e a autenticação.

Para entrar em sua conta do Batch com a Microsoft Entra ID, execute az batch login. Certifique-se de incluir os parâmetros necessários para o nome da sua conta do Batch (-n) e o nome do seu grupo de recursos (-g).

az batch account login -g <your-resource-group> -n <your-batch-account>

Autenticar com Chave Compartilhada

Você também pode usar a autenticação de Chave Compartilhada para entrar em sua conta do Batch. Esse método usa as chaves de acesso da sua conta para autenticar os comandos da Interface de Linha de Comando do Azure para o serviço Batch.

Para entrar em sua conta do Batch com a autenticação de Chave Compartilhada, execute az batch login com o parâmetro --shared-key-auth. Inclua os parâmetros necessários para o nome da sua conta do Batch (-n) e o nome do grupo de recursos (-g).

az batch account login -g <your-resource-group> -n <your-batch-account> --shared-key-auth

Aprenda os comandos do Batch

A documentação de referência da CLI do Azure lista todos os comandos da CLI do Azure para Batch.

Para listar todos os comandos do Batch na CLI do Azure, execute az batch -h.

Há vários scripts CLI de exemplo para tarefas comuns de Batch. Estes exemplos mostram como usar vários comandos disponíveis para o Batch na CLI do Azure. Você pode aprender a criar e gerenciar pools, trabalhos, tarefas e contas do Lote.

Usar comandos da extensão da CLI do Lote

Você pode usar a extensão Batch CLI para executar tarefas do Batch sem escrever código. A extensão fornece comandos para usar modelos JSON para criar pools, trabalhos e tarefas com a CLI do Azure. A extensão também fornece comandos para se conectar a uma conta de Armazenamento do Azure vinculada à sua conta Batch. Em seguida, você pode carregar arquivos de entrada do trabalho e baixar arquivos de entrada do trabalho.

Criar recursos com JSON

Você pode criar a maioria dos recursos do Batch usando apenas parâmetros da linha de comando. Alguns recursos exigem que você especifique um arquivo de configuração JSON. O arquivo JSON contém os detalhes de configuração do novo recurso. Por exemplo, você precisa usar um arquivo JSON para especificar arquivos de recurso para uma tarefa inicial.

Por exemplo, para usar um arquivo JSON para configurar um novo recurso de pool do Batch:

az batch pool <your-batch-pool-configuration>.json

Quando você especificar um arquivo JSON para um novo recurso, não use outros parâmetros em seu comando. O serviço usa apenas o arquivo JSON para configurar o recurso.

A documentação de referência da API REST do Lote lista a sintaxe JSON necessária para criar um recurso.

Para ver a sintaxe JSON necessária para criar um recurso, consulte a documentação de referência da Batch REST API. Vá para a seção Exemplos na página de referência da operação de recurso. Em seguida, localize a subseção intitulada Adicionar <tipo> de recurso. Por exemplo, adicione uma tarefa básica. Use o código JSON de exemplo como modelos para seus arquivos de configuração.

Para obter um script de exemplo que especifica um arquivo JSON, consulte Executar um trabalho e tarefas com o Batch.

Consultar recursos do Lote com eficiência

Você pode consultar sua conta Batch e listar todos os recursos usando o comando list. Por exemplo, para listar os pools em sua conta e as tarefas em um trabalho:

az batch pool list
az batch task list --job-id <your-job-id>

Especifique uma cláusula OData para limitar a quantidade de dados que a consulta Batch retorna. Toda a filtragem ocorre no lado do servidor, portanto, você só recebe os dados solicitados. Use essas cláusulas OData para economizar largura de banda e tempo com operações list. Para obter mais informações, consulte Criar consultas de lista eficientes para recursos do Batch.

Cláusula Description
--select-clause [select-clause] Retorna um subconjunto de propriedades para cada entidade.
--filter-clause [filter-clause] Retorna apenas entidades que correspondem à expressão OData especificada.
--expand-clause [expand-clause] Obtém as informações de entidade em uma única chamada REST subjacente. Atualmente, a cláusula de expansão dá suporte apenas à stats propriedade.

Para obter um script de exemplo que mostra como usar essas cláusulas, consulte Executar um trabalho e tarefas com Batch.

Resolução de problemas

Para obter ajuda com qualquer comando Batch, adicione -h ao final do comando. Não adicione outras opções. Por exemplo, para obter ajuda para criar uma conta do Batch, execute az batch account create -h.

Para retornar a saída de comando detalhada, adicione -v ou -vv ao final do comando. Use esses switches para exibir a saída de erro completa. O -vv sinalizador retorna as solicitações e respostas REST reais.

Para exibir a saída do comando no formato JSON, adicione --json ao final do comando. Por exemplo, para exibir as propriedades de um pool chamado pool001, execute az batch pool show pool001 --json. Em seguida, copie e modifique a saída para criar recursos Batch usando um arquivo de configuração JSON.

Solução geral de problemas da CLI do Azure

A CLI do Azure pode ser executada em vários ambientes de shell, mas com pequenas variações de formato. Se você tiver resultados inesperados com comandos da CLI do Azure, confira Como usar a CLI do Azure com êxito.

Próximas etapas

Início Rápido: Executar seu primeiro trabalho em Lote com a CLI do Azure

  • Last updated on