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.
Описание
- Получение фактов об учетной записи 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 логическое |
| Список ключей для учетной записи Automation. Обратите внимание, что это повлияет на сетевой трафик. Рекомендуется использовать только при заданном параметре name. |
| list_statistics логическое |
| Список статистических данных для учетной записи Automation. Обратите внимание, что это повлияет на сетевой трафик. Рекомендуется использовать только при заданном параметре name. |
| list_usages логическое |
| Список данных использования для учетной записи Automation. Обратите внимание, что это повлияет на сетевой трафик. Рекомендуется использовать только при заданном параметре name. |
| name строка | Имя учетной записи Automation. | |
| 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 сложный | всегда | Список словарей автоматизированных учетных записей. | |||
| 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/community/azure/azure_rm_automationaccount_info_module.html
