Модуль azure.azcollection.azure_rm_datafactory — управляемая фабрика данных
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_datafactory.
Добавлено в azure.azcollection 0.1.12
Краткое описание
- Создание, обновление или удаление фабрики данных.
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- 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. Значение по умолчанию По умолчанию: |
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, например, По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, будет ли выполняться обнаружение экземпляра при попытке аутентификации. Если установить значение true, обнаружение экземпляра и проверка центра будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно подключиться к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра предполагает получение метаданных центра с сайта https://login.microsoft.com/ для проверки центра. Установка значения **True** отключает проверку центра. Поэтому крайне важно убедиться, что настроенный узел центра является действительным и надежным. Задается в профиле файла учетных данных или с помощью переменной окружения Варианты:
|
if_match string | ETag сущности фабрики. Следует указывать только для операции get. Если ETag совпадает с существующим тегом сущности или указано значение *, содержимое возвращено не будет. |
location string | Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов. |
log_mode string | Аргумент родительского модуля. |
log_path string | Аргумент родительского модуля. |
name string / обязательный | Имя фабрики. |
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. |
public_network_access string | Разрешен ли публичный сетевой доступ к фабрике данных. Варианты:
|
repo_configuration dictionary | Конфигурация репозитория фабрики данных. |
|
account_name string / обязательный |
Имя учетной записи. |
|
collaboration_branch string / обязательный |
Ветка для совместной работы. |
|
project_name string |
Имя проекта VSTS. Обязательно, если type=FactoryVSTSConfiguration. |
|
repository_name string / обязательный |
Имя репозитория. |
|
root_folder string / обязательный |
Корневая папка. |
|
type string / обязательный |
Тип конфигурации репозитория. Варианты:
|
resource_group string / обязательный | Ограничивает результаты указанной группой ресурсов. Обязательно при использовании параметра name. |
secret string | Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
state string | Задает требуемое состояние общедоступного IP-адреса. Используйте Варианты:
|
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. |
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 the data factory
azure_rm_datafactory:
resource_group: "{{ resource_group }}"
name: "{{ name }}"
repo_configuration:
type: FactoryGitHubConfiguration
account_name: Fred-sun
collaboration_branch: testbranch
root_folder: "./"
repository_name: vault
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
state complex | Текущее состояние фабрики данных. Возвращается: всегда |
|
create_time string |
Время создания фабрики в формате ISO8601. Возвращается: всегда Пример: |
|
e_tag string |
Etag идентифицирует изменения ресурса. Возвращается: всегда Пример: |
|
id string |
Идентификатор фабрики данных. Возвращается: всегда Пример: |
|
identity string |
Управляемое удостоверение службы фабрики. Возвращается: всегда |
|
principal_id string |
Идентификатор субъекта удостоверения. Возвращается: всегда Пример: |
|
tenant_id string |
Идентификатор клиентского арендатора удостоверения. Возвращается: всегда Пример: |
|
location string |
Расположение ресурса. Возвращается: всегда Пример: |
|
name string |
Имя ресурса. Возвращается: всегда Пример: |
|
provisioning_state string |
Состояние подготовки фабрики, например Succeeded. Возвращается: всегда Пример: |
|
public_network_access string |
Разрешен ли доступ к фабрике данных из общедоступной сети. Возвращается: всегда Пример: |
|
repo_configuration string |
Информация о репозитории Git фабрики. Возвращается: всегда |
|
ccount_name string |
Имя учетной записи. Возвращается: всегда Пример: |
|
collaboration_branch string |
Ветка для совместной работы. Возвращается: всегда Пример: |
|
repository_name string |
Имя репозитория. Возвращается: всегда Пример: |
|
root_folder string |
Корневая папка. Возвращается: всегда Пример: |
|
type string |
Тип конфигурации репозитория. Возвращается: всегда Пример: |
|
tags string |
Список тегов фабрики данных. Возвращается: всегда Пример: |
|
type string |
Тип ресурса. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_datafactory_module.html