Batch Account - Get

Tjänst:

Batch Management

API-version:

2024-07-01

Hämtar information om det angivna Batch-kontot.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-zA-Z0-9]+$	Namnet på Batch-kontot.
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller Batch-kontot.
subscriptionId	path	True	string	Azure-prenumerations-ID:t. Det här är en GUID-formaterad sträng (t.ex. 00000000-0000-0000-0000-00000000000)
api-version	query	True	string	DEN API-version som ska användas med HTTP-begäran.

Svar

Name	Typ	Description
200 OK	BatchAccount	Åtgärden lyckades. Svaret innehåller Batch-kontoentiteten.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Autentiseringskodflöde för Microsoft Entra OAuth 2.0

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

BatchAccountGet

PrivateBatchAccountGet

BatchAccountGet

Exempelbegäran

HTTP

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

Java

/**
 * Samples for BatchAccount GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-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-07-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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e79d9ef3e065f2dcb6bd1db51e29c62a99dff5cb/specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-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-07-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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Batch.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Batch;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-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

Exempelsvar

Statuskod:

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

Exempelbegäran

HTTP

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

Java

/**
 * Samples for BatchAccount GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-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-07-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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e79d9ef3e065f2dcb6bd1db51e29c62a99dff5cb/specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-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-07-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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Batch.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Batch;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
AuthenticationMode	Autentiseringsläget för Batch-kontot.
AutoStorageAuthenticationMode	Det autentiseringsläge som Batch-tjänsten ska använda för att hantera kontot för automatisk lagring.
AutoStorageProperties	Innehåller information om det automatiskt lagringskonto som är associerat med ett Batch-konto.
BatchAccount	Innehåller information om ett Azure Batch-konto.
BatchAccountIdentity	Identiteten för Batch-kontot, om det är konfigurerat. Detta används när användaren anger "Microsoft.KeyVault" som krypteringskonfiguration för Batch-konto eller när ManagedIdentity väljs som autentiseringsläge för automatisk lagring.
CloudError	Ett felsvar från Batch-tjänsten.
CloudErrorBody	Ett felsvar från Batch-tjänsten.
ComputeNodeIdentityReference	Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda.
EncryptionProperties	Konfigurerar hur kunddata krypteras i Batch-kontot. Som standard krypteras konton med hjälp av en Microsoft-hanterad nyckel. För ytterligare kontroll kan en kundhanterad nyckel användas i stället.
EndpointAccessDefaultAction	Standardåtgärden när det inte finns någon IPRule matchad.
EndpointAccessProfile	Nätverksåtkomstprofil för Batch-slutpunkt.
IPRule	Regel för att filtrera klientens IP-adress.
IPRuleAction	Åtgärd när klientens IP-adress matchas.
KeySource	Typ av nyckelkälla.
KeyVaultProperties	KeyVault-konfiguration när du använder en krypteringsnyckelkälla för Microsoft.KeyVault.
KeyVaultReference	Identifierar azure-nyckelvalvet som är associerat med ett Batch-konto.
NetworkProfile	Nätverksprofil för Batch-konto, som innehåller nätverksregelinställningar för varje slutpunkt.
PoolAllocationMode	Allokeringsläget för att skapa pooler i Batch-kontot.
PrivateEndpoint	Den privata slutpunkten för den privata slutpunktsanslutningen.
PrivateEndpointConnection	Innehåller information om en privat länkresurs.
PrivateEndpointConnectionProvisioningState	Etableringstillståndet för den privata slutpunktsanslutningen.
PrivateLinkServiceConnectionState	Anslutningstillståndet för tjänsten private link för den privata slutpunktsanslutningen
PrivateLinkServiceConnectionStatus	Status för den privata Batch-slutpunktsanslutningen
ProvisioningState	Resursens etablerade tillstånd
PublicNetworkAccessType	Nätverksåtkomsttypen för drift på resurserna i Batch-kontot.
ResourceIdentityType	Den typ av identitet som används för Batch-kontot.
UserAssignedIdentities	Listan över associerade användaridentiteter.
VirtualMachineFamilyCoreQuota	En VM-familj och dess associerade kärnkvot för Batch-kontot.

AuthenticationMode

Uppräkning

Autentiseringsläget för Batch-kontot.

Värde	Description
AAD	Autentiseringsläget med Microsoft Entra-ID.
SharedKey	Autentiseringsläget med delade nycklar.
TaskAuthenticationToken	Autentiseringsläget med aktivitetsautentiseringstoken.

AutoStorageAuthenticationMode

Uppräkning

Det autentiseringsläge som Batch-tjänsten ska använda för att hantera kontot för automatisk lagring.

Värde	Description
BatchAccountManagedIdentity	Batch-tjänsten autentiserar begäranden om automatisk lagring med hjälp av den hanterade identitet som tilldelats Batch-kontot.
StorageKeys	Batch-tjänsten autentiserar begäranden till automatisk lagring med hjälp av lagringskontonycklar.

AutoStorageProperties

Objekt

Innehåller information om det automatiskt lagringskonto som är associerat med ett Batch-konto.

Name	Typ	Standardvärde	Description
authenticationMode	AutoStorageAuthenticationMode	StorageKeys	Det autentiseringsläge som Batch-tjänsten ska använda för att hantera kontot för automatisk lagring.
lastKeySync	string (date-time)		UTC-tiden då lagringsnycklar senast synkroniserades med Batch-kontot.
nodeIdentityReference	ComputeNodeIdentityReference		Referensen till den användartilldelade identitet som beräkningsnoder ska använda för att få åtkomst till automatisk lagring. Identiteten som refereras här måste tilldelas till pooler som har beräkningsnoder som behöver åtkomst till automatisk lagring.
storageAccountId	string (arm-id)		Resurs-ID för lagringskontot som ska användas för automatiskt lagringskonto.

BatchAccount

Objekt

Innehåller information om ett Azure Batch-konto.

Name	Typ	Standardvärde	Description
id	string		Resursens ID.
identity	BatchAccountIdentity		Identiteten för Batch-kontot.
location	string		Platsen för resursen.
name	string		Namnet på resursen.
properties.accountEndpoint	string		Kontoslutpunkten som används för att interagera med Batch-tjänsten.
properties.activeJobAndJobScheduleQuota	integer (int32)		Den aktiva jobb- och jobbschemakvoten för Batch-kontot.
properties.allowedAuthenticationModes	AuthenticationMode[]		Lista över tillåtna autentiseringslägen för Batch-kontot som kan användas för att autentisera med dataplanet. Detta påverkar inte autentisering med kontrollplanet.
properties.autoStorage	AutoStorageProperties		Egenskaper och status för alla konton för automatisk lagring som är associerade med Batch-kontot. Innehåller information om det automatiskt lagringskonto som är associerat med ett Batch-konto.
properties.dedicatedCoreQuota	integer (int32)		Den dedikerade kärnkvoten för Batch-kontot. För konton med PoolAllocationMode inställt på UserSubscription hanteras kvoten för prenumerationen så att det här värdet inte returneras.
properties.dedicatedCoreQuotaPerVMFamily	VirtualMachineFamilyCoreQuota[]		En lista över den dedikerade kärnkvoten per virtuell datorfamilj för Batch-kontot. För konton med PoolAllocationMode inställt på UserSubscription hanteras kvoten för prenumerationen så att det här värdet inte returneras.
properties.dedicatedCoreQuotaPerVMFamilyEnforced	boolean		Ett värde som anger om kärnkvoter per virtuell dator-familj tillämpas för det här kontot Om den här flaggan är sann tillämpas den dedikerade kärnkvoten via både egenskaperna dedicatedCoreQuotaPerVMFamily och dedicatedCoreQuota på kontot. Om den här flaggan är falsk tillämpas den dedikerade kärnkvoten endast via egenskapen dedicatedCoreQuota på kontot och överväger inte virtual machine-familjen.
properties.encryption	EncryptionProperties		Krypteringskonfigurationen för Batch-kontot. Konfigurerar hur kunddata krypteras i Batch-kontot. Som standard krypteras konton med hjälp av en Microsoft-hanterad nyckel. För ytterligare kontroll kan en kundhanterad nyckel användas i stället.
properties.keyVaultReference	KeyVaultReference		En referens till Azure-nyckelvalvet som är associerat med Batch-kontot. Identifierar azure-nyckelvalvet som är associerat med ett Batch-konto.
properties.lowPriorityCoreQuota	integer (int32)		Kärnkvoten Spot/low-priority för Batch-kontot. För konton med PoolAllocationMode inställt på UserSubscription hanteras kvoten för prenumerationen så att det här värdet inte returneras.
properties.networkProfile	NetworkProfile		Nätverksprofil för Batch-konto, som innehåller nätverksregelinställningar för varje slutpunkt. Nätverksprofilen träder endast i kraft när publicNetworkAccess är aktiverat.
properties.nodeManagementEndpoint	string		Slutpunkten som används av beräkningsnoden för att ansluta till Batch-nodhanteringstjänsten.
properties.poolAllocationMode	PoolAllocationMode		Det allokeringsläge som ska användas för att skapa pooler i Batch-kontot. Allokeringsläget för att skapa pooler i Batch-kontot.
properties.poolQuota	integer (int32)		Poolkvoten för Batch-kontot.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista över privata slutpunktsanslutningar som är associerade med Batch-kontot
properties.provisioningState	ProvisioningState		Resursens etablerade tillstånd
properties.publicNetworkAccess	PublicNetworkAccessType	Enabled	Nätverksgränssnittstypen för åtkomst till Azure Batch-tjänsten och Batch-kontoåtgärder. Om det inte anges är standardvärdet "aktiverat".
tags	object		Taggarna för resursen.
type	string		Resurstypen.

BatchAccountIdentity

Objekt

Identiteten för Batch-kontot, om det är konfigurerat. Detta används när användaren anger "Microsoft.KeyVault" som krypteringskonfiguration för Batch-konto eller när ManagedIdentity väljs som autentiseringsläge för automatisk lagring.

Name	Typ	Description
principalId	string	Huvud-ID för Batch-kontot. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
tenantId	string	Klient-ID:t som är associerat med Batch-kontot. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
type	ResourceIdentityType	Den typ av identitet som används för Batch-kontot.
userAssignedIdentities	<string,  UserAssignedIdentities>	Listan över användaridentiteter som är associerade med Batch-kontot.

CloudError

Objekt

Ett felsvar från Batch-tjänsten.

Name	Typ	Description
error	CloudErrorBody	Brödtexten i felsvaret.

CloudErrorBody

Objekt

Ett felsvar från Batch-tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
details	CloudErrorBody[]	En lista med ytterligare information om felet.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
target	string	Målet för det specifika felet. Till exempel namnet på egenskapen i fel.

ComputeNodeIdentityReference

Objekt

Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda.

Name	Typ	Description
resourceId	string	ARM-resurs-ID för den användartilldelade identiteten.

EncryptionProperties

Objekt

Konfigurerar hur kunddata krypteras i Batch-kontot. Som standard krypteras konton med hjälp av en Microsoft-hanterad nyckel. För ytterligare kontroll kan en kundhanterad nyckel användas i stället.

Name	Typ	Description
keySource	KeySource	Typ av nyckelkälla.
keyVaultProperties	KeyVaultProperties	Ytterligare information när du använder Microsoft.KeyVault

EndpointAccessDefaultAction

Uppräkning

Standardåtgärden när det inte finns någon IPRule matchad.

Värde	Description
Allow	Tillåt klientåtkomst.
Deny	Neka klientåtkomst.

EndpointAccessProfile

Objekt

Nätverksåtkomstprofil för Batch-slutpunkt.

Name	Typ	Description
defaultAction	EndpointAccessDefaultAction	Standardåtgärden när det inte finns någon IPRule matchad. Standardåtgärd för slutpunktsåtkomst. Det gäller endast när publicNetworkAccess är aktiverat.
ipRules	IPRule[]	Matris med IP-intervall för att filtrera klientens IP-adress.

IPRule

Objekt

Regel för att filtrera klientens IP-adress.

Name	Typ	Description
action	IPRuleAction	Åtgärd när klientens IP-adress matchas.
value	string	IP-adressen eller IP-adressintervallet som ska filtreras IPv4-adress eller IPv4-adressintervall i CIDR-format.

IPRuleAction

Uppräkning

Åtgärd när klientens IP-adress matchas.

Värde	Description
Allow	Tillåt åtkomst för den matchade klientens IP-adress.

KeySource

Uppräkning

Typ av nyckelkälla.

Värde	Description
Microsoft.Batch	Batch skapar och hanterar de krypteringsnycklar som används för att skydda kontodata.
Microsoft.KeyVault	Krypteringsnycklarna som används för att skydda kontodata lagras i ett externt nyckelvalv. Om detta anges måste Batch-kontoidentiteten anges till SystemAssigned och en giltig nyckelidentifierare måste också anges under keyVaultProperties.

KeyVaultProperties

Objekt

KeyVault-konfiguration när du använder en krypteringsnyckelkälla för Microsoft.KeyVault.

Name	Typ	Description
keyIdentifier	string	Fullständig sökväg till hemligheten med eller utan version. Exempel https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. eller https://mykeyvault.vault.azure.net/keys/testkey. För att kunna användas måste följande krav uppfyllas: Batch-kontot har en systemtilldelad identitet Kontoidentiteten har beviljats behörigheterna Nyckel/Hämta, Nyckel/Packa upp och Nyckel/Omslut. KeyVault har mjuk borttagning och rensningsskydd aktiverat

KeyVaultReference

Objekt

Identifierar azure-nyckelvalvet som är associerat med ett Batch-konto.

Name	Typ	Description
id	string (arm-id)	Resurs-ID för Azure-nyckelvalvet som är associerat med Batch-kontot.
url	string	URL:en för Azure-nyckelvalvet som är associerat med Batch-kontot.

NetworkProfile

Objekt

Nätverksprofil för Batch-konto, som innehåller nätverksregelinställningar för varje slutpunkt.

Name	Typ	Description
accountAccess	EndpointAccessProfile	Nätverksåtkomstprofil för batchAccount-slutpunkt (Batch-kontodataplans-API).
nodeManagementAccess	EndpointAccessProfile	Nätverksåtkomstprofil för nodeManagement-slutpunkt (Batch-tjänst som hanterar beräkningsnoder för Batch-pooler).

PoolAllocationMode

Uppräkning

Allokeringsläget för att skapa pooler i Batch-kontot.

Värde	Description
BatchService	Pooler allokeras i prenumerationer som ägs av Batch-tjänsten.
UserSubscription	Pooler allokeras i en prenumeration som ägs av användaren.

PrivateEndpoint

Objekt

Den privata slutpunkten för den privata slutpunktsanslutningen.

Name	Typ	Description
id	string	ARM-resursidentifieraren för den privata slutpunkten. Det här är formuläret /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Objekt

Innehåller information om en privat länkresurs.

Name	Typ	Description
etag	string	ETag för resursen, som används för samtidighetsinstruktioner.
id	string	Resursens ID.
name	string	Namnet på resursen.
properties.groupIds	string[]	Grupp-ID för den privata slutpunktsanslutningen. Värdet har ett och bara ett grupp-ID.
properties.privateEndpoint	PrivateEndpoint	ARM-resursidentifieraren för den privata slutpunkten. Den privata slutpunkten för den privata slutpunktsanslutningen.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Anslutningstillståndet för privat länktjänst för den privata slutpunktsanslutningen. Anslutningstillståndet för tjänsten private link för den privata slutpunktsanslutningen
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Etableringstillståndet för den privata slutpunktsanslutningen.
tags	object	Taggarna för resursen.
type	string	Resurstypen.

PrivateEndpointConnectionProvisioningState

Uppräkning

Etableringstillståndet för den privata slutpunktsanslutningen.

Värde	Description
Cancelled	Användaren har avbrutit skapandet av anslutningen.
Creating	Anslutningen skapas.
Deleting	Anslutningen tas bort.
Failed	Användaren begärde att anslutningen skulle uppdateras och att den misslyckades. Du kan försöka uppdatera igen.
Succeeded	Anslutningsstatusen är slutgiltig och är klar för användning om Status är Godkänd.
Updating	Användaren har begärt att anslutningsstatusen ska uppdateras, men uppdateringsåtgärden har ännu inte slutförts. Du kanske inte refererar till anslutningen när du ansluter Batch-kontot.

PrivateLinkServiceConnectionState

Objekt

Anslutningstillståndet för tjänsten private link för den privata slutpunktsanslutningen

Name	Typ	Description
actionsRequired	string	Åtgärd som krävs för det privata anslutningstillståndet
description	string	Beskrivning av det privata anslutningstillståndet
status	PrivateLinkServiceConnectionStatus	Status för den privata slutpunktsanslutningen för Batch-kontot

PrivateLinkServiceConnectionStatus

Uppräkning

Status för den privata Batch-slutpunktsanslutningen

Värde	Description
Approved	Den privata slutpunktsanslutningen är godkänd och kan användas för att komma åt Batch-kontot
Disconnected	Den privata slutpunktsanslutningen är frånkopplad och kan inte användas för att komma åt Batch-kontot
Pending	Den privata slutpunktsanslutningen väntar och kan inte användas för att komma åt Batch-kontot
Rejected	Den privata slutpunktsanslutningen avvisas och kan inte användas för att komma åt Batch-kontot

ProvisioningState

Uppräkning

Resursens etablerade tillstånd

Värde	Description
Cancelled	Den sista åtgärden för kontot avbryts.
Creating	Kontot skapas.
Deleting	Kontot tas bort.
Failed	Den sista åtgärden för kontot misslyckades.
Invalid	Kontot är i ett ogiltigt tillstånd.
Succeeded	Kontot har skapats och är redo att användas.

PublicNetworkAccessType

Uppräkning

Nätverksåtkomsttypen för drift på resurserna i Batch-kontot.

Värde	Description
Disabled	Inaktiverar offentlig anslutning och möjliggör privat anslutning till Azure Batch Service via en privat slutpunktsresurs.
Enabled	Möjliggör anslutning till Azure Batch via offentlig DNS.
SecuredByPerimeter	Skyddar anslutningen till Azure Batch via NSP-konfiguration.

ResourceIdentityType

Uppräkning

Den typ av identitet som används för Batch-kontot.

Värde	Description
None	Batch-kontot har ingen associerad identitet. Om du anger None i uppdateringskontot tas befintliga identiteter bort.
SystemAssigned	Batch-kontot har en systemtilldelad identitet med sig.
UserAssigned	Batch-kontot har användartilldelade identiteter med sig.

UserAssignedIdentities

Objekt

Listan över associerade användaridentiteter.

Name	Typ	Description
clientId	string	Klient-ID för användartilldelad identitet.
principalId	string	Huvud-ID för användartilldelad identitet.

VirtualMachineFamilyCoreQuota

Objekt

En VM-familj och dess associerade kärnkvot för Batch-kontot.

Name	Typ	Description
coreQuota	integer (int32)	Kärnkvoten för vm-familjen för Batch-kontot.
name	string	Familjenamnet för virtuell dator.