модуль azure.azcollection.azure_rm_ml_compute — создание, обновление или удаление вычислительного ресурса 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_compute.
Добавлено в azure.azcollection 3.15.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. |
admin_password string | Пароль учетной записи администратора. |
admin_username string | Имя учетной записи администратора, которую можно использовать для подключения к узлам по SSH. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
append_tags boolean | Определяет, является ли поле tags полным списком тегов или только дополняет существующие теги. При использовании полного списка все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. Варианты:
|
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной окружения Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Определяет поведение при проверке сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной окружения |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно определению в Azure Python SDK, например По умолчанию: |
description string | Описание целевого вычислительного ресурса. |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно обратиться к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра с https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра отключается. Поэтому крайне важно убедиться, что настроенный хост центра является допустимым и заслуживающим доверия. Задайте в профиле файла учетных данных или с помощью переменной окружения Варианты:
|
identity_type string | Тип управляемого удостоверения. Варианты:
|
idle_time_before_scale_down integer | Время простоя узла в секундах перед уменьшением размера кластера. |
location string | Регион для нового вычислительного ресурса. Если не указан, используется регион рабочей области. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
max_instances integer | Максимальное количество узлов в кластере. |
min_instances integer | Минимальное количество узлов в кластере. |
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. Также можно задать с помощью переменной окружения |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу с токеном OpenID Connect (OIDC) (JWT), используемым для аутентификации удостоверения рабочей нагрузки. Файл должен содержать только необработанный токен. Этот способ обычно используется на платформах, которые сохраняют токены OIDC в виде файлов. Также можно задать с помощью переменной окружения |
password string | Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
resource_definition string | Описание вычислительного ресурса в формате YAML |
resource_group string / обязательный | Имя группы ресурсов. |
secret string | Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
size string | Размер виртуальной машины для целевого вычислительного ресурса. Подробные сведения см. здесь: https://aka.ms/azureml-vm-details. |
ssh_key_value string | Открытый ключ SSH учетной записи администратора. |
ssh_public_access_enabled boolean | Указывает, включен ли общедоступный порт SSH. Варианты:
|
state string | Состояние вычислительного ресурса. Используйте Варианты:
|
subnet string | Имя подсети. Вместо имени можно также указать идентификатор подсети в существующей виртуальной сети. Если указан идентификатор подсети, параметр vnet_name игнорируется. Идентификатор подсети может указывать на виртуальную сеть или подсеть в другой группе ресурсов; для этого укажите полный идентификатор подсети. Обязательный параметр, если указано имя виртуальной сети. |
subscription_id string | Идентификатор вашей подписки Azure. |
tags dictionary | Словарь пар строка:строка, назначаемых объекту в качестве метаданных. Метаданные объекта будут обновлены с учетом всех указанных значений. Чтобы удалить теги, установите для параметра append_tags значение false. В настоящее время зоны Azure DNS и службы 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. |
tier string | Уровень приоритета виртуальной машины. Варианты:
|
type string | Тип целевого вычислительного ресурса. Варианты:
|
user_assigned_identities list / элементы=string | Назначенные пользователем удостоверения. |
user_object_id string | Идентификатор объекта AAD назначенного пользователя. |
user_tenant_id string | Идентификатор клиента AAD назначенного пользователя. |
vnet_name 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 Compute
azure.azcollection.azure_rm_ml_compute:
location: eastus
name: MyCompute
description: My Compute created by Ansible
resource_group: myResourceGroup
ml_workspace: myMLWorkspace
type: amlcompute
min_instances: 0
max_instances: 8
tags:
createdByToolkit: Ansible
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
changed boolean | Изменился ли ресурс. Возвращается: всегда Пример: |
ml_compute dictionary | Вычислительный ресурс, который был только что создан или обновлён. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_compute_module.html