azure.azcollection.azure_rm_availabilityset_info – Получение фактов о наборе доступности Azure

Примечание

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

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

Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_availabilityset_info.

Добавлена в версии 0.1.2: коллекции azure.azcollection

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

Описание

Получение фактов о конкретном наборе доступности или всех наборах доступности.

Требования

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

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.
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` могут быть использованы для определения идентификатора подписки, если их несколько, в противном случае используется стандартная подписка Azure 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`.
name строка		Ограничить результаты конкретным набором доступности.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не с помощью служебного принципала.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка		Группа ресурсов, в которой нужно найти необходимый набор доступности.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала.
subscription_id строка		Ваш идентификатор подписки Azure.
tags строка		Список тегов для сопоставления.
tenant строка		Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала.

Примечания

Примечание

Для аутентификации в 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 facts for one availability set
  azure_rm_availabilityset_info:
    name: Testing
    resource_group: myResourceGroup

- name: Get facts for all availability sets in a specific resource group
  azure_rm_availabilityset_info:
    resource_group: myResourceGroup

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

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

Ключ			Возвращаемое значение	Описание
azure_availabilityset сложный			всегда	Список словарей наборов доступности.
	location строка		успех	Расположение, где находится ресурс. Пример: eastus2
	name строка		успех	Имя ресурса. Пример: myAvailabilitySet
	properties словарь		успех	Свойства ресурса.
		platformFaultDomainCount целое число	успех	Количество зон отказоустойчивости. Пример: 3
		platformUpdateDomainCount целое число	успех	Количество зон обновления. Пример: 2
		virtualMachines список / элементы=строка	успех	Список ссылок на все виртуальные машины в наборе доступности.
	sku строка		успех	Расположение, где находится ресурс. Пример: Aligned
	tags словарь		успех	Теги ресурса. Пример: {'env': 'sandbox'}
	type строка		успех	Тип ресурса. Пример: Microsoft.Compute/availabilitySets

Авторы

Julien Stroheker (@julienstroheker)

© 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/azure/azcollection/azure_rm_availabilityset_info_module.html