Batch Account - Get

Service:

Batch Management

API Version:

2024-02-01

Obtém informações sobre a conta do Lote especificada.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}?api-version=2024-02-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
accountName	path	True	string	O nome da conta do Lote. Regex pattern: ^[a-zA-Z0-9]+$
resourceGroupName	path	True	string	O nome do grupo de recursos que contém a conta do Lote.
subscriptionId	path	True	string	A ID de assinatura do Azure. Esta é uma cadeia de caracteres formatada por GUID (por exemplo, 000000000-0000-0000-0000-0000000000000)
api-version	query	True	string	A versão da API a ser usada com a solicitação HTTP.

Respostas

Nome	Tipo	Description
200 OK	BatchAccount	A operação foi bem-sucedida. A resposta contém a entidade de conta do Lote.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Microsoft Entra fluxo de código de autenticação OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

BatchAccountGet

PrivateBatchAccountGet

BatchAccountGet

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2024-02-01

Java

/**
 * Samples for BatchAccount GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountGet.json
     */
    /**
     * Sample code: BatchAccountGet.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void batchAccountGet(com.azure.resourcemanager.batch.BatchManager manager) {
        manager.batchAccounts().getByResourceGroupWithResponse("default-azurebatch-japaneast", "sampleacct",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.batch import BatchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-batch
# USAGE
    python batch_account_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BatchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.batch_account.get(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
    )
    print(response)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armbatch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/batch/armbatch/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountGet.json
func ExampleAccountClient_Get_batchAccountGet() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbatch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountClient().Get(ctx, "default-azurebatch-japaneast", "sampleacct", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armbatch.Account{
	// 	Name: to.Ptr("sampleacct"),
	// 	Type: to.Ptr("Microsoft.Batch/batchAccounts"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct"),
	// 	Location: to.Ptr("japaneast"),
	// 	Identity: &armbatch.AccountIdentity{
	// 		Type: to.Ptr(armbatch.ResourceIdentityTypeNone),
	// 	},
	// 	Properties: &armbatch.AccountProperties{
	// 		AccountEndpoint: to.Ptr("sampleacct.japaneast.batch.azure.com"),
	// 		ActiveJobAndJobScheduleQuota: to.Ptr[int32](20),
	// 		AutoStorage: &armbatch.AutoStorageProperties{
	// 			StorageAccountID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"),
	// 			LastKeySync: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-03-10T23:48:38.987Z"); return t}()),
	// 		},
	// 		DedicatedCoreQuota: to.Ptr[int32](20),
	// 		LowPriorityCoreQuota: to.Ptr[int32](20),
	// 		PoolAllocationMode: to.Ptr(armbatch.PoolAllocationModeBatchService),
	// 		PoolQuota: to.Ptr[int32](20),
	// 		ProvisioningState: to.Ptr(armbatch.ProvisioningStateSucceeded),
	// 		PublicNetworkAccess: to.Ptr(armbatch.PublicNetworkAccessTypeEnabled),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { BatchManagementClient } = require("@azure/arm-batch");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets information about the specified Batch account.
 *
 * @summary Gets information about the specified Batch account.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountGet.json
 */
async function batchAccountGet() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.batchAccountOperations.get(resourceGroupName, accountName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Batch;
using Azure.ResourceManager.Batch.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountGet.json
// this example is just showing the usage of "BatchAccount_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BatchAccountResource created on azure
// for more information of creating BatchAccountResource, please refer to the document of BatchAccountResource
string subscriptionId = "subid";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
ResourceIdentifier batchAccountResourceId = BatchAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
BatchAccountResource batchAccount = client.GetBatchAccountResource(batchAccountResourceId);

// invoke the operation
BatchAccountResource result = await batchAccount.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
BatchAccountData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "BatchService",
    "dedicatedCoreQuota": 20,
    "lowPriorityCoreQuota": 20,
    "poolQuota": 20,
    "activeJobAndJobScheduleQuota": 20,
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
      "lastKeySync": "2016-03-10T23:48:38.9878479Z"
    },
    "publicNetworkAccess": "Enabled"
  },
  "identity": {
    "type": "None"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

PrivateBatchAccountGet

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2024-02-01

Java

/**
 * Samples for BatchAccount GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateBatchAccountGet.json
     */
    /**
     * Sample code: PrivateBatchAccountGet.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void privateBatchAccountGet(com.azure.resourcemanager.batch.BatchManager manager) {
        manager.batchAccounts().getByResourceGroupWithResponse("default-azurebatch-japaneast", "sampleacct",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.batch import BatchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-batch
# USAGE
    python private_batch_account_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BatchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.batch_account.get(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
    )
    print(response)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateBatchAccountGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armbatch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/batch/armbatch/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateBatchAccountGet.json
func ExampleAccountClient_Get_privateBatchAccountGet() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbatch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountClient().Get(ctx, "default-azurebatch-japaneast", "sampleacct", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armbatch.Account{
	// 	Name: to.Ptr("sampleacct"),
	// 	Type: to.Ptr("Microsoft.Batch/batchAccounts"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct"),
	// 	Location: to.Ptr("japaneast"),
	// 	Properties: &armbatch.AccountProperties{
	// 		AccountEndpoint: to.Ptr("sampleacct.japaneast.batch.azure.com"),
	// 		ActiveJobAndJobScheduleQuota: to.Ptr[int32](20),
	// 		AutoStorage: &armbatch.AutoStorageProperties{
	// 			StorageAccountID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"),
	// 			LastKeySync: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-03-10T23:48:38.987Z"); return t}()),
	// 		},
	// 		DedicatedCoreQuota: to.Ptr[int32](20),
	// 		LowPriorityCoreQuota: to.Ptr[int32](20),
	// 		PoolAllocationMode: to.Ptr(armbatch.PoolAllocationModeBatchService),
	// 		PoolQuota: to.Ptr[int32](20),
	// 		PrivateEndpointConnections: []*armbatch.PrivateEndpointConnection{
	// 			{
	// 				Name: to.Ptr("testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0"),
	// 				Type: to.Ptr("Microsoft.Batch/batchAccounts/privateEndpointConnections"),
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0"),
	// 				Properties: &armbatch.PrivateEndpointConnectionProperties{
	// 					PrivateEndpoint: &armbatch.PrivateEndpoint{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint"),
	// 					},
	// 					PrivateLinkServiceConnectionState: &armbatch.PrivateLinkServiceConnectionState{
	// 						Description: to.Ptr("Approved by xyz.abc@company.com"),
	// 						Status: to.Ptr(armbatch.PrivateLinkServiceConnectionStatusApproved),
	// 					},
	// 				},
	// 		}},
	// 		ProvisioningState: to.Ptr(armbatch.ProvisioningStateSucceeded),
	// 		PublicNetworkAccess: to.Ptr(armbatch.PublicNetworkAccessTypeDisabled),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { BatchManagementClient } = require("@azure/arm-batch");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets information about the specified Batch account.
 *
 * @summary Gets information about the specified Batch account.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateBatchAccountGet.json
 */
async function privateBatchAccountGet() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.batchAccountOperations.get(resourceGroupName, accountName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Batch;
using Azure.ResourceManager.Batch.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateBatchAccountGet.json
// this example is just showing the usage of "BatchAccount_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BatchAccountResource created on azure
// for more information of creating BatchAccountResource, please refer to the document of BatchAccountResource
string subscriptionId = "subid";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
ResourceIdentifier batchAccountResourceId = BatchAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
BatchAccountResource batchAccount = client.GetBatchAccountResource(batchAccountResourceId);

// invoke the operation
BatchAccountResource result = await batchAccount.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
BatchAccountData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "BatchService",
    "dedicatedCoreQuota": 20,
    "lowPriorityCoreQuota": 20,
    "poolQuota": 20,
    "activeJobAndJobScheduleQuota": 20,
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
      "lastKeySync": "2016-03-10T23:48:38.9878479Z"
    },
    "publicNetworkAccess": "Disabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
        "name": "testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
        "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Approved by xyz.abc@company.com"
          }
        }
      }
    ]
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

Definições

Nome	Description
AuthenticationMode	O modo de autenticação da conta do Lote.
AutoStorageAuthenticationMode	O modo de autenticação que o serviço do Lote usará para gerenciar a conta de armazenamento automático.
AutoStorageProperties	Contém informações sobre a conta de armazenamento automático associada a uma conta do Lote.
BatchAccount	Contém informações sobre uma conta Lote do Azure.
BatchAccountIdentity	A identidade da conta do Lote, se configurada. Isso é usado quando o usuário especifica 'Microsoft.KeyVault' como sua configuração de criptografia de conta do Lote ou quando ManagedIdentity é selecionado como o modo de autenticação de armazenamento automático.
CloudError	Uma resposta de erro do serviço do Lote.
CloudErrorBody	Uma resposta de erro do serviço do Lote.
ComputeNodeIdentityReference	A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará.
EncryptionProperties	Configura como os dados do cliente são criptografados na conta do Lote. Por padrão, as contas são criptografadas usando uma chave gerenciada da Microsoft. Para controle adicional, uma chave gerenciada pelo cliente pode ser usada.
EndpointAccessDefaultAction	A ação padrão quando não há nenhum IPRule correspondente.
EndpointAccessProfile	Perfil de acesso à rede para o ponto de extremidade do Lote.
IPRule	Regra para filtrar o endereço IP do cliente.
IPRuleAction	Ação quando o endereço IP do cliente é correspondido.
KeySource	Tipo da origem da chave.
KeyVaultProperties	Configuração do KeyVault ao usar uma KeySource de criptografia do Microsoft.KeyVault.
KeyVaultReference	Identifica o cofre de chaves do Azure associado a uma conta do Lote.
NetworkProfile	Perfil de rede para a conta do Lote, que contém as configurações de regra de rede para cada ponto de extremidade.
PoolAllocationMode	O modo de alocação para criar pools na conta do Lote.
PrivateEndpoint	O ponto de extremidade privado da conexão de ponto de extremidade privado.
PrivateEndpointConnection	Contém informações sobre um recurso de link privado.
PrivateEndpointConnectionProvisioningState	O estado de provisionamento da conexão de ponto de extremidade privado.
PrivateLinkServiceConnectionState	O estado de conexão do serviço de link privado da conexão de ponto de extremidade privado
PrivateLinkServiceConnectionStatus	O status da conexão de ponto de extremidade privado do Lote
ProvisioningState	O estado provisionado do recurso
PublicNetworkAccessType	O tipo de acesso à rede para operar nos recursos na conta do Lote.
ResourceIdentityType	O tipo de identidade usado para a conta do Lote.
UserAssignedIdentities	A lista de identidades de usuário associadas.
VirtualMachineFamilyCoreQuota	Uma Família de VMs e sua cota principal associada para a conta do Lote.

AuthenticationMode

O modo de autenticação da conta do Lote.

Nome	Tipo	Description
AAD	string	O modo de autenticação usando Microsoft Entra ID.
SharedKey	string	O modo de autenticação usando chaves compartilhadas.
TaskAuthenticationToken	string	O modo de autenticação usando tokens de autenticação de tarefa.

AutoStorageAuthenticationMode

O modo de autenticação que o serviço do Lote usará para gerenciar a conta de armazenamento automático.

Nome	Tipo	Description
BatchAccountManagedIdentity	string	O serviço lote autenticará solicitações para armazenamento automático usando a identidade gerenciada atribuída à conta do Lote.
StorageKeys	string	O serviço lote autenticará solicitações para armazenamento automático usando chaves de conta de armazenamento.

AutoStorageProperties

Contém informações sobre a conta de armazenamento automático associada a uma conta do Lote.

Nome	Tipo	Valor padrão	Description
authenticationMode	AutoStorageAuthenticationMode	StorageKeys	O modo de autenticação que o serviço do Lote usará para gerenciar a conta de armazenamento automático.
lastKeySync	string		A hora UTC em que as chaves de armazenamento foram sincronizadas pela última vez com a conta do Lote.
nodeIdentityReference	ComputeNodeIdentityReference		A referência à identidade atribuída pelo usuário que os nós de computação usarão para acessar o armazenamento automático. A identidade referenciada aqui deve ser atribuída a pools que têm nós de computação que precisam de acesso ao armazenamento automático.
storageAccountId	string		A ID do recurso da conta de armazenamento a ser usada para a conta de armazenamento automático.

BatchAccount

Contém informações sobre uma conta Lote do Azure.

Nome	Tipo	Valor padrão	Description
id	string		A ID do recurso.
identity	BatchAccountIdentity		A identidade da conta do Lote.
location	string		A localização do recurso.
name	string		O nome do recurso.
properties.accountEndpoint	string		O ponto de extremidade da conta usado para interagir com o serviço do Lote.
properties.activeJobAndJobScheduleQuota	integer		O trabalho ativo e a cota de agendamento de trabalho para a conta do Lote.
properties.allowedAuthenticationModes	AuthenticationMode[]		Lista de modos de autenticação permitidos para a conta do Lote que pode ser usada para autenticar com o plano de dados. Isso não afeta a autenticação com o painel de controle.
properties.autoStorage	AutoStorageProperties		As propriedades e status de qualquer conta de armazenamento automático associada à conta do Lote. Contém informações sobre a conta de armazenamento automático associada a uma conta do Lote.
properties.dedicatedCoreQuota	integer		A cota de núcleo dedicada para a conta do Lote. Para contas com PoolAllocationMode definido como UserSubscription, a cota é gerenciada na assinatura para que esse valor não seja retornado.
properties.dedicatedCoreQuotaPerVMFamily	VirtualMachineFamilyCoreQuota[]		Uma lista da cota de núcleo dedicada por família de Máquinas Virtuais para a conta do Lote. Para contas com PoolAllocationMode definido como UserSubscription, a cota é gerenciada na assinatura para que esse valor não seja retornado.
properties.dedicatedCoreQuotaPerVMFamilyEnforced	boolean		Um valor que indica se as cotas principais por família de Máquinas Virtuais são impostas para essa conta Se esse sinalizador for true, a cota de núcleo dedicada será imposta por meio das propriedades dedicatedCoreQuotaPerVMFamily e dedicatedCoreQuota na conta. Se esse sinalizador for falso, a cota de núcleo dedicada será imposta somente por meio da propriedade dedicatedCoreQuota na conta e não considerará a família de Máquinas Virtuais.
properties.encryption	EncryptionProperties		A configuração de criptografia para a conta do Lote. Configura como os dados do cliente são criptografados na conta do Lote. Por padrão, as contas são criptografadas usando uma chave gerenciada da Microsoft. Para controle adicional, uma chave gerenciada pelo cliente pode ser usada.
properties.keyVaultReference	KeyVaultReference		Uma referência ao cofre de chaves do Azure associado à conta do Lote. Identifica o cofre de chaves do Azure associado a uma conta do Lote.
properties.lowPriorityCoreQuota	integer		A cota de núcleo spot/de baixa prioridade para a conta do Lote. Para contas com PoolAllocationMode definido como UserSubscription, a cota é gerenciada na assinatura para que esse valor não seja retornado.
properties.networkProfile	NetworkProfile		Perfil de rede para a conta do Lote, que contém as configurações de regra de rede para cada ponto de extremidade. O perfil de rede só entra em vigor quando publicNetworkAccess está habilitado.
properties.nodeManagementEndpoint	string		O ponto de extremidade usado pelo nó de computação para se conectar ao serviço de gerenciamento de nós do Lote.
properties.poolAllocationMode	PoolAllocationMode		O modo de alocação a ser usado para criar pools na conta do Lote. O modo de alocação para criar pools na conta do Lote.
properties.poolQuota	integer		A cota de pool para a conta do Lote.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista de conexões de ponto de extremidade privado associadas à conta do Lote
properties.provisioningState	ProvisioningState		O estado provisionado do recurso
properties.publicNetworkAccess	PublicNetworkAccessType	Enabled	O tipo de interface de rede para acessar Lote do Azure serviço e operações de conta do Lote. Se não for especificado, o valor padrão será 'habilitado'.
tags	object		As marcas do recurso.
type	string		Tipo do recurso.

BatchAccountIdentity

A identidade da conta do Lote, se configurada. Isso é usado quando o usuário especifica 'Microsoft.KeyVault' como sua configuração de criptografia de conta do Lote ou quando ManagedIdentity é selecionado como o modo de autenticação de armazenamento automático.

Nome	Tipo	Description
principalId	string	A ID principal da conta do Lote. Essa propriedade só será fornecida para uma identidade atribuída pelo sistema.
tenantId	string	A ID do locatário associada à conta do Lote. Essa propriedade só será fornecida para uma identidade atribuída pelo sistema.
type	ResourceIdentityType	O tipo de identidade usado para a conta do Lote.
userAssignedIdentities	object	A lista de identidades de usuário associadas à conta do Lote.

CloudError

Uma resposta de erro do serviço do Lote.

Nome	Tipo	Description
error	CloudErrorBody	O corpo da resposta de erro.

CloudErrorBody

Uma resposta de erro do serviço do Lote.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

ComputeNodeIdentityReference

A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará.

Nome	Tipo	Description
resourceId	string	A ID de recurso do ARM da identidade atribuída pelo usuário.

EncryptionProperties

Configura como os dados do cliente são criptografados na conta do Lote. Por padrão, as contas são criptografadas usando uma chave gerenciada da Microsoft. Para controle adicional, uma chave gerenciada pelo cliente pode ser usada.

Nome	Tipo	Description
keySource	KeySource	Tipo da origem da chave.
keyVaultProperties	KeyVaultProperties	Detalhes adicionais ao usar Microsoft.KeyVault

EndpointAccessDefaultAction

A ação padrão quando não há nenhum IPRule correspondente.

Nome	Tipo	Description
Allow	string	Permitir o acesso do cliente.
Deny	string	Negar acesso ao cliente.

EndpointAccessProfile

Perfil de acesso à rede para o ponto de extremidade do Lote.

Nome	Tipo	Description
defaultAction	EndpointAccessDefaultAction	A ação padrão quando não há nenhum IPRule correspondente. Ação padrão para acesso ao ponto de extremidade. Ela só é aplicável quando publicNetworkAccess está habilitado.
ipRules	IPRule[]	Matriz de intervalos de IP para filtrar o endereço IP do cliente.

IPRule

Regra para filtrar o endereço IP do cliente.

Nome	Tipo	Description
action	IPRuleAction	Ação quando o endereço IP do cliente é correspondido.
value	string	O endereço IP ou intervalo de endereços IP a ser filtrado Endereço IPv4 ou intervalo de endereços IPv4 no formato CIDR.

IPRuleAction

Ação quando o endereço IP do cliente é correspondido.

Nome	Tipo	Description
Allow	string	Permitir acesso para o endereço IP do cliente correspondente.

KeySource

Tipo da origem da chave.

Nome	Tipo	Description
Microsoft.Batch	string	O Lote cria e gerencia as chaves de criptografia usadas para proteger os dados da conta.
Microsoft.KeyVault	string	As chaves de criptografia usadas para proteger os dados da conta são armazenadas em um cofre de chaves externo. Se isso for definido, a identidade da Conta do Lote deverá ser definida SystemAssigned como e um Identificador de Chave válido também deverá ser fornecido sob keyVaultProperties.

KeyVaultProperties

Configuração do KeyVault ao usar uma KeySource de criptografia do Microsoft.KeyVault.

Nome	Tipo	Description
keyIdentifier	string	Caminho completo para o segredo com ou sem versão. Exemplo https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. ou https://mykeyvault.vault.azure.net/keys/testkey. Para ser utilizável, os seguintes pré-requisitos devem ser atendidos: A Conta do Lote tem uma identidade atribuída pelo sistema A identidade da conta recebeu as permissões Key/Get, Key/Unwrap e Key/Wrap. O KeyVault tem a proteção contra exclusão reversível e limpeza habilitada

KeyVaultReference

Identifica o cofre de chaves do Azure associado a uma conta do Lote.

Nome	Tipo	Description
id	string	A ID de recurso do cofre de chaves do Azure associada à conta do Lote.
url	string	A URL do cofre de chaves do Azure associada à conta do Lote.

NetworkProfile

Perfil de rede para a conta do Lote, que contém as configurações de regra de rede para cada ponto de extremidade.

Nome	Tipo	Description
accountAccess	EndpointAccessProfile	Perfil de acesso à rede para o ponto de extremidade batchAccount (API do plano de dados da conta do Lote).
nodeManagementAccess	EndpointAccessProfile	Perfil de acesso à rede para o ponto de extremidade nodeManagement (serviço do Lote que gerencia nós de computação para pools do Lote).

PoolAllocationMode

O modo de alocação para criar pools na conta do Lote.

Nome	Tipo	Description
BatchService	string	Os pools serão alocados em assinaturas pertencentes ao serviço do Lote.
UserSubscription	string	Os pools serão alocados em uma assinatura de propriedade do usuário.

PrivateEndpoint

O ponto de extremidade privado da conexão de ponto de extremidade privado.

Nome	Tipo	Description
id	string	O identificador de recurso arm do ponto de extremidade privado. Este é do formulário /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Contém informações sobre um recurso de link privado.

Nome	Tipo	Description
etag	string	A ETag do recurso, usada para instruções de simultaneidade.
id	string	A ID do recurso.
name	string	O nome do recurso.
properties.groupIds	string[]	A ID do grupo da conexão de ponto de extremidade privado. O valor tem uma e apenas uma ID de grupo.
properties.privateEndpoint	PrivateEndpoint	O identificador de recurso arm do ponto de extremidade privado. O ponto de extremidade privado da conexão de ponto de extremidade privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	O estado de conexão do serviço de link privado da conexão de ponto de extremidade privado. O estado de conexão do serviço de link privado da conexão de ponto de extremidade privado
properties.provisioningState	PrivateEndpointConnectionProvisioningState	O estado de provisionamento da conexão de ponto de extremidade privado.
type	string	Tipo do recurso.

PrivateEndpointConnectionProvisioningState

O estado de provisionamento da conexão de ponto de extremidade privado.

Nome	Tipo	Description
Cancelled	string	O usuário cancelou a criação da conexão.
Creating	string	A conexão está sendo criada.
Deleting	string	A conexão está excluindo.
Failed	string	O usuário solicitou que a conexão fosse atualizada e ela falhou. Você pode repetir a operação de atualização.
Succeeded	string	A status de conexão é final e estará pronta para uso se Status for Aprovado.
Updating	string	O usuário solicitou que a conexão status ser atualizada, mas a operação de atualização ainda não foi concluída. Você não pode referenciar a conexão ao conectar a conta do Lote.

PrivateLinkServiceConnectionState

O estado de conexão do serviço de link privado da conexão de ponto de extremidade privado

Nome	Tipo	Description
actionsRequired	string	Ação necessária no estado de conexão privada
description	string	Descrição do estado de conexão privada
status	PrivateLinkServiceConnectionStatus	O status para a conexão de ponto de extremidade privado da conta do Lote

PrivateLinkServiceConnectionStatus

O status da conexão de ponto de extremidade privado do Lote

Nome	Tipo	Description
Approved	string	A conexão de ponto de extremidade privado é aprovada e pode ser usada para acessar a conta do Lote
Disconnected	string	A conexão de ponto de extremidade privado está desconectada e não pode ser usada para acessar a conta do Lote
Pending	string	A conexão de ponto de extremidade privado está pendente e não pode ser usada para acessar a conta do Lote
Rejected	string	A conexão de ponto de extremidade privado é rejeitada e não pode ser usada para acessar a conta do Lote

ProvisioningState

O estado provisionado do recurso

Nome	Tipo	Description
Cancelled	string	A última operação da conta foi cancelada.
Creating	string	A conta está sendo criada.
Deleting	string	A conta está sendo excluída.
Failed	string	Falha na última operação da conta.
Invalid	string	A conta está em um estado inválido.
Succeeded	string	A conta foi criada e está pronta para uso.

PublicNetworkAccessType

O tipo de acesso à rede para operar nos recursos na conta do Lote.

Nome	Tipo	Description
Disabled	string	Desabilita a conectividade pública e permite que a conectividade privada Lote do Azure Serviço por meio de um recurso de ponto de extremidade privado.
Enabled	string	Permite que a conectividade Lote do Azure por meio do DNS público.

ResourceIdentityType

O tipo de identidade usado para a conta do Lote.

Nome	Tipo	Description
None	string	A conta do Lote não tem nenhuma identidade associada a ela. A configuração None na conta de atualização removerá as identidades existentes.
SystemAssigned	string	A conta do Lote tem uma identidade atribuída pelo sistema com ela.
UserAssigned	string	A conta do Lote tem identidades atribuídas pelo usuário com ela.

UserAssignedIdentities

A lista de identidades de usuário associadas.

Nome	Tipo	Description
clientId	string	A ID do cliente da identidade atribuída pelo usuário.
principalId	string	A ID principal da identidade atribuída pelo usuário.

VirtualMachineFamilyCoreQuota

Uma Família de VMs e sua cota principal associada para a conta do Lote.

Nome	Tipo	Description
coreQuota	integer	A cota principal para a família de VMs da conta do Lote.
name	string	O nome da família da Máquina Virtual.