Модуль azure.azcollection.azure_rm_vmbackuppolicy — создание или удаление политики резервного копирования виртуальных машин 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"

append_tags

boolean

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

При использовании канонического режима из метаданных объекта будут удалены все теги, отсутствующие в параметре tags.

Варианты:

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

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 на хост-компьютере должен быть включен модуль MSI ресурса Azure. Если ресурсу предоставлен доступ к нескольким подпискам, для указания идентификатора подписки можно использовать 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"

count

integer

Количество единиц периода. Срок хранения определяется умножением единицы периода на значение Count.

По умолчанию: 1

disable_instance_discovery

boolean

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

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

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

Варианты:

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

log_mode

string

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

log_path

string

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

months

list / elements=string

Список месяцев года для годовой политики хранения.

По умолчанию: ["January"]

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

profile

string

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

resource_group

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

Имя группы ресурсов.

secret

string

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

state

string

Задает требуемое состояние элемента защиты.

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

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

Варианты:

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

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.

time

string

Время хранения согласно политике хранения в формате UTC.

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

vault_name

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

Имя хранилища служб восстановления.

weekdays

list / elements=string

Список дней недели.

По умолчанию: ["Monday"]

weeks

list / elements=string

Список недель месяца.

По умолчанию: ["First"]

x509_certificate_path

path

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

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

Сертификат должен быть добавлен к закрытому ключу.

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

response

complex

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

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

id

string

Идентификатор ресурса.

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

Пример: "/subscriptions/xxxxxxx/resourceGroups/resourcegroup_name/             providers/Microsoft.RecoveryServices/vaults/myVault/backupPolicies/myBackup"

name

string

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

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

Пример: "myBackup"

properties

dictionary

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

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

Пример: {"backupManagementType": "AzureIaasVM", "protectedItemsCount": 0, "retentionPolicy": {"monthlySchedule": {"retentionDuration": {"count": 2, "durationType": "Months"}, "retentionScheduleFormatType": "Weekly", "retentionScheduleWeekly": {"daysOfTheWeek": ["Wednesday", "Thursday"], "weeksOfTheMonth": ["First", "Third"]}, "retentionTimes": ["2018-01-24T10:00:00Z"]}, "retentionPolicyType": "LongTermRetentionPolicy", "weeklySchedule": {"daysOfTheWeek": ["Monday", "Wednesday", "Thursday"], "retentionDuration": {"count": 1, "durationType": "Weeks"}, "retentionTimes": ["2018-01-24T10:00:00Z"]}, "yearlySchedule": {"monthsOfYear": ["February", "November"], "retentionDuration": {"count": 4, "durationType": "Years"}, "retentionScheduleFormatType": "Weekly", "retentionScheduleWeekly": {"daysOfTheWeek": ["Monday", "Thursday"], "weeksOfTheMonth": ["Fourth"]}, "retentionTimes": ["2018-01-24T10:00:00Z"]}}, "schedulePolicy": {"schedulePolicyType": "SimpleSchedulePolicy", "scheduleRunDays": ["Monday", "Wednesday", "Thursday"], "scheduleRunFrequency": "Weekly", "scheduleRunTimes": ["2018-01-24T10:00:00Z"], "scheduleWeeklyFrequency": 0}, "timeZone": "Pacific Standard Time"}

type

string

Тип ресурса.

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

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