azure.azcollection.azure_rm_manageddisk_info – Получение фактов о управляемом диске

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в плейбуке укажите: azure.azcollection.azure_rm_manageddisk_info.

Новое в версии 0.1.2: из azure.azcollection

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Обзор

Получение фактов для конкретного управляемого диска или всех управляемых дисков.

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, выполняющем этот модуль.

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 логический тип	Варианты: нет да ←	Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении все теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлен в 0.0.1 из azure.azcollection	Варианты: авто ← cli credential_file env msi	Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды `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	Варианты: ignore validate	Управляет поведением проверки сертификатов для 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`.
managed_by строка		Ограничить результаты дисками, управляемыми заданным VM fqid.
name строка		Ограничить результаты конкретным управляемым диском.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка		Ограничить результаты определенной группой ресурсов. Требуется, если задано значение name
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_info:
    name: Testing
    resource_group: myResourceGroup

- name: Get facts for all managed disks
  azure_rm_manageddisk_info:

- name: Get facts for all managed disks managed by a specific vm
  azure_rm_manageddisk_info:
    managed_by: '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/rgName/Microsoft.Compute/virtualMachines/vmName'

- name: Get facts by tags
  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)
Paul Aiton (@paultaiton)

© 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/azure/azcollection/azure_rm_manageddisk_info_module.html