Модуль azure.azcollection.azure_rm_backuppolicy — управление политикой резервного копирования Azure

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; в противном случае будет использоваться подписка az cli по умолчанию.

Если задано значение msi, хост должен быть ресурсом Azure с включенным расширением MSI. Для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную окружения AZURE_SUBSCRIPTION_ID; в противном случае будет выбрана первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

• "auto" ← (по умолчанию)
• "cli"
• "credential_file"
• "env"
• "msi"

backup_management_type

string

Определяет тип ресурса, к которому будет применяться политика.

Варианты:

• "AzureIaasVM"

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"

daily_retention_count

integer

Количество дней хранения резервных копий.

Не применяется для еженедельной частоты.

disable_instance_discovery

boolean

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

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если задать значение true, обнаружение экземпляров и проверка центра будут полностью отключены. Эта возможность предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например в частных облаках или Azure Stack. При обнаружении экземпляров метаданные центра извлекаются с https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра отключается. Поэтому крайне важно убедиться, что настроенный узел центра является допустимым и заслуживающим доверия.

Задается в профиле файла учетных данных или с помощью переменной окружения AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

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

instant_recovery_snapshot_retention

integer

Количество дней хранения моментальных снимков для мгновенного восстановления.

log_mode

string

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

log_path

string

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

name

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, а не субъекта-службы.

policy_type

string

Определяет тип политики резервного копирования

Варианты:

• "V1" ← (по умолчанию)
• "V2"

profile

string

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

resource_group

string / обязательный

Имя группы ресурсов, в которой находится хранилище.

schedule_days

list / элементы=string

Список дней выполнения расписания.

Не применяется для ежедневной частоты.

schedule_run_frequency

string

Частота выполнения политики.

Варианты:

• "Daily"
• "Weekly"

schedule_run_time

integer

Час выполнения резервного копирования.

Допустимые значения — часы в 24-часовом формате (0–23).

schedule_weekly_frequency

integer

Количество недель между резервными копиями.

Резервное копирование выполняется раз в schedule_weekly_frequency неделю (недель).

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

Не применяется для ежедневной частоты.

secret

string

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

state

string

Задает требуемое состояние политики резервного копирования.

Используйте present для создания или обновления политики резервного копирования и absent для её удаления.

Варианты:

• "absent"
• "present" ← (по умолчанию)

subscription_id

string

Идентификатор вашей подписки Azure.

tenant

string

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

thumbprint

string

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

Отпечаток закрытого ключа, указанного в x509_certificate_path.

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

Обязателен, если задан x509_certificate_path.

time_zone

string

Часовой пояс для параметра schedule_run_time.

По умолчанию: "UTC"

vault_name

string / обязательный

Имя хранилища Recovery Services, которому принадлежит политика.

weekly_retention_count

integer

Количество недель хранения резервных копий.

x509_certificate_path

path

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

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

Закрытый ключ должен быть добавлен в конец сертификата.

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

id

string

Идентификатор указанной политики резервного копирования.

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.RecoveryServices/vaults/Vault_Name/backupPolicies/Policy_Name"

location

string

Расположение политики резервного копирования.

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

Пример: "eastus"

name

string

Имя политики резервного копирования.

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

Пример: "DefaultPolicy"

properties

dictionary

Атрибуты политики резервного копирования.

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

Пример: {"backup_management_type": "AzureIaasVM", "instant_rp_details": {}, "instant_rp_retention_range_in_days": 5, "protected_items_count": 0, "retention_policy": {"retention_policy_type": "LongTermRetentionPolicy", "weekly_schedule": {"days_of_the_week": ["Monday", "Wednesday", "Thursday"], "retention_duration": {"count": 4, "duration_type": "Weeks"}, "retention_times": ["2025-04-09T10:00:00.000Z"]}}, "schedule_policy": {"schedule_policy_type": "SimpleSchedulePolicy", "schedule_run_days": ["Monday", "Wednesday", "Thursday"], "schedule_run_frequency": "Weekly", "schedule_run_times": ["2025-04-09T10:00:00.000Z"], "schedule_weekly_frequency": 0}, "time_zone": "Pacific Standard Time"}

type

string

Тип политики резервного копирования.

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

Пример: "Microsoft.RecoveryServices/vaults/backupPolicies"