azure.azcollection.azure_rm_automationrunbook модуль — Управление автоматизацией runbook

Примечание

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

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

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

Для использования в playbook укажите: azure.azcollection.azure_rm_automationrunbook.

Новая в azure.azcollection 1.12.0

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

Описание

Создание, обновление, удаление или публикация runbook автоматизации.

Требования

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

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"`
automation_account_name string / required	Имя учетной записи автоматизации.
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"`
description string	Задает описание.
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`
location string	Расположение книги автоматизации.
log_activity_trace integer	Задает параметр для ведения журнала трассировки активности книги автоматизации.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.

log_progress boolean	Устанавливает опцию журнала выполнения. Варианты: `false` `true`
log_verbose boolean	Устанавливает опцию подробного журнала. Варианты: `false` `true`
name string / обязательно	Имя автоматизированного скрипта.
password string	Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо служебного принципала.
profile string	Профиль безопасности, найденный в файле ~/.azure/credentials.
publish boolean	Опубликовать скрипт или нет. Варианты: `false` `true`
resource_group string / обязательно	Название группы ресурсов.
runbook_type string	Устанавливает тип скрипта. Варианты: `"Script"` `"Graph"` `"PowerShellWorkflow"` `"PowerShell"` `"GraphPowerShellWorkflow"` `"GraphPowerShell"`
secret string	Секрет клиента Azure. Используйте при аутентификации со Служебным принципалом.
state string	Состояние автоматизированного скрипта. Используйте `present` для создания или обновления автоматизированного скрипта и `absent` для удаления. Варианты: `"present"` ← (по умолчанию) `"absent"`
subscription_id string	Ваш идентификатор подписки Azure.
tags словарь	Словарь пар строка:строка для назначения метаданных объекту. Метаданные метки объекта будут обновлены любыми предоставленными значениями. Для удаления меток установите опцию 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 путь добавлен в 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 automation runbook with default parameters
  azure_rm_automationrunbook:
    resource_group: "{{ resource_group }}"
    automation_account_name: "{{ account-name }}"
    name: "{{ runbook-name }}"
    runbook_type: "Script"
    description: "Fred test"

- name: create automation runbook with more parameters
  azure_rm_automationrunbook:
    resource_group: "{{ resource_group }}"
    automation_account_name: "{{ account-name }}"
    name: "{{ runbook-name }}"
    runbook_type: "Script"
    description: "Fred test"
    log_activity_trace: 3
    log_progress: true
    log_verbose: false
    tags:
      key1: value1

- name: Publish automation runbook
  azure_rm_automationrunbook:
    resource_group: "{{ resource_group }}"
    automation_account_name: "{{ account-name }}"
    name: "{{ runbook-name }}"
    publish: true

- name: Delete automation runbook
  azure_rm_automationrunbook:
    resource_group: "{{ resource_group }}"
    automation_account_name: "{{ account-name }}"
    name: "{{ runbook-name }}"
    state: absent

Значения возврата

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

Ключ	Описание
state сложный	Список словарей автоматизированных исполняемых файлов. Возвращается: всегда
creation_time строка	Дата и время создания ресурса. Возвращается: всегда Пример: `"2022-03-24T06:30:54.116666+00:00"`
id строка	Идентификатор ресурса. Возвращается: всегда Пример: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups /myResourceGroup/providers/Microsoft.Automation/automationAccounts/test/runbooks/runbook_name"`
job_count целое число	Количество задач исполняемого файла. Возвращается: всегда Пример: `3`
last_modified_by строка	Последний пользователь, изменивший ресурс. Возвращается: всегда Пример: `"Fred-sun"`
last_modified_time строка	Время последнего обновления ресурса. Возвращается: всегда Пример: `"2022-03-25T06:30:54.116666+00:00"`
location строка	Расположение ресурса. Возвращается: всегда Пример: `"eastus"`
log_activity_trace целое число	Параметр для ведения журнала трассировки активности исполняемого файла. Возвращается: всегда Пример: `3`
log_progress логический	Показывать ли журнал прогресса. Возвращается: всегда Пример: `true`
log_verbose логический	Показывать ли подробный журнал. Возвращается: всегда Пример: `true`
name строка	Имя ресурса. Возвращается: всегда Пример: `"Testing"`
output_types список / элементы=строка	Тип выходных данных исполняемого файла. Возвращается: всегда Пример: `[]`
resource_group строка	Имя группы ресурсов. Возвращается: всегда Пример: `"myResourceGroup"`
runbook_content_link строка	Ссылка на опубликованный контент исполняемого файла. Возвращается: всегда
state строка	Состояние ресурса. Возвращается: всегда Пример: `"Published"`
tags словарь	Теги ресурса. Возвращается: всегда Пример: `{"key1": "value1"}`
type строка	Тип ресурса автоматизированного исполняемого файла. Возвращается: всегда Пример: `"Microsoft.Automation/AutomationAccounts/Runbooks"`

Авторы

Фред Сан (@Fred-sun)

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

© 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_automationrunbook_module.html