Batch Account - Get

Ссылка

Служба:: Batch Management

Версия API:: 2024-07-01

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

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

Параметры URI

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

Ответы

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

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

azure_auth

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

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

Примеры

BatchAccountGet

PrivateBatchAccountGet

BatchAccountGet

Образец запроса

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


/**
 * 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

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

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

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

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

Пример ответа

Код состояния:: 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

Образец запроса

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


/**
 * 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

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

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 [email protected]"),
	// 						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

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

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

Пример ответа

Код состояния:: 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 [email protected]"
          }
        }
      }
    ]
  },
  "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 при использовании ключа шифрования Microsoft.KeyVault.
KeyVaultReference	Определяет хранилище ключей Azure, связанное с учетной записью пакетной службы.
NetworkProfile	Сетевой профиль для учетной записи пакетной службы, содержащей параметры сетевого правила для каждой конечной точки.
PoolAllocationMode	Режим выделения для создания пулов в учетной записи пакетной службы.
PrivateEndpoint	Частная конечная точка подключения частной конечной точки.
PrivateEndpointConnection	Содержит сведения о ресурсе приватного канала.
PrivateEndpointConnectionProvisioningState	Состояние подготовки подключения к частной конечной точке.
PrivateLinkServiceConnectionState	Состояние подключения службы приватного канала подключения частной конечной точки
PrivateLinkServiceConnectionStatus	Состояние подключения частной конечной точки пакетной службы
ProvisioningState	Подготовленное состояние ресурса
PublicNetworkAccessType	Тип сетевого доступа для работы с ресурсами в учетной записи пакетной службы.
ResourceIdentityType	Тип удостоверения, используемого для учетной записи пакетной службы.
UserAssignedIdentities	Список связанных удостоверений пользователей.
VirtualMachineFamilyCoreQuota	Семейство виртуальных машин и связанная с ней квота ядра для учетной записи пакетной службы.

AuthenticationMode

Перечисление

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

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

AutoStorageAuthenticationMode

Перечисление

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

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

AutoStorageProperties

Object

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

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

BatchAccount

Object

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

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

BatchAccountIdentity

Object

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

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

CloudError

Object

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

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

CloudErrorBody

Object

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

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

ComputeNodeIdentityReference

Object

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

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

EncryptionProperties

Object

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

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

EndpointAccessDefaultAction

Перечисление

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

Значение	Описание
Allow	Разрешить клиентский доступ.
Deny	Запретить доступ к клиенту.

EndpointAccessProfile

Object

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

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

IPRule

Object

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

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

IPRuleAction

Перечисление

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

Значение	Описание
Allow	Разрешить доступ для соответствующего IP-адреса клиента.

KeySource

Перечисление

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

Значение Описание

Microsoft.Batch

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

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

Microsoft.KeyVault

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

KeyVaultProperties

Object

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

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

Имя

Тип

Описание

keyIdentifier

string

Полный путь к секрету с версией или без нее. Пример https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. или https://mykeyvault.vault.azure.net/keys/testkey. Чтобы обеспечить удобство использования следующих предварительных требований, необходимо выполнить следующее:

Учетная запись пакетной службы имеет удостоверение, назначенное системой, удостоверение учетной записи было предоставлено key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault имеет обратимое удаление и защиту очистки.

KeyVaultReference

Object

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

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

NetworkProfile

Object

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

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

PoolAllocationMode

Перечисление

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

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

PrivateEndpoint

Object

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

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

PrivateEndpointConnection

Object

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

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

PrivateEndpointConnectionProvisioningState

Перечисление

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

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

PrivateLinkServiceConnectionState

Object

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

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

PrivateLinkServiceConnectionStatus

Перечисление

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

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

ProvisioningState

Перечисление

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

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

PublicNetworkAccessType

Перечисление

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

Значение	Описание
Disabled	Отключает общедоступное подключение и включает частное подключение к пакетной службе Azure через ресурс частной конечной точки.
Enabled	Включает подключение к пакетной службе Azure через общедоступную службу DNS.
SecuredByPerimeter	Защищает подключение к пакетной службе Azure с помощью конфигурации NSP.

ResourceIdentityType

Перечисление

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

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

UserAssignedIdentities

Object

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

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

VirtualMachineFamilyCoreQuota

Object

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

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

Поделиться через

Batch Account - Get

Параметры URI

Ответы

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

azure_auth

Области

Примеры

BatchAccountGet

Образец запроса

Пример ответа

PrivateBatchAccountGet

Образец запроса

Пример ответа

Определения

AuthenticationMode

AutoStorageAuthenticationMode

AutoStorageProperties

BatchAccount

BatchAccountIdentity

CloudError

CloudErrorBody

ComputeNodeIdentityReference

EncryptionProperties

EndpointAccessDefaultAction

EndpointAccessProfile

IPRule

IPRuleAction

KeySource

KeyVaultProperties

KeyVaultReference

NetworkProfile

PoolAllocationMode

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningState

PublicNetworkAccessType

ResourceIdentityType

UserAssignedIdentities

VirtualMachineFamilyCoreQuota

Дополнительные ресурсы