azure.azcollection.azure_rm_sqldatabase – Управление экземпляром базы данных SQL
Примечание
Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в книге задач укажите: azure.azcollection.azure_rm_sqldatabase.
Новое в версии 0.1.2: из azure.azcollection
Обзор
- Создание, обновление и удаление экземпляра базы данных SQL.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным объектом службы. | ||
| adfs_authority_url строка добавлен в 0.0.1 azure.azcollection | URL-адрес авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS авторизации. | ||
| api_profile строка добавлен в 0.0.1 azure.azcollection | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. | |
| append_tags логическое значение |
| Управление тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноничности любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| auth_source строка добавлен в 0.0.1 azure.azcollection |
| Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды 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. | |
| cert_validation_mode строка добавлен в 0.0.1 azure.azcollection |
| Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack, может потребоваться отключить это поведение, передавая ignore. Также может быть задано в профиле файла учетных данных или переменной среды AZURE_CERT_VALIDATION. | |
| client_id строка | Идентификатор клиента Azure. Используйте при аутентификации с главным объектом службы. | ||
| cloud_environment строка добавлен в 0.0.1 azure.azcollection | По умолчанию: "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 содержит все допустимые версии. Этот параметр будет устаревшим в версии 2.11, используйте sku вместо него. Невозможно установить sku при установке этого поля. | |
| elastic_pool_name строка | Имя эластичного пула, в котором находится база данных. Не поддерживается для edition=data_warehouse. | ||
| force_update логическое значение |
| База данных SQL будет обновлена, если заданные параметры отличаются от текущего состояния ресурса. Чтобы принудительно обновить базу данных SQL в любом случае, установите этот параметр в True. | |
| location строка | Расположение ресурса. Если не задано, расположение из группы ресурсов будет использовано по умолчанию. | ||
| max_size_bytes строка | Максимальный размер базы данных в байтах. Если не create_mode=default, это значение игнорируется. Для просмотра возможных значений запросите API возможностей (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities). указано операцией:'Capabilities_ListByLocation'. | ||
| name строка / обязательно | Имя базы данных, над которой выполняется операция (обновление или создание). | ||
| password строка | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным объектом службы. | ||
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| read_scale логическое значение |
| Если база данных является географической вторичной, указывает, разрешены ли чтений-только подключения к этой базе данных. Не поддерживается для edition=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, это значение игнорируется. Не поддерживается для edition=data_warehouse. | |
| secret строка | Секретный ключ клиента Azure. Используйте при аутентификации с главным объектом службы. | ||
| server_name строка / обязательно | Имя сервера. | ||
| sku строка | Sku базы данных. Перечисление DatabaseEditions содержит все допустимые sku. Если create_mode=non_readable_secondary или create_mode=online_secondary, это значение игнорируется. Для просмотра возможных значений запросите API возможностей (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) указано операцией:'Capabilities_ListByLocation'. Невозможно установить edition при установке этого поля. | ||
| capacity строка | Емкость конкретного SKU. | ||
| family строка | Если у службы есть разные поколения оборудования для одного и того же SKU, то это можно использовать здесь. | ||
| name строка / обязательно | Имя SKU базы данных, обычно буквенно-цифровое обозначение, например, P3. | ||
| size строка | Размер конкретного SKU. | ||
| tier строка | Уровень или версия конкретного SKU, например, Basic, Premium. | ||
| Дата удаления исходной базы данных строка | Требуется, если create_mode=restore и source_database_id — это оригинальный идентификатор ресурса удалённой базы данных (в отличие от текущего идентификатора восстановленной удалённой базы данных), тогда это значение обязательно. Указывает время удаления базы данных. | ||
| Идентификатор исходной базы данных строка | Требуется, если не create_mode=default или create_mode=restore_long_term_retention_backup. Указывает идентификатор ресурса исходной базы данных. | ||
| Состояние строка |
| Установите состояние базы данных SQL. Используйте present для создания или обновления базы данных SQL и absent для её удаления. | |
| Идентификатор подписки строка | Ваш идентификатор подписки Azure. | ||
| Теги словарь | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. | ||
| Токен строка | Идентификатор Azure токена. Используется при аутентификации с помощью принципала службы. | ||
| Зональная избыточность булево |
| Является ли эта база данных зонально избыточной? Это означает, что копии этой базы данных будут распределены по нескольким зонам доступности. | |
Примечания
Примечание
- Для аутентификации с 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 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"
- name: Create (or update) SQL Database with SKU
azure_rm_sqldatabase:
resource_group: myResourceGroup
server_name: sqlcrudtest-5961
name: testdb
location: eastus
sku:
name: S0
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| Идентификатор базы данных строка | всегда | Идентификатор базы данных. Пример: идентификатор_базы_данных |
| id строка | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/t estdb |
| Статус строка | всегда | Статус базы данных. Пример: В сети |
Авторы
- Zim Kalinowski (@zikalino)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_sqldatabase_module.html
