azure.azcollection.azure_rm_recoveryservicesvault_info – Получение подробностей хранилища Azure Recovery Services

Примечание

Этот плагин входит в состав коллекции azure.azcollection (версия 1.3.1).

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

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

Новое в версии 1.1.0: из azure.azcollection

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

Описание

Получение подробностей хранилища Azure Recovery Services.

Требования

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

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.
append_tags булево	Варианты: нет да ←	Управляет, будет ли поле тегов каноничным или просто добавляться к существующим тегам. При каноничном формате любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 0.0.1 от azure.azcollection	Варианты: авто ← 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` могут использоваться для определения идентификатора подписки, если их несколько; иначе используется стандартная подписка az 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 строка / обязательно		Имя хранилища Azure Recovery Service.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо сервисного принципала.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / обязательно		Имя группы ресурсов.
secret строка		Секрет клиента Azure. Используйте при аутентификации с помощью сервисного принципала.
subscription_id строка		Ваш идентификатор подписки Azure.
tags словарь		Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные тегов объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
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 Azure Recovery Services Vault Details.
  azure_rm_recoveryservicesvault_info:
    resource_group: 'myResourceGroup'
    name: 'testVault'

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

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

Ключ		Возвращаемое значение	Описание
response сложное		всегда	Ответ о текущем состоянии хранилища Recovery Services.
	etag строка	всегда	Уникальная неизменяемая строка, которая меняется при каждом создании ресурса. Пример: datetime'2020-09-16T02%3A44%3A27.834293Z'
	id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxx/resourceGroups/resourcegroup_name/ providers/Microsoft.RecoveryServices/vaults/rev_name
	location строка	всегда	Расположение ресурса. Пример: eastus
	name строка	всегда	Имя хранилища Recovery Services. Пример: revault_name
	properties словарь	всегда	Свойства хранилища Recovery Services. Пример: {'privateEndpointStateForBackup': 'None', 'privateEndpointStateForSiteRecovery': 'None', 'provisioningState': 'Succeeded'}
	sku строка	всегда	Тип SKU хранилища Recovery Services. Пример: Standard
	type строка	всегда	Тип хранилища Recovery Services. Пример: Microsoft.RecoveryServices/vaults

Авторы

Suyeb Ansari (@suyeb786)

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