Batch Account - Get

Service:

Batch Management

API Version:

2024-02-01

Pobiera informacje o określonym koncie usługi Batch.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
accountName	path	True	string	Nazwa konta usługi Batch. Regex pattern: ^[a-zA-Z0-9]+$
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej konto usługi Batch.
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure. Jest to ciąg w formacie GUID (np. 00000000-0000-0000-0000-0000-000000000000)
api-version	query	True	string	Wersja interfejsu API, która ma być używana z żądaniem HTTP.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	BatchAccount	Operacja zakończyła się pomyślnie. Odpowiedź zawiera jednostkę konta usługi Batch.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

przepływ kodu uwierzytelniania OAuth 2.0 Microsoft Entra

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa	Opis
AuthenticationMode	Tryb uwierzytelniania dla konta usługi Batch.
AutoStorageAuthenticationMode	Tryb uwierzytelniania używany przez usługę Batch do zarządzania kontem magazynu automatycznego.
AutoStorageProperties	Zawiera informacje o koncie automatycznego magazynu skojarzonego z kontem usługi Batch.
BatchAccount	Zawiera informacje o koncie Azure Batch.
BatchAccountIdentity	Tożsamość konta usługi Batch, jeśli została skonfigurowana. Jest to używane, gdy użytkownik określa wartość "Microsoft.KeyVault" jako konfigurację szyfrowania konta usługi Batch lub gdy ManagedIdentity jest wybierany jako tryb uwierzytelniania automatycznego magazynu.
CloudError	Odpowiedź na błąd z usługi Batch.
CloudErrorBody	Odpowiedź na błąd z usługi Batch.
ComputeNodeIdentityReference	Odwołanie do tożsamości przypisanej przez użytkownika skojarzonej z pulą usługi Batch, która będzie używana przez węzeł obliczeniowy.
EncryptionProperties	Konfiguruje sposób szyfrowania danych klienta wewnątrz konta usługi Batch. Domyślnie konta są szyfrowane przy użyciu klucza zarządzanego przez firmę Microsoft. Aby uzyskać dodatkową kontrolę, można zamiast tego użyć klucza zarządzanego przez klienta.
EndpointAccessDefaultAction	Domyślna akcja, gdy nie jest dopasowana reguła IPRule.
EndpointAccessProfile	Profil dostępu do sieci dla punktu końcowego usługi Batch.
IPRule	Reguła filtrowania adresu IP klienta.
IPRuleAction	Akcja w przypadku dopasowania adresu IP klienta.
KeySource	Typ źródła klucza.
KeyVaultProperties	Konfiguracja usługi KeyVault podczas korzystania z szyfrowania KeySource usługi Microsoft.KeyVault.
KeyVaultReference	Identyfikuje magazyn kluczy platformy Azure skojarzony z kontem usługi Batch.
NetworkProfile	Profil sieciowy dla konta usługi Batch, który zawiera ustawienia reguły sieci dla każdego punktu końcowego.
PoolAllocationMode	Tryb alokacji do tworzenia pul na koncie usługi Batch.
PrivateEndpoint	Prywatny punkt końcowy połączenia prywatnego punktu końcowego.
PrivateEndpointConnection	Zawiera informacje o zasobie łącza prywatnego.
PrivateEndpointConnectionProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.
PrivateLinkServiceConnectionState	Stan połączenia usługi łącza prywatnego połączenia z prywatnym punktem końcowym
PrivateLinkServiceConnectionStatus	Stan połączenia prywatnego punktu końcowego usługi Batch
ProvisioningState	Stan aprowizacji zasobu
PublicNetworkAccessType	Typ dostępu do sieci dla operacji na zasobach na koncie usługi Batch.
ResourceIdentityType	Typ tożsamości używanej dla konta usługi Batch.
UserAssignedIdentities	Lista skojarzonych tożsamości użytkowników.
VirtualMachineFamilyCoreQuota	Rodzina maszyn wirtualnych i skojarzony z nim limit przydziału rdzeni dla konta usługi Batch.

AuthenticationMode

Tryb uwierzytelniania dla konta usługi Batch.

Nazwa	Typ	Opis
AAD	string	Tryb uwierzytelniania przy użyciu Tożsamość Microsoft Entra.
SharedKey	string	Tryb uwierzytelniania przy użyciu kluczy udostępnionych.
TaskAuthenticationToken	string	Tryb uwierzytelniania przy użyciu tokenów uwierzytelniania zadań.

AutoStorageAuthenticationMode

Tryb uwierzytelniania używany przez usługę Batch do zarządzania kontem magazynu automatycznego.

Nazwa	Typ	Opis
BatchAccountManagedIdentity	string	Usługa Batch uwierzytelni żądania automatycznego magazynu przy użyciu tożsamości zarządzanej przypisanej do konta usługi Batch.
StorageKeys	string	Usługa Batch będzie uwierzytelniać żądania automatycznego magazynu przy użyciu kluczy konta magazynu.

AutoStorageProperties

Zawiera informacje o koncie automatycznego magazynu skojarzonego z kontem usługi Batch.

Nazwa	Typ	Wartość domyślna	Opis
authenticationMode	AutoStorageAuthenticationMode	StorageKeys	Tryb uwierzytelniania używany przez usługę Batch do zarządzania kontem magazynu automatycznego.
lastKeySync	string		Czas UTC, w którym klucze magazynu zostały ostatnio zsynchronizowane z kontem usługi Batch.
nodeIdentityReference	ComputeNodeIdentityReference		Odwołanie do tożsamości przypisanej przez użytkownika, której węzły obliczeniowe będą używać do uzyskiwania dostępu do automatycznego magazynu. Tożsamość, do której odwołuje się tutaj, musi być przypisana do pul, które mają węzły obliczeniowe, które wymagają dostępu do automatycznego magazynu.
storageAccountId	string		Identyfikator zasobu konta magazynu, który ma być używany dla konta magazynu automatycznego.

BatchAccount

Zawiera informacje o koncie Azure Batch.

Nazwa	Typ	Wartość domyślna	Opis
id	string		Identyfikator zasobu.
identity	BatchAccountIdentity		Tożsamość konta usługi Batch.
location	string		Lokalizacja zasobu.
name	string		Nazwa zasobu.
properties.accountEndpoint	string		Punkt końcowy konta używany do interakcji z usługą Batch.
properties.activeJobAndJobScheduleQuota	integer		Aktywny limit przydziału harmonogramu zadań i zadania dla konta usługi Batch.
properties.allowedAuthenticationModes	AuthenticationMode[]		Lista dozwolonych trybów uwierzytelniania dla konta usługi Batch, których można użyć do uwierzytelniania za pomocą płaszczyzny danych. Nie ma to wpływu na uwierzytelnianie za pomocą płaszczyzny sterowania.
properties.autoStorage	AutoStorageProperties		Właściwości i stan dowolnego konta magazynu automatycznego skojarzonego z kontem usługi Batch. Zawiera informacje o koncie automatycznego magazynu skojarzonego z kontem usługi Batch.
properties.dedicatedCoreQuota	integer		Dedykowany limit przydziału rdzeni dla konta usługi Batch. W przypadku kont z ustawieniem PoolAllocationMode na wartość UserSubscription limit przydziału jest zarządzany w ramach subskrypcji, więc ta wartość nie jest zwracana.
properties.dedicatedCoreQuotaPerVMFamily	VirtualMachineFamilyCoreQuota[]		Lista dedykowanego limitu przydziału rdzeni dla rodziny maszyn wirtualnych dla konta usługi Batch. W przypadku kont z ustawieniem PoolAllocationMode na wartość UserSubscription limit przydziału jest zarządzany w ramach subskrypcji, więc ta wartość nie jest zwracana.
properties.dedicatedCoreQuotaPerVMFamilyEnforced	boolean		Wartość wskazująca, czy limity przydziału rdzeni dla rodziny maszyn wirtualnych są wymuszane dla tego konta Jeśli ta flaga jest prawdziwa, dedykowany limit przydziału rdzeni jest wymuszany za pośrednictwem właściwości dedicatedCoreQuotaPerVMFamily i dedicatedCoreQuota na koncie. Jeśli ta flaga jest fałszywa, dedykowany limit przydziału rdzeni jest wymuszany tylko za pośrednictwem właściwości dedicatedCoreQuota na koncie i nie uwzględnia rodziny maszyn wirtualnych.
properties.encryption	EncryptionProperties		Konfiguracja szyfrowania dla konta usługi Batch. Konfiguruje sposób szyfrowania danych klienta wewnątrz konta usługi Batch. Domyślnie konta są szyfrowane przy użyciu klucza zarządzanego przez firmę Microsoft. Aby uzyskać dodatkową kontrolę, można zamiast tego użyć klucza zarządzanego przez klienta.
properties.keyVaultReference	KeyVaultReference		Odwołanie do magazynu kluczy platformy Azure skojarzonego z kontem usługi Batch. Identyfikuje magazyn kluczy platformy Azure skojarzony z kontem usługi Batch.
properties.lowPriorityCoreQuota	integer		Limit przydziału rdzeni typu spot/low-priority dla konta usługi Batch. W przypadku kont z ustawieniem PoolAllocationMode na wartość UserSubscription limit przydziału jest zarządzany w ramach subskrypcji, więc ta wartość nie jest zwracana.
properties.networkProfile	NetworkProfile		Profil sieciowy dla konta usługi Batch, który zawiera ustawienia reguły sieci dla każdego punktu końcowego. Profil sieciowy jest obowiązywać tylko wtedy, gdy funkcja publicNetworkAccess jest włączona.
properties.nodeManagementEndpoint	string		Punkt końcowy używany przez węzeł obliczeniowy do nawiązywania połączenia z usługą zarządzania węzłami usługi Batch.
properties.poolAllocationMode	PoolAllocationMode		Tryb alokacji na potrzeby tworzenia pul w ramach konta usługi Batch. Tryb alokacji do tworzenia pul na koncie usługi Batch.
properties.poolQuota	integer		Limit przydziału puli dla konta usługi Batch.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista połączeń prywatnego punktu końcowego skojarzonych z kontem usługi Batch
properties.provisioningState	ProvisioningState		Stan aprowizacji zasobu
properties.publicNetworkAccess	PublicNetworkAccessType	Enabled	Typ interfejsu sieciowego na potrzeby uzyskiwania dostępu do Azure Batch usług i operacji konta usługi Batch. Jeśli nie zostanie określona, wartość domyślna to "włączone".
tags	object		Tagi zasobu.
type	string		Typ zasobu.

BatchAccountIdentity

Tożsamość konta usługi Batch, jeśli została skonfigurowana. Jest to używane, gdy użytkownik określa wartość "Microsoft.KeyVault" jako konfigurację szyfrowania konta usługi Batch lub gdy ManagedIdentity jest wybierany jako tryb uwierzytelniania automatycznego magazynu.

Nazwa	Typ	Opis
principalId	string	Identyfikator podmiotu zabezpieczeń konta usługi Batch. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
tenantId	string	Identyfikator dzierżawy skojarzony z kontem usługi Batch. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
type	ResourceIdentityType	Typ tożsamości używany dla konta usługi Batch.
userAssignedIdentities	object	Lista tożsamości użytkowników skojarzonych z kontem usługi Batch.

CloudError

Odpowiedź na błąd z usługi Batch.

Nazwa	Typ	Opis
error	CloudErrorBody	Treść odpowiedzi o błędzie.

CloudErrorBody

Odpowiedź na błąd z usługi Batch.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

ComputeNodeIdentityReference

Odwołanie do tożsamości przypisanej przez użytkownika skojarzonej z pulą usługi Batch, która będzie używana przez węzeł obliczeniowy.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu usługi ARM tożsamości przypisanej przez użytkownika.

EncryptionProperties

Konfiguruje sposób szyfrowania danych klienta wewnątrz konta usługi Batch. Domyślnie konta są szyfrowane przy użyciu klucza zarządzanego przez firmę Microsoft. Aby uzyskać dodatkową kontrolę, można zamiast tego użyć klucza zarządzanego przez klienta.

Nazwa	Typ	Opis
keySource	KeySource	Typ źródła klucza.
keyVaultProperties	KeyVaultProperties	Dodatkowe szczegóły dotyczące korzystania z usługi Microsoft.KeyVault

EndpointAccessDefaultAction

Domyślna akcja, gdy nie jest dopasowana reguła IPRule.

Nazwa	Typ	Opis
Allow	string	Zezwalaj na dostęp klienta.
Deny	string	Odmowa dostępu klienta.

EndpointAccessProfile

Profil dostępu do sieci dla punktu końcowego usługi Batch.

Nazwa	Typ	Opis
defaultAction	EndpointAccessDefaultAction	Domyślna akcja, gdy nie jest dopasowana reguła IPRule. Domyślna akcja dostępu do punktu końcowego. Ma zastosowanie tylko wtedy, gdy funkcja publicNetworkAccess jest włączona.
ipRules	IPRule[]	Tablica zakresów adresów IP do filtrowania adresu IP klienta.

IPRule

Reguła filtrowania adresu IP klienta.

Nazwa	Typ	Opis
action	IPRuleAction	Akcja w przypadku dopasowania adresu IP klienta.
value	string	Adres IP lub zakres adresów IP do filtrowania Adres IPv4 lub zakres adresów IPv4 w formacie CIDR.

IPRuleAction

Akcja w przypadku dopasowania adresu IP klienta.

Nazwa	Typ	Opis
Allow	string	Zezwalaj na dostęp dla dopasowanego adresu IP klienta.

KeySource

Typ źródła klucza.

Nazwa	Typ	Opis
Microsoft.Batch	string	Usługa Batch tworzy klucze szyfrowania używane do ochrony danych konta i zarządza nimi.
Microsoft.KeyVault	string	Klucze szyfrowania używane do ochrony danych konta są przechowywane w zewnętrznym magazynie kluczy. Jeśli jest to ustawione, tożsamość konta usługi Batch musi być ustawiona na SystemAssigned , a prawidłowy identyfikator klucza musi być również podany w obszarze keyVaultProperties.

KeyVaultProperties

Konfiguracja usługi KeyVault podczas korzystania z szyfrowania KeySource usługi Microsoft.KeyVault.

Nazwa	Typ	Opis
keyIdentifier	string	Pełna ścieżka do wpisu tajnego z wersją lub bez tej wersji. Przykład https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. lub https://mykeyvault.vault.azure.net/keys/testkey. Aby można było korzystać z następujących wymagań wstępnych, należy spełnić następujące wymagania wstępne: Konto usługi Batch ma tożsamość przypisaną przez system Tożsamość konta została udzielona: Klucz/Pobieranie, Klucz/Odpakowywanie i Zawijanie klucza/Opakowywanie uprawnienia KeyVault ma włączone usuwanie nietrwałe i ochronę przed przeczyszczaniem

KeyVaultReference

Identyfikuje magazyn kluczy platformy Azure skojarzony z kontem usługi Batch.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu usługi Azure Key Vault skojarzonego z kontem usługi Batch.
url	string	Adres URL usługi Azure Key Vault skojarzonego z kontem usługi Batch.

NetworkProfile

Profil sieciowy dla konta usługi Batch, który zawiera ustawienia reguły sieci dla każdego punktu końcowego.

Nazwa	Typ	Opis
accountAccess	EndpointAccessProfile	Profil dostępu do sieci dla punktu końcowego usługi BatchAccount (interfejs API płaszczyzny danych konta usługi Batch).
nodeManagementAccess	EndpointAccessProfile	Profil dostępu do sieci dla punktu końcowego nodeManagement (usługa Batch zarządzająca węzłami obliczeniowymi dla pul usługi Batch).

PoolAllocationMode

Tryb alokacji do tworzenia pul na koncie usługi Batch.

Nazwa	Typ	Opis
BatchService	string	Pule zostaną przydzielone w subskrypcjach należących do usługi Batch.
UserSubscription	string	Pule zostaną przydzielone w subskrypcji należącej do użytkownika.

PrivateEndpoint

Prywatny punkt końcowy połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu usługi ARM prywatnego punktu końcowego. Jest to formularz /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Zawiera informacje o zasobie łącza prywatnego.

Nazwa	Typ	Opis
etag	string	Element ETag zasobu używany do instrukcji współbieżności.
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.groupIds	string[]	Identyfikator grupy połączenia prywatnego punktu końcowego. Wartość ma jeden i tylko jeden identyfikator grupy.
properties.privateEndpoint	PrivateEndpoint	Identyfikator zasobu usługi ARM prywatnego punktu końcowego. Prywatny punkt końcowy połączenia prywatnego punktu końcowego.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stan połączenia usługi private link połączenia z prywatnym punktem końcowym. Stan połączenia usługi łącza prywatnego połączenia z prywatnym punktem końcowym
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.
type	string	Typ zasobu.

PrivateEndpointConnectionProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
Cancelled	string	Użytkownik anulował tworzenie połączenia.
Creating	string	Trwa tworzenie połączenia.
Deleting	string	Połączenie jest usuwane.
Failed	string	Użytkownik zażądał, aby połączenie zostało zaktualizowane i nie powiodło się. Możesz ponowić próbę wykonania operacji aktualizacji.
Succeeded	string	Stan połączenia jest końcowy i jest gotowy do użycia, jeśli stan to Zatwierdzone.
Updating	string	Użytkownik zażądał zaktualizowania stanu połączenia, ale operacja aktualizacji nie została jeszcze ukończona. Nie można odwoływać się do połączenia podczas nawiązywania połączenia z kontem usługi Batch.

PrivateLinkServiceConnectionState

Stan połączenia usługi łącza prywatnego połączenia z prywatnym punktem końcowym

Nazwa	Typ	Opis
actionsRequired	string	Akcja wymagana w stanie połączenia prywatnego
description	string	Opis stanu połączenia prywatnego
status	PrivateLinkServiceConnectionStatus	Stan połączenia prywatnego punktu końcowego konta usługi Batch

PrivateLinkServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego usługi Batch

Nazwa	Typ	Opis
Approved	string	Połączenie prywatnego punktu końcowego jest zatwierdzone i może służyć do uzyskiwania dostępu do konta usługi Batch
Disconnected	string	Połączenie prywatnego punktu końcowego jest rozłączone i nie można go użyć do uzyskiwania dostępu do konta usługi Batch
Pending	string	Połączenie prywatnego punktu końcowego oczekuje i nie może być używane do uzyskiwania dostępu do konta usługi Batch
Rejected	string	Połączenie prywatnego punktu końcowego jest odrzucane i nie można go użyć do uzyskiwania dostępu do konta usługi Batch

ProvisioningState

Stan aprowizacji zasobu

Nazwa	Typ	Opis
Cancelled	string	Ostatnia operacja konta została anulowana.
Creating	string	Konto jest tworzone.
Deleting	string	Konto jest usuwane.
Failed	string	Ostatnia operacja dla konta nie powiodła się.
Invalid	string	Konto jest w nieprawidłowym stanie.
Succeeded	string	Konto zostało utworzone i jest gotowe do użycia.

PublicNetworkAccessType

Typ dostępu do sieci dla operacji na zasobach na koncie usługi Batch.

Nazwa	Typ	Opis
Disabled	string	Wyłącza łączność publiczną i umożliwia łączność prywatną z usługą Azure Batch za pośrednictwem zasobu prywatnego punktu końcowego.
Enabled	string	Umożliwia łączność z Azure Batch za pośrednictwem publicznego systemu DNS.

ResourceIdentityType

Typ tożsamości używanej dla konta usługi Batch.

Nazwa	Typ	Opis
None	string	Konto usługi Batch nie ma skojarzonej tożsamości. Ustawienie None na koncie aktualizacji spowoduje usunięcie istniejących tożsamości.
SystemAssigned	string	Konto usługi Batch ma tożsamość przypisaną przez system.
UserAssigned	string	Konto usługi Batch ma przypisane przez użytkownika tożsamości.

UserAssignedIdentities

Lista skojarzonych tożsamości użytkowników.

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta tożsamości przypisanej przez użytkownika.
principalId	string	Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika.

VirtualMachineFamilyCoreQuota

Rodzina maszyn wirtualnych i skojarzony z nim limit przydziału rdzeni dla konta usługi Batch.

Nazwa	Typ	Opis
coreQuota	integer	Limit przydziału rdzeni dla rodziny maszyn wirtualnych dla konta usługi Batch.
name	string	Nazwa rodziny maszyn wirtualnych.