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


Batch Deployments - List

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

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

Параметры URI

Имя В Обязательно Тип Описание
endpointName
path True

string

имя конечной точки;

resourceGroupName
path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

subscriptionId
path True

string

Идентификатор целевой подписки.

workspaceName
path True

string

Имя рабочей области Машинного обучения Azure.

Шаблон регулярного выражения: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$

api-version
query True

string

Версия API, используемая для данной операции.

$orderBy
query

string

Порядок списка.

$skip
query

string

Маркер продолжения для разбиения на страницы.

$top
query

integer

int32

В верхней части списка.

Ответы

Имя Тип Описание
200 OK

BatchDeploymentTrackedResourceArmPaginatedResult

Успешное завершение

Other Status Codes

ErrorResponse

Ошибка

Примеры

List Workspace Batch Deployment.

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

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=2024-04-01&$orderBy=string&$top=1

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

{
  "value": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "properties": {
        "description": "string",
        "properties": {
          "string": "string"
        },
        "codeConfiguration": {
          "codeId": "string",
          "scoringScript": "string"
        },
        "environmentId": "string",
        "environmentVariables": {
          "string": "string"
        },
        "compute": "string",
        "errorThreshold": 1,
        "retrySettings": {
          "maxRetries": 1,
          "timeout": "PT5M"
        },
        "miniBatchSize": 1,
        "loggingLevel": "Info",
        "model": {
          "referenceType": "Id",
          "assetId": "string"
        },
        "maxConcurrencyPerInstance": 1,
        "outputAction": "SummaryOnly",
        "outputFileName": "string",
        "resources": {
          "instanceCount": 1,
          "instanceType": "string",
          "properties": {
            "string": {
              "a3c13e2e-a213-4cac-9f5a-b49966906ad6": null
            }
          }
        },
        "provisioningState": "Creating"
      },
      "systemData": {
        "createdAt": "2020-01-01T12:34:56.999Z",
        "createdBy": "string",
        "createdByType": "User",
        "lastModifiedAt": "2020-01-01T12:34:56.999Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User"
      },
      "tags": {},
      "location": "string",
      "kind": "string",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "00000000-1111-2222-3333-444444444444",
        "tenantId": "00000000-1111-2222-3333-444444444444",
        "userAssignedIdentities": {
          "string": {
            "principalId": "00000000-1111-2222-3333-444444444444",
            "clientId": "00000000-1111-2222-3333-444444444444"
          }
        }
      },
      "sku": {
        "name": "string",
        "tier": "Free",
        "size": "string",
        "family": "string",
        "capacity": 1
      }
    }
  ],
  "nextLink": "string"
}

Определения

Имя Описание
BatchDeployment

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

BatchDeploymentConfigurationType

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

BatchDeploymentTrackedResource
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

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

Имя Тип Default value Описание
codeConfiguration

CodeConfiguration

Конфигурация кода для развертывания конечной точки.

compute

string

Целевой объект вычислений для операции пакетного вывода.

deploymentConfiguration BatchDeploymentConfiguration:

BatchPipelineComponentDeploymentConfiguration

Свойства, относящиеся к различным типам развертывания.

description

string

Описание развертывания конечной точки.

environmentId

string

Идентификатор ресурса ARM или AssetId спецификации среды для развертывания конечной точки.

environmentVariables

object

Конфигурация переменных среды для развертывания.

errorThreshold

integer

-1

Порог ошибок. Если количество ошибок для всех входных данных превышает это значение, пакетный вывод будет прерван. Диапазон — [-1, int. MaxValue]. Для FileDataset это значение является числом сбоев файлов. Для TabularDataset это значение является числом сбоев записей. Если задано значение -1 (нижняя граница), все сбои при пакетном выводе будут игнорироваться.

loggingLevel

BatchLoggingLevel

Info

Уровень ведения журнала для операции пакетного вывода.

maxConcurrencyPerInstance

integer

1

Указывает максимальное число параллелизма на экземпляр.

miniBatchSize

integer

10

Размер мини-пакета, передаваемого каждому вызову пакета. Для FileDataset это количество файлов на мини-пакет. Для TabularDataset это размер записей в байтах на мини-пакет.

model AssetReferenceBase:

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

outputAction

BatchOutputAction

AppendRow

Указывает, как будут организованы выходные данные.

outputFileName

string

predictions.csv

Настраиваемое имя выходного файла для действия вывода append_row.

properties

object

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

provisioningState

DeploymentProvisioningState

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

resources

DeploymentResourceConfiguration

Указывает конфигурацию вычислений для задания. Если параметр не указан, по умолчанию будут использоваться значения по умолчанию, определенные в ResourceConfiguration.

retrySettings

BatchRetrySettings

Параметры повтора для операции пакетного вывода. Если этот параметр не указан, по умолчанию будут использоваться значения по умолчанию, определенные в BatchRetrySettings.

BatchDeploymentConfigurationType

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

Имя Тип Описание
Model

string

PipelineComponent

string

BatchDeploymentTrackedResource

Имя Тип Описание
id

string

Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ManagedServiceIdentity

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

kind

string

Метаданные, используемые порталом, инструментами и т. д. для визуализации различных интерфейсов для ресурсов одного типа.

location

string

Географическое расположение, в котором находится ресурс

name

string

Имя ресурса.

properties

BatchDeployment

[Обязательно] Дополнительные атрибуты сущности.

sku

Sku

Сведения о SKU, необходимые для контракта ARM для автомасштабирования.

systemData

systemData

Azure Resource Manager метаданные, содержащие сведения о createdBy и modifiedBy.

tags

object

Теги ресурсов.

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

BatchDeploymentTrackedResourceArmPaginatedResult

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

Имя Тип Описание
nextLink

string

Ссылка на следующую страницу объектов BatchDeployment. Если значение равно null, дополнительные страницы отсутствуют.

value

BatchDeploymentTrackedResource[]

Массив объектов типа BatchDeployment.

BatchLoggingLevel

Детализация журнала для пакетного вывода. Порядок детализации для ведения журнала: Предупреждение, Сведения и Отладка. Значение по умолчанию — Info.

Имя Тип Описание
Debug

string

Info

string

Warning

string

BatchOutputAction

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

Имя Тип Описание
AppendRow

string

SummaryOnly

string

BatchPipelineComponentDeploymentConfiguration

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

Имя Тип Описание
componentId

IdAssetReference

Идентификатор ARM запускаемого компонента.

deploymentConfigurationType string:

PipelineComponent

[Обязательный параметр] Тип развертывания

description

string

Описание, которое будет применено к заданию.

settings

object

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

tags

object

Теги, которые будут применены к заданию.

BatchRetrySettings

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

Имя Тип Default value Описание
maxRetries

integer

3

Максимальное число повторных попыток для мини-пакета

timeout

string

PT30S

Время ожидания вызова для мини-пакета в формате ISO 8601.

CodeConfiguration

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

Имя Тип Описание
codeId

string

Идентификатор ресурса ARM ресурса кода.

scoringScript

string

[Обязательно] Скрипт, выполняемый при запуске. Например: "score.py"

createdByType

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

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

DataPathAssetReference

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

Имя Тип Описание
datastoreId

string

Идентификатор ресурса ARM хранилища данных, в котором находится ресурс.

path

string

Путь к файлу или каталогу в хранилище данных.

referenceType string:

DataPath

[Обязательный параметр] Указывает тип ссылки на ресурс.

DeploymentProvisioningState

Возможные значения deploymentProvisioningState.

Имя Тип Описание
Canceled

string

Creating

string

Deleting

string

Failed

string

Scaling

string

Succeeded

string

Updating

string

DeploymentResourceConfiguration

Имя Тип Default value Описание
instanceCount

integer

1

Необязательное число экземпляров или узлов, используемых целевым объектом вычислений.

instanceType

string

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

properties

object

Контейнер дополнительных свойств.

ErrorAdditionalInfo

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

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorDetail

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

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

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

code

string

Код ошибки.

details

ErrorDetail[]

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

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

IdAssetReference

Ссылка на ресурс с помощью идентификатора ресурса ARM.

Имя Тип Описание
assetId

string

[Обязательный параметр] Идентификатор ресурса ARM для ресурса.

referenceType string:

Id

[Обязательный параметр] Указывает тип ссылки на ресурс.

ManagedServiceIdentity

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

Имя Тип Описание
principalId

string

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

tenantId

string

Идентификатор клиента удостоверения, назначаемого системой. Это свойство предоставляется только для удостоверения, назначаемого системой.

type

ManagedServiceIdentityType

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

userAssignedIdentities

<string,  UserAssignedIdentity>

Удостоверения User-Assigned
Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут иметь идентификаторы ресурсов ARM в формате :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.

ManagedServiceIdentityType

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

Имя Тип Описание
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

OutputPathAssetReference

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

Имя Тип Описание
jobId

string

Идентификатор ресурса ARM задания.

path

string

Путь к файлу или каталогу в выходных данных задания.

referenceType string:

OutputPath

[Обязательный параметр] Указывает тип ссылки на ресурс.

ReferenceType

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

Имя Тип Описание
DataPath

string

Id

string

OutputPath

string

Sku

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

Имя Тип Описание
capacity

integer

Если номер SKU поддерживает горизонтальное увеличение масштаба, необходимо включить целое число емкости. Если горизонтальное увеличение масштаба невозможно для ресурса, это можно опустить.

family

string

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

name

string

Имя номера SKU. Пример — P3. Обычно это буква+числовой код.

size

string

Размер номера SKU. Если поле имени является сочетанием уровня и другого значения, это будет автономный код.

tier

SkuTier

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

SkuTier

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

Имя Тип Описание
Basic

string

Free

string

Premium

string

Standard

string

systemData

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

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

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

lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy

string

Удостоверение, которое в последний раз изменял ресурс.

lastModifiedByType

createdByType

Тип удостоверения, изменяющего ресурс в последний раз.

UserAssignedIdentity

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

Имя Тип Описание
clientId

string

Идентификатор клиента назначенного удостоверения.

principalId

string

Идентификатор субъекта назначенного удостоверения.