azure_rm_automationaccount_info – Получение фактов о учетной записи автоматизации Azure
Новая версия 2.9.
Синопсис
- Получить факты об учетной записи автоматизации.
Псевдонимы: azure_rm_automationaccount_facts
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| adfs_authority_url строка добавлено в 2.6 | URL-адрес службы Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной службой ADFS. | |
| api_profile строка добавлено в 2.5 | По умолчанию: "latest" | Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| auth_source строка добавлено в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды ANSIBLE_AZURE_AUTH_SOURCE, и по умолчанию будет auto если переменная не определена.auto будет следовать умолчанию приоритета параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.При установке в cli, учетные данные будут извлекаться из профиля Azure CLI по умолчанию.Также может быть установлено через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.При установке в msi, машина хоста должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут быть использованы для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.msi была добавлена в Ansible 2.6. |
| cert_validation_mode строка добавлено в 2.5 |
| Управляет поведением проверки сертификатов для Azure-точек конечных ресурсов. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или подключения к Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id строка | Идентификатор клиента Azure. Используется при аутентификации с помощью принципала службы. | |
| cloud_environment строка добавлено в 2.4 | По умолчанию: "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 complex | всегда | Список словарей счетов автоматизации. | |||
| creation_time строка | всегда | Дата и время создания ресурса. Пример: 2019-04-26T02:55:16.500Z | |||
| id строка | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups /myResourceGroup/providers/Microsoft.Automation/automationAccounts/Testing | |||
| keys complex | всегда | Ключи ресурса. | |||
| key_name строка | всегда | Имя ключа. Пример: Основной | |||
| permissions строка | всегда | Разрешения ключа. Пример: Полный | |||
| value строка | всегда | Значение ключа. Пример: MbepKTO6IyGwml0GaKBkKN | |||
| last_modified_time строка | всегда | Дата и время последнего изменения ресурса. Пример: 2019-04-26T02:55:16.500Z | |||
| location строка | всегда | Расположение ресурса. Пример: eastus | |||
| name строка | всегда | Имя ресурса. Пример: Testing | |||
| resource_group строка | всегда | Имя группы ресурсов. Пример: myResourceGroup | |||
| state строка | всегда | Состояние ресурса. Пример: ok | |||
| statistics complex | всегда | Статистика ресурса. | |||
| counter_property строка | всегда | Значение свойства статистики. Пример: New | |||
| 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 complex | всегда | Использование ресурса. | |||
| current_value вещественное число | всегда | Текущее использование. | |||
| limit целое число | всегда | Максимальное ограничение, -1 для неограниченного.Пример: -1 | |||
| name complex | всегда | Имя счетчика использования. | |||
| localized_value строка | всегда | Локализованное имя. Пример: SubscriptionUsage | |||
| value строка | всегда | Значение имени. Пример: SubscriptionUsage | |||
| throttle_status строка | всегда | Статус ограничения использования. Пример: NotThrottled | |||
| unit строка | всегда | Имя единицы измерения использования. Пример: Минута | |||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/azure_rm_automationaccount_info_module.html