Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_automationaccount_info – Получение сведений об учетной записи Azure Automation

Примечание

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

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

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

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

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

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

Описание

  • Получение сведений об учетной записи Automation.

Требования

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

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

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.

Варианты:

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

cert_validation_mode

string

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

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.

Варианты:

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

list_keys

boolean

Список ключей для учетной записи автоматизации.

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

Варианты:

  • false
  • true

list_statistics

boolean

Список сведений о статистике для учетной записи автоматизации.

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

Варианты:

  • false
  • true

list_usages

boolean

Список сведений об использовании для учетной записи автоматизации.

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

Варианты:

  • false
  • true

log_mode

string

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

log_path

string

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

name

string

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

пароль

строка

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

профиль

строка

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

группа_ресурсов

строка / обязательно

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

секрет

строка

Секрет Azure клиента. Используется при аутентификации с сервисным принципалом.

идентификатор_подписки

строка

Ваш идентификатор подписки Azure.

метки

список / элементы=строка

Ограничьте результаты, предоставив список меток. Формат меток — ‘ключ’ или ‘ключ:значение’.

арендатор

строка

Идентификатор арендатора Azure. Используется при аутентификации с сервисным принципалом.

отпечаток_пальца

строка

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

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

Используется при аутентификации с сервисным принципалом.

Требуется, если определен x509_certificate_path.

путь_к_сертификату_x509

путь

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

Путь к сертификату X509, используемому для создания сервисного принципала в формате PEM.

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

Используется при аутентификации с сервисным принципалом.

Примечания

Примечание

  • Для аутентификации с Azure вы можете передавать параметры, устанавливать переменные среды, использовать профиль, хранящийся в ~/.azure/credentials, или войти в систему перед выполнением задач или плейбука с помощью az login.
  • Аутентификация также возможна с помощью сервисного принципала или пользователя Active Directory.
  • Для аутентификации через сервисный принцип передайте идентификатор подписки, идентификатор клиента, секрет и арендатор или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
  • Для аутентификации через пользователя Active Directory передайте ad_user и пароль или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
  • В качестве альтернативы учетные данные могут храниться в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: идентификатор подписки, идентификатор клиента, секрет и арендатор или идентификатор подписки, ad_user и пароль. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

См. также

Вход с помощью Azure CLI

Как войти в систему с помощью команды az login.

Примеры

- name: Get details of an automation account
  azure_rm_automationaccount_info:
    name: Testing
    resource_group: myResourceGroup
    list_statistics: true
    list_usages: true
    list_keys: true
    tags:
      - key
      - key:value

- name: List automation account in a resource group
  azure_rm_automationaccount_info:
    resource_group: myResourceGroup

- name: List automation account in a resource group
  azure_rm_automationaccount_info:

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

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

Ключ

Описание

automation_accounts

сложный

Список словарей учетных записей автоматизации.

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

creation_time

строка

Дата и время создания ресурса.

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

Пример: "2019-04-26T02:55:16.500Z"

id

строка

Идентификатор ресурса.

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups /myResourceGroup/providers/Microsoft.Automation/automationAccounts/Testing"

keys

сложный

Ключи ресурса.

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

key_name

строка

Имя ключа.

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

Пример: "Primary"

permissions

строка

Разрешение ключа.

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

Пример: "Full"

value

строка

Значение ключа.

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

Пример: "MbepKTO6IyGwml0GaKBkKN"

last_modified_time

строка

Дата и время последнего изменения ресурса.

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

Пример: "2019-04-26T02:55:16.500Z"

location

строка

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

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

Пример: "eastus"

name

строка

Имя ресурса.

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

Пример: "Testing"

resource_group

строка

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

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

Пример: "myResourceGroup"

state

строка

Состояние ресурса.

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

Пример: "ok"

statistics

сложный

Статистика ресурса.

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

counter_property

строка

Значение свойства статистики.

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

Пример: "New"

counter_value

целое число

Значение статистики.

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

Пример: 0

end_time

строка

Конец периода статистики.

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

Пример: "2019-04-26T06:29:43.587518Z"

id

строка

Идентификатор статистики.

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups /myResourceGroup/providers/Microsoft.Automation/automationAccounts/Testing/statistics/New"

start_time

строка

Начало периода статистики.

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

Пример: "2019-04-26T06:29:43.587518Z"

использование

сложный

Использование ресурсов.

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

текущее_значение

вещественное

Текущее использование.

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

Пример: 0.0

предел

целое число

Максимальный предел, -1 для неограниченного.

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

Пример: -1

имя

сложный

Имя счетчика использования.

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

локальное_значение

строка

Локализованное имя.

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

Пример: "SubscriptionUsage"

значение

строка

Значение имени.

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

Пример: "SubscriptionUsage"

статус_ограничения

строка

Статус ограничения использования.

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

Пример: "NotThrottled"

единица

строка

Имя единицы измерения использования.

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

Пример: "Minute"

Авторы

  • Yuwei Zhou (@yuwzho)

Ссылки на сборку

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (источники)

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

Spec-Zone.ru

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