Partilhar via

Gerir recursos Batch com o Azure CLI

Pode gerir as suas contas e recursos Azure Batch usando a Interface Azure Command-Line (Azure CLI). Existem comandos para criar e atualizar recursos em lote, como pools, jobs e tarefas. Também podes criar scripts para muitas das mesmas tarefas que fazes através de APIs Batch, cmdlets PowerShell e do portal Azure.

Pode executar o Azure CLI no Azure Cloud Shell ou instalar o Azure CLI localmente. Existem versões disponíveis para sistemas operativos Windows, Mac e Linux.

Este artigo explica como usar o Azure CLI com contas e recursos em lote.

Configurar a CLI do Azure

Escolhe como queres configurar a CLI do Azure:

Se és novo a usar a CLI do Azure, vê Comece com o CLI do Azure antes de continuar.

Se já instalou o Azure CLI localmente, certifique-se de atualizar a sua instalação para a versão mais recente.

Autenticar com a CLI do Azure

Para usar a CLI Azure com Batch, primeiro inicie sessão na sua conta Azure e depois inicie sessão na sua conta Batch.

Entrar na conta do Azure

Para usar a CLI do Azure, primeiro inicie sessão na sua conta Azure. Este passo permite aceder aos comandos do Azure Resource Manager, que incluem os do serviço de Gestão de Lotes. Depois, pode executar comandos para gerir contas Batch, chaves, pacotes de aplicações e quotas.

Pode autenticar a sua conta Azure na CLI do Azure de duas formas. Para executar comandos sozinho, inicie sessão interativamente na CLI do Azure. O Azure CLI armazena em cache as suas credenciais e pode usar essas mesmas credenciais para iniciar sessão na sua conta Batch depois. Para executar comandos de um script ou de uma aplicação, inicie sessão na CLI do Azure com um principal de serviço.

Para iniciar sessão interativamente no Azure CLI, execute az login:

az login

Iniciar sessão na conta Batch

De seguida, inicia sessão na tua conta Batch na CLI do Azure usando o comando az batch account login. Este passo dá-lhe acesso a comandos de serviço Batch. Depois, podes gerir recursos em lote como pools, trabalhos e tarefas.

Pode autenticar a sua conta em lote no Azure CLI de duas formas. O método padrão é autenticar usando o Microsoft Entra ID. Recomendamos usar este método na maioria dos cenários. Outra opção é usar autenticação por Chave Partilhada.

Se estiveres a criar scripts de CLI Azure para automatizar comandos Batch, podes usar qualquer um dos métodos de autenticação. Em alguns cenários, a autenticação por chave partilhada pode ser mais simples do que criar um principal de serviço.

Autenticar com o Microsoft Entra ID

O método padrão para autenticar com a sua conta Batch é através do Microsoft Entra ID. Quando inicia sessão interativamente na CLI do Azure ou com um principal de serviço, pode usar essas mesmas credenciais em cache para iniciar sessão na sua conta Batch com o Microsoft Entra ID. Este método de autenticação também oferece controlo de acesso baseado em funções no Azure (Azure RBAC). Com o Azure RBAC, o acesso dos utilizadores depende da função atribuída, não das chaves da conta. Só precisas de gerir os papéis do Azure, não as chaves de conta. O Microsoft Entra ID gere então o acesso e a autenticação.

Para iniciar sessão na sua conta Batch com o ID Microsoft Entra, execute az batch login. Certifique-se de incluir os parâmetros exigidos para o nome da sua conta de lote (-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 Partilhada

Também pode usar a autenticação por Chave Partilhada para iniciar sessão na sua conta Batch. Este método usa as chaves de acesso à sua conta para autenticar comandos Azure CLI para o serviço Batch.

Para iniciar sessão na sua conta Batch com autenticação de Chave Partilhada, execute o comando az batch login com o parâmetro --shared-key-auth. Certifique-se de incluir os parâmetros exigidos para o nome da sua conta de lote (-n), e o nome do seu grupo de recursos (-g).

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

Aprenda comandos em lote

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

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

Existem vários scripts de CLI de exemplo para tarefas comuns em lote. Estes exemplos mostram como usar muitos comandos disponíveis para Batch na CLI do Azure. Pode aprender a criar e gerir contas Batch, pools, trabalhos e tarefas.

Usar comandos da extensão Batch CLI

Podes usar a extensão Batch CLI para executar trabalhos Batch sem escrever código. A extensão fornece comandos para usar templates JSON para criar pools, jobs e tarefas com a CLI do Azure. A extensão também fornece comandos para se ligar a uma conta Azure Storage ligada à sua conta Batch. Depois, podes carregar ficheiros de entrada de trabalhos e descarregar ficheiros de entrada de trabalhos.

Crie recursos com JSON

Podes criar a maioria dos recursos em lote usando apenas parâmetros de linha de comandos. Algumas funcionalidades exigem que especifique um ficheiro de configuração JSON em vez disso. O ficheiro JSON contém os detalhes de configuração do seu novo recurso. Por exemplo, tens de usar um ficheiro JSON para especificar ficheiros de recurso para uma tarefa inicial.

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

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

Quando especificar um ficheiro JSON para um novo recurso, não use outros parâmetros no seu comando. O serviço utiliza apenas o ficheiro JSON para configurar o recurso.

A documentação de referência da API REST do Batch lista qualquer 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á à secção Exemplos na página de referência da operação de recursos. Depois, encontre a subseção intitulada Adicionar <tipo> de recurso. Por exemplo, adicionar uma tarefa básica. Usa o código JSON de exemplo como modelos para os teus ficheiros de configuração.

Para um script de exemplo que especifica um ficheiro JSON, veja Executar um trabalho e tarefas com Batch.

Consultar recursos em lote de forma eficiente

Pode consultar a sua conta Batch e listar todos os recursos usando o list comando. Por exemplo, para listar os pools na sua conta e as tarefas de um trabalho:

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

Para limitar a quantidade de dados que a sua consulta em lote devolve, especifique uma cláusula OData. Toda a filtragem ocorre no lado do servidor, por isso só recebe os dados que solicita. Use estas cláusulas OData para poupar largura de banda e tempo nas list operações. Para mais informações, consulte Como criar consultas de listas eficientes para recursos em lote.

Cláusula Description
--select-clause [select-clause] Devolve um subconjunto de propriedades para cada entidade.
--filter-clause [filter-clause] Devolve apenas entidades que correspondem à expressão OData especificada.
--expand-clause [expand-clause] Obtém a informação da entidade numa única chamada REST subjacente. Atualmente, a cláusula de expansão suporta apenas a stats propriedade.

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

Solução de problemas

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

Para devolver um comando verboso, adicione -v ou -vv ao final do seu comando. Use estas opções para mostrar o resultado completo do erro. A -vv flag devolve os pedidos e respostas REST reais.

Para ver a saída do comando em formato JSON, adicione --json ao final do seu comando. Por exemplo, para mostrar as propriedades de um pool chamado pool001, execute az batch pool show pool001 --json. Depois, copie e modifique a saída para criar recursos em lote usando um ficheiro 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.

Próximos passos

Quickstart: Executa o teu primeiro trabalho em lote com o Azure CLI

  • Last updated on