Модуль azure.azcollection.azure_rm_sqlmanagedinstance — Управление управляемыми экземплярами SQL
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для её установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_sqlmanagedinstance.
Добавлена в azure.azcollection 1.14.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. |
administrator_login string | Имя пользователя администратора для управляемого экземпляра. Может быть указано только при создании управляемого экземпляра (и требуется для создания). |
administrator_login_password string | Пароль для входа администратора (требуется для создания управляемого экземпляра). |
administrators string | Администратор Azure Active Directory сервера. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
append_tags boolean | Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. Если канонический, любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices:
|
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Может быть также установлен через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Choices:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав Choices:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi). Может быть также установлен через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
collation string | Сортировка управляемого экземпляра. |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив его в **True**, проверка узла отключается. В результате крайне важно убедиться, что настроенный узел является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Choices:
|
dns_zone string | DNS-зона, в которой находится управляемый экземпляр. |
dns_zone_partner string | Идентификатор ресурса другого управляемого экземпляра, DNS-зону которого будет совместно использовать этот управляемый экземпляр после создания. |
identity dictionary | Настройка идентификации Azure Active Directory для ресурса. |
|
principal_id string |
Идентификатор принципала Azure Active Directory. |
|
tenant_id string |
Идентификатор арендатора Azure Active Directory. |
|
type string |
Тип идентификации. Установите значение в |
|
user_assigned_identities string |
Идентификаторы ресурсов пользовательских идентификаторов, которые необходимо использовать. |
instance_pool_id string | Идентификатор пула экземпляров, к которому принадлежит этот управляемый сервер. |
key_id string | URI CMK используемого ключа для шифрования. |
license_type string | Тип лицензии. Возможные значения: Скидочная цена AHB за использование собственных лицензий SQL. Регулярная цена, включающая новую лицензию SQL. Варианты:
|
location string | Расположение управляемого экземпляра SQL. |
log_mode string | Аргумент родительского элемента. |
log_path string | Аргумент родительского элемента. |
maintenance_configuration_id string | Указывает идентификатор конфигурации технического обслуживания, который необходимо применить к этому управляемому экземпляру. |
managed_instance_create_mode string | Указывает режим создания базы данных. |
minimal_tls_version string | Минимальная версия TLS. Разрешённые значения Варианты:
|
name string / обязательно | Имя управляемого экземпляра SQL. |
password string | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо принципала службы. |
primary_user_assigned_identity_id string | Идентификатор ресурса пользовательского идентификатора, который будет использоваться по умолчанию. |
private_endpoint_connections list / элементы=строка | Список подключений к частному конечному пункту управляемого экземпляра. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
proxy_override string | Тип подключения, используемый для подключения к экземпляру. Варианты:
|
public_data_endpoint_enabled boolean | Включен ли общедоступный конечный пункт данных. Варианты:
|
resource_group string / обязательно | Имя группы ресурсов. |
restore_point_in_time string | Указывает момент времени (формат ISO8601) исходной базы данных, которая будет восстановлена для создания новой базы данных. |
secret string | Секретный ключ Azure. Используется при аутентификации с помощью принципала службы. |
sku dictionary | ARM ресурс SKU. |
|
capacity string |
Емкость управляемого экземпляра в количестве виртуальных ядер (vcores). |
|
family string |
Если у сервиса есть разные поколения оборудования для одного и того же SKU, это можно указать здесь. |
|
name string |
Имя SKU, как правило, код из букв и цифр. |
|
size string |
Размер конкретного SKU. |
|
tier string |
Уровень или издание конкретного SKU. |
source_managed_instance_id string | Идентификатор ресурса исходного управляемого экземпляра, связанного с операцией создания этого экземпляра. |
state string | Состояние управляемого экземпляра SQL. Используйте Варианты:
|
storage_account_type string | Тип хранилища, используемого для хранения резервных копий этого экземпляра. |
storage_size_in_gb integer | Размер хранилища в ГБ. Минимальное значение — Допускаются только приращения по 32 ГБ. |
subnet_id 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 | Отпечаток цифрового сертификата (thumbprint) приватного ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью принципала службы. Требуется, если определен x509_certificate_path. |
timezone_id string | Идентификатор часового пояса. Допустимые значения — часовые пояса, поддерживаемые Windows. Информация о поддерживаемых часовых поясах хранится в Windows. |
v_cores integer | Количество виртуальных ядер. Варианты:
|
x509_certificate_path path добавлен в azure.azcollection 1.14.0 | Путь к X509 сертификату, используемому для создания принципала службы в формате PEM. Сертификат должен быть приложен к приватному ключу. Используется при аутентификации с помощью принципала службы. |
zone_redundant boolean | Включена ли многозонная доступность (multi-az). Варианты:
|
Примечания
Примечание
- Для аутентификации в 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: Create sql managed instance
azure_rm_sqlmanagedinstance:
resource_group: "{{ resource_group }}"
name: testmanagedinstance
subnet_id: subnet_id
sku:
name: GP_Gen5
tier: GeneralPurpose
family: Gen5
capacity: 5
identity:
type: SystemAssigned
administrator_login: azureuser
administrator_login_password: Ft@password0329test
storage_size_in_gb: 256
v_cores: 8
- name: Delete sql managed instance
azure_rm_sqlmanagedinstance:
resource_group: "{{ resource_group }}"
name: testmanagedinstance
state: absent
Значения возврата
Общие значения возврата документированы здесь, ниже приведены поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
sql_managed_instance complex | Список словарей, содержащих факты для управляемого экземпляра SQL. Возвращается: всегда |
|
administrator_login string |
Имя пользователя администратора для управляемого экземпляра. Возвращается: всегда Пример: |
|
administrators string |
Администратор Azure Active Directory сервера. Возвращается: всегда |
|
collation string |
Сортировка управляемого экземпляра SQL. Возвращается: всегда Пример: |
|
dns_zone string |
-DNS-зона, в которой находится управляемый экземпляр. Возвращается: всегда Пример: |
|
dns_zone_partner string |
Идентификатор ресурса другого управляемого экземпляра, DNS-зону которого будет совместно использовать этот управляемый экземпляр после создания. Возвращается: всегда |
|
fully_qualified_domain_name string |
Полностью определённое доменное имя управляемого экземпляра. Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса. Возвращается: всегда Пример: |
|
identity complex |
Конфигурация удостоверения Azure Active Directory для ресурса. Возвращается: всегда |
|
principal_id string |
Идентификатор субъекта Azure Active Directory. Возвращается: всегда Пример: |
|
tenant_id string |
Идентификатор клиента Azure Active Directory. Возвращается: всегда Пример: |
|
type string |
Тип удостоверения. Возвращается: всегда Пример: |
|
user_assigned_identities string |
Идентификаторы ресурсов назначенных пользователю удостоверений для использования. Возвращается: всегда |
|
instance_pool_id string |
Идентификатор пула экземпляров, к которому принадлежит этот управляемый сервер. Возвращается: всегда |
|
key_id string |
URI ключа CMK для использования при шифровании. Возвращается: всегда |
|
license_type string |
Тип лицензии. Возвращается: всегда Пример: |
|
location string |
Расположение ресурса. Возвращается: всегда Пример: |
|
maintenance_configuration_id string |
Указывает идентификатор конфигурации обслуживания для применения к этому управляемому экземпляру. Возвращается: всегда Пример: |
|
managed_instance_create_mode string |
Задает режим создания базы данных. Возвращается: всегда |
|
minimal_tls_version string |
Минимальная версия TLS. Допустимые значения «None», «1.0», «1.1», «1.2». Возвращается: всегда Пример: |
|
name string |
Имя управляемого экземпляра SQL. Возвращается: всегда Пример: |
|
primary_user_assigned_identity_id string |
Идентификатор ресурса назначенной пользователем идентичности, которая будет использоваться по умолчанию. Возвращается: всегда |
|
private_endpoint_connections list / elements=string |
Список подключений частной конечной точки к управляемому экземпляру. Возвращается: всегда Пример: |
|
provisioning_state string |
Состояние управляемого экземпляра SQL. Возвращается: всегда Пример: |
|
proxy_override string |
Тип соединения, используемый для подключения к экземпляру. Возвращается: всегда Пример: |
|
public_data_endpoint_enabled boolean |
Включена ли общедоступная конечная точка данных. Возвращается: всегда Пример: |
|
restore_point_in_time string |
Указывает момент времени (формат ISO8601) исходной базы данных, которая будет восстановлена для создания новой базы данных. Возвращается: всегда |
|
sku complex |
ARM Resource SKU. Возвращается: всегда |
|
capacity integer |
Пропускная способность SKU. Возвращается: всегда Пример: |
|
family string |
Если у службы есть разные поколения оборудования для одного и того же SKU, это можно указать здесь. Возвращается: всегда Пример: |
|
name string |
Название SKU. Возвращается: всегда Пример: |
|
size string |
Размер конкретного SKU. Возвращается: всегда |
|
tier string |
Уровень SKU. Возвращается: всегда Пример: |
|
source_managed_instance_id string |
Идентификатор ресурса исходного управляемого экземпляра, связанного с операцией создания этого экземпляра. Возвращается: всегда |
|
state string |
Состояние управляемого экземпляра. Возвращается: всегда Пример: |
|
storage_account_type string |
Тип хранилища учетных данных, используемого для хранения резервных копий для этого экземпляра. Возвращаемое значение: всегда Пример: |
|
storage_size_in_gb integer |
Размер хранилища в ГБ. Минимальное значение 32. Максимальное значение 8192. Возвращаемое значение: всегда Пример: |
|
subnet_id string |
Идентификатор ресурса подсети для управляемого экземпляра. Возвращаемое значение: всегда Пример: |
|
tags dictionary |
Теги ресурса. Возвращаемое значение: всегда Пример: |
|
timezone_id string |
Идентификатор часового пояса. Допустимые значения — поддерживаемые Windows часовые пояса. Возвращаемое значение: всегда Пример: |
|
type string |
Тип управляемого экземпляра SQL. Возвращаемое значение: всегда Пример: |
|
v_cores integer |
Количество виртуальных ядер. Допустимые значения: 8, 16, 24, 32, 40, 64, 80. Возвращаемое значение: всегда Пример: |
|
zone_redundant boolean |
Включена ли многозонная доступность. Возвращаемое значение: всегда Пример: |
Ссылки на сборку
© 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_sqlmanagedinstance_module.html