модуль azure.azcollection.azure_rm_automationaccount_info — получение сведений об учетной записи автоматизации Azure
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить ее, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные зависимости; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_automationaccount_info.
Добавлено в azure.azcollection 0.1.2
Краткое описание
- Получение сведений об учетной записи автоматизации.
Требования
На узле, выполняющем этот модуль, необходимы следующие компоненты.
- python >= 2.7
- На узле, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из Galaxy
- Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на узле, выполняющем модули из azure.azcollection
- Полные инструкции по установке приведены по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используется для аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
adfs_authority_url string добавлено в azure.azcollection 0.0.1 | URL центра Azure AD. Используется для аутентификации по имени пользователя и паролю, если у вас есть собственный центр ADFS. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной среды Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Допустимые значения:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Допустимые значения:
|
client_id string | Идентификатор клиента Azure. Используется для аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, — имя среды (как определено в Azure Python SDK, например По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если задать значение true, обнаружение экземпляров и проверка центра будут полностью отключены. Эта функция предназначена для случаев, когда невозможно получить доступ к конечной точке метаданных, например в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает получение метаданных центра с сайта https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра будет отключена. Поэтому важно убедиться в том, что настроенный узел центра является допустимым и заслуживающим доверия. Задается в профиле файла учетных данных или с помощью переменной среды Допустимые значения:
|
list_keys boolean | Вывести список ключей учетной записи автоматизации. Обратите внимание: это увеличит сетевую нагрузку; рекомендуется использовать параметр только при заданном name. Допустимые значения:
|
list_statistics boolean | Вывести подробные сведения статистики для учетной записи автоматизации. Обратите внимание: это увеличит сетевую нагрузку; рекомендуется использовать параметр только при заданном name. Допустимые значения:
|
list_usages boolean | Вывести подробные сведения об использовании учетной записи автоматизации. Обратите внимание: это увеличит сетевую нагрузку; рекомендуется использовать параметр только при заданном name. Допустимые значения:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Имя учетной записи автоматизации. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации по удостоверению рабочей нагрузки. Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной среды |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации по удостоверению рабочей нагрузки. Файл должен содержать только токен в исходном виде. Этот способ часто используется на платформах, которые сохраняют токены OIDC в файлах. Также можно задать с помощью переменной среды |
password string | Пароль пользователя Active Directory. Используется для аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
resource_group string | Имя группы ресурсов. |
secret string | Секрет клиента Azure. Используется для аутентификации с помощью субъекта-службы. |
subscription_id string | Идентификатор вашей подписки Azure. |
tags list / элементы=string | Ограничение результатов с помощью списка тегов. Указывайте теги в формате «ключ» или «ключ:значение». |
tenant string | Идентификатор клиента Azure. Используется для аутентификации с помощью субъекта-службы. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток закрытого ключа, указанного в x509_certificate_path. Используется для аутентификации с помощью субъекта-службы. Обязателен, если задан x509_certificate_path. |
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы. Сертификат должен быть добавлен к закрытому ключу. Используется для аутентификации с помощью субъекта-службы. |
Примечания
Примечание
- Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль из ~/.azure/credentials или войти в систему перед запуском задач или плейбука с помощью
az login. - Аутентификация также возможна с помощью субъекта-службы или пользователя Active Directory.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации через субъект-службу передайте 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: true
list_usages: true
list_keys: true
tags:
- key
- key:value
- 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 | Список словарей учетных записей автоматизации. Возвращается: всегда |
|
account_keys complex |
Ключи ресурса. Возвращается: при list_keys=True |
|
key_name string |
Имя ключа. Возвращается: при list_keys=True Пример: |
|
permissions string |
Разрешение ключа. Возвращается: при list_keys=True Пример: |
|
value string |
Значение ключа. Возвращается: при list_keys=True Пример: |
|
creation_time string |
Дата и время создания ресурса. Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса. Возвращается: всегда Пример: |
|
keys complex |
Ключи ресурса. Это возвращаемое значение устарело и будет удалено в одном из выпусков после 2027-05-01. Вместо него используйте Возвращается: при list_keys=True |
|
key_name string |
Имя ключа. Возвращается: при list_keys=True Пример: |
|
permissions string |
Разрешение ключа. Возвращается: при list_keys=True Пример: |
|
value string |
Значение ключа. Возвращается: при list_keys=True Пример: |
|
last_modified_time string |
Дата и время последнего изменения ресурса. Возвращается: всегда Пример: |
|
location string |
Расположение ресурса. Возвращается: всегда Пример: |
|
name string |
Имя ресурса. Возвращается: всегда Пример: |
|
resource_group string |
Имя группы ресурсов. Возвращается: всегда Пример: |
|
state string |
Состояние ресурса. Возвращается: всегда Пример: |
|
statistics complex |
Статистика ресурса. Возвращается: всегда |
|
counter_property string |
Значение свойства статистики. Возвращается: всегда Пример: |
|
counter_value integer |
Значение статистики. Возвращается: всегда Пример: |
|
end_time string |
Время окончания статистического периода. Возвращается: всегда Пример: |
|
id string |
Идентификатор статистики. Возвращается: всегда Пример: |
|
start_time string |
Время начала статистического периода. Возвращается: всегда Пример: |
|
usages complex |
Использование ресурса. Возвращается: всегда |
|
current_value float |
Текущее использование. Возвращается: всегда Пример: |
|
limit integer |
Максимальный предел; Возвращается: всегда Пример: |
|
name complex |
Имя счетчика использования. Возвращается: всегда |
|
localized_value string |
Локализованное имя. Возвращается: всегда Пример: |
|
value string |
Значение имени. Возвращается: всегда Пример: |
|
throttle_status string |
Статус ограничения использования. Возвращается: всегда Пример: |
|
unit string |
Название единицы измерения использования. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_automationaccount_info_module.html