Модуль azure.azcollection.azure_rm_recoveryservicesvault — создание и удаление хранилища Azure Recovery Services
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в сценарии, укажите: azure.azcollection.azure_rm_recoveryservicesvault.
Добавлено в azure.azcollection 1.1.0
Краткое описание
- Создание или удаление хранилища Azure Recovery Services.
Требования
Следующие требования должны быть выполнены на узле, на котором запускается этот модуль.
- 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. Значение по умолчанию По умолчанию: |
append_tags boolean | Управляет тем, является ли поле tags каноническим или только дополняет существующие теги. В каноническом режиме все теги, отсутствующие в параметре tags, удаляются из метаданных объекта. Варианты:
|
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** проверка центра авторизации отключается. Поэтому необходимо убедиться, что настроенный узел центра авторизации является допустимым и заслуживающим доверия. Задается через профиль файла учетных данных или переменную окружения Варианты:
|
identity dictionary | Удостоверение объекта |
|
type string |
Тип управляемого удостоверения Варианты:
|
|
user_assigned_identities dictionary |
Назначенные пользователем управляемые удостоверения и их параметры По умолчанию: |
|
append boolean |
Нужно ли добавить список удостоверений к текущим удостоверениям (true) или заменить текущие удостоверения (false) Варианты:
|
|
id list / elements=string |
Список идентификаторов назначенных пользователем удостоверений, связанных с объектом По умолчанию: |
location string / обязательный | Расположение ресурса Azure. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / обязательный | Имя хранилища Azure Recovery Services. |
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. |
resource_group string / обязательный | Имя группы ресурсов. |
secret string | Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
state string | Задает требуемое состояние элемента защиты. Используйте Используйте Варианты:
|
subscription_id string | Идентификатор вашей подписки Azure. |
tags dictionary | Словарь пар строка:строка, назначаемых объекту в качестве метаданных. Теги метаданных объекта обновляются с использованием переданных значений. Чтобы удалить теги, задайте для параметра append_tags значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают пробелы в тегах. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов. |
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: Create/Update Azure Recovery Service vault
azure_rm_recoveryservicesvault:
resource_group: 'myResourceGroup'
name: 'testVault'
location: 'westeurope'
state: 'present'
- name: Delete Recovery Service Vault
azure_rm_recoveryservicesvault:
resource_group: 'myResourceGroup'
name: 'testVault'
location: 'westeurope'
state: 'absent'
Возвращаемые значения
Общие возвращаемые значения описаны здесь, далее перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
response complex | Сведения о текущем состоянии хранилища служб восстановления. Возвращается: всегда |
|
etag string |
Уникальная строка только для чтения, которая изменяется при создании ресурса. Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса. Возвращается: всегда Пример: |
|
location string |
Расположение ресурса. Возвращается: всегда Пример: |
|
name string |
Имя хранилища служб восстановления. Возвращается: всегда Пример: |
|
properties dictionary |
Свойства хранилища служб восстановления. Возвращается: всегда Пример: |
|
sku string |
Тип SKU хранилища служб восстановления. Возвращается: всегда Пример: |
|
tags dictionary |
Теги ресурса. Возвращается: при использовании Пример: |
|
type string |
Тип хранилища служб восстановления. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_recoveryservicesvault_module.html