Spec-Zone.ru › Ansible 2.11

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

Примечание

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

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

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

Новое в версии 0.1.2: из azure.azcollection

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

Обзор

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

Требования

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

  • 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
  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
  azure_rm_automationaccount_info:
      resource_group: myResourceGroup

- name: List automation account in a resource group
  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/azure/azcollection/azure_rm_automationaccount_info_module.html

Spec-Zone.ru

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