Spec-Zone.ru › Ansible 2.11

community.azure.azure_rm_automationaccount_info – Получение фактов о учетной записи Azure Automation

Примечание

Этот плагин является частью коллекции community.azure (версия 1.0.0).

Для его установки используйте: ansible-galaxy collection install community.azure.

Для использования в книге задач, укажите: community.azure.azure_rm_automationaccount_info.

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

Обзор

  • Получение фактов об учетной записи автоматизации.

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url
строка
добавлено в 0.0.1 azure.azcollection
URL-адрес авторитета Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственном авторитете ADFS.
api_profile
строка
добавлено в 0.0.1 azure.azcollection
По умолчанию:
"latest"
Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
auth_source
строка
добавлено в 0.0.1 azure.azcollection
    Варианты:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Также может быть задан через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.
При установке в auto (по умолчанию) приоритет имеет: параметры модуля -> env -> credential_file -> cli.
При установке в env, учетные данные будут считываться из переменных среды
При установке в credential_file, будет считан профиль из ~/.azure/credentials.
При установке в cli, учетные данные будут взяты из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут быть использованы для определения идентификатора подписки, если их несколько; в противном случае используется по умолчанию подписка Azure CLI.
При установке в msi, хост-машина должна быть Azure-ресурсом с включённой расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут быть использованы для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам; в противном случае выбирается первая подписка.
Ключевое слово msi было добавлено в Ansible 2.6.
cert_validation_mode
строка
добавлено в 0.0.1 azure.azcollection
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или работе с Azure Stack, может потребоваться отключить это поведение, передав ignore. Также может быть задан в файле профиля учетных данных или переменной среды AZURE_CERT_VALIDATION.
client_id
строка
Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.
cloud_environment
строка
добавлено в 0.0.1 azure.azcollection
По умолчанию:
"AzureCloud"
Для облачных сред, отличных от общедоступного облака США, имя среды (определённое Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задан в файле профиля учетных данных или переменной среды AZURE_CLOUD_ENVIRONMENT.
list_keys
булево
    Варианты:
  • no
  • yes
Список ключей для учетной записи автоматизации.
Обратите внимание, что это потребует сетевых затрат, рекомендуется использовать только при заданном параметре name.
list_statistics
булево
    Варианты:
  • no
  • yes
Список статистических данных для учетной записи автоматизации.
Обратите внимание, что это потребует сетевых затрат, рекомендуется использовать только при заданном параметре name.
list_usages
булево
    Варианты:
  • no
  • yes
Список данных использования для учетной записи автоматизации.
Обратите внимание, что это потребует сетевых затрат, рекомендуется использовать только при заданном параметре name.
name
строка
Имя учетной записи автоматизации.
password
строка
Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
строка / обязательный
Имя группы ресурсов.
secret
строка
Секрет клиента Azure. Используйте при аутентификации с принципалом службы.
subscription_id
строка
Ваш идентификатор подписки Azure.
tags
список / элементы=строка
Ограничьте результаты, предоставив список тегов. Формат тегов как 'ключ' или 'ключ:значение'.
tenant
строка
Идентификатор Azure-аренды. Используйте при аутентификации с принципалом службы.

Примечания

Примечание

  • Для аутентификации с 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: Get details of an automation account
  community.azure.azure_rm_automationaccount_info:
      name: Testing
      resource_group: myResourceGroup
      list_statistics: yes
      list_usages: yes
      list_keys: yes

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

- name: List automation account in a resource group
  community.azure.azure_rm_automationaccount_info:

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

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

Ключ Возвращаемое значение Описание
automation_accounts
complex
всегда
Список словарей учетных записей автоматизации.
creation_time
string
всегда
Дата и время создания ресурса.

Пример:
2019-04-26T02:55:16.500Z
id
string
всегда
Идентификатор ресурса.

Пример:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups /myResourceGroup/providers/Microsoft.Automation/automationAccounts/Testing
keys
complex
всегда
Ключи ресурса.
key_name
string
всегда
Имя ключа.

Пример:
Основной
permissions
string
всегда
Разрешения ключа.

Пример:
Полные
value
string
всегда
Значение ключа.

Пример:
MbepKTO6IyGwml0GaKBkKN
last_modified_time
string
всегда
Дата и время последнего изменения ресурса.

Пример:
2019-04-26T02:55:16.500Z
location
string
всегда
Расположение ресурса.

Пример:
eastus
name
string
всегда
Имя ресурса.

Пример:
Testing
resource_group
string
всегда
Имя группы ресурсов.

Пример:
myResourceGroup
state
string
всегда
Состояние ресурса.

Пример:
ok
statistics
complex
всегда
Статистика ресурса.
counter_property
string
всегда
Значение свойства статистики.

Пример:
New
counter_value
integer
всегда
Значение статистики.
end_time
string
всегда
Конечное время статистики.

Пример:
2019-04-26T06:29:43.587518Z
id
string
всегда
Идентификатор статистики.

Пример:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups /myResourceGroup/providers/Microsoft.Automation/automationAccounts/Testing/statistics/New
start_time
string
всегда
Начальное время статистики.

Пример:
2019-04-26T06:29:43.587518Z
usages
complex
всегда
Использование ресурса.
current_value
float
всегда
Текущее использование.
limit
integer
всегда
Максимальное ограничение, -1 для неограниченного.

Пример:
-1
name
complex
всегда
Имя счётчика использования.
localized_value
string
всегда
Локализованное имя.

Пример:
SubscriptionUsage
value
string
всегда
Значение имени.

Пример:
SubscriptionUsage
throttle_status
string
всегда
Состояние ограничения использования.

Пример:
NotThrottled
unit
string
всегда
Название единицы измерения использования.

Пример:
Минута


Авторы

  • Yuwei Zhou (@yuwzho)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/azure/azure_rm_automationaccount_info_module.html

Spec-Zone.ru

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