Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_resource_info – Общие сведения о ресурсах Azure

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля потребуются дополнительные требования, см. Требования для получения подробностей.

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

Новая в azure.azcollection 0.1.2

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

Описание

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

Требования

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

  • 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

added in azure.azcollection 0.0.1

URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

api_version

string

Конкретная версия API, которая будет использоваться.

auth_source

string

added in azure.azcollection 0.0.1

Управляет источником учетных данных, используемых для аутентификации.

Также может быть установлен через переменную среды 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.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi).

Также может быть установлен через переменную среды AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате важно убедиться, что настроенный узел полномочий действителен и заслуживает доверия.

Устанавливается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • true

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

method

string

HTTP-метод запроса или ответа. Должен быть в верхнем регистре.

Варианты:

  • "GET" ← (по умолчанию)
  • "PUT"
  • "POST"
  • "HEAD"
  • "PATCH"
  • "DELETE"
  • "MERGE"

password

string

Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

provider

string

Тип провайдера, должен быть указан, если URL-адрес не указан.

resource_group

string

Группа ресурсов, которая будет использоваться.

Требуется, если URL не указан.

resource_name

string

Имя ресурса.

resource_type

string

Тип ресурса.

secret

string

Секретный ключ клиента Azure. Используйте при аутентификации с помощью Служебного принципа.

subresource

list / elements=dictionary

Список подресурсов.

По умолчанию: []

name

string

Имя подресурса.

namespace

string

Пространство имен подресурса.

type

string

Тип подресурса.

subscription_id

string

Идентификатор вашей подписки Azure.

tags

dictionary

Словарь тегов для фильтрации.

Каждая пара ключ-значение в словаре указывает имя тега и его значение для фильтрации различных ресурсов.

По умолчанию: {}

tenant

string

Идентификатор Azure-аренды. Используйте при аутентификации с помощью Служебного принципа.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток цифрового сертификата для открытого ключа, указанного в x509_certificate_path.

Используйте при аутентификации с помощью Служебного принципа.

Требуется, если определён x509_certificate_path.

url

string

URL Azure RM ресурса.

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к X509 сертификату, используемому для создания служебного принципа в формате PEM.

Сертификат должен быть присоединён к закрытому ключу.

Используйте при аутентификации с помощью Служебного принципа.

Примечания

Примечание

  • Для аутентификации с Azure можно передать параметры, установить переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед выполнением задач или playbook с 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

- name: Get all snapshots of all resource groups of a subscription but filtering with two tags.
  azure_rm_resource_info:
    provider: compute
    resource_type: snapshots
    tags:
      enviroment: dev
      department: hr

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ

Описание

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

строка

Состояние подготовки.

Возвращается: всегда

Пример: "Succeeded"

storageProfile

сложный тип

Указывает тип хранилища для управляемого диска.

Возвращается: всегда

dataDisks

список / элементы=строка

Указывает параметры для добавления диска данных к виртуальной машине.

Возвращается: всегда

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

словарь

Указывает информацию об используемом образе.

Возвращается: всегда

Пример: {"offer": "UbuntuServer", "publisher": "Canonical", "sku": "20_04-lts", "version": "latest"}

osDisk

словарь

Указывает информацию о системном диске виртуальной машины.

Возвращается: всегда

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

строка

Уникальный идентификатор ВМ (128 бит), закодированный и хранящийся во всех ВМ Azure лаaS в SMBIOS.

Его можно прочитать с помощью команд BIOS платформы.

Возвращается: всегда

Пример: "eb86d9bb-6725-4787-a487-2e497d5b340c"

type

строка

Тип идентификатора, используемого для виртуальной машины.

Возвращается: всегда

Пример: "Microsoft.Compute/virtualMachines"

Авторы

  • Zim Kalinowski (@zikalino)

Ссылки на сборку

  • Система отслеживания проблем
  • Главная страница
  • Репозиторий (источники)

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

Spec-Zone.ru

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