Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_datafactory — Управляемая фабрика данных

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.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

added in azure.azcollection 0.0.1

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

api_profile

string

added in azure.azcollection 0.0.1

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

Default: "latest"

append_tags

boolean

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

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

Choices:

  • false
  • true ← (default)

auth_source

string

added in 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.

Choices:

  • "auto" ← (default)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

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

Choices:

  • "ignore"
  • "validate"

client_id

string

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

Также может быть задано через переменную среды AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

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

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

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

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

Choices:

  • false ← (default)
  • true

if_match

string

ETag сущности фабрики.

Следует указывать только для получения.

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

location

string

Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.

log_mode

string

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

log_path

string

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

name

string / required

Имя фабрики.

password

string

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

profile

string

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

public_network_access

string

Разрешен ли общедоступный сетевой доступ для фабрики данных.

Варианты:

  • "Enabled"
  • "Disabled"

repo_configuration

dictionary

Настройка репозитория фабрики данных.

account_name

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

Имя учетной записи.

collaboration_branch

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

Ветка сотрудничества.

project_name

string

Имя проекта VSTS.

Требуется при type=FactoryVSTSConfiguration.

repository_name

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

Имя репозитория.

root_folder

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

Корневая папка.

type

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

Тип конфигурации репозитория.

Варианты:

  • "FactoryGitHubConfiguration"
  • "FactoryVSTSConfiguration"

resource_group

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

Ограничить результаты по группе ресурсов. Требуется при использовании параметра name.

secret

string

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

state

string

Утвердить состояние публичного IP-адреса. Используйте present для создания или обновления, и absent для удаления.

Варианты:

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

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.
  • Для аутентификации с помощью принципала службы передайте 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

сложный

Текущее состояние фабрики данных.

Возвращаемое значение: всегда

create_time

строка

Время создания фабрики в формате ISO8601.

Возвращаемое значение: всегда

Пример: "2022-04-26T08:24:41.391164+00:00"

e_tag

строка

Значение ETag, идентифицирующее изменения в ресурсе.

Возвращаемое значение: всегда

Пример: "3000fa80-0000-0100-0000-6267ac490000"

id

строка

Идентификатор фабрики данных.

Возвращаемое значение: всегда

Пример: "/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.DataFactory/factories/testpro"

identity

строка

Управляемая служба идентификации фабрики.

Возвращаемое значение: всегда

principal_id

строка

Идентификатор принципа (principal) идентификации.

Возвращаемое значение: всегда

Пример: "***********"

tenant_id

строка

Идентификатор клиента-арендатора (tenant) идентификации.

Возвращаемое значение: всегда

Пример: "***********"

location

строка

Расположение ресурса.

Возвращаемое значение: всегда

Пример: "eastus"

name

строка

Имя ресурса.

Возвращаемое значение: всегда

Пример: "testfactory"

provisioning_state

строка

Состояние подготовки фабрики, например, "Успешно".

Возвращаемое значение: всегда

Пример: "Succeeded"

public_network_access

строка

Разрешен ли публичный сетевой доступ для фабрики данных.

Возвращаемое значение: всегда

Пример: "Enabled"

repo_configuration

строка

Информация о репозитории Git фабрики.

Возвращаемое значение: всегда

ccount_name

строка

Имя учетной записи.

Возвращаемое значение: всегда

Пример: "fredaccount"

collaboration_branch

строка

Ветка совместной работы.

Возвращаемое значение: всегда

Пример: "branch"

repository_name

строка

Имя репозитория.

Возвращаемое значение: всегда

Пример: "vault"

root_folder

строка

Корневая папка.

Возвращаемое значение: всегда

Пример: "/home/"

type

строка

Тип конфигурации репозитория.

Возвращаемое значение: всегда

Пример: "FactoryGitHubConfiguration"

tags

строка

Список тегов фабрики данных.

Возвращаемое значение: всегда

Пример: "{'key1': 'value1'}"

тип

строка

Тип ресурса.

Возвращаемое значение: всегда

Пример: "Microsoft.DataFactory/factories"

Авторы

  • Fred-sun (@Fred-sun)
  • xuzhang3 (@xuzhang3)

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

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

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

Spec-Zone.ru

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