azure.azcollection.azure_rm_automationaccount_info – Получение фактов о учетной записи Azure Automation
Примечание
Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в книге задач укажите: azure.azcollection.azure_rm_automationaccount_info.
Введено в версии 0.1.2: of azure.azcollection
Краткое описание
- Получение фактов об учетной записи Automation.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 |
| Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды 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. |
| cert_validation_mode строка добавлен в 0.0.1 из azure.azcollection |
| Управляет поведением проверки сертификата для 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 булево |
| Список ключей для учетной записи автоматизации. Обратите внимание, это потребует сетевых затрат. Рекомендуется использовать только при заданном name. |
| list_statistics булево |
| Список статистических данных для учетной записи автоматизации. Обратите внимание, это потребует сетевых затрат. Рекомендуется использовать только при заданном name. |
| list_usages булево |
| Список данных использования для учетной записи автоматизации. Обратите внимание, это потребует сетевых затрат. Рекомендуется использовать только при заданном 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 сложный | всегда | Список словарей автоматизированных учетных записей. | |||
| 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 строка | всегда | Имя ключа. Пример: Основной | |||
| permissions строка | всегда | Разрешения ключа. Пример: Полный доступ | |||
| value строка | всегда | Значение ключа. Пример: MbepKTO6IyGwml0GaKBkKN | |||
| last_modified_time строка | всегда | Дата и время последнего изменения ресурса. Пример: 2019-04-26T02:55:16.500Z | |||
| location строка | всегда | Расположение ресурса. Пример: eastus | |||
| name строка | всегда | Имя ресурса. Пример: Testing | |||
| resource_group строка | всегда | Имя группы ресурсов. Пример: myResourceGroup | |||
| state строка | всегда | Состояние ресурса. Пример: ok | |||
| statistics сложный | всегда | Статистика ресурса. | |||
| counter_property строка | всегда | Значение свойства статистики. Пример: Новый | |||
| counter_value целое число | всегда | Значение статистики. | |||
| 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 | |||
| usages сложный | всегда | Использование ресурсов. | |||
| current_value число с плавающей точкой | всегда | Текущее использование. | |||
| limit целое число | всегда | Максимальное ограничение, -1 для неограниченного.Пример: -1 | |||
| name сложный | всегда | Имя счетчика использования. | |||
| localized_value строка | всегда | Локализованное имя. Пример: SubscriptionUsage | |||
| value строка | всегда | Значение имени. Пример: SubscriptionUsage | |||
| throttle_status строка | всегда | Статус ограничения использования. Пример: NotThrottled | |||
| unit строка | всегда | Имя единицы измерения использования. Пример: Минута | |||
Авторы
- Yuwei Zhou (@yuwzho)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/azure/azcollection/azure_rm_automationaccount_info_module.html
