Модуль azure.azcollection.azure_rm_vmsku_info — получение списка SKU, связанных с вычислительными ресурсами

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.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

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

Краткое описание

Получение сведений о 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. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
auth_source string добавлено в 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`; в противном случае будет использоваться подписка Azure CLI по умолчанию. Если задано значение `msi`, узел должен быть ресурсом Azure с включенным расширением MSI. Для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать `subscription_id` или переменную окружения `AZURE_SUBSCRIPTION_ID`; в противном случае будет выбрана первая подписка. Параметр `msi` добавлен в Ansible 2.6. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string добавлено в 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 добавлено в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, — имя среды (как определено в Azure Python SDK, например `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (обязателен для Azure Stack). Значение также можно задать в профиле файла учетных данных или с помощью переменной окружения `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
disable_instance_discovery boolean добавлено в 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	Родительский аргумент.
oidc_token string добавлено в azure.azcollection 3.17.0	Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions и Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной окружения `AZURE_FEDERATED_TOKEN`.
oidc_token_file_path path добавлено в azure.azcollection 3.17.0	Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только необработанный токен. Этот способ обычно используется на платформах, которые предоставляют токены OIDC в виде файлов. Также можно задать с помощью переменной окружения `AZURE_FEDERATED_TOKEN_FILE`.
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.
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, используемому для создания субъекта-службы. Закрытый ключ должен быть добавлен в конец сертификата. Используйте этот параметр для аутентификации с помощью субъекта-службы.
zone boolean	Показывать SKU, поддерживающие зоны доступности. Варианты: `false` ← (по умолчанию) `true`

Примечания

Примечание

Для аутентификации в 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 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 complex	Список SKU ресурсов, связанных с вычислениями. Возвращается: всегда
capabilities complex	Пара «имя — значение», описывающая возможность. Возвращается: всегда
name string	Неизменяемое значение, описывающее функцию. Возвращается: всегда Пример: `"ultrassdavailable"`
value string	Неизменяемое значение, если функция измеряется количественно. Возвращается: всегда Пример: `"True"`
family string	Семейство данного SKU. Возвращается: всегда Пример: `"standardBSFamily"`
location_info complex	Список регионов и зон доступности в этих регионах, где доступен SKU. Возвращается: всегда
location string	Регион, в котором доступен SKU. Возвращается: всегда Пример: `"eastus"`
zone_details complex	Сведения о возможностях, доступных для SKU в определённых зонах. Возвращается: всегда
capabilities complex	Список возможностей, доступных для SKU в указанном списке зон. Возвращается: всегда
name string	Неизменяемое значение, описывающее функцию. Возвращается: всегда Пример: `"ultrassdavailable"`
value string	Неизменяемое значение, если функция измеряется количественно. Возвращается: всегда Пример: `"True"`
zones list / elements=string	Список зон доступности, в которых поддерживается SKU. Возвращается: всегда Пример: `["1", "2", "3"]`
locations list / elements=string	Набор регионов, в которых доступен SKU. Возвращается: всегда Пример: `["eastus"]`
name string	Имя SKU. Возвращается: всегда Пример: `"Standard_B1s"`
resource_type string	Тип ресурса, к которому применяется SKU. Возвращается: всегда Пример: `"virtual_machine"`
restrictions complex	Ограничения, из-за которых нельзя использовать SKU. Если ограничений нет, список пуст. Возвращается: всегда
reason_code string	Причина ограничения. Возвращается: при успехе Пример: `"QuotaId"`
restriction_info complex	Сведения об ограничении, из-за которого нельзя использовать SKU. Возвращается: всегда
locations list / elements=string	Регионы, в которых использование SKU ограничено. Возвращается: при успехе Пример: `["location"]`
zones list / elements=string	Список зон доступности, в которых использование SKU ограничено. Возвращается: при успехе Пример: `["1", "2"]`
restriction_values list / elements=string	Значения ограничений. Если для типа ограничения указано расположение, здесь перечисляются регионы, в которых использование SKU ограничено. Возвращается: всегда Пример: `["eastus"]`
type string	Тип ограничений. Возвращается: всегда Пример: `"location"`
values list / elements=string	Значения ограничений. Если для типа ограничения указано расположение, здесь перечисляются регионы, в которых использование SKU ограничено. Это возвращаемое значение устарело и будет удалено в одном из выпусков после 2027-05-01. Вместо него используйте `restriction_values`. Возвращается: всегда Пример: `["eastus"]`
size string	Размер SKU. Возвращается: всегда Пример: `"B1s"`
tier string	Указывает уровень виртуальных машин в масштабируемом наборе. Возвращается: всегда Пример: `"Standard"`

Авторы

Nir Argaman (@nirarg)

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

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