Batch Account - Get

Service:

Batch Management

API Version:

2024-02-01

Hiermee haalt u informatie op over het opgegeven Batch-account.

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

URI-parameters

Name	In	Vereist	Type	Description
accountName	path	True	string	De naam van het Batch-account. Regex pattern: ^[a-zA-Z0-9]+$
resourceGroupName	path	True	string	De naam van de resourcegroep die het Batch-account bevat.
subscriptionId	path	True	string	De Azure-abonnements-id. Dit is een tekenreeks in GUID-indeling (bijvoorbeeld 000000000-0000-0000-0000-000000000000)
api-version	query	True	string	De API-versie die moet worden gebruikt met de HTTP-aanvraag.

Antwoorden

Name	Type	Description
200 OK	BatchAccount	De bewerking is geslaagd. Het antwoord bevat de entiteit Batch-account.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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"
}

Definities

Name	Description
AuthenticationMode	De verificatiemodus voor het Batch-account.
AutoStorageAuthenticationMode	De verificatiemodus die door de Batch-service wordt gebruikt om het automatische opslagaccount te beheren.
AutoStorageProperties	Bevat informatie over het automatische opslagaccount dat is gekoppeld aan een Batch-account.
BatchAccount	Bevat informatie over een Azure Batch-account.
BatchAccountIdentity	De identiteit van het Batch-account, indien geconfigureerd. Dit wordt gebruikt wanneer de gebruiker 'Microsoft.KeyVault' opgeeft als de batch-accountversleutelingsconfiguratie of wanneer ManagedIdentity is geselecteerd als de verificatiemodus voor automatische opslag.
CloudError	Een foutreactie van de Batch-service.
CloudErrorBody	Een foutreactie van de Batch-service.
ComputeNodeIdentityReference	De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.
EncryptionProperties	Hiermee configureert u hoe klantgegevens worden versleuteld in het Batch-account. Accounts worden standaard versleuteld met behulp van een door Microsoft beheerde sleutel. Voor extra controle kan in plaats daarvan een door de klant beheerde sleutel worden gebruikt.
EndpointAccessDefaultAction	De standaardactie wanneer er geen IPRule overeenkomt.
EndpointAccessProfile	Netwerktoegangsprofiel voor Batch-eindpunt.
IPRule	Regel om het IP-adres van de client te filteren.
IPRuleAction	Actie wanneer het IP-adres van de client overeenkomt.
KeySource	Type van de sleutelbron.
KeyVaultProperties	KeyVault-configuratie bij gebruik van een versleutelingssleutelbron van Microsoft.KeyVault.
KeyVaultReference	Identificeert de Azure-sleutelkluis die is gekoppeld aan een Batch-account.
NetworkProfile	Netwerkprofiel voor Batch-account, dat netwerkregelinstellingen voor elk eindpunt bevat.
PoolAllocationMode	De toewijzingsmodus voor het maken van pools in het Batch-account.
PrivateEndpoint	Het privé-eindpunt van de privé-eindpuntverbinding.
PrivateEndpointConnection	Bevat informatie over een private link-resource.
PrivateEndpointConnectionProvisioningState	De inrichtingsstatus van de privé-eindpuntverbinding.
PrivateLinkServiceConnectionState	De verbindingsstatus van de Private Link-service van de privé-eindpuntverbinding
PrivateLinkServiceConnectionStatus	De status van de verbinding met het privé-eindpunt van Batch
ProvisioningState	De ingerichte status van de resource
PublicNetworkAccessType	Het netwerktoegangstype voor het uitvoeren van de resources in het Batch-account.
ResourceIdentityType	Het type identiteit dat wordt gebruikt voor het Batch-account.
UserAssignedIdentities	De lijst met gekoppelde gebruikersidentiteiten.
VirtualMachineFamilyCoreQuota	Een VM-serie en het bijbehorende kernquotum voor het Batch-account.

AuthenticationMode

De verificatiemodus voor het Batch-account.

Name	Type	Description
AAD	string	De verificatiemodus met Microsoft Entra ID.
SharedKey	string	De verificatiemodus met gedeelde sleutels.
TaskAuthenticationToken	string	De verificatiemodus met behulp van taakverificatietokens.

AutoStorageAuthenticationMode

De verificatiemodus die door de Batch-service wordt gebruikt om het automatische opslagaccount te beheren.

Name	Type	Description
BatchAccountManagedIdentity	string	De Batch-service verifieert aanvragen voor automatische opslag met behulp van de beheerde identiteit die is toegewezen aan het Batch-account.
StorageKeys	string	De Batch-service verifieert aanvragen voor automatische opslag met behulp van opslagaccountsleutels.

AutoStorageProperties

Bevat informatie over het automatische opslagaccount dat is gekoppeld aan een Batch-account.

Name	Type	Standaardwaarde	Description
authenticationMode	AutoStorageAuthenticationMode	StorageKeys	De verificatiemodus die door de Batch-service wordt gebruikt om het automatische opslagaccount te beheren.
lastKeySync	string		De UTC-tijd waarop opslagsleutels voor het laatst zijn gesynchroniseerd met het Batch-account.
nodeIdentityReference	ComputeNodeIdentityReference		De verwijzing naar de door de gebruiker toegewezen identiteit die rekenknooppunten gebruiken om toegang te krijgen tot automatische opslag. De identiteit waarnaar hier wordt verwezen, moet worden toegewezen aan pools met rekenknooppunten die toegang nodig hebben tot automatische opslag.
storageAccountId	string		De resource-id van het opslagaccount dat moet worden gebruikt voor een automatisch opslagaccount.

BatchAccount

Bevat informatie over een Azure Batch-account.

Name	Type	Standaardwaarde	Description
id	string		De id van de resource.
identity	BatchAccountIdentity		De identiteit van het Batch-account.
location	string		De locatie van de resource.
name	string		De naam van de resource.
properties.accountEndpoint	string		Het accounteindpunt dat wordt gebruikt voor interactie met de Batch-service.
properties.activeJobAndJobScheduleQuota	integer		Het quotum voor de actieve taak en taakplanning voor het Batch-account.
properties.allowedAuthenticationModes	AuthenticationMode[]		Lijst met toegestane verificatiemodi voor het Batch-account die kunnen worden gebruikt voor verificatie met het gegevensvlak. Dit heeft geen invloed op de verificatie met het besturingsvlak.
properties.autoStorage	AutoStorageProperties		De eigenschappen en status van een automatisch opslagaccount dat is gekoppeld aan het Batch-account. Bevat informatie over het automatische opslagaccount dat is gekoppeld aan een Batch-account.
properties.dedicatedCoreQuota	integer		Het toegewezen kernquotum voor het Batch-account. Voor accounts waarvoor PoolAllocationMode is ingesteld op UserSubscription, wordt het quotum beheerd voor het abonnement, zodat deze waarde niet wordt geretourneerd.
properties.dedicatedCoreQuotaPerVMFamily	VirtualMachineFamilyCoreQuota[]		Een lijst met het toegewezen kernquotum per virtuele-machinefamilie voor het Batch-account. Voor accounts waarvoor PoolAllocationMode is ingesteld op UserSubscription, wordt het quotum beheerd voor het abonnement, zodat deze waarde niet wordt geretourneerd.
properties.dedicatedCoreQuotaPerVMFamilyEnforced	boolean		Een waarde die aangeeft of kernquota per virtuele-machinefamilie worden afgedwongen voor dit account Als deze vlag waar is, wordt toegewezen kernquotum afgedwongen via de eigenschappen dedicatedCoreQuotaPerVMFamily en dedicatedCoreQuota voor het account. Als deze vlag onwaar is, wordt toegewezen kernquotum alleen afgedwongen via de eigenschap dedicatedCoreQuota in het account en wordt er geen rekening gehouden met de virtuele-machinefamilie.
properties.encryption	EncryptionProperties		De versleutelingsconfiguratie voor het Batch-account. Hiermee configureert u hoe klantgegevens worden versleuteld in het Batch-account. Accounts worden standaard versleuteld met behulp van een door Microsoft beheerde sleutel. Voor extra controle kan in plaats daarvan een door de klant beheerde sleutel worden gebruikt.
properties.keyVaultReference	KeyVaultReference		Een verwijzing naar de Azure-sleutelkluis die is gekoppeld aan het Batch-account. Identificeert de Azure-sleutelkluis die is gekoppeld aan een Batch-account.
properties.lowPriorityCoreQuota	integer		Het kernquotum spot/lage prioriteit voor het Batch-account. Voor accounts waarvoor PoolAllocationMode is ingesteld op UserSubscription, wordt het quotum beheerd voor het abonnement, zodat deze waarde niet wordt geretourneerd.
properties.networkProfile	NetworkProfile		Netwerkprofiel voor Batch-account, dat netwerkregelinstellingen voor elk eindpunt bevat. Het netwerkprofiel wordt alleen van kracht wanneer publicNetworkAccess is ingeschakeld.
properties.nodeManagementEndpoint	string		Het eindpunt dat door het rekenknooppunt wordt gebruikt om verbinding te maken met de Batch-knooppuntbeheerservice.
properties.poolAllocationMode	PoolAllocationMode		De toewijzingsmodus die moet worden gebruikt om pools te maken in het Batch-account. De toewijzingsmodus voor het maken van pools in het Batch-account.
properties.poolQuota	integer		Het poolquotum voor het Batch-account.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lijst met privé-eindpuntverbindingen die zijn gekoppeld aan het Batch-account
properties.provisioningState	ProvisioningState		De ingerichte status van de resource
properties.publicNetworkAccess	PublicNetworkAccessType	Enabled	Het netwerkinterfacetype voor toegang tot Azure Batch service- en Batch-accountbewerkingen. Als u dit niet opgeeft, is de standaardwaarde ingeschakeld.
tags	object		De tags van de resource.
type	string		Het type resource.

BatchAccountIdentity

De identiteit van het Batch-account, indien geconfigureerd. Dit wordt gebruikt wanneer de gebruiker 'Microsoft.KeyVault' opgeeft als de batch-accountversleutelingsconfiguratie of wanneer ManagedIdentity is geselecteerd als de verificatiemodus voor automatische opslag.

Name	Type	Description
principalId	string	De principal-id van het Batch-account. Deze eigenschap wordt alleen opgegeven voor een door het systeem toegewezen identiteit.
tenantId	string	De tenant-id die is gekoppeld aan het Batch-account. Deze eigenschap wordt alleen opgegeven voor een door het systeem toegewezen identiteit.
type	ResourceIdentityType	Het type identiteit dat wordt gebruikt voor het Batch-account.
userAssignedIdentities	object	De lijst met gebruikersidentiteiten die zijn gekoppeld aan het Batch-account.

CloudError

Een foutreactie van de Batch-service.

Name	Type	Description
error	CloudErrorBody	De hoofdtekst van het foutbericht.

CloudErrorBody

Een foutreactie van de Batch-service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap fout.

ComputeNodeIdentityReference

De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.

Name	Type	Description
resourceId	string	De ARM-resource-id van de door de gebruiker toegewezen identiteit.

EncryptionProperties

Hiermee configureert u hoe klantgegevens worden versleuteld in het Batch-account. Accounts worden standaard versleuteld met behulp van een door Microsoft beheerde sleutel. Voor extra controle kan in plaats daarvan een door de klant beheerde sleutel worden gebruikt.

Name	Type	Description
keySource	KeySource	Type van de sleutelbron.
keyVaultProperties	KeyVaultProperties	Aanvullende informatie bij het gebruik van Microsoft.KeyVault

EndpointAccessDefaultAction

De standaardactie wanneer er geen IPRule overeenkomt.

Name	Type	Description
Allow	string	Clienttoegang toestaan.
Deny	string	Clienttoegang weigeren.

EndpointAccessProfile

Netwerktoegangsprofiel voor Batch-eindpunt.

Name	Type	Description
defaultAction	EndpointAccessDefaultAction	De standaardactie wanneer er geen IPRule overeenkomt. Standaardactie voor toegang tot eindpunten. Dit is alleen van toepassing wanneer publicNetworkAccess is ingeschakeld.
ipRules	IPRule[]	Matrix van IP-bereiken om het IP-adres van de client te filteren.

IPRule

Regel om het IP-adres van de client te filteren.

Name	Type	Description
action	IPRuleAction	Actie wanneer het IP-adres van de client overeenkomt.
value	string	Het IP-adres of IP-adresbereik dat moet worden gefilterd IPv4-adres of IPv4-adresbereik in CIDR-indeling.

IPRuleAction

Actie wanneer het IP-adres van de client overeenkomt.

Name	Type	Description
Allow	string	Sta toegang toe voor het overeenkomende IP-adres van de client.

KeySource

Type van de sleutelbron.

Name	Type	Description
Microsoft.Batch	string	Batch maakt en beheert de versleutelingssleutels die worden gebruikt om de accountgegevens te beveiligen.
Microsoft.KeyVault	string	De versleutelingssleutels die worden gebruikt om de accountgegevens te beveiligen, worden opgeslagen in een externe sleutelkluis. Als dit is ingesteld, moet de identiteit van het Batch-account worden ingesteld op SystemAssigned en moet er ook een geldige sleutel-id worden opgegeven onder de keyVaultProperties.

KeyVaultProperties

KeyVault-configuratie bij gebruik van een versleutelingssleutelbron van Microsoft.KeyVault.

Name	Type	Description
keyIdentifier	string	Volledig pad naar het geheim met of zonder versie. Voorbeeld https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. https://mykeyvault.vault.azure.net/keys/testkey gebruiken. Om bruikbaar te zijn, moet aan de volgende vereisten worden voldaan: Het Batch-account heeft een door het systeem toegewezen identiteit De accountidentiteit heeft machtigingen voor sleutel/ophalen, sleutel/uitpakken en sleutel/verpakken de sleutelkluis heeft voorlopig verwijderen en opschonen ingeschakeld

KeyVaultReference

Identificeert de Azure-sleutelkluis die is gekoppeld aan een Batch-account.

Name	Type	Description
id	string	De resource-id van de Azure-sleutelkluis die is gekoppeld aan het Batch-account.
url	string	De URL van de Azure-sleutelkluis die is gekoppeld aan het Batch-account.

NetworkProfile

Netwerkprofiel voor Batch-account, dat netwerkregelinstellingen voor elk eindpunt bevat.

Name	Type	Description
accountAccess	EndpointAccessProfile	Netwerktoegangsprofiel voor batchAccount-eindpunt (Gegevensvlak-API voor Batch-account).
nodeManagementAccess	EndpointAccessProfile	Netwerktoegangsprofiel voor nodeManagement-eindpunt (Batch-service die rekenknooppunten voor Batch-pools beheert).

PoolAllocationMode

De toewijzingsmodus voor het maken van pools in het Batch-account.

Name	Type	Description
BatchService	string	Pools worden toegewezen in abonnementen die eigendom zijn van de Batch-service.
UserSubscription	string	Pools worden toegewezen in een abonnement dat eigendom is van de gebruiker.

PrivateEndpoint

Het privé-eindpunt van de privé-eindpuntverbinding.

Name	Type	Description
id	string	De ARM-resource-id van het privé-eindpunt. Dit heeft de vorm /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Bevat informatie over een private link-resource.

Name	Type	Description
etag	string	De ETag van de resource, die wordt gebruikt voor gelijktijdigheidsinstructies.
id	string	De id van de resource.
name	string	De naam van de resource.
properties.groupIds	string[]	De groeps-id van de privé-eindpuntverbinding. De waarde heeft slechts één groeps-id.
properties.privateEndpoint	PrivateEndpoint	De ARM-resource-id van het privé-eindpunt. Het privé-eindpunt van de privé-eindpuntverbinding.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	De verbindingsstatus van de private link-service van de privé-eindpuntverbinding. De verbindingsstatus van de private link-service van de privé-eindpuntverbinding
properties.provisioningState	PrivateEndpointConnectionProvisioningState	De inrichtingsstatus van de privé-eindpuntverbinding.
type	string	Het type resource.

PrivateEndpointConnectionProvisioningState

De inrichtingsstatus van de privé-eindpuntverbinding.

Name	Type	Description
Cancelled	string	De gebruiker heeft het maken van de verbinding geannuleerd.
Creating	string	De verbinding wordt gemaakt.
Deleting	string	De verbinding wordt verwijderd.
Failed	string	De gebruiker heeft gevraagd om de verbinding bij te werken, maar dit is mislukt. U kunt de updatebewerking opnieuw proberen.
Succeeded	string	De verbindingsstatus is definitief en kan worden gebruikt als de status Goedgekeurd is.
Updating	string	De gebruiker heeft gevraagd de verbindingsstatus bij te werken, maar de updatebewerking is nog niet voltooid. U mag niet verwijzen naar de verbinding wanneer u verbinding maakt met het Batch-account.

PrivateLinkServiceConnectionState

De verbindingsstatus van de Private Link-service van de privé-eindpuntverbinding

Name	Type	Description
actionsRequired	string	Actie vereist voor de status van de privéverbinding
description	string	Beschrijving van de privéverbindingsstatus
status	PrivateLinkServiceConnectionStatus	De status voor de privé-eindpuntverbinding van het Batch-account

PrivateLinkServiceConnectionStatus

De status van de verbinding met het privé-eindpunt van Batch

Name	Type	Description
Approved	string	De verbinding met het privé-eindpunt is goedgekeurd en kan worden gebruikt voor toegang tot het Batch-account
Disconnected	string	De verbinding met het privé-eindpunt is verbroken en kan niet worden gebruikt voor toegang tot het Batch-account
Pending	string	De privé-eindpuntverbinding is in behandeling en kan niet worden gebruikt voor toegang tot het Batch-account
Rejected	string	De verbinding met het privé-eindpunt is geweigerd en kan niet worden gebruikt voor toegang tot het Batch-account

ProvisioningState

De ingerichte status van de resource

Name	Type	Description
Cancelled	string	De laatste bewerking voor het account wordt geannuleerd.
Creating	string	Het account wordt gemaakt.
Deleting	string	Het account wordt verwijderd.
Failed	string	De laatste bewerking voor het account is mislukt.
Invalid	string	Het account heeft een ongeldige status.
Succeeded	string	Het account is gemaakt en is klaar voor gebruik.

PublicNetworkAccessType

Het netwerktoegangstype voor het uitvoeren van de resources in het Batch-account.

Name	Type	Description
Disabled	string	Hiermee schakelt u openbare connectiviteit uit en schakelt u privéconnectiviteit met Azure Batch Service in via een privé-eindpuntresource.
Enabled	string	Hiermee kunt u connectiviteit met Azure Batch via openbare DNS.

ResourceIdentityType

Het type identiteit dat wordt gebruikt voor het Batch-account.

Name	Type	Description
None	string	Er is geen identiteit aan het Batch-account gekoppeld. Als u het account bijwerken instelt None , worden bestaande identiteiten verwijderd.
SystemAssigned	string	Batch-account heeft een door het systeem toegewezen identiteit.
UserAssigned	string	Batch-account heeft door de gebruiker toegewezen identiteiten.

UserAssignedIdentities

De lijst met gekoppelde gebruikersidentiteiten.

Name	Type	Description
clientId	string	De client-id van de door de gebruiker toegewezen identiteit.
principalId	string	De principal-id van de door de gebruiker toegewezen identiteit.

VirtualMachineFamilyCoreQuota

Een VM-serie en het bijbehorende kernquotum voor het Batch-account.

Name	Type	Description
coreQuota	integer	Het kernquotum voor de VM-familie voor het Batch-account.
name	string	De naam van de virtuele machinefamilie.