Модуль azure.azcollection.azure_rm_imagesku_info — получение списка SKU образов, связанных с вычислительными ресурсами
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для работы с этим модулем требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_imagesku_info.
Добавлено в azure.azcollection 2.4.0
Краткое описание
- Получение сведений о SKU образов ресурсов, связанных с вычислительными ресурсами.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- 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**, проверка центра авторизации будет отключена. Поэтому необходимо убедиться, что настроенный узел центра авторизации действителен и заслуживает доверия. Задается в профиле файла учетных данных или с помощью переменной среды Возможные значения:
|
location string | Регион, поддерживаемый текущей подпиской. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
offer string | `Offer` — это конкретная линейка продуктов операционной системы или программного обеспечения. Предложение обычно включает несколько версий или конфигураций продукта. |
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. |
publisher string | `Publisher` — это организация, предоставляющая образ ОС. Например, это может быть Microsoft, Canonical (для Ubuntu), Red Hat и т. д. Это обязательное поле, определяющее поставщика образа. |
secret string | Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
subscription_id string | Идентификатор вашей подписки Azure. |
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, используемому для создания субъекта-службы. Сертификат должен быть добавлен к закрытому ключу. Используйте при аутентификации с помощью субъекта-службы. |
Примечания
Примечание
- Для аутентификации в 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: Gather Resource Group info
azure.azcollection.azure_rm_resourcegroup_info:
name: "{{ resource_group }}"
register: rg_info
- name: List available Image SKUs for 0001-com-ubuntu-server-focal
azure.azcollection.azure_rm_imagesku_info:
location: westus
offer: 0001-com-ubuntu-server-focal
publisher: Canonical
register: available_image_skus_results
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
available_skus complex | Список SKU образов Azure для подготовки виртуальных машин. Возвращается: всегда |
|
automatic_os_upgrade_supported boolean |
Поддерживает ли этот SKU автоматическое обновление ОС. Возвращается: всегда Пример: |
|
id string |
Полный идентификатор ресурса SKU в Azure. Возвращается: всегда Пример: |
|
location string |
Регион Azure, в котором доступен SKU. Возвращается: всегда Пример: |
|
name string |
Имя или версия конкретного SKU. Возвращается: всегда Пример: |
|
restrictions complex |
Ограничения на использование этого SKU образа, например ограничения по регионам или несовместимость функций. Возвращается: всегда |
|
reason_code string |
Причина ограничения, например лимиты квоты или особые требования к оборудованию. Возвращается: при успешном выполнении Пример: |
|
restriction_info complex |
Дополнительные сведения об ограничениях, например о неподдерживаемых регионах или функциях. Возвращается: всегда |
|
locations list / элементы=string |
Расположения, в которых этот SKU ограничен или недоступен. Возвращается: при успешном выполнении Пример: |
|
zones list / элементы=string |
Зоны доступности в регионе, в которых этот SKU ограничен. Возвращается: при успешном выполнении Пример: |
|
restriction_values list / элементы=string |
Список расположений, регионов или зон, в которых использование SKU образа запрещено. Возвращается: всегда Пример: |
|
type string |
Тип ограничения, который может включать ограничения по расположению или проблемы совместимости оборудования. Возвращается: всегда Пример: |
|
values list / элементы=string |
Список расположений, регионов или зон, в которых использование SKU образа запрещено. Это возвращаемое значение устарело и будет удалено в одном из выпусков после 2027-05-01. Вместо него используйте Возвращается: всегда Пример: |
Авторы
- Hen Yaish (@hyaish)
Ссылки на коллекцию
© 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_imagesku_info_module.html