Spec-Zone.ru › Ansible

модуль azure.azcollection.azure_rm_ml_environment — создание, архивирование или восстановление среды Azure Machine Learning

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_ml_environment.

Добавлено в azure.azcollection 3.16.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Создание, архивирование или восстановление среды Azure Machine Learning.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • python >= 2.7
  • На узле, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
  • Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на узле, выполняющем модули из azure.azcollection
  • Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

ad_user

string

Имя пользователя Active Directory. Используйте этот параметр для аутентификации пользователя Active Directory вместо субъекта-службы.

adfs_authority_url

string

добавлено в azure.azcollection 0.0.1

URL-адрес центра Azure AD. Используйте при аутентификации с помощью имени пользователя и пароля, если у вас есть собственный центр ADFS.

api_profile

string

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

append_tags

boolean

Определяет, является ли поле тегов каноническим или теги только добавляются к существующим.

При использовании канонического режима из метаданных объекта будут удалены все теги, отсутствующие в параметре tags.

Варианты:

  • false
  • true ← (по умолчанию)

auth_source

string

добавлено в azure.azcollection 0.0.1

Определяет источник учётных данных для аутентификации.

Также можно задать с помощью переменной окружения ANSIBLE_AZURE_AUTH_SOURCE.

Если задано значение auto (по умолчанию), приоритет источников следующий: параметры модуля -> env -> credential_file -> cli.

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

Если задано значение credential_file, профиль будет считываться из ~/.azure/credentials.

Если задано значение cli, учётные данные будут получены из профиля Azure CLI. Для идентификации идентификатора подписки, если их несколько, можно использовать subscription_id или переменную окружения AZURE_SUBSCRIPTION_ID; в противном случае будет использоваться подписка az cli по умолчанию.

Если задано значение msi, узел должен быть ресурсом Azure с включённым расширением MSI. Для идентификации идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную окружения AZURE_SUBSCRIPTION_ID; в противном случае будет выбрана первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

build_context

string

Локальный путь к каталогу, используемому в качестве контекста сборки Docker. Аргументы build_context и image взаимоисключающие.

cert_validation_mode

string

добавлено в azure.azcollection 0.0.1

Определяет поведение проверки сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Также можно задать в профиле файла учётных данных или с помощью переменной окружения AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Также можно задать с помощью переменной окружения AZURE_CLIENT_ID.

cloud_environment

string

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, — имя среды (согласно определению в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (обязателен для Azure Stack). Также можно задать в профиле файла учётных данных или с помощью переменной окружения AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

conda_file

string

Локальный путь к файлу спецификации conda. При использовании этого аргумента также необходимо указать image.

datastore

string

Хранилище данных, в которое будет загружен локальный артефакт.

description

string

Описание среды.

disable_instance_discovery

boolean

добавлено в azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра будут полностью отключены. Эта функция предназначена для ситуаций, когда невозможно получить доступ к конечной точке метаданных, например в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных центра с сайта https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра будет отключена. Поэтому крайне важно убедиться, что настроенный узел центра является допустимым и заслуживающим доверия.

Задаётся в профиле файла учётных данных или с помощью переменной окружения AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • true

dockerfile_path

string

Относительный путь к Dockerfile внутри каталога, указанного в build_context. Если не указан, используется «./Dockerfile».

По умолчанию: "./Dockerfile"

image

string

Образ Docker. Аргументы image и build_context взаимоисключающие.

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

ml_registry

string

Имя реестра Azure ML.

ml_workspace

string

Имя рабочей области Azure ML.

name

string / обязательный

Имя среды Azure ML.

oidc_token

string

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки.

Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC.

Полезен в системах CI (например, GitHub Actions и Azure DevOps), где платформа предоставляет токен OIDC напрямую.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

добавлено в azure.azcollection 3.17.0

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки.

Файл должен содержать только необработанный токен.

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

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN_FILE.

os_type

string

Тип операционной системы.

Варианты:

  • "linux" ← (по умолчанию)
  • "windows"

password

string

Пароль пользователя Active Directory. Используйте этот параметр для аутентификации пользователя Active Directory вместо субъекта-службы.

profile

string

Профиль безопасности из файла ~/.azure/credentials.

resource_definition

string

Определение среды в формате YAML

resource_group

string

Имя группы ресурсов.

secret

string

Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.

state

string

Состояние среды. Используйте present для создания или обновления, archive — для архивирования, restore — для восстановления.

Варианты:

  • "present" ← (по умолчанию)
  • "archive"
  • "restore"

subscription_id

string

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

tags

dictionary

Словарь пар строка:строка, назначаемых объекту в качестве метаданных.

Метаданные тегов объекта будут обновлены с использованием всех указанных значений.

Чтобы удалить теги, задайте для параметра append_tags значение false.

В настоящее время зоны DNS Azure и службы Traffic Manager также не допускают пробелы в тегах.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов.

tenant

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используйте при аутентификации с помощью субъекта-службы.

Обязателен, если задан x509_certificate_path.

version

string

Версия ресурса данных.

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

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

Используйте при аутентификации с помощью субъекта-службы.

Примечания

Примечание

  • Для аутентификации в Azure можно передавать параметры, задавать переменные окружения, использовать профиль из ~/.azure/credentials или войти в систему перед запуском задач или плейбука с помощью az login.
  • Аутентификация также возможна с помощью субъекта-службы или пользователя Active Directory.
  • Для аутентификации через OIDC передайте client_id, tenant и oidc_token либо oidc_token_file_path или задайте переменные окружения AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN либо AZURE_FEDERATED_TOKEN_FILE.
  • Для аутентификации через субъект-службу передайте subscription_id, client_id, secret и tenant или задайте переменные окружения AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
  • Для аутентификации пользователя Active Directory передайте ad_user и password или задайте в окружении AZURE_AD_USER и AZURE_PASSWORD.
  • Кроме того, учётные данные можно хранить в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant либо subscription_id, ad_user и password. Можно также добавить дополнительные профили. Укажите профиль, передав profile или задав переменную окружения AZURE_PROFILE.

См. также

См. также

Вход с помощью Azure CLI

Как пройти аутентификацию с помощью команды az login.

Примеры

- name: Create ML Environment
  azure.azcollection.azure_rm_ml_environment:
    name: environmentxxxxxxxxxx
    resource_group: xxxxx-ml-environment
    ml_workspace: workspace-xxxxxxxxxx
    version: 2
    resource_definition: |
      $schema: https://azuremlschemas.azureedge.net/latest/environment.schema.json
      image: mcr.microsoft.com/azureml/openmpi3.1.2-ubuntu18.04:20220303.v1
      conda_file: ./files/python-aml-rai.yaml

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

changed

boolean

Изменился ли ресурс.

Возвращается: всегда

Пример: false

ml_environment

dictionary

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

Возвращается: всегда

Пример: {"conda_file": {"channels": ["conda-forge"], "dependencies": ["python=3.8", "pip=20.0.2", {"pip": ["numpy", "pandas", "pyarrow", "scikit-learn", "mlflow", "azureml-mlflow", "responsibleai~=0.17.0", "raiwidgets~=0.17.0", "markupsafe<=2.0.1", "itsdangerous==2.0.1", "azureml-dataset-runtime", "azureml-core"]}], "name": "aml-rai-environment"}, "creation_context": {"created_at": "2026-03-20T17:34:28.790877+00:00", "created_by": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "created_by_type": "Application", "last_modified_at": "2026-03-20T17:34:28.790877+00:00", "last_modified_by": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "last_modified_by_type": "Application"}, "id": "azureml:/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxxx-ml-environment/providers/Microsoft.MachineLearningServices/workspaces/workspace-xxxxxxxxxx/environments/environmentxxxxxxxxxx/versions/2", "image": "mcr.microsoft.com/azureml/openmpi3.1.2-ubuntu18.04:20220303.v1", "name": "environmentxxxxxxxxxx", "os_type": "linux", "tags": {}, "version": "2"}

Авторы

  • Bill Peck (@p3ck)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_ml_environment_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API