Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_ml_workspace_info — Список рабочих областей ML

Примечание

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

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

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

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

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

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

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

  • Список рабочих областей ML.

Требования

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

  • 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"

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; в противном случае используется подписка Azure CLI по умолчанию.

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

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

Варианты:

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

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"

disable_instance_discovery

boolean

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

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

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

Варианты:

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

filtered_kinds

list / elements=string

Выводить только рабочие области ML указанных типов.

Варианты:

  • "default"
  • "hub"
  • "project"

По умолчанию: []

log_mode

string

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

log_path

string

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

name

string

Получить сведения об определенной рабочей области 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.

password

string

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

profile

string

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

resource_group

string

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

secret

string

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

subscription_id

string

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

tenant

string

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

thumbprint

string

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

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

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

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

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: Get info on a specific ml workspaces
  azure.azcollection.azure_rm_ml_workspace_info:
    name: my_workspace
    resource_group: test_ml_workspace
  register: result

- name: List all ml workspaces in subscription
  azure.azcollection.azure_rm_ml_workspace_info:
  register: results

- name: List all hub workspaces in resource group
  azure.azcollection.azure_rm_ml_workspace_info:
    resource_group: test_ml_workspace
    filtered_kinds:
      - hub
  register: results

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

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

Ключ

Описание

ml_workspaces

dictionary

Список рабочих областей ML.

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

Пример: [{"allow_roleassignment_on_rg": true, "application_insights": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-ml-workspace/providers/Microsoft.insights/components/workspacinsightsxxxxxxxx", "description": "Workspace Integration Tests", "discovery_url": "https://westus3.api.azureml.ms/discovery", "display_name": "workspace-xxxxxxx-xxx", "enable_data_isolation": false, "hbi_workspace": false, "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-ml-workspace/providers/Microsoft.MachineLearningServices/workspaces/workspace-xxxxxxx-xxx", "identity": {"principal_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "type": "system_assigned"}, "key_vault": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-ml-workspace/providers/Microsoft.Keyvault/vaults/workspackeyvaultxxxxxxxx", "location": "westus3", "managed_network": {"firewall_sku": "standard", "isolation_mode": "allow_only_approved_outbound", "network_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "outbound_rules": [{"category": "user_defined", "destination": "microsoft.com", "name": "microsoft", "status": "Inactive", "type": "fqdn"}, {"category": "user_defined", "destination": {"address_prefixes": ["168.63.129.16", "10.0.0.0/24"], "port_ranges": "80, 8080-8089", "protocol": "TCP", "service_tag": "sometag"}, "name": "servicetag-w-prefixes", "status": "Inactive", "type": "service_tag"}, {"category": "required", "destination": {"address_prefixes": [], "port_ranges": "443", "protocol": "TCP", "service_tag": "AzureMonitor"}, "name": "__SYS_ST_AzureMonitor_TCP", "status": "Inactive", "type": "service_tag"}, {"category": "required", "destination": {"address_prefixes": [], "port_ranges": "443", "protocol": "TCP", "service_tag": "AzureResourceManager"}, "name": "__SYS_ST_AzureResourceManager_TCP", "status": "Inactive", "type": "service_tag"}, {"category": "required", "destination": {"service_resource_id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-ml-workspace/providers/Microsoft.Storage/storageAccounts/workspacstoragexxxxxxxxx", "spark_enabled": true, "subresource_target": "file"}, "name": "__SYS_PE_workspacstoragexxxxxxxxx_file_xxxxxxxx", "status": "Inactive", "type": "private_endpoint"}, {"category": "required", "destination": {"address_prefixes": [], "port_ranges": "443", "protocol": "TCP", "service_tag": "MicrosoftContainerRegistry.westus3"}, "name": "__SYS_ST_MicrosoftContainerRegistry.westus3_TCP", "status": "Inactive", "type": "service_tag"}, {"category": "required", "destination": {"address_prefixes": [], "port_ranges": "*", "protocol": "*", "service_tag": "VirtualNetwork"}, "name": "__SYS_ST_VirtualNetwork", "status": "Inactive", "type": "service_tag"}, {"category": "required", "destination": {"address_prefixes": [], "port_ranges": "443", "protocol": "TCP", "service_tag": "BatchNodeManagement"}, "name": "__SYS_ST_BatchNodeManagement_TCP", "status": "Inactive", "type": "service_tag"}, {"category": "required", "destination": {"address_prefixes": [], "port_ranges": "80, 443", "protocol": "TCP", "service_tag": "AzureActiveDirectory"}, "name": "__SYS_ST_AzureActiveDirectory_TCP", "status": "Inactive", "type": "service_tag"}, {"category": "required", "destination": {"service_resource_id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-ml-workspace/providers/Microsoft.Storage/storageAccounts/workspacstoragexxxxxxxxx", "spark_enabled": true, "subresource_target": "blob"}, "name": "__SYS_PE_workspacstoragexxxxxxxxx_blob_xxxxxxxx", "status": "Inactive", "type": "private_endpoint"}, {"category": "required", "destination": {"service_resource_id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-ml-workspace/providers/Microsoft.MachineLearningServices/workspaces/workspace-xxxxxxx-xxx", "spark_enabled": true, "subresource_target": "amlworkspace"}, "name": "__SYS_PE_workspace-xxxxxxx-xxx_amlworkspace_xxxxxxxx", "status": "Inactive", "type": "private_endpoint"}, {"category": "required", "destination": {"address_prefixes": [], "port_ranges": "*", "protocol": "*", "service_tag": "AzureFrontDoor.FirstParty"}, "name": "__SYS_ST_AzureFrontDoor.FirstParty", "status": "Inactive", "type": "service_tag"}, {"category": "required", "destination": {"address_prefixes": [], "port_ranges": "443", "protocol": "TCP", "service_tag": "AzureMachineLearning"}, "name": "__SYS_ST_AzureMachineLearning_TCP", "status": "Inactive", "type": "service_tag"}, {"category": "required", "destination": {"service_resource_id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-ml-workspace/providers/Microsoft.Keyvault/vaults/workspackeyvaultxxxxxxxx", "spark_enabled": true, "subresource_target": "vault"}, "name": "__SYS_PE_workspackeyvault2aa0c6bf_vault_xxxxxxxx", "status": "Inactive", "type": "private_endpoint"}, {"category": "required", "destination": {"address_prefixes": [], "port_ranges": "5831", "protocol": "UDP", "service_tag": "AzureMachineLearning"}, "name": "__SYS_ST_AzureMachineLearning_UDP", "status": "Inactive", "type": "service_tag"}], "status": {"spark_ready": false, "status": "Inactive"}}, "mlflow_tracking_uri": "azureml://westus3.api.azureml.ms/mlflow/v1.0/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-ml-workspace/providers/Microsoft.MachineLearningServices/workspaces/workspace-xxxxxxx-xxx", "name": "workspace-xxxxxxx-xxx", "network_acls": {"default_action": "Allow", "ip_rules": []}, "provision_network_now": false, "public_network_access": "Disabled", "resource_group": "test-ml-workspace", "serverless_compute": {"no_public_ip": false}, "storage_account": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-ml-workspace/providers/Microsoft.Storage/storageAccounts/workspacstoragefxxxxxxxx", "system_datastores_auth_mode": "accesskey", "tags": {}}]

Авторы

  • 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_workspace_info_module.html

Spec-Zone.ru

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