Модуль azure.azcollection.azure_rm_manageddisk_info – получение сведений об управляемых дисках
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_manageddisk_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**, проверка центра будет отключена. Поэтому крайне важно убедиться, что настроенный узел центра является допустимым и заслуживающим доверия. Задается через профиль файла учетных данных или переменную окружения Варианты:
|
log_mode string | Аргумент родительского модуля. |
log_path string | Аргумент родительского модуля. |
managed_by string | Ограничивает результаты дисками, управляемыми виртуальной машиной с указанным fqid. |
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 | Ограничивает результаты указанной группой ресурсов. Обязательно, если задан параметр name. |
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, используемому для создания субъекта-службы. Сертификат должен быть добавлен в конец закрытого ключа. Используется при аутентификации с помощью субъекта-службы. |
Примечания
Примечание
- До Ansible 2.8 этот модуль назывался azure.azcollection.azure_rm_managed_disk_facts. Способ использования не изменился.
- Для аутентификации в 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 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 list / elements=string | Список словарей управляемых дисков. Возвращается: всегда |
|
create_option string |
Параметр создания диска. Возвращается: при успешном выполнении Пример: |
|
disk_access_id string |
Идентификатор ARM ресурса DiskAccess для использования частных конечных точек на дисках. Возвращается: всегда Пример: |
|
disk_iops_read_only integer |
Общая пропускная способность (МБ/с), разрешенная для всех виртуальных машин, подключающих общий диск в режиме ReadOnly. За одну операцию можно передать от 4 до 256 КБ. Возвращается: всегда Пример: |
|
disk_iops_read_write integer |
Количество операций ввода-вывода в секунду, разрешенное для этого диска. Можно задать только для дисков storage_account_type=UltraSSD_LRS. За одну операцию можно передать от 4 до 256 КБ. Возвращается: всегда Пример: |
|
disk_m_bps_read_only integer |
Общая пропускная способность (МБ/с), разрешенная для всех виртуальных машин, подключающих общий диск в режиме ReadOnly. МБ/с означает миллионы байт в секунду — здесь МБ соответствует нотации ISO, использующей степени 10. Возвращается: всегда Пример: |
|
disk_m_bps_read_write integer |
Пропускная способность, разрешенная для этого диска. Можно задать только для дисков storage_account_type=UltraSSD_LRS. За одну операцию можно передать от 4 до 256 КБ. Возвращается: всегда Пример: |
|
disk_size_gb string |
Размер создаваемого управляемого диска в ГБ. Возвращается: при успешном выполнении |
|
gallery_image_reference dictionary |
Сведения об образе из галереи. Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса. Возвращается: при успешном выполнении |
|
image_reference dictionary |
Сведения об источнике диска для PIR, пользовательских образов или образа из галереи. Возвращается: всегда Пример: |
|
last_ownership_update_time string |
Время UTC, когда состояние владения диском изменялось в последний раз. Время последнего подключения диска к виртуальной машине или его отключения от нее, либо время остановки или запуска виртуальной машины, к которой был подключен диск. Возвращается: всегда Пример: |
|
location string |
Допустимое расположение Azure. Возвращается: при успешном выполнении |
|
logical_sector_size integer |
Размер логического сектора в байтах для дисков Ultra. Возвращается: всегда Пример: |
|
managed_by string |
Имя существующей виртуальной машины, с которой диск связан или будет связан; эта виртуальная машина должна находиться в той же группе ресурсов. Возвращается: при успешном выполнении Пример: |
|
managed_by_extended list / elements=string |
Список идентификаторов существующих виртуальных машин, с которыми диск связан или будет связан. Возвращается: при успешном выполнении Пример: |
|
integer |
Максимальное количество виртуальных машин, которые могут одновременно подключить диск. Значение больше единицы указывает на то, что диск можно одновременно подключить к нескольким виртуальным машинам. Возвращается: при успешном выполнении Пример: |
|
name string |
Имя управляемого диска. Возвращается: при успешном выполнении |
|
network_access_policy string |
Политика доступа к диску по сети. Возвращается: всегда Пример: |
|
os_type string |
Тип операционной системы. Возвращается: при успешном выполнении Возможные значения:
|
|
performance_plus boolean |
Флаг целевого показателя производительности развернутого диска. Возвращается: всегда Пример: |
|
public_network_access string |
Политика управления экспортом диска. Возвращается: всегда Пример: |
|
security_profile complex |
Сведения о безопасности ресурса. Возвращается: при успешном выполнении |
|
secure_vm_disk_encryption_set_id string |
ResourceId набора шифрования дисков, связанного с поддерживаемым диском конфиденциальной виртуальной машины, зашифрованным ключом, управляемым клиентом. Возвращается: при использовании Пример: |
|
security_type string |
Указывает тип безопасности виртуальной машины. Возвращается: при использовании Пример: |
|
source_resource_id string |
Идентификатор ARM исходного снимка или диска. Возвращается: всегда Пример: |
|
source_uri string |
URI допустимого файла VHD, который будет использоваться, или идентификатор ресурса управляемого диска для копирования. Возвращается: при успешном выполнении |
|
storage_account_type string |
Тип хранилища для управляемого диска. Дополнительные сведения об этом типе см. на странице https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types. Возвращается: при успешном выполнении Пример: |
|
tags dictionary |
Теги, назначаемые управляемому диску. Возвращается: при успешном выполнении Пример: |
|
tier string |
Уровень производительности, назначенный управляемому диску. Дополнительные сведения об уровнях производительности дисков см. на странице https://learn.microsoft.com/en-us/azure/virtual-machines/disks-change-performance. Возвращается: при успешном выполнении Пример: |
|
time_created string |
Время создания диска. Возвращается: при успешном выполнении Пример: |
|
upload_size_bytes integer |
Размер загружаемого содержимого, включая нижний колонтитул VHD. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_manageddisk_info_module.html