Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_vmsku_info – Получение списка SKUs, связанных с вычислениями

Примечание

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

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

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

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

Новая функция в azure.azcollection 2.4.0

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

Обзор

  • Получение сведений о ресурсах SKUs, связанных с вычислениями.

Требования

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

  • 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"

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

location

string

Регион, поддерживаемый текущей подпиской.

log_mode

string

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

log_path

string

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

password

string

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

profile

string

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

resource_type

string

Типы ресурсов, например, «availabilitySets», «snapshots», «disks» и т.д.

secret

string

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

size

string

Имя размера, допускается частичное имя.

subscription_id

string

Ваш идентификатор подписки Azure.

арендатор

строка

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

отпечаток

строка

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

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

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

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

x509_certificate_path

путь

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

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

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

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

зона

логический

Показывать SKU, поддерживающие зоны доступности.

Варианты:

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

Примечания

Примечание

  • Для аутентификации с 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: Gather Resource Group info
  azure.azcollection.azure_rm_resourcegroup_info:
    name: "{{ resource_group }}"
  register: rg_info

- name: List available VM SKUs
  azure.azcollection.azure_rm_vmsku_info:
    location: "{{ rg_info.resourcegroups.0.location }}"
    resource_type: "virtualMachines"
    size: "standard_B1"
    zone: true
  register: available_skus_result

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

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

Ключ

Описание

available_skus

сложное

Список ресурсов SKU, связанных с вычислениями.

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

capabilities

сложное

Пара имя-значение для описания возможности.

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

name

строка

Инвариант для описания функции.

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

Пример: "ultrassdavailable"

value

строка

Инвариант, если функция измеряется количеством.

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

Пример: "True"

family

строка

Семейство этого SKU.

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

Пример: "standardBSFamily"

location_info

сложное

Список расположений и зон доступности в этих расположениях, где SKU доступен.

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

location

строка

Расположение SKU.

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

Пример: "eastus"

zone_details

сложное

Подробности возможностей, доступных для SKU в определенных зонах.

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

capabilities

сложное

Список возможностей, доступных для SKU в указанном списке зон.

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

name

строка

Инвариант для описания функции.

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

Пример: "ultrassdavailable"

value

строка

Инвариант, если функция измеряется количеством.

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

Пример: "True"

zones

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

Список зон доступности, где поддерживается SKU.

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

Пример: ["1", "2", "3"]

locations

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

Набор расположений, где SKU доступен.

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

Пример: ["eastus"]

name

строка

Имя SKU.

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

Пример: "Standard_B1s"

resource_type

строка

Тип ресурса, к которому относится SKU.

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

Пример: "virtual_machine"

restrictions

сложное

Ограничения, из-за которых SKU нельзя использовать. Пусто, если ограничений нет.

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

reason_code

строка

Причина ограничения.

Возвращается: успех

Пример: "QuotaId"

restriction_info

сложное

Информация об ограничении, из-за которого SKU нельзя использовать.

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

locations

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

Регионы, в которых SKU ограничено.

Возвращается: успех

Пример: ["location"]

zones

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

Список зон доступности, в которых SKU ограничено.

Возвращается: успех

Пример: ["1", "2"]

type

строка

Тип ограничений.

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

Пример: "location"

values

строка

Значение ограничений. Если тип ограничения установлен как местоположение, это будут разные местоположения, в которых SKU ограничено.

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

Пример: "['eastus']"

size

строка

Размер SKU.

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

Пример: "B1s"

tier

строка

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

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

Пример: "Standard"

Авторы

  • Nir Argaman (@nirarg)

Ссылки на коллекцию

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

© 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_vmsku_info_module.html

Spec-Zone.ru

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