Gerir contas e quotas do Batch com a biblioteca de cliente de Gestão do Batch para .NET

Artigo
10/18/2023

Você pode reduzir a sobrecarga de manutenção em seus aplicativos do Lote do Azure usando a biblioteca .NET do Gerenciamento de Lotes para automatizar a criação, exclusão, gerenciamento de chaves e descoberta de cotas de contas em lote.

Crie e exclua contas em lote em qualquer região. Se, como um fornecedor independente de software (ISV), por exemplo, você fornecer um serviço para seus clientes no qual cada um recebe uma conta de lote separada para fins de faturamento, você pode adicionar recursos de criação e exclusão de conta ao seu portal do cliente.
Recupere e regenere chaves de conta programaticamente para qualquer uma das suas contas Batch. Isso pode ajudá-lo a cumprir as políticas de segurança que impõem a substituição periódica ou a expiração das chaves de conta. Quando você tem várias contas de lote em várias regiões do Azure, a automação desse processo de substituição aumenta a eficiência da sua solução.
Verifique as cotas de conta e elimine as suposições de tentativa e erro para determinar quais contas de lote têm quais limites. Ao verificar suas cotas de conta antes de iniciar trabalhos, criar pools ou adicionar nós de computação, você pode ajustar proativamente onde ou quando esses recursos de computação são criados. Você pode determinar quais contas exigem aumentos de cota antes de alocar recursos adicionais nessas contas.
Combine recursos de outros serviços do Azure para uma experiência de gerenciamento completa usando o Batch Management .NET, o Microsoft Entra ID e o Azure Resource Manager juntos no mesmo aplicativo. Usando esses recursos e suas APIs, você pode fornecer uma experiência de autenticação sem atritos, a capacidade de criar e excluir grupos de recursos e os recursos descritos acima para uma solução de gerenciamento de ponta a ponta.

Nota

Embora este artigo se concentre no gerenciamento programático de suas contas, chaves e cotas em lote, você também pode executar muitas dessas atividades usando o portal do Azure.

Criar e excluir contas em lote

Um dos principais recursos da API de Gerenciamento de Lote é criar e excluir contas de Lote em uma região do Azure. Para fazer isso, use BatchManagementClient.Account.CreateAsync e DeleteAsync ou suas contrapartes síncronas.

O trecho de código a seguir cria uma conta, obtém a conta recém-criada do serviço Batch e a exclui. Neste trecho e nos outros neste artigo, batchManagementClient está uma instância totalmente inicializada de BatchManagementClient.

// Create a new Batch account
await batchManagementClient.Account.CreateAsync("MyResourceGroup",
    "mynewaccount",
    new BatchAccountCreateParameters() { Location = "West US" });

// Get the new account from the Batch service
AccountResource account = await batchManagementClient.Account.GetAsync(
    "MyResourceGroup",
    "mynewaccount");

// Delete the account
await batchManagementClient.Account.DeleteAsync("MyResourceGroup", account.Name);

Nota

Os aplicativos que usam a biblioteca .NET do Batch Management e sua classe BatchManagementClient exigem acesso de administrador de serviço ou coadministrador à assinatura que possui a conta Batch a ser gerenciada. Para obter mais informações, consulte a seção ID do Microsoft Entra e o exemplo de código AccountManagement .

Recuperar e regenerar chaves de conta

Obtenha chaves de conta primárias e secundárias de qualquer conta Batch dentro da sua assinatura usando GetKeysAsync. Você pode regenerar essas chaves usando RegenerateKeyAsync.

// Get and print the primary and secondary keys
BatchAccountGetKeyResult accountKeys =
    await batchManagementClient.Account.GetKeysAsync(
        "MyResourceGroup",
        "mybatchaccount");
Console.WriteLine("Primary key:   {0}", accountKeys.Primary);
Console.WriteLine("Secondary key: {0}", accountKeys.Secondary);

// Regenerate the primary key
BatchAccountRegenerateKeyResponse newKeys =
    await batchManagementClient.Account.RegenerateKeyAsync(
        "MyResourceGroup",
        "mybatchaccount",
        new BatchAccountRegenerateKeyParameters() {
            KeyName = AccountKeyType.Primary
            });

Gorjeta

Você pode criar um fluxo de trabalho de conexão simplificado para seus aplicativos de gerenciamento. Primeiro, obtenha uma chave de conta para a conta Batch que você deseja gerenciar com GetKeysAsync. Em seguida, use essa chave ao inicializar a classe BatchSharedKeyCredentials da biblioteca Batch .NET, que é usada ao inicializar BatchClient.

Verificar a subscrição do Azure e as quotas da conta em lote

As assinaturas do Azure e os serviços individuais do Azure, como o Batch, têm cotas padrão que limitam o número de determinadas entidades dentro delas. Para obter as cotas padrão para assinaturas do Azure, consulte Limites de assinatura, cotas e restrições de serviço e assinatura do Azure. Para obter as cotas padrão do serviço em lote, consulte Cotas e limites para o serviço de lote do Azure. Usando a biblioteca .NET do Batch Management, você pode verificar essas cotas em seus aplicativos. Isso permite que você tome decisões de alocação antes de adicionar contas ou recursos de computação, como pools e nós de computação.

Verificar uma subscrição do Azure para quotas de conta em lote

Antes de criar uma conta em lote em uma região, você pode verificar sua assinatura do Azure para ver se é possível adicionar uma conta nessa região.

No trecho de código abaixo, primeiro usamos ListAsync para obter uma coleção de todas as contas Batch que estão dentro de uma assinatura. Depois de obter essa coleção, determinamos quantas contas estão na região de destino. Em seguida, usamos GetQuotasAsync para obter a cota de conta de lote e determinar quantas contas (se houver) podem ser criadas nessa região.

// Get a collection of all Batch accounts within the subscription
BatchAccountListResponse listResponse =
        await batchManagementClient.BatchAccount.ListAsync(new AccountListParameters());
IList<AccountResource> accounts = listResponse.Accounts;
Console.WriteLine("Total number of Batch accounts under subscription id {0}:  {1}",
    creds.SubscriptionId,
    accounts.Count);

// Get a count of all accounts within the target region
string region = "westus";
int accountsInRegion = accounts.Count(o => o.Location == region);

// Get the account quota for the specified region
SubscriptionQuotasGetResponse quotaResponse = await batchManagementClient.Location.GetQuotasAsync(region);
Console.WriteLine("Account quota for {0} region: {1}", region, quotaResponse.AccountQuota);

// Determine how many accounts can be created in the target region
Console.WriteLine("Accounts in {0}: {1}", region, accountsInRegion);
Console.WriteLine("You can create {0} accounts in the {1} region.", quotaResponse.AccountQuota - accountsInRegion, region);

No trecho acima, creds é uma instância de TokenCredentials. Para ver um exemplo de criação desse objeto, consulte o exemplo de código AccountManagement no GitHub.

Verificar uma conta de lote para cotas de recursos de computação

Antes de aumentar os recursos de computação em sua solução em lote, você pode verificar se os recursos que deseja alocar não excederão as cotas da conta. No trecho de código abaixo, imprimimos as informações de cota para a conta de lote chamada mybatchaccount. Em seu próprio aplicativo, você pode usar essas informações para determinar se a conta pode lidar com os recursos adicionais a serem criados.

// First obtain the Batch account
BatchAccountGetResponse getResponse =
    await batchManagementClient.Account.GetAsync("MyResourceGroup", "mybatchaccount");
AccountResource account = getResponse.Resource;

// Now print the compute resource quotas for the account
Console.WriteLine("Core quota: {0}", account.Properties.CoreQuota);
Console.WriteLine("Pool quota: {0}", account.Properties.PoolQuota);
Console.WriteLine("Active job and job schedule quota: {0}", account.Properties.ActiveJobAndJobScheduleQuota);

Importante

Embora existam cotas padrão para assinaturas e serviços do Azure, muitos desses limites podem ser aumentados solicitando um aumento de cota no portal do Azure.

Usar o Microsoft Entra ID com o Batch Management .NET

A biblioteca .NET do Batch Management é um cliente do provedor de recursos do Azure e é usada junto com o Azure Resource Manager para gerenciar recursos de conta programaticamente. A ID do Microsoft Entra é necessária para autenticar solicitações feitas por meio de qualquer cliente de provedor de recursos do Azure, incluindo a biblioteca .NET de Gerenciamento de Lotes, e por meio do Gerenciador de Recursos do Azure. Para obter informações sobre como usar o Microsoft Entra ID com a biblioteca .NET do Batch Management, consulte Usar o Microsoft Entra ID para autenticar soluções em lote.

Exemplo de projeto no GitHub

Para ver o Batch Management .NET em ação, confira o projeto de exemplo AccountManagement no GitHub. O aplicativo de exemplo AccountManagement demonstra as seguintes operações:

Adquira um token de segurança do Microsoft Entra ID usando Adquirir e armazenar tokens de cache usando a Biblioteca de Autenticação da Microsoft (MSAL). Se o usuário ainda não estiver conectado, ele será solicitado a fornecer suas credenciais do Azure.
Com o token de segurança obtido do Microsoft Entra ID, crie um SubscriptionClient para consultar o Azure para obter uma lista de assinaturas associadas à conta. O usuário pode selecionar uma assinatura na lista se ela contiver mais de uma assinatura.
Obtenha credenciais associadas à assinatura selecionada.
Crie um objeto ResourceManagementClient usando as credenciais.
Use um objeto ResourceManagementClient para criar um grupo de recursos.
Use um objeto BatchManagementClient para executar várias operações de conta de lote:
- Crie uma conta de lote no novo grupo de recursos.
- Obtenha a conta recém-criada do serviço Batch.
- Imprima as chaves da conta para a nova conta.
- Regenere uma nova chave primária para a conta.
- Imprima as informações da cota da conta.
- Imprima as informações de cota da assinatura.
- Imprima todas as contas dentro da assinatura.
- Exclua a conta recém-criada.
Exclua o grupo de recursos.

Para executar o aplicativo de exemplo com êxito, você deve primeiro registrá-lo com seu locatário do Microsoft Entra no portal do Azure e conceder permissões à API do Azure Resource Manager. Siga as etapas fornecidas em Autenticar soluções de gerenciamento de lote com o Ative Directory.

Próximos passos

Saiba mais sobre o fluxo de trabalho do serviço em lote e os recursos primários, como pools, nós, trabalhos e tarefas.
Aprenda os conceitos básicos de programação de uma aplicação compatível com o Batch ao utilizar a biblioteca de cliente .NET do Batch ou Python. Estes guias de início rápido guiam você por um aplicativo de exemplo que usa o serviço Batch para executar uma carga de trabalho em vários nós de computação, usando o Armazenamento do Azure para preparo de arquivos de carga de trabalho e o pus retrieval.git