Batch Account - Get

Service:

Batch Management

API Version:

2024-02-01

Возвращает сведения об указанной учетной записи пакетной службы.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
accountName	path	True	string	Имя учетной записи пакетной службы. Regex pattern: ^[a-zA-Z0-9]+$
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей учетную запись пакетной службы.
subscriptionId	path	True	string	Идентификатор подписки Azure. Это строка в формате GUID (например, 0000000-0000-0000-0000-0000-000000000000000).
api-version	query	True	string	Версия API, используемая с HTTP-запросом.

Ответы

Имя	Тип	Описание
200 OK	BatchAccount	Операция выполнена успешно. Ответ содержит сущность учетной записи пакетной службы.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Microsoft Entra поток кода проверки подлинности OAuth 2.0

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Определения

Имя	Описание
AuthenticationMode	Режим проверки подлинности для учетной записи пакетной службы.
AutoStorageAuthenticationMode	Режим проверки подлинности, который пакетная служба будет использовать для управления учетной записью автоматического хранения.
AutoStorageProperties	Содержит сведения об учетной записи автоматического хранения, связанной с учетной записью пакетной службы.
BatchAccount	Содержит сведения об учетной записи пакетная служба Azure.
BatchAccountIdentity	Удостоверение учетной записи пакетной службы, если настроено. Используется, когда пользователь указывает Microsoft.KeyVault в качестве конфигурации шифрования учетной записи пакетной службы или если ManagedIdentity выбран режим проверки подлинности автоматического хранения.
CloudError	Ответ об ошибке от пакетной службы.
CloudErrorBody	Ответ об ошибке от пакетной службы.
ComputeNodeIdentityReference	Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
EncryptionProperties	Настраивает способ шифрования данных клиента в учетной записи пакетной службы. По умолчанию учетные записи шифруются с помощью ключа, управляемого Корпорацией Майкрософт. Для дополнительного управления можно использовать ключ, управляемый клиентом.
EndpointAccessDefaultAction	Действие по умолчанию при отсутствии сопоставления IPRule.
EndpointAccessProfile	Профиль доступа к сети для конечной точки пакетной службы.
IPRule	Правило для фильтрации IP-адреса клиента.
IPRuleAction	Действие при сопоставлении IP-адреса клиента.
KeySource	Тип источника ключа.
KeyVaultProperties	Конфигурация KeyVault при использовании keySource шифрования Microsoft.KeyVault.
KeyVaultReference	Определяет хранилище ключей Azure, связанное с учетной записью пакетной службы.
NetworkProfile	Сетевой профиль для учетной записи пакетной службы, который содержит параметры правил сети для каждой конечной точки.
PoolAllocationMode	Режим выделения для создания пулов в учетной записи пакетной службы.
PrivateEndpoint	Частная конечная точка подключения к частной конечной точке.
PrivateEndpointConnection	Содержит сведения о ресурсе приватного канала.
PrivateEndpointConnectionProvisioningState	Состояние подготовки подключения к частной конечной точке.
PrivateLinkServiceConnectionState	Состояние подключения службы приватного канала для подключения к частной конечной точке
PrivateLinkServiceConnectionStatus	Состояние подключения к частной конечной точке пакетной службы
ProvisioningState	Подготовленное состояние ресурса
PublicNetworkAccessType	Тип сетевого доступа для работы с ресурсами в учетной записи пакетной службы.
ResourceIdentityType	Тип удостоверения, используемого для учетной записи пакетной службы.
UserAssignedIdentities	Список связанных удостоверений пользователей.
VirtualMachineFamilyCoreQuota	Семейство виртуальных машин и связанная с ним квота ядра для учетной записи пакетной службы.

AuthenticationMode

Режим проверки подлинности для учетной записи пакетной службы.

Имя	Тип	Описание
AAD	string	Режим проверки подлинности с использованием Microsoft Entra ID.
SharedKey	string	Режим проверки подлинности с использованием общих ключей.
TaskAuthenticationToken	string	Режим проверки подлинности с использованием маркеров проверки подлинности задачи.

AutoStorageAuthenticationMode

Режим проверки подлинности, который пакетная служба будет использовать для управления учетной записью автоматического хранения.

Имя	Тип	Описание
BatchAccountManagedIdentity	string	Пакетная служба будет проверять подлинность запросов к автоматическому хранилищу с помощью управляемого удостоверения, назначенного учетной записи пакетной службы.
StorageKeys	string	Пакетная служба будет проверять подлинность запросов к автоматическому хранению с помощью ключей учетной записи хранения.

AutoStorageProperties

Содержит сведения об учетной записи автоматического хранения, связанной с учетной записью пакетной службы.

Имя	Тип	Значение по умолчанию	Описание
authenticationMode	AutoStorageAuthenticationMode	StorageKeys	Режим проверки подлинности, который пакетная служба будет использовать для управления учетной записью автоматического хранения.
lastKeySync	string		Время в формате UTC, в которое ключи хранилища были синхронизированы с учетной записью пакетной службы.
nodeIdentityReference	ComputeNodeIdentityReference		Ссылка на назначенное пользователем удостоверение, которое вычислительные узлы будут использовать для доступа к автоматическому хранилищу. Указанное здесь удостоверение должно быть назначено пулам с вычислительными узлами, которым требуется доступ к автоматическому хранилищу.
storageAccountId	string		Идентификатор ресурса учетной записи хранения, которая будет использоваться для учетной записи автоматического хранения.

BatchAccount

Содержит сведения об учетной записи пакетная служба Azure.

Имя	Тип	Значение по умолчанию	Описание
id	string		Идентификатор ресурса.
identity	BatchAccountIdentity		Удостоверение учетной записи пакетной службы.
location	string		Расположение ресурса.
name	string		Имя ресурса.
properties.accountEndpoint	string		Конечная точка учетной записи, используемая для взаимодействия с пакетной службой.
properties.activeJobAndJobScheduleQuota	integer		Квота активного задания и расписания заданий для учетной записи пакетной службы.
properties.allowedAuthenticationModes	AuthenticationMode[]		Список разрешенных режимов проверки подлинности для учетной записи пакетной службы, которые можно использовать для проверки подлинности в плоскости данных. Это не влияет на проверку подлинности на уровне управления.
properties.autoStorage	AutoStorageProperties		Свойства и состояние любой учетной записи автоматического хранения, связанной с учетной записью пакетной службы. Содержит сведения об учетной записи автоматического хранения, связанной с учетной записью пакетной службы.
properties.dedicatedCoreQuota	integer		Выделенная квота на ядра для учетной записи пакетной службы. Для учетных записей с параметром PoolAllocationMode, для параметра UserSubscription квота управляется в подписке, поэтому это значение не возвращается.
properties.dedicatedCoreQuotaPerVMFamily	VirtualMachineFamilyCoreQuota[]		Список выделенной квоты ядер на семейство виртуальных машин для учетной записи пакетной службы. Для учетных записей с параметром PoolAllocationMode, для параметра UserSubscription квота управляется в подписке, поэтому это значение не возвращается.
properties.dedicatedCoreQuotaPerVMFamilyEnforced	boolean		Значение, указывающее, применяются ли квоты на ядра для семейства виртуальных машин для этой учетной записи. Если этот флаг имеет значение true, квота выделенного ядра применяется с помощью свойств dedicatedCoreQuotaPerVMFamily и dedicatedCoreQuota учетной записи. Если этот флаг имеет значение false, выделенная квота на ядра применяется только через свойство dedicatedCoreQuota учетной записи и не учитывает семейство виртуальных машин.
properties.encryption	EncryptionProperties		Конфигурация шифрования для учетной записи пакетной службы. Настраивает способ шифрования данных клиента в учетной записи пакетной службы. По умолчанию учетные записи шифруются с помощью ключа, управляемого Корпорацией Майкрософт. Для дополнительного управления можно использовать ключ, управляемый клиентом.
properties.keyVaultReference	KeyVaultReference		Ссылка на хранилище ключей Azure, связанное с учетной записью пакетной службы. Определяет хранилище ключей Azure, связанное с учетной записью пакетной службы.
properties.lowPriorityCoreQuota	integer		Квота точечных и низкоприоритетных ядер для учетной записи пакетной службы. Для учетных записей с параметром PoolAllocationMode, для параметра UserSubscription квота управляется в подписке, поэтому это значение не возвращается.
properties.networkProfile	NetworkProfile		Сетевой профиль для учетной записи пакетной службы, который содержит параметры правил сети для каждой конечной точки. Сетевой профиль вступает в силу только при включении publicNetworkAccess.
properties.nodeManagementEndpoint	string		Конечная точка, используемая вычислительным узлом для подключения к службе управления узлами пакетной службы.
properties.poolAllocationMode	PoolAllocationMode		режим выделения для создания пулов в учетной записи пакетной службы. Режим выделения для создания пулов в учетной записи пакетной службы.
properties.poolQuota	integer		Квота пула для учетной записи пакетной службы.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Список подключений к частной конечной точке, связанных с учетной записью пакетной службы
properties.provisioningState	ProvisioningState		Подготовленное состояние ресурса
properties.publicNetworkAccess	PublicNetworkAccessType	Enabled	Тип сетевого интерфейса для доступа к пакетная служба Azure службам и операциям учетной записи пакетной службы. Если значение не указано, по умолчанию используется значение "enabled".
tags	object		Теги ресурса.
type	string		Тип ресурса.

BatchAccountIdentity

Удостоверение учетной записи пакетной службы, если настроено. Используется, когда пользователь указывает Microsoft.KeyVault в качестве конфигурации шифрования учетной записи пакетной службы или если ManagedIdentity выбран режим проверки подлинности автоматического хранения.

Имя	Тип	Описание
principalId	string	Идентификатор субъекта учетной записи пакетной службы. Это свойство предоставляется только для удостоверения, назначаемого системой.
tenantId	string	Идентификатор клиента, связанный с учетной записью пакетной службы. Это свойство предоставляется только для удостоверения, назначаемого системой.
type	ResourceIdentityType	Тип удостоверения, используемого для учетной записи пакетной службы.
userAssignedIdentities	object	Список удостоверений пользователей, связанных с учетной записью пакетной службы.

CloudError

Ответ об ошибке от пакетной службы.

Имя	Тип	Описание
error	CloudErrorBody	Текст ответа об ошибке.

CloudErrorBody

Ответ об ошибке от пакетной службы.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение с описанием ошибки, предназначенное для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

ComputeNodeIdentityReference

Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса ARM для удостоверения, назначаемого пользователем.

EncryptionProperties

Настраивает способ шифрования данных клиента в учетной записи пакетной службы. По умолчанию учетные записи шифруются с помощью ключа, управляемого Корпорацией Майкрософт. Для дополнительного управления можно использовать ключ, управляемый клиентом.

Имя	Тип	Описание
keySource	KeySource	Тип источника ключа.
keyVaultProperties	KeyVaultProperties	Дополнительные сведения об использовании Microsoft.KeyVault

EndpointAccessDefaultAction

Действие по умолчанию при отсутствии сопоставления IPRule.

Имя	Тип	Описание
Allow	string	Разрешить клиентский доступ.
Deny	string	Запретить доступ клиента.

EndpointAccessProfile

Профиль доступа к сети для конечной точки пакетной службы.

Имя	Тип	Описание
defaultAction	EndpointAccessDefaultAction	Действие по умолчанию при отсутствии сопоставления IPRule. Действие по умолчанию для доступа к конечной точке. Это применимо, только если включена функция publicNetworkAccess.
ipRules	IPRule[]	Массив диапазонов IP-адресов для фильтрации IP-адресов клиента.

IPRule

Правило для фильтрации IP-адреса клиента.

Имя	Тип	Описание
action	IPRuleAction	Действие при сопоставлении IP-адреса клиента.
value	string	IP-адрес или диапазон IP-адресов для фильтрации IPv4-адрес или диапазон IPv4-адресов в формате CIDR.

IPRuleAction

Действие при сопоставлении IP-адреса клиента.

Имя	Тип	Описание
Allow	string	Разрешите доступ для соответствующего IP-адреса клиента.

KeySource

Тип источника ключа.

Имя	Тип	Описание
Microsoft.Batch	string	Пакетная служба создает ключи шифрования, используемые для защиты данных учетной записи, и управляет ими.
Microsoft.KeyVault	string	Ключи шифрования, используемые для защиты данных учетной записи, хранятся во внешнем хранилище ключей. Если этот параметр задан, для удостоверения учетной записи пакетной службы должно быть задано значение SystemAssigned , а в keyVaultProperties также должен быть указан допустимый идентификатор ключа.

KeyVaultProperties

Конфигурация KeyVault при использовании keySource шифрования Microsoft.KeyVault.

Имя	Тип	Описание
keyIdentifier	string	Полный путь к секрету с версией или без нее. Пример https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. или https://mykeyvault.vault.azure.net/keys/testkey. Чтобы обеспечить возможность использования, необходимо выполнить следующие предварительные требования: Учетная запись пакетной службы имеет удостоверение, назначаемое системой. Удостоверение учетной записи было предоставлено разрешение Key/Get, Key/Unwrap и Key/Wrap( Хранилище ключей имеет обратимое удаление и защиту от очистки)

KeyVaultReference

Определяет хранилище ключей Azure, связанное с учетной записью пакетной службы.

Имя	Тип	Описание
id	string	идентификатор ресурса хранилища ключей Azure, связанный с учетной записью пакетной службы.
url	string	URL-адрес хранилища ключей Azure, связанный с учетной записью пакетной службы.

NetworkProfile

Сетевой профиль для учетной записи пакетной службы, который содержит параметры правил сети для каждой конечной точки.

Имя	Тип	Описание
accountAccess	EndpointAccessProfile	Профиль сетевого доступа для конечной точки batchAccount (API плоскости данных учетной записи пакетной службы).
nodeManagementAccess	EndpointAccessProfile	Профиль доступа к сети для конечной точки nodeManagement (пакетная служба, управляющая вычислительными узлами для пулов пакетной службы).

PoolAllocationMode

Режим выделения для создания пулов в учетной записи пакетной службы.

Имя	Тип	Описание
BatchService	string	Пулы будут выделены в подписках, принадлежащих пакетной службе.
UserSubscription	string	Пулы будут выделены в подписке, принадлежащей пользователю.

PrivateEndpoint

Частная конечная точка подключения к частной конечной точке.

Имя	Тип	Описание
id	string	Идентификатор ресурса ARM частной конечной точки. Это форма /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Содержит сведения о ресурсе приватного канала.

Имя	Тип	Описание
etag	string	ETag ресурса, используемого для операторов параллелизма.
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.groupIds	string[]	Идентификатор группы подключения к частной конечной точке. Значение имеет один и только один идентификатор группы.
properties.privateEndpoint	PrivateEndpoint	Идентификатор ресурса ARM частной конечной точки. Частная конечная точка подключения к частной конечной точке.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Состояние подключения службы приватного канала для подключения к частной конечной точке. Состояние подключения службы приватного канала для подключения к частной конечной точке
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Состояние подготовки подключения к частной конечной точке.
type	string	Тип ресурса.

PrivateEndpointConnectionProvisioningState

Состояние подготовки подключения к частной конечной точке.

Имя	Тип	Описание
Cancelled	string	Пользователь отменил создание подключения.
Creating	string	Соединение создается.
Deleting	string	Подключение удаляется.
Failed	string	Пользователь запросил обновление подключения, и оно завершилось сбоем. Вы можете повторить операцию обновления.
Succeeded	string	Состояние подключения является окончательным и готово к использованию, если состояние — Утверждено.
Updating	string	Пользователь запросил обновление состояния подключения, но операция обновления еще не завершена. При подключении учетной записи пакетной службы нельзя ссылать на подключение.

PrivateLinkServiceConnectionState

Состояние подключения службы приватного канала для подключения к частной конечной точке

Имя	Тип	Описание
actionsRequired	string	Действие, необходимое для состояния частного подключения
description	string	Описание состояния частного подключения
status	PrivateLinkServiceConnectionStatus	Состояние подключения к частной конечной точке учетной записи пакетной службы

PrivateLinkServiceConnectionStatus

Состояние подключения к частной конечной точке пакетной службы

Имя	Тип	Описание
Approved	string	Подключение к частной конечной точке утверждено и может использоваться для доступа к учетной записи пакетной службы.
Disconnected	string	Подключение к частной конечной точке отключено и не может использоваться для доступа к учетной записи пакетной службы.
Pending	string	Подключение к частной конечной точке находится в состоянии ожидания и не может использоваться для доступа к учетной записи пакетной службы
Rejected	string	Подключение к частной конечной точке отклонено и не может использоваться для доступа к учетной записи пакетной службы.

ProvisioningState

Подготовленное состояние ресурса

Имя	Тип	Описание
Cancelled	string	Последняя операция для учетной записи отменяется.
Creating	string	Создается учетная запись.
Deleting	string	Учетная запись удаляется.
Failed	string	Последняя операция для учетной записи завершается сбоем.
Invalid	string	Учетная запись находится в недопустимом состоянии.
Succeeded	string	Учетная запись создана и готова к использованию.

PublicNetworkAccessType

Тип сетевого доступа для работы с ресурсами в учетной записи пакетной службы.

Имя	Тип	Описание
Disabled	string	Отключает общедоступное подключение и включает частное подключение к службе пакетная служба Azure через ресурс частной конечной точки.
Enabled	string	Обеспечивает подключение к пакетная служба Azure через общедоступную службу DNS.

ResourceIdentityType

Тип удостоверения, используемого для учетной записи пакетной службы.

Имя	Тип	Описание
None	string	Учетная запись пакетной службы не связана с ней. Настройка None в учетной записи обновления приведет к удалению существующих удостоверений.
SystemAssigned	string	Учетная запись пакетной службы имеет назначенное системой удостоверение.
UserAssigned	string	Учетная запись пакетной службы имеет удостоверения, назначенные пользователем.

UserAssignedIdentities

Список связанных удостоверений пользователей.

Имя	Тип	Описание
clientId	string	Идентификатор клиента удостоверения, назначаемого пользователем.
principalId	string	Идентификатор субъекта удостоверения, назначаемого пользователем.

VirtualMachineFamilyCoreQuota

Семейство виртуальных машин и связанная с ним квота ядра для учетной записи пакетной службы.

Имя	Тип	Описание
coreQuota	integer	Квота ядра для семейства виртуальных машин для учетной записи пакетной службы.
name	string	Имя семейства виртуальных машин.