Схема YAML для подключенной конечной точки в CLI (версия 2)

Статья
11/20/2023

ОБЛАСТЬ ПРИМЕНЕНИЯ:расширение Машинного обучения для Azure CLI версии 2 (текущая версия)

Исходная схема JSON можно найти в https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json управляемой сетевой конечной точке и в https://azuremlschemas.azureedge.net/latest/kubernetesOnlineEndpoint.schema.json веб-конечной точке Kubernetes. Различия между управляемой сетевой конечной точкой и веб-конечной точкой Kubernetes описаны в таблице свойств в этой статье. Пример в этой статье посвящен управляемой сетевой конечной точке.

Примечание.

Синтаксис YAML, описанный в этом документе, основан на схеме JSON для последней версии расширения ML CLI (версия 2). Этот синтаксис гарантированно работает только с последней версией расширения ML CLI (версия 2). Схемы для старых версий расширений можно найти по адресу https://azuremlschemasprod.azureedge.net/.

Примечание.

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

Синтаксис YAML

Ключ.	Тип	Описание	Допустимые значения	Default value
`$schema`	строка	Схема YAML. При создании файла YAML с помощью расширения VS Code Машинного обучения Azure вы можете добавить `$schema` в верхней части файла, чтобы вызывать завершение схемы и ресурсов.
`name`	строка	Обязательно. Имя конечной точки. Должно быть уникальным на уровне региона Azure. Правила именования определяются в ограничениях конечных точек.
`description`	строка	Описание конечной точки.
`tags`	объект	Словарь тегов для конечной точки.
`auth_mode`	строка	Способ проверки подлинности для конечной точки. Поддерживаются аутентификация на основе ключей и Машинное обучение Azure аутентификация на основе маркеров. Срок действия проверки подлинности на основе ключей не истекает, но Машинное обучение Azure проверка подлинности на основе маркеров выполняется.	`key`, `aml_token`	`key`
`compute`	строка	Имя целевого объекта вычислений, на котором будут запущены развертывания конечных точек. Это поле применимо только для развертываний конечных точек в кластерах Kubernetes с поддержкой Azure Arc (целевой объект вычислений, указанный в этом поле, должен иметь тип `type: kubernetes`). Не указывайте это поле, если выполняется управляемый интерактивный вывод.
`identity`	объект	Конфигурация управляемого удостоверения для доступа к ресурсам Azure для подготовки и вывода конечных точек.
`identity.type`	строка	Тип управляемого удостоверения. Если используется тип `user_assigned`, необходимо также указать свойство `identity.user_assigned_identities`.	`system_assigned`, `user_assigned`
`identity.user_assigned_identities`	array	Список полных идентификаторов ресурсов для назначаемых пользователем удостоверений.
`traffic`	объект	Трафик отражает процент запросов, обслуживаемых различными развертываниями. Он представлен в виде словаря пар "ключ-значение", в котором ключи содержат имя развертывания, а значение — процент трафика для этого развертывания. Например, `blue: 90 green: 10` означает, что 90 % запросов отправляются в развертывание с именем `blue` и 10 % запросов отправляются в развертывание `green`. Общий трафик должен быть равен 0 или составлять в сумме 100. Чтобы посмотреть, как работает конфигурация трафика, обратитесь к разделу Безопасное развертывание для подключенных конечных точек. Примечание. Это поле не может быть задано во время создания подключенной конечной точки, так как развертывания в этой конечной точке необходимо создать до того, как можно будет настроить трафик. Вы можете обновить трафик для подключенной конечной точки после создания развертываний с помощью `az ml online-endpoint update`, например, `az ml online-endpoint update --name <endpoint_name> --traffic "blue=90 green=10"`.
`public_network_access`	строка	С помощью этого флага можно управлять видимостью управляемой конечной точки. Если задано `disabled`, входящие запросы оценки принимаются с помощью частной конечной точки рабочей области Машинного обучения Azure, а доступ к конечной точке нельзя получить из общедоступных сетей. Этот флаг применим только для управляемых конечных точек.	`enabled`, `disabled`	`enabled`
`mirror_traffic`	строка	Процент динамического трафика для зеркального отображения в развертывании. Зеркальное отображение трафика не приводит к изменению результатов, возвращаемых клиентам. Зеркально отображенный процент трафика копируется и отправляется в указанное развертывание, чтобы можно было собирать метрики и вести журнал без влияния на ваших клиентов. Например, оно позволяет проверить, находится ли задержка в допустимых границах, а также убедиться в отсутствии ошибок HTTP. Он представлен в виде словаря пары "ключ-значение", в котором ключ содержит имя развертывания, а значение — процент трафика для зеркального отображения в развертывание. Дополнительные сведения см. в статье Тестирование развертывания с зеркально отображенным трафиком.

Замечания

Команды az ml online-endpoint можно использовать для управления подключенными конечными точками Машинного обучения Azure.

Примеры

Примеры доступны в репозитории примеров GitHub. Ниже показаны некоторые из них.

YAML: базовый

$schema: https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json
name: my-endpoint
auth_mode: key

YAML: удостоверение, назначаемое системой

$schema: https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json
name: my-sai-endpoint
auth_mode: key

YAML: удостоверение, назначаемое пользователем

$schema: https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json
name: my-uai-endpoint
auth_mode: key
identity:
  type: user_assigned
  user_assigned_identities:
    - resource_id: user_identity_ARM_id_place_holder