azure_rm_resource_info – Общие сведения о ресурсах Azure
Новая версия с 2.9.
Обзор
- Получение сведений о любом ресурсе с помощью Azure REST API.
- Этот модуль предоставляет доступ к ресурсам, которые не поддерживаются модулями Ansible.
- Подробную информацию о REST API конкретного ресурса см. на странице https://docs.microsoft.com/en-us/rest/api/.
Псевдонимы: azure_rm_resource_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. | |
| api_version - | Конкретная версия API для использования. | ||
| 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. | |
| password строка | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не сервисного принципала. | ||
| profile строка | Профиль безопасности в файле ~/.azure/credentials. | ||
| provider - | Тип поставщика, должен быть указан, если не указан URL. | ||
| resource_group - | Группа ресурсов для использования. Требуется, если URL не указан. | ||
| resource_name - | Имя ресурса. | ||
| resource_type - | Тип ресурса. | ||
| secret строка | Секретный ключ клиента Azure. Используется при аутентификации с помощью сервисного принципала. | ||
| subresource - | Список подресурсов. | ||
| name - | Имя подресурса. | ||
| namespace - | Пространство имён подресурса. | ||
| type - | Тип подресурса. | ||
| subscription_id строка | Идентификатор вашей подписки Azure. | ||
| tenant строка | Идентификатор Azure-аренды. Используется при аутентификации с помощью сервисного принципала. | ||
| url - | URL ресурса Azure RM. | ||
Примечания
Примечание
- Для аутентификации в 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 scaleset info
azure_rm_resource_info:
resource_group: myResourceGroup
provider: compute
resource_type: virtualmachinescalesets
resource_name: myVmss
api_version: "2017-12-01"
- name: Query all the resources in the resource group
azure_rm_resource_info:
resource_group: "{{ resource_group }}"
resource_type: resources
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| response complex | всегда | Ответ, специфичный для типа ресурса. | |||
| id string | всегда | Идентификатор Azure-ресурса. Пример: /subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/virtualMachines/myVM | |||
| location string | всегда | Расположение ресурса. Пример: eastus | |||
| name string | всегда | Имя ресурса. Пример: myVM | |||
| properties complex | всегда | Указывает свойства виртуальной машины. | |||
| diagnosticsProfile complex | всегда | Указывает состояние настроек диагностики загрузки. | |||
| bootDiagnostics dictionary | всегда | Функция отладки, позволяющая просматривать вывод консоли и скриншоты для диагностики состояния ВМ. Пример: {'enabled': True, 'storageUri': 'https://vxisurgdiag.blob.core.windows.net/'} | |||
| hardwareProfile dictionary | всегда | Указывает аппаратные настройки виртуальной машины. Пример: {'vmSize': 'Standard_D2s_v3'} | |||
| networkProfile complex | всегда | Указывает сетевые интерфейсы виртуальной машины. | |||
| networkInterfaces list | всегда | Описание ссылки на сетевой интерфейс. Пример: [{'id': '/subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/networkInterfaces/myvm441'}] | |||
| osProfile complex | всегда | Указывает настройки операционной системы для виртуальной машины. | |||
| adminUsername string | всегда | Указывает имя учетной записи администратора. Пример: azureuser | |||
| allowExtensionOperations boolean | всегда | Указывает, разрешены ли операции с расширениями на виртуальной машине. Это может быть установлено только в значение False, если на виртуальной машине нет расширений. Пример: True | |||
| computerName string | всегда | Указывает имя хост-ОС виртуальной машины. Пример: myVM | |||
| linuxConfiguration dictionary | при типе ОС Linux | Указывает настройки операционной системы Linux на виртуальной машине. Пример: {'disablePasswordAuthentication': False, 'provisionVMAgent': True} | |||
| requireGuestProvisionSignale boolean | всегда | Указывает, требует ли хост сигнал подготовки гостевой ОС или нет. Пример: True | |||
| secrets list | всегда | Указывает набор сертификатов, которые должны быть установлены на виртуальной машине. | |||
| provisioningState string | всегда | Состояние подготовки. Пример: Успешно | |||
| storageProfile complex | всегда | Указывает тип хранилища для управляемого диска. | |||
| dataDisks list | всегда | Указывает параметры, используемые для добавления диска данных к виртуальной машине. Пример: [{'caching': 'None', 'createOption': 'Attach', 'diskSizeGB': 1023, 'lun': 2, 'managedDisk': {'id': '/subscriptions/xxxx....xxxx/resourceGroups/V-XISURG/providers/Microsoft.Compute/disks/testdisk2', 'storageAccountType': 'StandardSSD_LRS'}, 'name': 'testdisk2'}, {'caching': 'None', 'createOption': 'Attach', 'diskSizeGB': 1023, 'lun': 1, 'managedDisk': {'id': '/subscriptions/xxxx...xxxx/resourceGroups/V-XISURG/providers/Microsoft.Compute/disks/testdisk3', 'storageAccountType': 'StandardSSD_LRS'}, 'name': 'testdisk3'}] | |||
| imageReference dictionary | всегда | Указывает информацию об используемом образе. Пример: {'offer': 'UbuntuServer', 'publisher': 'Canonical', 'sku': '18.04-LTS', 'version': 'latest'} | |||
| osDisk dictionary | всегда | Указывает информацию об операционном диске, используемом виртуальной машиной. Пример: {'caching': 'ReadWrite', 'createOption': 'FromImage', 'diskSizeGB': 30, 'managedDisk': {'id': '/subscriptions/xxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/disks/myVM_disk1_xxx', 'storageAccountType': 'Premium_LRS'}, 'name': 'myVM_disk1_xxx', 'osType': 'Linux'} | |||
| vmID string | всегда | Указывает уникальный идентификатор ВМ, который представляет собой 128-битный идентификатор, закодированный и хранящийся во всех виртуальных машинах Azure SMBIOS. Его можно прочитать с помощью команд BIOS платформы. Пример: eb86d9bb-6725-4787-a487-2e497d5b340c | |||
| type string | всегда | Тип идентификации, используемой для виртуальной машины. Пример: Microsoft.Compute/virtualMachines | |||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Зим Калиновски (@zikalino)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_resource_info_module.html
