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

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 каноническим или дополняет существующие теги.

Если поле каноническое, все теги, отсутствующие в параметре 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; в противном случае используется подписка az 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"

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

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

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. Используйте при аутентификации с помощью субъекта-службы.

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.

vault_name

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

Имя хранилища Recovery Services.

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"