Gerir os recursos do Batch com a CLI do Azure
Você pode gerenciar suas contas e recursos do Lote do Azure usando a Interface de Linha de Comando do Azure (CLI do Azure). Há comandos para criar e atualizar recursos em lote, como pools, trabalhos e tarefas. Você também pode criar scripts para muitas das mesmas tarefas que você faz por meio de APIs em lote, cmdlets do PowerShell e o 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 os sistemas operacionais Windows, Mac e Linux (SO).
Este artigo explica como usar a CLI do Azure com contas e recursos em lote.
Configurar a CLI do Azure
Escolha como você deseja configurar a CLI do Azure:
- Execute a CLI do Azure no Cloud Shell.
- Instale a CLI do Azure localmente.
Se você é novo no 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 na sua conta do Azure e, em seguida, entre na sua conta do Batch.
Entrar na conta do Azure
Para usar a CLI do Azure, primeiro entre na sua conta do Azure. Esta etapa dá acesso aos comandos do Azure Resource Manager, que incluem comandos de serviço de Gerenciamento de Lotes. Em seguida, você pode executar comandos para gerenciar contas em lote, 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 CLI do Azure armazena em cache suas credenciais e pode usar essas mesmas credenciais para entrar em sua conta do Batch depois. Para executar comandos de um script ou aplicativo, entre na CLI do Azure com uma entidade de serviço.
Para entrar na CLI do Azure interativamente, execute az login:
az login
Iniciar sessão na conta Batch
Em seguida, entre na sua conta Batch na CLI do Azure usando o comando az batch account login . Esta etapa dá acesso aos comandos do serviço em lote. Em seguida, você pode gerenciar recursos em lote, como pools, trabalhos e tarefas.
Você pode autenticar sua conta Batch na CLI do Azure de duas maneiras. O método padrão é autenticar usando o Microsoft Entra ID. Recomendamos o uso desse 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 em lote, 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.
Autenticar com o Microsoft Entra ID
O método padrão para autenticação com sua conta Batch é através do Microsoft Entra ID. Quando você entra na CLI do Azure interativamente ou com uma entidade de serviço, pode usar essas mesmas credenciais armazenadas em cache para entrar em sua conta de lote com a ID do Microsoft Entra. Esse método de autenticação também oferece controle de acesso baseado em função do Azure (Azure RBAC). Com o RBAC do Azure, o acesso do usuário depende de sua função atribuída, não das chaves de conta. Você só precisa gerenciar as funções do Azure, não as chaves de conta. Em seguida, o Microsoft Entra ID lida com o acesso e a autenticação.
Para iniciar sessão na sua conta Batch com o Microsoft Entra ID, execute az batch login. Certifique-se de incluir os parâmetros necessários para o nome da sua conta de lote () e o nome do seu grupo de recursos (-n-g).
az batch account login -g <your-resource-group> -n <your-batch-account>
Autenticar com chave compartilhada
Também pode utilizar a autenticação de Chave Partilhada para iniciar sessão na sua conta Batch. Esse método usa suas chaves de acesso de conta para autenticar comandos da CLI do Azure para o serviço em lote.
Para iniciar sessão na sua conta Batch com autenticação de Chave Partilhada, execute az batch login com o parâmetro --shared-key-auth. Certifique-se de incluir os parâmetros necessários para o nome da sua conta de lote () e o nome do seu grupo de recursos (-n-g).
az batch account login -g <your-resource-group> -n <your-batch-account> --shared-key-auth
Aprender comandos em lote
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 em lote na CLI do Azure, execute az batch -h.
Há vários exemplos de scripts CLI para tarefas em lote comuns. Estes exemplos mostram como usar muitos comandos disponíveis para Batch na CLI do Azure. Você pode aprender a criar e gerenciar contas, pools, trabalhos e tarefas em lote.
Usar comandos de extensão da CLI em lote
Você pode usar a extensão Batch CLI para executar trabalhos em lote 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 do Batch. Em seguida, você pode carregar arquivos de entrada de trabalho e baixar arquivos de entrada de trabalho.
Criar recursos com JSON
Você pode criar a maioria dos recursos em lote usando apenas parâmetros de 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 para seu novo recurso. Por exemplo, você precisa usar um arquivo JSON para especificar arquivos de recursos para uma tarefa inicial.
Por exemplo, para usar um arquivo JSON para configurar um novo recurso de pool de lotes:
az batch pool <your-batch-pool-configuration>.json
Ao 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 em lote lista qualquer sintaxe JSON necessária para criar um recurso.
Para ver a sintaxe do JSON necessário para criar um recurso, veja a documentação Batch REST API reference (Referência à API REST do Batch). 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, Adicionar uma tarefa básica. Use o exemplo de código JSON como modelos para seus arquivos de configuração.
Para obter um script de exemplo que especifica um ficheiro JSON, veja Run a job and tasks with Batch (Executar um trabalho e tarefas com o Batch).
Recursos do Lote de Consulta de forma eficiente
Você pode consultar sua conta do Batch e listar todos os recursos usando o list comando. Por exemplo, para listar os pools em sua conta e tarefas em um trabalho:
az batch pool list
az batch task list --job-id <your-job-id>
Para limitar a quantidade de dados retornados pela consulta em lote, especifique uma cláusula OData. Toda a filtragem ocorre no lado do servidor, para que você receba apenas os dados solicitados. Use essas cláusulas OData para economizar largura de banda e tempo com list operações. Para obter mais informações, consulte Projetar consultas de lista eficientes para recursos em lote.
| Cláusula | Descrição |
|---|---|
--select-clause [select-clause] |
Devolve um subconjunto de propriedades para cada entidade. |
--filter-clause [filter-clause] |
Devolve apenas as entidades que correspondem à expressão OData especificada. |
--expand-clause [expand-clause] |
Obtém as informações da entidade numa única chamada REST subjacente. Atualmente, a cláusula expand só suporta a propriedade stats. |
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 em lote, execute az batch account create -h.
Para retornar a saída detalhada do comando, adicione -v ou -vv ao final do comando. Use essas opções 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 em lote usando um arquivo de configuração JSON.
Solução de problemas gerais 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 os comandos da CLI do Azure, consulte Como usar a CLI do Azure com êxito.