azure_rm_manageddisk_facts – Получение фактов о управляемых дисках
Новое в версии 2.4.
Описание
- Получение фактов о конкретном управляемом диске или всех управляемых дисках.
Псевдонимы: azure_rm_managed_disk_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. |
| append_tags логический |
| Управление тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом виде любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| 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. |
| name строка | Ограничение результатов конкретным управляемым диском. | |
| password - | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не сервисного принципала. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group строка | Ограничение результатов конкретной группой ресурсов. | |
| secret строка | Секрет клиента Azure. Используется при аутентификации с помощью сервисного принципала. | |
| subscription_id строка | Ваш идентификатор подписки Azure. | |
| tags список | Ограничение результатов с помощью списка тегов. Формат тегов: 'ключ' или 'ключ:значение'. | |
| tenant строка | Идентификатор 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
azure_rm_manageddisk_facts:
name: Testing
resource_group: myResourceGroup
- name: Get facts for all managed disks
azure_rm_manageddisk_facts:
- name: Get facts by tags
azure_rm_manageddisk_facts:
tags:
- testing
Значения возврата
Общие значения возврата описаны в документации, ниже перечислены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| azure_managed_disk список | всегда | Список словарей управляемых дисков. | |
| create_option строка | Параметр создания диска Пример: copy | ||
| disk_size_gb строка | Размер управляемого диска в ГБ, который будет создан. | ||
| id строка | Идентификатор ресурса. | ||
| location строка | Допустимое расположение Azure. | ||
| managed_by строка | Имя существующей виртуальной машины, с которой диск связан или будет связан; эта ВМ должна находиться в той же группе ресурсов. | ||
| name строка | Имя управляемого диска. | ||
| os_type строка | Тип операционной системы: linux или windows. | ||
| source_uri строка | URI файла VHD, который будет использоваться, или идентификатор ресурса управляемого диска для копирования. | ||
| storage_account_type строка | Тип хранилища для управляемого диска. Дополнительную информацию об этом типе см. на странице https://docs.microsoft.com/ru-ru/azure/virtual-machines/windows/disks-types. Пример: Standard_LRS | ||
| tags словарь | Теги, которые нужно назначить управляемому диску. Пример: {'tag': 'значение'} | ||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/azure_rm_manageddisk_facts_module.html