community.azure.azure_rm_managed_disk_facts – Получение фактов о управляемых дисках
Примечание
Этот плагин входит в коллекцию community.azure (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install community.azure.
Чтобы использовать его в книге задач, укажите: community.azure.azure_rm_managed_disk_facts.
Обзор
- Получение фактов о конкретном управляемом диске или всех управляемых дисках.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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. |
| append_tags логическое значение |
| Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В случае канонического значения любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. |
| 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 могут быть использованы для определения идентификатора подписки, если их несколько; в противном случае используется стандартная подписка Azure 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. |
| name строка | Ограничить результаты конкретным управляемым диском. | |
| password строка | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group строка | Ограничить результаты конкретной группой ресурсов. | |
| secret строка | Секрет клиента Azure. Используется при аутентификации с помощью службы-принципала. | |
| subscription_id строка | Ваш идентификатор подписки Azure. | |
| tags список / элементы=строка | Ограничить результаты, предоставив список тегов. Формат тегов: 'ключ' или 'ключ:значение'. | |
| tenant строка | Идентификатор клиента Azure. Используется при аутентификации с помощью службы-принципала. |
Примечания
Примечание
- Этот модуль назывался community.azure.azure_rm_managed_disk_facts до Ansible 2.8. Использование не изменилось.
- Для аутентификации в 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 facts for one managed disk
community.azure.azure_rm_manageddisk_info:
name: Testing
resource_group: myResourceGroup
- name: Get facts for all managed disks
community.azure.azure_rm_manageddisk_info:
- name: Get facts by tags
community.azure.azure_rm_manageddisk_info:
tags:
- testing
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| azure_managed_disk список / элементы=строка | всегда | Список словарей управляемых дисков. | |
| create_option строка | успешно | Вариант создания диска. Пример: копия | |
| disk_size_gb строка | успешно | Размер управляемого диска в ГБ, который будет создан. | |
| id строка | успешно | Идентификатор ресурса. | |
| location строка | успешно | Допустимое расположение Azure. | |
| managed_by строка | успешно | Имя существующей виртуальной машины, с которой диск связан или будет связан, эта ВМ должна находиться в той же группе ресурсов. | |
| name строка | успешно | Имя управляемого диска. | |
| os_type строка | успешно | Тип операционной системы. | |
| source_uri строка | успешно | URI файла VHD, который будет использоваться, или идентификатор ресурса управляемого диска для копирования. | |
| storage_account_type строка | успешно | Тип хранилища для управляемого диска. Дополнительную информацию о типе см. на странице https://docs.microsoft.com/ru-ru/azure/virtual-machines/windows/disks-types. Пример: Standard_LRS | |
| tags словарь | успешно | Теги для назначения управляемому диску. Пример: {'тег': 'значение'} | |
Авторы
- Bruno Medina (@brusMX)
© 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_managed_disk_facts_module.html