Batch Deployments - List

Служба:: Machine Learning

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

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments?api-version=2025-12-01

С использованием необязательных параметров:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/deployments?api-version=2025-12-01&$orderBy={$orderBy}&$top={$top}&$skip={$skip}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpointName	path	True	string	Имя конечной точки пакетной службы.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Имя рабочей области Машинного обучения Azure
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
$orderBy	query		string	Упорядочение списка.
$skip	query		string	Маркер продолжения для разбиения на страницы.
$top	query		integer (int32)	Верхняя часть списка.

Ответы

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

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Области

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

Примеры

List Workspace Batch Deployment.

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

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/batchEndpoints/testEndpointName/deployments?api-version=2025-12-01&$orderBy=string&$top=1

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

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

{
  "nextLink": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/batchEndpoints/testEndpointName/deployments?api-version=2025-07-01-preview&$skip=2",
  "value": [
    {
      "name": "string",
      "type": "string",
      "id": "string",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "00000000-1111-2222-3333-444444444444",
        "tenantId": "00000000-1111-2222-3333-444444444444",
        "userAssignedIdentities": {
          "string": {
            "clientId": "00000000-1111-2222-3333-444444444444",
            "principalId": "00000000-1111-2222-3333-444444444444"
          }
        }
      },
      "kind": "string",
      "location": "string",
      "properties": {
        "description": "string",
        "codeConfiguration": {
          "codeId": "string",
          "scoringScript": "string"
        },
        "compute": "string",
        "environmentId": "string",
        "environmentVariables": {
          "string": "string"
        },
        "errorThreshold": 1,
        "loggingLevel": "Info",
        "maxConcurrencyPerInstance": 1,
        "miniBatchSize": 1,
        "model": {
          "assetId": "string",
          "referenceType": "Id"
        },
        "outputAction": "SummaryOnly",
        "outputFileName": "string",
        "properties": {
          "string": "string"
        },
        "provisioningState": "Creating",
        "resources": {
          "instanceCount": 1,
          "instanceType": "string",
          "properties": {
            "string": {
              "a3c13e2e-a213-4cac-9f5a-b49966906ad6": null
            }
          }
        },
        "retrySettings": {
          "maxRetries": 1,
          "timeout": "PT5M"
        }
      },
      "sku": {
        "name": "string",
        "capacity": 1,
        "family": "string",
        "size": "string",
        "tier": "Free"
      },
      "systemData": {
        "createdAt": "2020-01-01T12:34:56.999Z",
        "createdBy": "string",
        "createdByType": "User",
        "lastModifiedAt": "2020-01-01T12:34:56.999Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User"
      },
      "tags": {}
    }
  ]
}

Определения

Имя	Описание
BatchDeployment	Конкретные отслеживаемые типы ресурсов можно создать путем псевдонима этого типа с помощью определенного типа свойства.
BatchDeploymentConfigurationType	Перечисляемые типы свойств для пакетных развертываний.
BatchDeploymentProperties	Параметры пакетного вывода для каждого развертывания.
BatchDeploymentTrackedResourceArmPaginatedResult	Список сущностей BatchDeployment с разбивкой на страницы.
BatchLoggingLevel	Логарифмируйте детализацию для пакетного вывода. Порядок возрастания детализации для ведения журнала выглядит следующим образом: Предупреждение, Информация и Отладка. По умолчанию используется значение Info.
BatchOutputAction	Перечисление для определения того, как пакетный вывод будет обрабатывать выходные данные
BatchPipelineComponentDeploymentConfiguration	Свойства для развертывания компонента пакетного конвейера.
BatchRetrySettings	Повторите настройки для операции пакетного вывода.
CodeConfiguration	Конфигурация для ресурса кода оценки.
createdByType	Тип удостоверения, создавшего ресурс.
DataPathAssetReference	Ссылка на актив через его путь в хранилище данных.
DeploymentProvisioningState	Возможные значения для DeploymentProvisioningState.
DeploymentResourceConfiguration
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
IdAssetReference	Ссылка на актив через идентификатор ресурса ARM.
ManagedServiceIdentity	Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения
ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
OutputPathAssetReference	Ссылка на актив через его путь в выходных данных задания.
ReferenceType	Перечисление, чтобы определить, какой метод ссылки следует использовать для актива.
Sku	Определение модели ресурсов, представляющее номер SKU
SkuTier	Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
UserAssignedIdentity	Свойства назначаемого пользователем удостоверения

BatchDeployment

Объект

Конкретные отслеживаемые типы ресурсов можно создать путем псевдонима этого типа с помощью определенного типа свойства.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения
kind	string	Метаданные, используемые порталом или инструментом и т. д., для отображения различных интерфейсов пользовательского интерфейса для ресурсов одного типа.
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса.
properties	BatchDeploymentProperties	[Обязательный] Дополнительные атрибуты сущности.
sku	Sku	Сведения о SKU, необходимые для контракта ARM для автомасштабирования.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

BatchDeploymentConfigurationType

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

Перечисляемые типы свойств для пакетных развертываний.

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

BatchDeploymentProperties

Объект

Параметры пакетного вывода для каждого развертывания.

Имя	Тип	Default value	Описание
codeConfiguration	CodeConfiguration		Конфигурация кода для развертывания конечной точки.
compute	string		Целевой объект вычислений для операции вывода пакетной службы.
deploymentConfiguration	BatchDeploymentConfiguration: BatchPipelineComponentDeploymentConfiguration		Свойства, относящиеся к разным типам развертывания.
description	string		Описание развертывания конечной точки.
environmentId	string		Идентификатор ресурса ARM или AssetId спецификации среды для развертывания конечной точки.
environmentVariables	object		Конфигурация переменных среды для развертывания.
errorThreshold	integer (int32)	-1	Порог ошибки, если количество ошибок для всего ввода превысит это значение, вывод пакета будет прерван. Диапазон равен [-1, int. MaxValue]. Для FileDataset это значение — количество сбоев файлов. Для TabularDataset это значение — количество сбоев записей. Если задано значение -1 (нижняя граница), все ошибки во время вывода пакетной службы будут игнорироваться.
loggingLevel	BatchLoggingLevel	Info	Логарифмируйте детализацию для пакетного вывода. Порядок возрастания детализации для ведения журнала выглядит следующим образом: Предупреждение, Информация и Отладка. По умолчанию используется значение Info.
maxConcurrencyPerInstance	integer (int32)	1	Указывает максимальное количество параллелизма на экземпляр.
miniBatchSize	integer (int64)	10	Размер мини-пакета, передаваемого каждому вызову пакета. Для FileDataset это число файлов на мини-пакет. Для TabularDataset это размер записей в байтах на мини-пакет.
model	AssetReferenceBase: DataPathAssetReference IdAssetReference OutputPathAssetReference		Ссылка на ресурс модели для развертывания конечной точки.
outputAction	BatchOutputAction	AppendRow	Перечисление для определения того, как пакетный вывод будет обрабатывать выходные данные
outputFileName	string	predictions.csv	Настраиваемое имя выходного файла для действия вывода append_row.
properties	object		Словарь свойств. Свойства можно добавлять, но не удалять или изменять.
provisioningState	DeploymentProvisioningState		Состояние подготовки для развертывания конечной точки.
resources	DeploymentResourceConfiguration		Указывает конфигурацию вычислений для задания. Если это не указано, по умолчанию используется значение по умолчанию, определенное в ResourceConfiguration.
retrySettings	BatchRetrySettings		Параметры повтора для операции вывода пакетной службы. Если этот параметр не указан, по умолчанию используется значение по умолчанию, определенное в BatchRetrySettings.

BatchDeploymentTrackedResourceArmPaginatedResult

Объект

Список сущностей BatchDeployment с разбивкой на страницы.

Имя	Тип	Описание
nextLink	string (uri)	Ссылка на следующую страницу элементов
value	BatchDeployment[]	Пункты BatchDeployment на этой странице

BatchLoggingLevel

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

Логарифмируйте детализацию для пакетного вывода. Порядок возрастания детализации для ведения журнала выглядит следующим образом: Предупреждение, Информация и Отладка. По умолчанию используется значение Info.

Значение	Описание
Info
Warning
Debug

BatchOutputAction

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

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

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

BatchPipelineComponentDeploymentConfiguration

Объект

Свойства для развертывания компонента пакетного конвейера.

Имя	Тип	Описание
componentId	IdAssetReference	Идентификатор ARM для запуска компонента.
deploymentConfigurationType	string: PipelineComponent	[Обязательный] Тип развертывания
description	string	Описание, которое будет применено к заданию.
settings	object	Параметры времени выполнения для задания конвейера.
tags	object	Теги, которые будут применены к заданию.

BatchRetrySettings

Объект

Повторите настройки для операции пакетного вывода.

Имя	Тип	Default value	Описание
maxRetries	integer (int32)	3	Максимальное число повторных попыток для мини-пакета
timeout	string (duration)	PT30S	Время ожидания вызова для мини-пакета в формате ISO 8601.

CodeConfiguration

Объект

Конфигурация для ресурса кода оценки.

Имя	Тип	Описание
codeId	string	Идентификатор ресурса ARM ресурса ресурса кода.
scoringScript	string minLength: 1 pattern: [a-zA-Z0-9_]	[Обязательный] Скрипт, выполняемый при запуске. eg. "score.py"

createdByType

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

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

DataPathAssetReference

Объект

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

Имя	Тип	Описание
datastoreId	string	Идентификатор ресурса ARM хранилища данных, где находится ресурс.
path	string	Путь к файлу или каталогу в хранилище данных.
referenceType	string: DataPath	[Обязательный] Указывает тип ссылки на ресурс.

DeploymentProvisioningState

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

Возможные значения для DeploymentProvisioningState.

Значение	Описание
Creating
Deleting
Scaling
Updating
Succeeded
Failed
Canceled

DeploymentResourceConfiguration

Объект

Имя	Тип	Default value	Описание
instanceCount	integer (int32)	1	Необязательное количество экземпляров или узлов, используемых целевым объектом вычислений.
instanceType	string		Необязательный тип виртуальной машины, используемой в качестве поддержки целевого объекта вычислений.
properties			Дополнительные контейнеры свойств.

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

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

IdAssetReference

Объект

Ссылка на актив через идентификатор ресурса ARM.

Имя	Тип	Описание
assetId	string minLength: 1 pattern: [a-zA-Z0-9_]	[Обязательный] Идентификатор ресурса ARM ресурса ресурса.
referenceType	string: Id	[Обязательный] Указывает тип ссылки на ресурс.

ManagedServiceIdentity

Объект

Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения

Имя	Тип	Описание
principalId	string (uuid)	Идентификатор субъекта-службы назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.
tenantId	string (uuid)	Идентификатор клиента назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.
type	ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	удостоверения User-Assigned Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.

ManagedServiceIdentityType

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

Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).

Значение	Описание
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

OutputPathAssetReference

Объект

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

Имя	Тип	Описание
jobId	string	Идентификатор ресурса ARM задания.
path	string	Путь к файлу или каталогу в выходных данных задания.
referenceType	string: OutputPath	[Обязательный] Указывает тип ссылки на ресурс.

ReferenceType

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

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

Значение	Описание
Id
DataPath
OutputPath

Sku

Объект

Определение модели ресурсов, представляющее номер SKU

Имя	Тип	Описание
capacity	integer (int32)	Если номер SKU поддерживает горизонтальное масштабирование или в, то целое число емкости должно быть включено. Если горизонтальное масштабирование невозможно для ресурса, это может быть опущено.
family	string	Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь.
name	string	Имя номера SKU. Пример - П3. Обычно это код буквы и числа
size	string	Размер номера SKU. Если поле имени является сочетанием уровня и другого значения, это будет автономный код.
tier	SkuTier	Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT.

SkuTier

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

Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT.

Значение	Описание
Free
Basic
Standard
Premium

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Временная метка последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

UserAssignedIdentity

Объект

Свойства назначаемого пользователем удостоверения

Имя	Тип	Описание
clientId	string (uuid)	Идентификатор клиента назначенного удостоверения.
principalId	string (uuid)	Основной идентификатор назначенного удостоверения.

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

Batch Deployments - List

Параметры URI

Ответы

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

azure_auth

Области

Примеры

List Workspace Batch Deployment.

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

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

Определения

BatchDeployment

BatchDeploymentConfigurationType

BatchDeploymentProperties

BatchDeploymentTrackedResourceArmPaginatedResult

BatchLoggingLevel

BatchOutputAction

BatchPipelineComponentDeploymentConfiguration

BatchRetrySettings

CodeConfiguration

createdByType

DataPathAssetReference

DeploymentProvisioningState

DeploymentResourceConfiguration

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdAssetReference

ManagedServiceIdentity

ManagedServiceIdentityType

OutputPathAssetReference

ReferenceType

Sku

SkuTier

systemData

UserAssignedIdentity