azure_rm_sqldatabase – Управление экземпляром SQL Database
Новая версия 2.5.
Обзор
- Создание, обновление и удаление экземпляра SQL Database.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации пользователем Active Directory, а не служебным принципалом. | |
| adfs_authority_url строка добавлен в 2.6 | URL-адрес авторизации Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и собственной службой ADFS. | |
| api_profile строка добавлен в 2.5 | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| append_tags булево |
| Управление тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении все теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| auth_source строка добавлен в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, используется переменная среды ANSIBLE_AZURE_AUTH_SOURCE, по умолчанию auto если переменная не определена.auto будет следовать стандартному приоритету параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.При значении cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также можно задать через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.При значении msi, хост-машина должна быть Azure-ресурсом с включённой расширенной MSI. subscription_id или переменная окружения AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если ресурс имеет доступ к нескольким подпискам, в противном случае выбирается первая подписка.msi был добавлен в Ansible 2.6. |
| cert_validation_mode строка добавлен в 2.5 |
| Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или подключении к Azure Stack, может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную окружения AZURE_CERT_VALIDATION. |
| client_id строка | Идентификатор клиента Azure. Используйте при аутентификации с помощью служебного принципала. | |
| cloud_environment строка добавлен в 2.4 | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки входа для обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную окружения AZURE_CLOUD_ENVIRONMENT. |
| collation - | Коллирование базы данных. Если create_mode не default, это значение игнорируется. | |
| create_mode - |
| Определяет режим создания базы данных. default: обычное создание базы данных.copy: создаёт базу данных как копию существующей базы данных.online_secondary/non_readable_secondary: создаёт базу данных как (читаемую или нечитаемую) вторичную реплику существующей базы данных.point_in_time_restore: создаёт базу данных путём восстановления резервной копии в указанный момент времени существующей базы данных.recovery: создаёт базу данных путём восстановления географически реплицированной резервной копии.restore: создаёт базу данных путём восстановления резервной копии удалённой базы данных.restore_long_term_retention_backup: создаёт базу данных путём восстановления из хранилища долгосрочного хранения.copy, non_readable_secondary, online_secondary и restore_long_term_retention_backup не поддерживаются для версии data_warehouse. |
| edition - |
| Версия базы данных. Перечисление DatabaseEditions содержит все допустимые версии. Если create_mode non_readable_secondary или online_secondary, это значение игнорируется. Для просмотра возможных значений обратитесь к API возможностей (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities), указанный operationId: 'Capabilities_ListByLocation.'. |
| elastic_pool_name - | Имя упругого пула, в котором находится база данных. Не поддерживается для версии data_warehouse. | |
| force_update булево |
| База данных SQL будет обновлена, если заданные параметры отличаются от состояния существующего ресурса. Для принудительного обновления базы данных SQL в любых обстоятельствах установите этот параметр в True. |
| location - | Расположение ресурса. Если не задано, используется расположение из группы ресурсов как default. | |
| max_size_bytes - | Максимальный размер базы данных в байтах. Если create_mode не default, это значение игнорируется. Для просмотра возможных значений обратитесь к API возможностей (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) с operationId: 'Capabilities_ListByLocation.' | |
| name - / обязательно | Имя базы данных, над которой выполняется операция (обновление или создание). | |
| password - | Пароль пользователя Active Directory. Используйте при аутентификации пользователем Active Directory, а не служебным принципалом. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| read_scale булево |
| Если база данных является географически вторичной, указывает, разрешены ли только чтение подключения к этой базе данных. Не поддерживается для версии data_warehouse. |
| recovery_services_recovery_point_resource_id - | Требуется, если create_mode restore_long_term_retention_backup, в этом случае это значение обязательно. Указывает идентификатор ресурса точки восстановления для восстановления. | |
| resource_group - / обязательно | Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала. | |
| restore_point_in_time - | Требуется, если create_mode point_in_time_restore, в этом случае это значение обязательно. Если create_mode restore, это значение необязательно. Указывает момент времени (формат ISO8601) исходной базы данных, которая будет восстановлена для создания новой базы данных. Должно быть больше или равно значению earliestRestoreDate исходной базы данных. | |
| sample_name - |
| Указывает имя образца схемы, применяемой при создании этой базы данных. Если create_mode не default, это значение игнорируется. Не поддерживается для версии data_warehouse. |
| secret строка | Секрет клиента Azure. Используйте при аутентификации с помощью служебного принципала. |
| server_name - / обязательно | Имя сервера. | |
| source_database_deletion_date - | Обязательно, если create_mode равен restore и source_database_id — это исходный идентификатор ресурса удалённой базы данных (в отличие от текущего идентификатора восстанавливаемой удалённой базы данных), тогда это значение обязательно. Указывает время удаления базы данных. | |
| source_database_id - | Обязательно, если create_mode не равен default или restore_long_term_retention_backup. Указывает идентификатор ресурса исходной базы данных. | |
| state - |
| Установите состояние базы данных SQL. Используйте present для создания или обновления базы данных SQL и absent для её удаления. |
| subscription_id строка | Ваш идентификатор подписки Azure. | |
| tags словарь | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены с любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. | |
| tenant строка | Идентификатор Azure-аренды. Используется при аутентификации с помощью сервисного принципала. | |
| zone_redundant булево |
| Является ли база данных зонально избыточной? Это означает, что реплики этой базы данных будут распределены по нескольким зонам доступности. |
Примечания
Примечание
- Для аутентификации с 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 и пароль или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
- В качестве альтернативы учетные данные можно сохранить в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и пароль. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.
См. также
См. также
- Вход в Azure CLI
- Как войти в систему с помощью команды
az login.
Примеры
- name: Create (or update) SQL Database
azure_rm_sqldatabase:
resource_group: myResourceGroup
server_name: sqlcrudtest-5961
name: testdb
location: eastus
- name: Restore SQL Database
azure_rm_sqldatabase:
resource_group: myResourceGroup
server_name: sqlcrudtest-5961
name: restoreddb
location: eastus
create_mode: restore
restorable_dropped_database_id: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/s
ervers/testsvr/restorableDroppedDatabases/testdb2,131444841315030000"
- name: Create SQL Database in Copy Mode
azure_rm_sqldatabase:
resource_group: myResourceGroup
server_name: sqlcrudtest-5961
name: copydb
location: eastus
create_mode: copy
source_database_id: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/tests
vr/databases/testdb"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| database_id строка | всегда | Идентификатор базы данных. Пример: database_id |
| id строка | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/t estdb |
| status строка | всегда | Статус базы данных. Пример: Online |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [предварительная версия]
- Данный модуль поддерживается сообществом Ansible. [community]
Авторы
- Zim Kalinowski (@zikalino)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_sqldatabase_module.html
