Модуль azure.azcollection.azure_rm_ml_workspace — создание, обновление или удаление рабочей области Azure Machine Learning

ad_user

string

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

adfs_authority_url

string

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

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

all_resources

boolean

Применяется только к state=absent. Удалить все зависимые ресурсы, связанные с рабочей областью (учетную запись службы хранилища Azure, реестр контейнеров Azure, Application Insights Azure, хранилище ключей Azure).

Варианты:

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

allow_roleassignment_on_rg

boolean

Флаг, определяющий, могут ли рабочей области назначаться роли на уровне группы ресурсов.

Варианты:

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

api_profile

string

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

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

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

append_tags

boolean

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

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

Варианты:

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

application_insights

string

Идентификатор ARM ресурса Application Insights, связанного с этой рабочей областью.

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, на компьютере должна быть включена подсистема расширений MSI ресурса Azure. Для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать 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"

container_registry

string

Идентификатор ARM реестра контейнеров, связанного с этой рабочей областью.

default_resource_group

string

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

description

string

Описание рабочей области Azure ML.

disable_instance_discovery

boolean

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

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

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

Варианты:

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

display_name

string

Отображаемое имя рабочей области.

enable_data_isolation

boolean

Флаг, определяющий, включена ли в рабочей области изоляция данных. Этот флаг можно задать только при создании; изменить его впоследствии нельзя.

Варианты:

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

hub_id

string

Применяется только к kind=Project. Идентификатор ARM, определяющий родительский центр этого проекта.

image_build_compute

string

Имя целевого вычислительного ресурса для сборки образов Docker среды, если реестр контейнеров находится за виртуальной сетью.

key_vault

string

Идентификатор ARM хранилища ключей, связанного с этой рабочей областью.

kind

string

Указывает тип рабочей области.

Варианты:

• "hub"
• "project"

location

string

Расположение для новой рабочей области.

log_mode

string

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

log_path

string

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

managed_network

string

Режим изоляции управляемой сети для рабочей области.

Варианты:

• "disabled"
• "allow_internet_outbound"
• "allow_only_approved_outbound"

name

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

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

network_acls

list / элементы=string

Список правил для входящих IP-подключений

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, а не субъекта-службы.

permanently_delete

boolean

Применяется только к state=absent. По умолчанию рабочие области переходят в состояние обратимого удаления, чтобы можно было восстановить данные рабочей области. Установите этот флаг, чтобы отменить обратимое удаление и удалить рабочую область без возможности восстановления.

Варианты:

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

primary_user_assigned_identity

string

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

profile

string

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

provision_network_now

boolean

Установите этот параметр, чтобы запустить подготовку управляемой сети при создании рабочей области с включенной управляемой сетью; в противном случае он не выполняет никаких действий.

Варианты:

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

public_network_access

string

Разрешить подключение через общедоступную конечную точку, если для рабочей области включена поддержка Private Link.

Варианты:

• "Disabled" ← (по умолчанию)
• "Enabled"

resource_definition

string

Определение рабочей области в YAML

resource_group

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

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

secret

string

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

state

string

Состояние рабочей области. Используйте present для создания или обновления и absent для удаления.

Варианты:

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

storage_account

string

Идентификатор ARM учетной записи службы хранилища, связанной с этой рабочей областью.

subscription_id

string

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

system_datastores_auth_mode

string

Указывает режим аутентификации для системных хранилищ данных.

Варианты:

• "accesskey"
• "identity"

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.

update_dependent_resources

boolean

Указывая update_dependent_resources, вы соглашаетесь на обновление ресурсов, от которых зависит рабочая область. Обновление подключенного к рабочей области реестра контейнеров Azure или ресурса Application Insights может нарушить связь с предыдущими заданиями, развернутыми конечными точками вывода или возможность повторного запуска прежних заданий в этой рабочей области.

Варианты:

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

x509_certificate_path

path

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

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

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

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

changed

логическое значение

Был ли изменён ресурс.

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

Пример: false

ml_workspace

словарь

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

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

Пример: {"allow_roleassignment_on_rg": false, "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"}], "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/workspacstoragexxxxxxxxx", "system_datastores_auth_mode": "accesskey", "tags": {"createdByToolkit": "sdk-v2-1.31.0", "foo": "bar"}}