azure.azcollection.azure_rm_sqlelasticpool модуль – Управление экземпляром SQL Elastic Pool
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.
Для использования в плейбуке укажите: azure.azcollection.azure_rm_sqlelasticpool.
Добавлена в azure.azcollection 1.14.0
Обзор
- Создание, обновление и удаление экземпляра SQL Elastic Pool.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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. Значение по умолчанию 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: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате важно убедиться, что настроенный узел полномочий является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Choices:
|
license_type string | Тип лицензии для применения к этому пулу эластичных баз данных. Choices:
|
location string | Расположение ресурса. Если не указано, по умолчанию будет использоваться расположение из группы ресурсов. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
maintenance_configuration_id string | Идентификатор конфигурации обслуживания, назначенный пулу эластичных баз данных. |
max_size_bytes string | Максимальный размер пула эластичности, выраженный в байтах. Если не указано create_mode=default, это значение игнорируется. Для просмотра возможных значений обратитесь к API возможностей (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities). указанный операцией:’Capabilities_ListByLocation’. |
name string / обязательно | Имя пула эластичности, с которым будет выполняться операция (обновление или создание). |
password string | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. |
per_elasticpool_settings словарь | Настройки по базе данных для пула эластичности. |
|
max_capacity float |
Максимальная гарантированная емкость всех баз данных. |
|
min_capacity float |
Минимальная гарантированная емкость всех баз данных. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string / обязательно | Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала. |
secret string | Служебный секрет Azure. Используется при аутентификации с помощью служебного принципала. |
server_name string / обязательно | Имя сервера. |
sku словарь | SKU пула эластичности. Перечисление Elastic PoolEditions содержит все допустимые SKU. |
|
capacity целое число |
Емкость конкретного SKU. |
|
family string |
Если у сервиса есть разные поколения оборудования для одного SKU, это можно использовать здесь |
|
name string / обязательно |
Имя SKU пула эластичности, как правило, буквенно-цифровой код, например, P3 |
|
size string |
Размер конкретного SKU |
|
tier string |
Уровень или издание конкретного SKU, например, Basic, Premium |
state string | Установите состояние SQL пула эластичности. Используйте Выборы:
|
subscription_id string | Ваш идентификатор подписки Azure. |
tags словарь | Словарь пар строка:строка, назначаемых в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр 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. |
x509_certificate_path путь Добавлен в azure.azcollection 1.14.0 | Путь к сертификату X509, используемому для создания служебного принципала в формате PEM. Сертификат должен быть добавлен к закрытому ключу. Используется при аутентификации с помощью служебного принципала. |
zone_redundant boolean | Является ли этот elasticpool зонально-избыточным? Это означает, что реплики этого elasticpool будут распределены по нескольким зонам доступности. Варианты:
|
Примечания
Примечание
- Для аутентификации с 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 (or update) SQL Elastic Pool
azure_rm_elastic_pool:
resource_group: myResourceGroup
server_name: sqlcrudtest-5961
name: testEP
zone_redundant: false
sku:
name: GP_Gen5
family: Gen5
capacity: 3
tags:
key1: value1
- name: Delete SQL Elastic Pool
azure_rm_elastic_pool:
resource_group: myResourceGroup
server_name: sqlcrudtest-5961
name: testEP
state: absent
Значения возврата
Общие значения возврата описаны здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
elastic_pool complex | Список словарей, содержащих факты для SQL Elastic Pool. Возвращается: всегда |
|
id string |
Идентификатор ресурса. Возвращается: всегда Пример: |
|
license_type string |
Тип лицензии для применения к этому пулу упругих баз данных. Возвращается: всегда Пример: |
|
location string |
Расположение ресурса. Возвращается: всегда Пример: |
|
maintenance_configuration_id string |
Идентификатор конфигурации обслуживания, назначенный пулу упругих баз данных. Возвращается: всегда Пример: |
|
max_size_bytes string |
Предел хранения для пула упругих баз данных в байтах. Возвращается: всегда Пример: |
|
name string |
Имя пула упругих баз данных. Возвращается: всегда Пример: |
|
per_database_settings complex |
Настройки для каждой базы данных в пуле упругих баз данных. Возвращается: всегда |
|
max_capacity float |
Максимальная емкость, которую может использовать любая база данных. Возвращается: всегда Пример: |
|
min_capacity float |
Минимальная емкость, гарантированная для всех баз данных Возвращается: всегда Пример: |
|
sku complex |
Имя и уровень SKU. Возвращается: всегда |
|
capacity integer |
Емкость SKU. Возвращается: всегда Пример: |
|
family string |
Если у службы есть разные поколения оборудования для одного и того же SKU, это можно указать здесь. Возвращается: всегда Пример: |
|
name string |
Имя SKU. Возвращается: всегда Пример: |
|
size string |
Размер конкретного SKU. Возвращается: всегда |
|
tier string |
Уровень SKU. Возвращается: всегда Пример: |
|
tags dictionary |
Теги ресурса. Возвращается: всегда Пример: |
|
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_sqlelasticpool_module.html