Batch Account - Get

Référence

Service:: Batch Management

Version d'API:: 2024-02-01

Obtient des informations sur le compte Batch spécifié.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string	Le nom du compte Batch. Modèle d’expression régulière: `^[a-zA-Z0-9]+$`
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient le compte Batch.
subscriptionId	path	True	string	L’ID d’abonnement Azure. Il s’agit d’une chaîne au format GUID (par exemple, 0000000-0000-0000-0000-000000000000000)
api-version	query	True	string	Version de l’API à utiliser avec la requête HTTP.

Réponses

Nom	Type	Description
200 OK	BatchAccount	L'opération a réussi. La réponse contient l’entité de compte Batch.
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

flux de code d’authentification OAuth 2.0 Microsoft Entra

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

BatchAccountGet

PrivateBatchAccountGet

BatchAccountGet

Exemple de requête

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


/**
 * 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

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

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

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

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

Exemple de réponse

Code d’état:: 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

Exemple de requête

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


/**
 * 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

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

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

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

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

Exemple de réponse

Code d’état:: 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"
}

Définitions

Nom	Description
AuthenticationMode	Mode d’authentification pour le compte Batch.
AutoStorageAuthenticationMode	Mode d’authentification utilisé par le service Batch pour gérer le compte de stockage automatique.
AutoStorageProperties	Contient des informations sur le compte de stockage automatique associé à un compte Batch.
BatchAccount	Contient des informations sur un compte Azure Batch.
BatchAccountIdentity	Identité du compte Batch, si configuré. Il est utilisé lorsque l’utilisateur spécifie « Microsoft.KeyVault » comme configuration de chiffrement de son compte Batch ou quand `ManagedIdentity` est sélectionné comme mode d’authentification de stockage automatique.
CloudError	Réponse d’erreur du service Batch.
CloudErrorBody	Réponse d’erreur du service Batch.
ComputeNodeIdentityReference	Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera.
EncryptionProperties	Configure la façon dont les données du client sont chiffrées à l’intérieur du compte Batch. Par défaut, les comptes sont chiffrés à l’aide d’une clé managée Microsoft. Pour un contrôle supplémentaire, une clé gérée par le client peut être utilisée à la place.
EndpointAccessDefaultAction	Action par défaut lorsqu’aucune valeur IPRule n’est mise en correspondance.
EndpointAccessProfile	Profil d’accès réseau pour le point de terminaison Batch.
IPRule	Règle pour filtrer l’adresse IP du client.
IPRuleAction	Action lorsque l’adresse IP du client est mise en correspondance.
KeySource	Type de la source de clé.
KeyVaultProperties	Configuration de KeyVault lors de l’utilisation d’un KeySource de chiffrement de Microsoft.KeyVault.
KeyVaultReference	Identifie le coffre de clés Azure associé à un compte Batch.
NetworkProfile	Profil réseau pour le compte Batch, qui contient les paramètres de règle réseau pour chaque point de terminaison.
PoolAllocationMode	Mode d’allocation pour la création de pools dans le compte Batch.
PrivateEndpoint	Point de terminaison privé de la connexion de point de terminaison privé.
PrivateEndpointConnection	Contient des informations sur une ressource de liaison privée.
PrivateEndpointConnectionProvisioningState	État d’approvisionnement de la connexion de point de terminaison privé.
PrivateLinkServiceConnectionState	État de connexion du service de liaison privée de la connexion de point de terminaison privé
PrivateLinkServiceConnectionStatus	Status de la connexion de point de terminaison privé Batch
ProvisioningState	État provisionné de la ressource
PublicNetworkAccessType	Type d’accès réseau pour fonctionner sur les ressources dans le compte Batch.
ResourceIdentityType	Type d’identité utilisé pour le compte Batch.
UserAssignedIdentities	Liste des identités utilisateur associées.
VirtualMachineFamilyCoreQuota	Une famille de machines virtuelles et son quota de cœurs associé pour le compte Batch.

AuthenticationMode

Mode d’authentification pour le compte Batch.

Nom	Type	Description
AAD	string	Mode d’authentification à l’aide de Microsoft Entra ID.
SharedKey	string	Mode d’authentification à l’aide de clés partagées.
TaskAuthenticationToken	string	Mode d’authentification à l’aide de jetons d’authentification de tâche.

AutoStorageAuthenticationMode

Mode d’authentification utilisé par le service Batch pour gérer le compte de stockage automatique.

Nom	Type	Description
BatchAccountManagedIdentity	string	Le service Batch authentifie les demandes de stockage automatique à l’aide de l’identité managée affectée au compte Batch.
StorageKeys	string	Le service Batch authentifie les demandes de stockage automatique à l’aide de clés de compte de stockage.

AutoStorageProperties

Contient des informations sur le compte de stockage automatique associé à un compte Batch.

Nom	Type	Valeur par défaut	Description
authenticationMode	AutoStorageAuthenticationMode	StorageKeys	Mode d’authentification utilisé par le service Batch pour gérer le compte de stockage automatique.
lastKeySync	string		Heure UTC à laquelle les clés de stockage ont été synchronisées pour la dernière fois avec le compte Batch.
nodeIdentityReference	ComputeNodeIdentityReference		Référence à l’identité affectée par l’utilisateur que les nœuds de calcul utiliseront pour accéder au stockage automatique. L’identité référencée ici doit être affectée aux pools qui ont des nœuds de calcul qui ont besoin d’accéder au stockage automatique.
storageAccountId	string		ID de ressource du compte de stockage à utiliser pour le compte de stockage automatique.

BatchAccount

Contient des informations sur un compte Azure Batch.

Nom	Type	Valeur par défaut	Description
id	string		ID de la ressource.
identity	BatchAccountIdentity		Identité du compte Batch.
location	string		Emplacement de la ressource.
name	string		Nom de la ressource.
properties.accountEndpoint	string		Point de terminaison de compte utilisé pour interagir avec le service Batch.
properties.activeJobAndJobScheduleQuota	integer		Quota de planification de travail et de travail actif pour le compte Batch.
properties.allowedAuthenticationModes	AuthenticationMode[]		Liste des modes d’authentification autorisés pour le compte Batch qui peuvent être utilisés pour s’authentifier auprès du plan de données. Cela n’affecte pas l’authentification avec le plan de contrôle.
properties.autoStorage	AutoStorageProperties		Propriétés et status de tout compte de stockage automatique associé au compte Batch. Contient des informations sur le compte de stockage automatique associé à un compte Batch.
properties.dedicatedCoreQuota	integer		Quota de cœurs dédiés pour le compte Batch. Pour les comptes avec PoolAllocationMode défini sur UserSubscription, le quota est géré sur l’abonnement. Cette valeur n’est donc pas retournée.
properties.dedicatedCoreQuotaPerVMFamily	VirtualMachineFamilyCoreQuota[]		Liste du quota de cœurs dédiés par famille de machines virtuelles pour le compte Batch. Pour les comptes avec PoolAllocationMode défini sur UserSubscription, le quota est géré sur l’abonnement. Cette valeur n’est donc pas retournée.
properties.dedicatedCoreQuotaPerVMFamilyEnforced	boolean		Valeur indiquant si les quotas de cœur par famille de machines virtuelles sont appliqués pour ce compte Si cet indicateur a la valeur true, le quota de cœurs dédiés est appliqué via les propriétés dedicatedCoreQuotaPerVMFamily et dedicatedCoreQuota sur le compte. Si cet indicateur est false, le quota de cœurs dédiés est appliqué uniquement via la propriété dedicatedCoreQuota sur le compte et ne prend pas en compte la famille de machines virtuelles.
properties.encryption	EncryptionProperties		Configuration de chiffrement pour le compte Batch. Configure la façon dont les données du client sont chiffrées à l’intérieur du compte Batch. Par défaut, les comptes sont chiffrés à l’aide d’une clé managée Microsoft. Pour un contrôle supplémentaire, une clé gérée par le client peut être utilisée à la place.
properties.keyVaultReference	KeyVaultReference		Référence au coffre de clés Azure associé au compte Batch. Identifie le coffre de clés Azure associé à un compte Batch.
properties.lowPriorityCoreQuota	integer		Quota de cœurs Spot/basse priorité pour le compte Batch. Pour les comptes avec PoolAllocationMode défini sur UserSubscription, le quota est géré sur l’abonnement. Cette valeur n’est donc pas retournée.
properties.networkProfile	NetworkProfile		Profil réseau pour le compte Batch, qui contient les paramètres de règle réseau pour chaque point de terminaison. Le profil réseau prend effet uniquement lorsque publicNetworkAccess est activé.
properties.nodeManagementEndpoint	string		Point de terminaison utilisé par le nœud de calcul pour se connecter au service de gestion des nœuds Batch.
properties.poolAllocationMode	PoolAllocationMode		Mode d’allocation à utiliser pour créer des pools dans le compte Batch. Mode d’allocation pour la création de pools dans le compte Batch.
properties.poolQuota	integer		Quota de pool pour le compte Batch.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Liste des connexions de point de terminaison privé associées au compte Batch
properties.provisioningState	ProvisioningState		État provisionné de la ressource
properties.publicNetworkAccess	PublicNetworkAccessType	Enabled	Type d’interface réseau permettant d’accéder à Azure Batch service et aux opérations de compte Batch. Si elle n’est pas spécifiée, la valeur par défaut est « enabled ».
tags	object		Balises de la ressource.
type	string		Type de la ressource.

BatchAccountIdentity

Identité du compte Batch, si configuré. Il est utilisé lorsque l’utilisateur spécifie « Microsoft.KeyVault » comme configuration de chiffrement de son compte Batch ou quand ManagedIdentity est sélectionné comme mode d’authentification de stockage automatique.

Nom	Type	Description
principalId	string	ID principal du compte Batch. Cette propriété est fournie uniquement pour une identité affectée par le système.
tenantId	string	ID de locataire associé au compte Batch. Cette propriété est fournie uniquement pour une identité affectée par le système.
type	ResourceIdentityType	Type d’identité utilisé pour le compte Batch.
userAssignedIdentities	<string, UserAssignedIdentities>	Liste des identités d’utilisateur associées au compte Batch.

CloudError

Réponse d’erreur du service Batch.

Nom	Type	Description
error	CloudErrorBody	Corps de la réponse d’erreur.

CloudErrorBody

Réponse d’erreur du service Batch.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété dans l’erreur.

ComputeNodeIdentityReference

Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera.

Nom	Type	Description
resourceId	string	ID de ressource ARM de l’identité affectée par l’utilisateur.

EncryptionProperties

Configure la façon dont les données du client sont chiffrées à l’intérieur du compte Batch. Par défaut, les comptes sont chiffrés à l’aide d’une clé managée Microsoft. Pour un contrôle supplémentaire, une clé gérée par le client peut être utilisée à la place.

Nom	Type	Description
keySource	KeySource	Type de la source de clé.
keyVaultProperties	KeyVaultProperties	Détails supplémentaires lors de l’utilisation de Microsoft.KeyVault

EndpointAccessDefaultAction

Action par défaut lorsqu’aucune valeur IPRule n’est mise en correspondance.

Nom	Type	Description
Allow	string	Autoriser l’accès client.
Deny	string	Refuser l’accès au client.

EndpointAccessProfile

Profil d’accès réseau pour le point de terminaison Batch.

Nom	Type	Description
defaultAction	EndpointAccessDefaultAction	Action par défaut lorsqu’aucune valeur IPRule n’est mise en correspondance. Action par défaut pour l’accès au point de terminaison. Elle s’applique uniquement lorsque publicNetworkAccess est activé.
ipRules	IPRule[]	Tableau de plages d’adresses IP pour filtrer l’adresse IP du client.

IPRule

Règle pour filtrer l’adresse IP du client.

Nom	Type	Description
action	IPRuleAction	Action lorsque l’adresse IP du client est mise en correspondance.
value	string	Adresse IP ou plage d’adresses IP à filtrer Adresse IPv4 ou plage d’adresses IPv4 au format CIDR.

IPRuleAction

Action lorsque l’adresse IP du client est mise en correspondance.

Nom	Type	Description
Allow	string	Autorisez l’accès à l’adresse IP du client correspondant.

KeySource

Type de la source de clé.

Nom	Type	Description
Microsoft.Batch	string	Batch crée et gère les clés de chiffrement utilisées pour protéger les données du compte.
Microsoft.KeyVault	string	Les clés de chiffrement utilisées pour protéger les données du compte sont stockées dans un coffre de clés externe. Si ce paramètre est défini, l’identité du compte Batch doit être définie sur `SystemAssigned` et un identificateur de clé valide doit également être fourni sous keyVaultProperties.

KeyVaultProperties

Configuration de KeyVault lors de l’utilisation d’un KeySource de chiffrement de Microsoft.KeyVault.

Nom	Type	Description
keyIdentifier	string	Chemin d’accès complet au secret avec ou sans version. Par exemple : https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. ou https://mykeyvault.vault.azure.net/keys/testkey. Pour être utilisable, les conditions préalables suivantes doivent être remplies : Le compte Batch a une identité affectée par le système L’identité du compte a reçu les autorisations Clé/Obtenir, Clé/Unwrap et Clé/Wrap Le Coffre de clés a la suppression réversible et la protection contre le vidage activée

Nom

Type

Description

keyIdentifier

string

Chemin d’accès complet au secret avec ou sans version. Par exemple : https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. ou https://mykeyvault.vault.azure.net/keys/testkey. Pour être utilisable, les conditions préalables suivantes doivent être remplies :

Le compte Batch a une identité affectée par le système L’identité du compte a reçu les autorisations Clé/Obtenir, Clé/Unwrap et Clé/Wrap Le Coffre de clés a la suppression réversible et la protection contre le vidage activée

KeyVaultReference

Identifie le coffre de clés Azure associé à un compte Batch.

Nom	Type	Description
id	string	ID de ressource du coffre de clés Azure associé au compte Batch.
url	string	URL du coffre de clés Azure associé au compte Batch.

NetworkProfile

Profil réseau pour le compte Batch, qui contient les paramètres de règle réseau pour chaque point de terminaison.

Nom	Type	Description
accountAccess	EndpointAccessProfile	Profil d’accès réseau pour le point de terminaison batchAccount (API de plan de données de compte Batch).
nodeManagementAccess	EndpointAccessProfile	Profil d’accès réseau pour le point de terminaison nodeManagement (service Batch gérant les nœuds de calcul pour les pools Batch).

PoolAllocationMode

Mode d’allocation pour la création de pools dans le compte Batch.

Nom	Type	Description
BatchService	string	Les pools seront alloués dans les abonnements appartenant au service Batch.
UserSubscription	string	Les pools seront alloués dans un abonnement appartenant à l’utilisateur.

PrivateEndpoint

Point de terminaison privé de la connexion de point de terminaison privé.

Nom	Type	Description
id	string	Identificateur de ressource ARM du point de terminaison privé. Il s’agit de la forme /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Contient des informations sur une ressource de liaison privée.

Nom	Type	Description
etag	string	ETag de la ressource, utilisé pour les instructions d’accès concurrentiel.
id	string	ID de la ressource.
name	string	Nom de la ressource.
properties.groupIds	string[]	ID de groupe de la connexion de point de terminaison privé. La valeur a un seul ID de groupe.
properties.privateEndpoint	PrivateEndpoint	Identificateur de ressource ARM du point de terminaison privé. Point de terminaison privé de la connexion de point de terminaison privé.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	État de connexion du service de liaison privée de la connexion de point de terminaison privé. État de connexion du service de liaison privée de la connexion de point de terminaison privé
properties.provisioningState	PrivateEndpointConnectionProvisioningState	État d’approvisionnement de la connexion de point de terminaison privé.
type	string	Type de la ressource.

PrivateEndpointConnectionProvisioningState

État d’approvisionnement de la connexion de point de terminaison privé.

Nom	Type	Description
Cancelled	string	L’utilisateur a annulé la création de la connexion.
Creating	string	La connexion est en cours de création.
Deleting	string	La connexion est en cours de suppression.
Failed	string	L’utilisateur a demandé que la connexion soit mise à jour et elle a échoué. Vous pouvez réessayer l’opération de mise à jour.
Succeeded	string	Le status de connexion est final et prêt à être utilisé si l’état est Approuvé.
Updating	string	L’utilisateur a demandé que la connexion status être mise à jour, mais l’opération de mise à jour n’est pas encore terminée. Vous ne pouvez pas référencer la connexion lors de la connexion au compte Batch.

PrivateLinkServiceConnectionState

État de connexion du service de liaison privée de la connexion de point de terminaison privé

Nom	Type	Description
actionsRequired	string	Action requise sur l’état de la connexion privée
description	string	Description de l’état de la connexion privée
status	PrivateLinkServiceConnectionStatus	Status pour la connexion de point de terminaison privé du compte Batch

PrivateLinkServiceConnectionStatus

Status de la connexion de point de terminaison privé Batch

Nom	Type	Description
Approved	string	La connexion de point de terminaison privé est approuvée et peut être utilisée pour accéder au compte Batch
Disconnected	string	La connexion de point de terminaison privé est déconnectée et ne peut pas être utilisée pour accéder au compte Batch
Pending	string	La connexion de point de terminaison privé est en attente et ne peut pas être utilisée pour accéder au compte Batch
Rejected	string	La connexion de point de terminaison privé est rejetée et ne peut pas être utilisée pour accéder au compte Batch

ProvisioningState

État provisionné de la ressource

Nom	Type	Description
Cancelled	string	La dernière opération du compte est annulée.
Creating	string	Le compte est en cours de création.
Deleting	string	Le compte est en cours de suppression.
Failed	string	La dernière opération du compte a échoué.
Invalid	string	Le compte est dans un état non valide.
Succeeded	string	Le compte a été créé et est prêt à être utilisé.

PublicNetworkAccessType

Type d’accès réseau pour fonctionner sur les ressources dans le compte Batch.

Nom	Type	Description
Disabled	string	Désactive la connectivité publique et active la connectivité privée à Azure Batch Service via une ressource de point de terminaison privé.
Enabled	string	Active la connectivité à Azure Batch via le DNS public.

ResourceIdentityType

Type d’identité utilisé pour le compte Batch.

Nom	Type	Description
None	string	Aucune identité n’est associée au compte Batch. La définition `None` dans le compte de mise à jour supprime les identités existantes.
SystemAssigned	string	Le compte Batch possède une identité affectée par le système.
UserAssigned	string	Le compte Batch comporte des identités affectées par l’utilisateur.

UserAssignedIdentities

Liste des identités utilisateur associées.

Nom	Type	Description
clientId	string	ID client de l’identité affectée par l’utilisateur.
principalId	string	ID principal de l’identité affectée par l’utilisateur.

VirtualMachineFamilyCoreQuota

Une famille de machines virtuelles et son quota de cœurs associé pour le compte Batch.

Nom	Type	Description
coreQuota	integer	Quota de cœurs pour la famille de machines virtuelles pour le compte Batch.
name	string	Nom de la famille de la machine virtuelle.

Partager via

Batch Account - Get

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

BatchAccountGet

Exemple de requête

Exemple de réponse

PrivateBatchAccountGet

Exemple de requête

Exemple de réponse

Définitions

AuthenticationMode

AutoStorageAuthenticationMode

AutoStorageProperties

BatchAccount

BatchAccountIdentity

CloudError

CloudErrorBody

ComputeNodeIdentityReference

EncryptionProperties

EndpointAccessDefaultAction

EndpointAccessProfile

IPRule

IPRuleAction

KeySource

KeyVaultProperties

KeyVaultReference

NetworkProfile

PoolAllocationMode

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningState

PublicNetworkAccessType

ResourceIdentityType

UserAssignedIdentities

VirtualMachineFamilyCoreQuota

Ressources supplémentaires