Batch Account - Get Keys

Служба:: Batch Management

Версия API:: 2025-06-01

Возвращает ключи учетной записи для указанной учетной записи пакетной службы.
Эта операция применяется только к учетным записям пакетной службы с разрешенной службойAuthenticationModes, содержащей SharedKey. Если учетная запись пакетной службы не содержит SharedKey в разрешенной службеAuthenticationMode, клиенты не могут использовать общие ключи для проверки подлинности и вместо этого должны использовать другой разрешенный параметрAuthenticationModes. В этом случае получение ключей завершится ошибкой.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-zA-Z0-9]+$	Название для аккаунта Batch, которое должно быть уникальным в регионе. Названия пакетных аккаунтов должны быть длиной от 3 до 24 символов и использовать только цифры и строчные буквы. Это имя используется как часть DNS-имени, которое используется для доступа к пакетному сервису в регионе, где создан аккаунт. Например: `http://accountname.region.batch.azure.com/`.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	BatchAccountKeys	Операция Azure успешно завершена.
Other Status Codes	CloudError	Непредвиденное сообщение об ошибке.

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Области

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

Примеры

BatchAccountGetKeys

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

HTTP
dotnet

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Batch.Models;
using Azure.ResourceManager.Batch;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountGetKeys.json
// this example is just showing the usage of "BatchAccount_GetKeys" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BatchAccountResource created on azure
// for more information of creating BatchAccountResource, please refer to the document of BatchAccountResource
string subscriptionId = "12345678-1234-1234-1234-123456789012";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
ResourceIdentifier batchAccountResourceId = BatchAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
BatchAccountResource batchAccount = client.GetBatchAccountResource(batchAccountResourceId);

// invoke the operation
BatchAccountKeys result = await batchAccount.GetKeysAsync();

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

Код состояния:: 200

{
  "accountName": "sampleacct",
  "primary": "AAAA==",
  "secondary": "BBBB=="
}

Определения

Имя	Описание
BatchAccountKeys	Набор ключей учетной записи пакетной службы Azure.
CloudError	Ответ на ошибку из пакетной службы.
CloudErrorBody	Ответ на ошибку из пакетной службы.

BatchAccountKeys

Объект

Набор ключей учетной записи пакетной службы Azure.

Имя	Тип	Описание
accountName	string	Имя учетной записи пакетной службы.
primary	string	Первичный ключ, связанный с учетной записью.
secondary	string	Вторичный ключ, связанный с учетной записью.

CloudError

Объект

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

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

CloudErrorBody

Объект

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

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