Batch Account - Get

Služba:

Batch Management

Verze rozhraní API:

2025-06-01

Získá informace o zadaném účtu Batch.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-zA-Z0-9]+$	Název pro batch účet, který musí být v rámci regionu jedinečný. Dávkové názvy účtů musí mít délku mezi 3 a 24 znaky a musí používat pouze čísla a malá písmena. Toto jméno se používá jako součást DNS jména, které slouží k přístupu k dávkové službě v regionu, kde je účet vytvořen. Například: http://accountname.region.batch.azure.com/.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	BatchAccount	Operace Azure byla úspěšně dokončena.
Other Status Codes	CloudError	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

BatchAccountGet

PrivateBatchAccountGet

BatchAccountGet

Ukázkový požadavek

HTTP

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2025-06-01

Java

/**
 * Samples for BatchAccount GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-06-01/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="SUBSCRIPTION_ID",
    )

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


# x-ms-original-file: 2025-06-01/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/v4"
)

// Generated from example definition: 2025-06-01/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("12345678-1234-1234-1234-123456789012", 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 = armbatch.AccountClientGetResponse{
	// 	Account: &armbatch.Account{
	// 		Name: to.Ptr("sampleacct"),
	// 		Type: to.Ptr("Microsoft.Batch/batchAccounts"),
	// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct"),
	// 		Identity: &armbatch.AccountIdentity{
	// 			Type: to.Ptr(armbatch.ResourceIdentityTypeNone),
	// 		},
	// 		Location: to.Ptr("japaneast"),
	// 		Properties: &armbatch.AccountProperties{
	// 			AccountEndpoint: to.Ptr("sampleacct.japaneast.batch.azure.com"),
	// 			ActiveJobAndJobScheduleQuota: to.Ptr[int32](20),
	// 			AutoStorage: &armbatch.AutoStorageProperties{
	// 				LastKeySync: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-03-10T23:48:38.9878479Z"); return t}()),
	// 				StorageAccountID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"),
	// 			},
	// 			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: 2025-06-01/BatchAccountGet.json
 */
async function batchAccountGet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "12345678-1234-1234-1234-123456789012";
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.batchAccount.get("default-azurebatch-japaneast", "sampleacct");
  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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Batch.Models;
using Azure.ResourceManager.Batch;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-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 = "12345678-1234-1234-1234-123456789012";
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

Ukázková odpověď

Stavový kód:

200

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

PrivateBatchAccountGet

Ukázkový požadavek

HTTP

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2025-06-01

Java

/**
 * Samples for BatchAccount GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-06-01/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="SUBSCRIPTION_ID",
    )

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


# x-ms-original-file: 2025-06-01/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/v4"
)

// Generated from example definition: 2025-06-01/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("12345678-1234-1234-1234-123456789012", 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 = armbatch.AccountClientGetResponse{
	// 	Account: &armbatch.Account{
	// 		Name: to.Ptr("sampleacct"),
	// 		Type: to.Ptr("Microsoft.Batch/batchAccounts"),
	// 		ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789012/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{
	// 				LastKeySync: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-03-10T23:48:38.9878479Z"); return t}()),
	// 				StorageAccountID: to.Ptr("/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"),
	// 			},
	// 			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/12345678-1234-1234-1234-123456789012/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/12345678-1234-1234-1234-123456789012/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: 2025-06-01/PrivateBatchAccountGet.json
 */
async function privateBatchAccountGet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "12345678-1234-1234-1234-123456789012";
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.batchAccount.get("default-azurebatch-japaneast", "sampleacct");
  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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Batch.Models;
using Azure.ResourceManager.Batch;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-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 = "12345678-1234-1234-1234-123456789012";
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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
AuthenticationMode	Režim ověřování pro účet Batch.
AutoStorageAuthenticationMode	Režim ověřování, který bude služba Batch používat ke správě účtu automatického úložiště.
AutoStorageProperties	Obsahuje informace o účtu automatického úložiště přidruženého k účtu Batch.
BatchAccount	Obsahuje informace o účtu Azure Batch.
BatchAccountIdentity	Identita účtu Batch, pokud je nakonfigurovaná. Používá se, když uživatel jako konfiguraci šifrování účtu Batch zadá Microsoft.KeyVault nebo když ManagedIdentity vybere režim ověřování automatického úložiště.
CloudError	Odpověď na chybu ze služby Batch
CloudErrorBody	Odpověď na chybu ze služby Batch
ComputeNodeIdentityReference	Odkaz na identitu přiřazenou uživatelem přidruženou k fondu Batch, který bude používat výpočetní uzel.
createdByType	Typ identity, která prostředek vytvořila.
EncryptionProperties	Konfiguruje způsob šifrování zákaznických dat v rámci účtu Batch. Ve výchozím nastavení se účty šifrují pomocí spravovaného klíče Microsoftu. Pro další kontrolu je možné použít klíč spravovaný zákazníkem.
EndpointAccessDefaultAction	Výchozí akce pro přístup ke koncovému bodu Dá se použít jenom v případě, že je povolená funkce PublicNetworkAccess.
EndpointAccessProfile	Profil síťového přístupu pro koncový bod Batch.
IPRule	Pravidlo pro filtrování IP adresy klienta
IPRuleAction	Akce, kdy je IP adresa klienta spárována.
KeySource	Typ zdroje klíče.
KeyVaultProperties	Konfigurace služby KeyVault při použití šifrovacího zdroje klíčů Microsoft.KeyVault
KeyVaultReference	Identifikuje trezor klíčů Azure přidružený k účtu Batch.
NetworkProfile	Profil sítě pro účet Batch, který obsahuje nastavení pravidel sítě pro každý koncový bod.
PoolAllocationMode	Režim přidělování pro vytváření fondů v účtu Batch.
PrivateEndpoint	Privátní koncový bod připojení privátního koncového bodu.
PrivateEndpointConnection	Obsahuje informace o prostředku privátního propojení.
PrivateEndpointConnectionProvisioningState	Stav zřizování připojení privátního koncového bodu.
PrivateLinkServiceConnectionState	Stav připojení služby Private Link připojení privátního koncového bodu
PrivateLinkServiceConnectionStatus	Stav připojení privátního koncového bodu služby Batch
ProvisioningState	Zřízený stav prostředku
PublicNetworkAccessType	Typ síťového rozhraní pro přístup ke službě Azure Batch a operacím účtu Batch.
ResourceIdentityType	Typ identity používané pro účet Batch.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
UserAssignedIdentities	Seznam přidružených identit uživatelů
VirtualMachineFamilyCoreQuota	Řada virtuálních počítačů a přidružená kvóta jader pro účet Batch

AuthenticationMode

Výčet

Režim ověřování pro účet Batch.

Hodnota	Description
SharedKey	Režim ověřování pomocí sdílených klíčů.
AAD	Režim ověřování pomocí MICROSOFT Entra ID.
TaskAuthenticationToken	Režim ověřování pomocí ověřovacích tokenů úloh.

AutoStorageAuthenticationMode

Výčet

Režim ověřování, který bude služba Batch používat ke správě účtu automatického úložiště.

Hodnota	Description
StorageKeys	Služba Batch ověří požadavky na automatické úložiště pomocí klíčů účtu úložiště.
BatchAccountManagedIdentity	Služba Batch ověří požadavky na automatické úložiště pomocí spravované identity přiřazené k účtu Batch.

AutoStorageProperties

Objekt

Obsahuje informace o účtu automatického úložiště přidruženého k účtu Batch.

Name	Typ	Default value	Description
authenticationMode	AutoStorageAuthenticationMode	StorageKeys	Režim ověřování, který bude služba Batch používat ke správě účtu automatického úložiště.
lastKeySync	string (date-time)		Čas UTC, kdy byly klíče úložiště naposledy synchronizovány s účtem Batch.
nodeIdentityReference	ComputeNodeIdentityReference		Odkaz na identitu přiřazenou uživatelem, kterou výpočetní uzly použijí pro přístup k automatickému úložišti. Identita, na kterou se odkazuje, musí být přiřazena fondům, které mají výpočetní uzly, které potřebují přístup k automatickému úložišti.
storageAccountId	string (arm-id)		ID prostředku účtu úložiště, který se má použít pro účet automatického úložiště.

BatchAccount

Objekt

Obsahuje informace o účtu Azure Batch.

Name	Typ	Default value	Description
id	string (arm-id)		Plně kvalifikované ID prostředku pro prostředek. Např. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	BatchAccountIdentity		Identita účtu Batch.
location	string		Geografická poloha, kde se prostředek nachází
name	string		Název prostředku
properties.accountEndpoint	string		Koncový bod účtu používaný k interakci se službou Batch.
properties.activeJobAndJobScheduleQuota	integer (int32)		Aktivní kvóta úlohy a plánu úloh pro účet Batch. Aktivní kvóta úlohy a plánu úloh pro účet Batch.
properties.allowedAuthenticationModes	AuthenticationMode[]		Seznam povolených režimů ověřování pro účet Batch, který se dá použít k ověření v rovině dat. To nemá vliv na ověřování v řídicí rovině.
properties.autoStorage	AutoStorageProperties		Vlastnosti a stav libovolného účtu automatického úložiště přidruženého k účtu Batch. Obsahuje informace o účtu automatického úložiště přidruženého k účtu Batch.
properties.dedicatedCoreQuota	integer (int32)		Kvóta vyhrazeného jádra pro účet Batch. U účtů s parametrem PoolAllocationMode nastaveným na UserSubscription se kvóta spravuje v předplatném, takže tato hodnota se nevrátí.
properties.dedicatedCoreQuotaPerVMFamily	VirtualMachineFamilyCoreQuota[]		Seznam kvóty vyhrazených jader pro řadu virtuálních počítačů pro účet Batch. U účtů s parametrem PoolAllocationMode nastaveným na UserSubscription se kvóta spravuje v předplatném, takže tato hodnota se nevrátí.
properties.dedicatedCoreQuotaPerVMFamilyEnforced	boolean		Hodnota označující, jestli se pro tento účet vynucují kvóty jader na řadu virtuálních počítačů Pokud je tento příznak pravdivý, vynucuje se kvóta vyhrazeného jádra prostřednictvím vlastností dedicatedCoreQuotaPerVMFamily i dedicatedCoreQuota v účtu. Pokud je tento příznak false, kvóta vyhrazeného jádra se vynucuje pouze prostřednictvím vyhrazené vlastnostiCoreQuota na účtu a nebere v úvahu řadu virtuálních počítačů.
properties.encryption	EncryptionProperties		Konfigurace šifrování pro účet Batch. Konfiguruje způsob šifrování zákaznických dat v rámci účtu Batch. Ve výchozím nastavení se účty šifrují pomocí spravovaného klíče Microsoftu. Pro další kontrolu je možné použít klíč spravovaný zákazníkem.
properties.keyVaultReference	KeyVaultReference		Odkaz na trezor klíčů Azure přidružený k účtu Batch. Identifikuje trezor klíčů Azure přidružený k účtu Batch.
properties.lowPriorityCoreQuota	integer (int32)		Kvóta jader spotového/nízké priority pro účet Batch. U účtů s parametrem PoolAllocationMode nastaveným na UserSubscription se kvóta spravuje v předplatném, takže tato hodnota se nevrátí.
properties.networkProfile	NetworkProfile		Profil sítě pro účet Batch, který obsahuje nastavení pravidel sítě pro každý koncový bod. Profil sítě se projeví jenom při povolení publicNetworkAccess.
properties.nodeManagementEndpoint	string		Koncový bod používaný výpočetním uzlem pro připojení ke službě pro správu uzlů Batch.
properties.poolAllocationMode	PoolAllocationMode		Režim přidělování, který se použije k vytváření fondů v účtu Batch. Režim přidělování pro vytváření fondů v účtu Batch.
properties.poolQuota	integer (int32)		Kvóta fondu pro účet Batch. Kvóta fondu pro účet Batch.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Seznam připojení privátních koncových bodů přidružených k účtu Batch
properties.provisioningState	ProvisioningState		Zřízený stav prostředku
properties.publicNetworkAccess	PublicNetworkAccessType	Enabled	Typ síťového rozhraní pro přístup ke službě Azure Batch a operacím účtu Batch. Typ síťového přístupu pro provoz na prostředcích v účtu Batch.
systemData	systemData		Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
tags	object		Značky prostředků
type	string		Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"

BatchAccountIdentity

Objekt

Identita účtu Batch, pokud je nakonfigurovaná. Používá se, když uživatel jako konfiguraci šifrování účtu Batch zadá Microsoft.KeyVault nebo když ManagedIdentity vybere režim ověřování automatického úložiště.

Name	Typ	Description
principalId	string	ID objektu zabezpečení účtu Batch. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
tenantId	string	ID tenanta přidruženého k účtu Batch. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
type	ResourceIdentityType	Typ identity používané pro účet Batch.
userAssignedIdentities	<string,  UserAssignedIdentities>	Seznam identit uživatelů přidružených k účtu Batch.

CloudError

Objekt

Odpověď na chybu ze služby Batch

Name	Typ	Description
error	CloudErrorBody	Text odpovědi na chybu.

CloudErrorBody

Objekt

Odpověď na chybu ze služby Batch

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby. Například název vlastnosti v chybě.

ComputeNodeIdentityReference

Objekt

Odkaz na identitu přiřazenou uživatelem přidruženou k fondu Batch, který bude používat výpočetní uzel.

Name	Typ	Description
resourceId	string	ID prostředku ARM identity přiřazené uživatelem.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

EncryptionProperties

Objekt

Konfiguruje způsob šifrování zákaznických dat v rámci účtu Batch. Ve výchozím nastavení se účty šifrují pomocí spravovaného klíče Microsoftu. Pro další kontrolu je možné použít klíč spravovaný zákazníkem.

Name	Typ	Description
keySource	KeySource	Typ zdroje klíče.
keyVaultProperties	KeyVaultProperties	Další podrobnosti při používání služby Microsoft.KeyVault

EndpointAccessDefaultAction

Výčet

Výchozí akce pro přístup ke koncovému bodu Dá se použít jenom v případě, že je povolená funkce PublicNetworkAccess.

Hodnota	Description
Allow	Povolit klientský přístup.
Deny	Odepřít klientský přístup.

EndpointAccessProfile

Objekt

Profil síťového přístupu pro koncový bod Batch.

Name	Typ	Description
defaultAction	EndpointAccessDefaultAction	Výchozí akce, pokud se neshoduje žádný protokol IPRule. Výchozí akce pro přístup ke koncovému bodu Dá se použít jenom v případě, že je povolená funkce PublicNetworkAccess.
ipRules	IPRule[]	Pole rozsahů IP adres pro filtrování IP adres klienta

IPRule

Objekt

Pravidlo pro filtrování IP adresy klienta

Name	Typ	Description
action	IPRuleAction	Akce při porovnávání IP adresy klienta
value	string	Ip adresa nebo rozsah IP adres pro filtrování Adresa IPv4 nebo rozsah adres IPv4 ve formátu CIDR

IPRuleAction

Výčet

Akce, kdy je IP adresa klienta spárována.

Hodnota	Description
Allow	Povolte přístup pro odpovídající IP adresu klienta.

KeySource

Výčet

Typ zdroje klíče.

Hodnota	Description
Microsoft.Batch	Služba Batch vytvoří a spravuje šifrovací klíče použité k ochraně dat účtu.
Microsoft.KeyVault	Šifrovací klíče používané k ochraně dat účtu se ukládají do externího trezoru klíčů. Pokud je tato hodnota nastavená, musí být identita účtu Batch nastavená na SystemAssigned a musí být zadán také platný identifikátor klíče v rámci keyVaultProperties.

KeyVaultProperties

Objekt

Konfigurace služby KeyVault při použití šifrovacího zdroje klíčů Microsoft.KeyVault

Name	Typ	Description
keyIdentifier	string	Úplná cesta k tajnému kódu s verzí nebo bez. Příklad https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. nebo https://mykeyvault.vault.azure.net/keys/testkey. Aby bylo možné splnit následující požadavky: Účet Batch má identitu přiřazenou systémem. Identita účtu má udělený klíč/ získání, klíč/ rozbalení a oprávnění k zalamování klíčů. Služba KeyVault má povolenou ochranu proti obnovitelnému odstranění a vymazání.

KeyVaultReference

Objekt

Identifikuje trezor klíčů Azure přidružený k účtu Batch.

Name	Typ	Description
id	string (arm-id)	ID prostředku trezoru klíčů Azure přidruženého k účtu Batch.
url	string	Adresa URL trezoru klíčů Azure přidruženého k účtu Batch.

NetworkProfile

Objekt

Profil sítě pro účet Batch, který obsahuje nastavení pravidel sítě pro každý koncový bod.

Name	Typ	Description
accountAccess	EndpointAccessProfile	Profil přístupu k síti pro koncový bod batchAccount (rozhraní API roviny dat účtu Batch)
nodeManagementAccess	EndpointAccessProfile	Profil přístupu k síti pro koncový bod nodeManagement (služba Batch spravující výpočetní uzly pro fondy Batch)

PoolAllocationMode

Výčet

Režim přidělování pro vytváření fondů v účtu Batch.

Hodnota	Description
BatchService	Fondy budou přiděleny v předplatných vlastněných službou Batch.
UserSubscription	Fondy budou přiděleny v předplatném vlastněné uživatelem.

PrivateEndpoint

Objekt

Privátní koncový bod připojení privátního koncového bodu.

Name	Typ	Description
id	string	Identifikátor prostředku ARM privátního koncového bodu. Toto je formulář /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. Identifikátor prostředku ARM privátního koncového bodu. Toto je formulář /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Objekt

Obsahuje informace o prostředku privátního propojení.

Name	Typ	Description
etag	string	ETag prostředku, který se používá pro příkazy souběžnosti.
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Např. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties.groupIds	string[]	ID skupiny připojení privátního koncového bodu. Hodnota má jedno a pouze jedno ID skupiny.
properties.privateEndpoint	PrivateEndpoint	Identifikátor prostředku ARM privátního koncového bodu. Privátní koncový bod připojení privátního koncového bodu.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stav připojení služby Private Link pro připojení privátního koncového bodu. Stav připojení služby Private Link pro připojení privátního koncového bodu.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stav zřizování připojení privátního koncového bodu. Stav zřizování připojení privátního koncového bodu.
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
tags	object	Značky prostředku.
type	string	Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Výčet

Stav zřizování připojení privátního koncového bodu.

Hodnota	Description
Creating	Připojení se vytváří.
Updating	Uživatel požádal o aktualizaci stavu připojení, ale operace aktualizace ještě nebyla dokončena. Při připojování účtu Batch nemusí odkazovat na připojení.
Deleting	Připojení se odstraňuje.
Succeeded	Stav připojení je konečný a je připravený k použití, pokud je stav schválen.
Failed	Uživatel požádal o aktualizaci připojení a připojení se nezdařilo. Operaci aktualizace můžete opakovat.
Cancelled	Uživatel zrušil vytvoření připojení.

PrivateLinkServiceConnectionState

Objekt

Stav připojení služby Private Link připojení privátního koncového bodu

Name	Typ	Description
actionsRequired	string	Požadovaná akce ve stavu privátního připojení Požadovaná akce ve stavu privátního připojení
description	string	Popis stavu privátního připojení Popis stavu privátního připojení
status	PrivateLinkServiceConnectionStatus	Stav připojení privátního koncového bodu služby Batch Stav připojení privátního koncového bodu služby Batch

PrivateLinkServiceConnectionStatus

Výčet

Stav připojení privátního koncového bodu služby Batch

Hodnota	Description
Approved	Připojení privátního koncového bodu je schválené a dá se použít pro přístup k účtu Batch.
Pending	Připojení privátního koncového bodu čeká na vyřízení a nejde ho použít pro přístup k účtu Batch.
Rejected	Připojení privátního koncového bodu je odmítnuto a nelze ho použít pro přístup k účtu Batch.
Disconnected	Připojení privátního koncového bodu je odpojené a nelze ho použít pro přístup k účtu Batch.

ProvisioningState

Výčet

Zřízený stav prostředku

Hodnota	Description
Invalid	Účet je v neplatném stavu.
Creating	Účet se vytváří.
Deleting	Účet se odstraňuje.
Succeeded	Účet byl vytvořen a je připravený k použití.
Failed	Poslední operace pro účet se nezdařila.
Cancelled	Poslední operace účtu se zruší.

PublicNetworkAccessType

Výčet

Typ síťového rozhraní pro přístup ke službě Azure Batch a operacím účtu Batch.

Hodnota	Description
Enabled	Umožňuje připojení ke službě Azure Batch prostřednictvím veřejného DNS.
Disabled	Zakáže veřejné připojení a umožňuje privátní připojení ke službě Azure Batch prostřednictvím prostředku privátního koncového bodu.
SecuredByPerimeter	Zabezpečuje připojení ke službě Azure Batch prostřednictvím konfigurace NSP.

ResourceIdentityType

Výčet

Typ identity používané pro účet Batch.

Hodnota	Description
SystemAssigned	Účet Batch má přiřazenou identitu systému.
UserAssigned	Účet Batch má přiřazené identity uživatelem.
None	Účet Batch nemá přidruženou žádnou identitu. Nastavení None v účtu aktualizace odebere existující identity.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

UserAssignedIdentities

Objekt

Seznam přidružených identit uživatelů

Name	Typ	Description
clientId	string	ID klienta identity přiřazené uživatelem.
principalId	string	ID objektu zabezpečení identity přiřazené uživatelem.

VirtualMachineFamilyCoreQuota

Objekt

Řada virtuálních počítačů a přidružená kvóta jader pro účet Batch

Name	Typ	Description
coreQuota	integer (int32)	Kvóta jader pro řadu virtuálních počítačů pro účet Batch.
name	string	Název rodiny virtuálních počítačů.