Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_sqlmidbshorttermretentionpolicy — Управление политикой кратковременного хранения резервных копий базы данных SQL управляемого экземпляра

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля потребуются дополнительные требования. Подробности см. в разделе Требования.

Для использования в playbook укажите: azure.azcollection.azure_rm_sqlmidbshorttermretentionpolicy.

Добавлена в azure.azcollection 2.4.0

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

Обзор

  • Управление политикой кратковременного хранения резервных копий базы данных SQL управляемого экземпляра.

Требования

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

  • 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

added in azure.azcollection 0.0.1

URL-адрес центра проверки подлинности Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и имеет собственный центр проверки подлинности ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

auth_source

string

added in 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"

cert_validation_mode

string

added in 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

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Может быть также установлен через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

database_name

string / required

Имя базы данных управляемого экземпляра SQL.

disable_instance_discovery

boolean

added in 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

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

managed_instance_name

string / required

Имя управляемого экземпляра SQL.

password

string

Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не субъекта безопасности.

policy_name

string / required

Имя политики краткосрочного хранения управляемого экземпляра SQL.

Варианты:

  • "default"

profile

string

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

resource_group

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

Имя группы ресурсов, содержащей ресурс.

retention_days

целое число

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

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

secret

строка

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

subscription_id

строка

Ваш идентификатор подписки Azure.

tenant

строка

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

thumbprint

строка

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

Отпечаток цифрового сертификата для закрытого ключа, указанного в x509_certificate_path.

Используется при аутентификации с помощью Служебного принципала.

Необходимо, если определён x509_certificate_path.

x509_certificate_path

путь

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

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

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

Используется при аутентификации с помощью Служебного принципала.

Примечания

Примечание

  • Для аутентификации с 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: Update SQL managed instance short term retention policy's retention_days
  azure_rm_sqlmidbshorttermretentionpolicy:
    resource_group: testrg
    managed_instance_name: testinstancename
    database_name: newdatabase
    policy_name: default
    retention_days: 3

Значения возврата

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

Ключ

Описание

short_term_retention_policy

сложное

Словарь, содержащий данные о политиках краткосрочного хранения резервных копий для управляемых экземпляров SQL.

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

database_name

строка

Имя базы данных управляемого экземпляра SQL.

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

Пример: "newdatabase"

id

строка

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

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Sql/ managedInstances/fredsqlmi/databases/newdatabase/backupShortTermRetentionPolicies/default"

managed_instance_name

строка

Имя управляемого экземпляра SQL.

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

Пример: "testmanagedinstance"

policy_name

строка

Имя политики краткосрочного хранения резервных копий управляемого экземпляра SQL.

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

Пример: "default"

resource_group

строка

Группа ресурсов, к которой относится данный ресурс.

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

Пример: "testRG"

retention_days

целое число

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

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

Пример: 7

type

строка

Тип управляемого экземпляра SQL.

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

Пример: "Microsoft.Sql/managedInstances"

Авторы

  • xuzhang3 (@xuzhang3)
  • Fred-sun (@Fred-sun)

Ссылки на коллекцию

  • Система отслеживания проблем
  • Главная страница
  • Репозиторий (источники)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API