Spec-Zone.ru › Ansible 2.11

community.azure.azure_rm_resource_info – Общие сведения об Azure-ресурсах

Примечание

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

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

Для использования в книге задач укажите: community.azure.azure_rm_resource_info.

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

Обзор

  • Получение сведений о любом ресурсе с помощью Azure REST API.
  • Этот модуль предоставляет доступ к ресурсам, которые не поддерживаются модулями Ansible.
  • Подробную информацию о REST API конкретного ресурса см. на странице https://docs.microsoft.com/en-us/rest/api/.

Требования

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

  • 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.
api_version
строка
Конкретная версия API для использования.
auth_source
строка
добавлен в 0.0.1 azure.azcollection
    Варианты:
  • auto ←
  • 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.
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
  community.azure.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
  community.azure.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 / elements=string
всегда
Описывает ссылку на сетевой интерфейс.

Пример:
[{'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 / elements=string
всегда
Указывает набор сертификатов, которые должны быть установлены на виртуальной машине.
provisioningState
string
всегда
Состояние подготовки.

Пример:
Завершено
storageProfile
complex
всегда
Указывает тип хранилища для управляемого диска.
dataDisks
list / elements=string
всегда
Указывает параметры, используемые для добавления диска данных к виртуальной машине.

Пример:
[{'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


Авторы

  • Зим Калиновский (@zikalino)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/azure/azure_rm_resource_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API