Batch Account - Get

Service:

Batch Management

API Version:

2024-02-01

Ruft Informationen zum angegebenen Batch-Konto ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string	Der Name des Batch-Kontos. Regex pattern: ^[a-zA-Z0-9]+$
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die das Batch-Konto enthält.
subscriptionId	path	True	string	Die Azure-Abonnement-ID. Dies ist eine GUID-formatierte Zeichenfolge (z. B. 000000000-0000-0000-000000000000000000000)
api-version	query	True	string	Die API-Version, die mit der HTTP-Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	BatchAccount	Der Vorgang wurde durchgeführt. Die Antwort enthält die Batch-Kontoentität.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodeflow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name	Beschreibung
AuthenticationMode	Der Authentifizierungsmodus für das Batch-Konto.
AutoStorageAuthenticationMode	Der Authentifizierungsmodus, den der Batch-Dienst zum Verwalten des Kontos für den automatischen Speicher verwendet.
AutoStorageProperties	Enthält Informationen zum Autospeicherkonto, das einem Batch-Konto zugeordnet ist.
BatchAccount	Enthält Informationen zu einem Azure Batch-Konto.
BatchAccountIdentity	Die Identität des Batch-Kontos, sofern konfiguriert. Dies wird verwendet, wenn der Benutzer "Microsoft.KeyVault" als Verschlüsselungskonfiguration für das Batch-Konto angibt oder wenn ManagedIdentity als Authentifizierungsmodus für die automatische Speicherung ausgewählt ist.
CloudError	Eine Fehlerantwort des Batch-Diensts.
CloudErrorBody	Eine Fehlerantwort des Batch-Diensts.
ComputeNodeIdentityReference	Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.
EncryptionProperties	Konfiguriert, wie Kundendaten innerhalb des Batch-Kontos verschlüsselt werden. Standardmäßig werden Konten mit einem von Microsoft verwalteten Schlüssel verschlüsselt. Für zusätzliche Steuerung kann stattdessen ein kundenseitig verwalteter Schlüssel verwendet werden.
EndpointAccessDefaultAction	Die Standardaktion, wenn keine IPRule übereinstimmt.
EndpointAccessProfile	Netzwerkzugriffsprofil für Batch-Endpunkt.
IPRule	Regel zum Filtern der Client-IP-Adresse.
IPRuleAction	Aktion, wenn die Client-IP-Adresse abgeglichen wird.
KeySource	Typ der Schlüsselquelle.
KeyVaultProperties	KeyVault-Konfiguration bei Verwendung einer Verschlüsselungs-KeySource von Microsoft.KeyVault.
KeyVaultReference	Identifiziert den Azure-Schlüsseltresor, der einem Batch-Konto zugeordnet ist.
NetworkProfile	Netzwerkprofil für das Batch-Konto, das Netzwerkregeleinstellungen für jeden Endpunkt enthält.
PoolAllocationMode	Der Zuordnungsmodus zum Erstellen von Pools im Batch-Konto.
PrivateEndpoint	Der private Endpunkt der Verbindung mit dem privaten Endpunkt.
PrivateEndpointConnection	Enthält Informationen zu einer Private Link-Ressource.
PrivateEndpointConnectionProvisioningState	Der Bereitstellungsstatus der Privaten Endpunktverbindung.
PrivateLinkServiceConnectionState	Der Verbindungsstatus des Private Link-Diensts der Verbindung mit dem privaten Endpunkt
PrivateLinkServiceConnectionStatus	Die status der Privaten Batch-Endpunktverbindung
ProvisioningState	Der bereitgestellte Zustand der Ressource
PublicNetworkAccessType	Der Netzwerkzugriffstyp für den Betrieb mit den Ressourcen im Batch-Konto.
ResourceIdentityType	Der Identitätstyp, der für das Batch-Konto verwendet wird.
UserAssignedIdentities	Die Liste der zugeordneten Benutzeridentitäten.
VirtualMachineFamilyCoreQuota	Eine VM-Familie und das zugehörige Kernkontingent für das Batch-Konto.

AuthenticationMode

Der Authentifizierungsmodus für das Batch-Konto.

Name	Typ	Beschreibung
AAD	string	Der Authentifizierungsmodus mit Microsoft Entra ID.
SharedKey	string	Der Authentifizierungsmodus mit freigegebenen Schlüsseln.
TaskAuthenticationToken	string	Der Authentifizierungsmodus mit Aufgabenauthentifizierungstoken.

AutoStorageAuthenticationMode

Der Authentifizierungsmodus, den der Batch-Dienst zum Verwalten des Kontos für den automatischen Speicher verwendet.

Name	Typ	Beschreibung
BatchAccountManagedIdentity	string	Der Batch-Dienst authentifiziert Anforderungen an die automatische Speicherung mithilfe der verwalteten Identität, die dem Batch-Konto zugewiesen ist.
StorageKeys	string	Der Batch-Dienst authentifiziert Anforderungen an die automatische Speicherung mithilfe von Speicherkontoschlüsseln.

AutoStorageProperties

Enthält Informationen zum Autospeicherkonto, das einem Batch-Konto zugeordnet ist.

Name	Typ	Standardwert	Beschreibung
authenticationMode	AutoStorageAuthenticationMode	StorageKeys	Der Authentifizierungsmodus, den der Batch-Dienst zum Verwalten des Kontos für die automatische Speicherung verwendet.
lastKeySync	string		Die UTC-Zeit, zu der Speicherschlüssel zuletzt mit dem Batch-Konto synchronisiert wurden.
nodeIdentityReference	ComputeNodeIdentityReference		Der Verweis auf die vom Benutzer zugewiesene Identität, die Computeknoten für den Zugriff auf den automatischen Speicher verwenden. Die identität, auf die hier verwiesen wird, muss Pools zugewiesen werden, die über Computeknoten verfügen, die Zugriff auf den automatischen Speicher benötigen.
storageAccountId	string		Die Ressourcen-ID des Speicherkontos, das für das Konto für die automatische Speicherung verwendet werden soll.

BatchAccount

Enthält Informationen zu einem Azure Batch-Konto.

Name	Typ	Standardwert	Beschreibung
id	string		Die ID der Ressource.
identity	BatchAccountIdentity		Die Identität des Batch-Kontos.
location	string		Der Speicherort der Ressource.
name	string		Der Name der Ressource.
properties.accountEndpoint	string		Der Kontoendpunkt, der für die Interaktion mit dem Batch-Dienst verwendet wird.
properties.activeJobAndJobScheduleQuota	integer		Das aktive Auftrags- und Auftragszeitplankontingent für das Batch-Konto.
properties.allowedAuthenticationModes	AuthenticationMode[]		Liste der zulässigen Authentifizierungsmodi für das Batch-Konto, das für die Authentifizierung bei der Datenebene verwendet werden kann. Dies wirkt sich nicht auf die Authentifizierung mit der Steuerungsebene aus.
properties.autoStorage	AutoStorageProperties		Die Eigenschaften und status jedes Autospeicherkontos, das dem Batch-Konto zugeordnet ist. Enthält Informationen zum Autospeicherkonto, das einem Batch-Konto zugeordnet ist.
properties.dedicatedCoreQuota	integer		Das dedizierte Kernkontingent für das Batch-Konto. Für Konten, für die PoolAllocationMode auf UserSubscription festgelegt ist, wird das Kontingent für das Abonnement verwaltet, sodass dieser Wert nicht zurückgegeben wird.
properties.dedicatedCoreQuotaPerVMFamily	VirtualMachineFamilyCoreQuota[]		Eine Liste des dedizierten Kernkontingents pro VM-Familie für das Batch-Konto. Für Konten, für die PoolAllocationMode auf UserSubscription festgelegt ist, wird das Kontingent für das Abonnement verwaltet, sodass dieser Wert nicht zurückgegeben wird.
properties.dedicatedCoreQuotaPerVMFamilyEnforced	boolean		Ein Wert, der angibt, ob Kernkontingente pro VM-Familie für dieses Konto erzwungen werden. Wenn dieses Flag true ist, wird das dedizierte Kernkontingent sowohl über die Eigenschaften dedicatedCoreQuotaPerVMFamily und dedicatedCoreQuota für das Konto erzwungen. Wenn dieses Flag false ist, wird das dedizierte Kernkontingent nur über die eigenschaft dedicatedCoreQuota für das Konto erzwungen und berücksichtigt nicht die VM-Familie.
properties.encryption	EncryptionProperties		Die Verschlüsselungskonfiguration für das Batch-Konto. Konfiguriert, wie Kundendaten innerhalb des Batch-Kontos verschlüsselt werden. Standardmäßig werden Konten mit einem von Microsoft verwalteten Schlüssel verschlüsselt. Für zusätzliche Steuerung kann stattdessen ein kundenseitig verwalteter Schlüssel verwendet werden.
properties.keyVaultReference	KeyVaultReference		Ein Verweis auf den Azure-Schlüsseltresor, der dem Batch-Konto zugeordnet ist. Identifiziert den Azure-Schlüsseltresor, der einem Batch-Konto zugeordnet ist.
properties.lowPriorityCoreQuota	integer		Das Spot-/Kernkontingent mit niedriger Priorität für das Batch-Konto. Für Konten, für die PoolAllocationMode auf UserSubscription festgelegt ist, wird das Kontingent für das Abonnement verwaltet, sodass dieser Wert nicht zurückgegeben wird.
properties.networkProfile	NetworkProfile		Netzwerkprofil für das Batch-Konto, das Netzwerkregeleinstellungen für jeden Endpunkt enthält. Das Netzwerkprofil wird nur wirksam, wenn publicNetworkAccess aktiviert ist.
properties.nodeManagementEndpoint	string		Der Endpunkt, der vom Computeknoten zum Herstellen einer Verbindung mit dem Batch-Knotenverwaltungsdienst verwendet wird.
properties.poolAllocationMode	PoolAllocationMode		Der Zuordnungsmodus, der beim Erstellen von Pools im Batch-Konto verwendet werden soll. Der Zuordnungsmodus zum Erstellen von Pools im Batch-Konto.
properties.poolQuota	integer		Das Poolkontingent für das Batch-Konto.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Liste der privaten Endpunktverbindungen, die dem Batch-Konto zugeordnet sind
properties.provisioningState	ProvisioningState		Der bereitgestellte Zustand der Ressource
properties.publicNetworkAccess	PublicNetworkAccessType	Enabled	Der Netzwerkschnittstellentyp für den Zugriff auf Azure Batch-Dienst- und Batch-Kontovorgänge. Wenn nicht angegeben, lautet der Standardwert "enabled".
tags	object		Die Tags der Ressource.
type	string		Der Typ der Ressource.

BatchAccountIdentity

Die Identität des Batch-Kontos, sofern konfiguriert. Dies wird verwendet, wenn der Benutzer "Microsoft.KeyVault" als Verschlüsselungskonfiguration für das Batch-Konto angibt oder wenn ManagedIdentity als Authentifizierungsmodus für die automatische Speicherung ausgewählt ist.

Name	Typ	Beschreibung
principalId	string	Die Prinzipal-ID des Batch-Kontos. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
tenantId	string	Die Mandanten-ID, die dem Batch-Konto zugeordnet ist. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
type	ResourceIdentityType	Der Identitätstyp, der für das Batch-Konto verwendet wird.
userAssignedIdentities	object	Die Liste der Benutzeridentitäten, die dem Batch-Konto zugeordnet sind.

CloudError

Eine Fehlerantwort des Batch-Diensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Der Text der Fehlerantwort.

CloudErrorBody

Eine Fehlerantwort des Batch-Diensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
target	string	Das Ziel des jeweiligen Fehlers. Beispiel: Der Name der -Eigenschaft im Fehler.

ComputeNodeIdentityReference

Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.

Name	Typ	Beschreibung
resourceId	string	Die ARM-Ressourcen-ID der benutzerseitig zugewiesenen Identität.

EncryptionProperties

Konfiguriert, wie Kundendaten innerhalb des Batch-Kontos verschlüsselt werden. Standardmäßig werden Konten mit einem von Microsoft verwalteten Schlüssel verschlüsselt. Für zusätzliche Steuerung kann stattdessen ein kundenseitig verwalteter Schlüssel verwendet werden.

Name	Typ	Beschreibung
keySource	KeySource	Typ der Schlüsselquelle.
keyVaultProperties	KeyVaultProperties	Zusätzliche Details bei Verwendung von Microsoft.KeyVault

EndpointAccessDefaultAction

Die Standardaktion, wenn keine IPRule übereinstimmt.

Name	Typ	Beschreibung
Allow	string	Clientzugriff zulassen.
Deny	string	Verweigern des Clientzugriffs.

EndpointAccessProfile

Netzwerkzugriffsprofil für Batch-Endpunkt.

Name	Typ	Beschreibung
defaultAction	EndpointAccessDefaultAction	Die Standardaktion, wenn keine IPRule übereinstimmt. Standardaktion für den Endpunktzugriff. Sie gilt nur, wenn publicNetworkAccess aktiviert ist.
ipRules	IPRule[]	Array von IP-Bereichen zum Filtern der Client-IP-Adresse.

IPRule

Regel zum Filtern der Client-IP-Adresse.

Name	Typ	Beschreibung
action	IPRuleAction	Aktion, wenn die Client-IP-Adresse abgeglichen wird.
value	string	Die zu filternde IP-Adresse oder der IP-Adressbereich IPv4-Adresse oder IPv4-Adressbereich im CIDR-Format.

IPRuleAction

Aktion, wenn die Client-IP-Adresse abgeglichen wird.

Name	Typ	Beschreibung
Allow	string	Lassen Sie den Zugriff für die übereinstimmene Client-IP-Adresse zu.

KeySource

Typ der Schlüsselquelle.

Name	Typ	Beschreibung
Microsoft.Batch	string	Batch erstellt und verwaltet die Verschlüsselungsschlüssel, die zum Schutz der Kontodaten verwendet werden.
Microsoft.KeyVault	string	Die Zum Schutz der Kontodaten verwendeten Verschlüsselungsschlüssel werden in einem externen Schlüsseltresor gespeichert. Wenn dies festgelegt ist, muss die Identität des Batch-Kontos auf SystemAssigned festgelegt werden, und unter keyVaultProperties muss auch ein gültiger Schlüsselbezeichner angegeben werden.

KeyVaultProperties

KeyVault-Konfiguration bei Verwendung einer Verschlüsselungs-KeySource von Microsoft.KeyVault.

Name	Typ	Beschreibung
keyIdentifier	string	Vollständiger Pfad zum Geheimnis mit oder ohne Version. Beispiel: https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. oder https://mykeyvault.vault.azure.net/keys/testkey. Um verwendbar zu sein, müssen die folgenden Voraussetzungen erfüllt sein: Das Batch-Konto verfügt über eine systemseitig zugewiesene Identität Die Kontoidentität wurde den Berechtigungen Schlüssel/Abrufen, Schlüssel/Auspacken und Schlüssel/Umschließen gewährt. Der KeyVault hat vorläufiges Löschen und Löschen des Schutzes aktiviert.

KeyVaultReference

Identifiziert den Azure-Schlüsseltresor, der einem Batch-Konto zugeordnet ist.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID des Azure-Schlüsseltresors, der dem Batch-Konto zugeordnet ist.
url	string	Die URL des Azure-Schlüsseltresors, der dem Batch-Konto zugeordnet ist.

NetworkProfile

Netzwerkprofil für das Batch-Konto, das Netzwerkregeleinstellungen für jeden Endpunkt enthält.

Name	Typ	Beschreibung
accountAccess	EndpointAccessProfile	Netzwerkzugriffsprofil für batchAccount-Endpunkt (Datenebenen-API für Batch-Konten).
nodeManagementAccess	EndpointAccessProfile	Netzwerkzugriffsprofil für nodeManagement-Endpunkt (Batch-Dienst zur Verwaltung von Computeknoten für Batch-Pools).

PoolAllocationMode

Der Zuordnungsmodus zum Erstellen von Pools im Batch-Konto.

Name	Typ	Beschreibung
BatchService	string	Pools werden in Abonnements zugeordnet, die dem Batch-Dienst gehören.
UserSubscription	string	Pools werden in einem Abonnement zugeordnet, das dem Benutzer gehört.

PrivateEndpoint

Der private Endpunkt der Verbindung mit dem privaten Endpunkt.

Name	Typ	Beschreibung
id	string	Der ARM-Ressourcenbezeichner des privaten Endpunkts. Dies hat das Format /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Enthält Informationen zu einer Private Link-Ressource.

Name	Typ	Beschreibung
etag	string	Das ETag der Ressource, die für Parallelitätsanweisungen verwendet wird.
id	string	Die ID der Ressource.
name	string	Der Name der Ressource.
properties.groupIds	string[]	Die Gruppen-ID der Verbindung mit dem privaten Endpunkt. Der Wert weist nur eine Gruppen-ID auf.
properties.privateEndpoint	PrivateEndpoint	Der ARM-Ressourcenbezeichner des privaten Endpunkts. Der private Endpunkt der Verbindung mit dem privaten Endpunkt.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Der Private Link-Dienstverbindungsstatus der Verbindung mit dem privaten Endpunkt. Der Verbindungsstatus des Private Link-Diensts der Verbindung mit dem privaten Endpunkt
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Der Bereitstellungsstatus der Verbindung mit dem privaten Endpunkt.
type	string	Der Typ der Ressource.

PrivateEndpointConnectionProvisioningState

Der Bereitstellungsstatus der Privaten Endpunktverbindung.

Name	Typ	Beschreibung
Cancelled	string	Der Benutzer hat die Verbindungserstellung abgebrochen.
Creating	string	Die Verbindung wird erstellt.
Deleting	string	Die Verbindung wird gelöscht.
Failed	string	Der Benutzer hat die Aktualisierung der Verbindung angefordert, und es ist ein Fehler aufgetreten. Sie können den Aktualisierungsvorgang wiederholen.
Succeeded	string	Die Verbindung status ist endgültig und kann verwendet werden, wenn Der Status Genehmigt ist.
Updating	string	Der Benutzer hat angefordert, dass die Verbindung aktualisiert status, aber der Aktualisierungsvorgang ist noch nicht abgeschlossen. Sie dürfen beim Herstellen einer Verbindung mit dem Batch-Konto nicht auf die Verbindung verweisen.

PrivateLinkServiceConnectionState

Der Verbindungsstatus des Private Link-Diensts der Verbindung mit dem privaten Endpunkt

Name	Typ	Beschreibung
actionsRequired	string	Aktion erforderlich für den privaten Verbindungszustand
description	string	Beschreibung des privaten Verbindungszustands
status	PrivateLinkServiceConnectionStatus	Die status für die Verbindung des privaten Endpunkts des Batch-Kontos

PrivateLinkServiceConnectionStatus

Die status der Privaten Batch-Endpunktverbindung

Name	Typ	Beschreibung
Approved	string	Die Verbindung des privaten Endpunkts ist genehmigt und kann für den Zugriff auf das Batch-Konto verwendet werden.
Disconnected	string	Die Verbindung mit dem privaten Endpunkt ist getrennt und kann nicht für den Zugriff auf das Batch-Konto verwendet werden.
Pending	string	Die Verbindung des privaten Endpunkts steht aus und kann nicht für den Zugriff auf das Batch-Konto verwendet werden.
Rejected	string	Die Verbindung mit dem privaten Endpunkt wird abgelehnt und kann nicht für den Zugriff auf das Batch-Konto verwendet werden.

ProvisioningState

Der bereitgestellte Zustand der Ressource

Name	Typ	Beschreibung
Cancelled	string	Der letzte Vorgang für das Konto wird abgebrochen.
Creating	string	Das Konto wird erstellt.
Deleting	string	Das Konto wird gelöscht.
Failed	string	Der letzte Vorgang für das Konto ist fehlgeschlagen.
Invalid	string	Das Konto befindet sich in einem ungültigen Zustand.
Succeeded	string	Das Konto wurde erstellt und kann verwendet werden.

PublicNetworkAccessType

Der Netzwerkzugriffstyp für den Betrieb mit den Ressourcen im Batch-Konto.

Name	Typ	Beschreibung
Disabled	string	Deaktiviert die öffentliche Konnektivität und aktiviert private Konnektivität mit Azure Batch Service über eine private Endpunktressource.
Enabled	string	Ermöglicht die Konnektivität mit Azure Batch über öffentliches DNS.

ResourceIdentityType

Der Identitätstyp, der für das Batch-Konto verwendet wird.

Name	Typ	Beschreibung
None	string	Batch-Konto ist keine Identität zugeordnet. Durch festlegen None im Updatekonto werden vorhandene Identitäten entfernt.
SystemAssigned	string	Batch-Konto verfügt über eine systemseitig zugewiesene Identität.
UserAssigned	string	Batch-Konto verfügt über benutzerseitig zugewiesene Identitäten.

UserAssignedIdentities

Die Liste der zugeordneten Benutzeridentitäten.

Name	Typ	Beschreibung
clientId	string	Die Client-ID der benutzerseitig zugewiesenen Identität.
principalId	string	Die Prinzipal-ID der benutzerseitig zugewiesenen Identität.

VirtualMachineFamilyCoreQuota

Eine VM-Familie und das zugehörige Kernkontingent für das Batch-Konto.

Name	Typ	Beschreibung
coreQuota	integer	Das Kernkontingent für die VM-Familie für das Batch-Konto.
name	string	Der Name der Vm-Familie.