通过

Azure SQL 托管实例的托管 API 参考

  • 项目

适用于：Azure SQL 托管实例

可以使用 Azure 门户、PowerShell、Azure CLI、REST API 和 Transact-SQL 创建和配置 Azure SQL 托管实例的托管实例。 在本文中，你可以找到可用于创建和配置托管实例的函数和 API 的概述。

Azure 门户：创建托管实例

有关演示如何创建托管实例的快速入门，请参阅快速入门：创建托管实例。

PowerShell：创建和配置托管实例

注意

本文使用 Azure Az PowerShell 模块，这是与 Azure 交互时推荐使用的 PowerShell 模块。 若要开始使用 Az PowerShell 模块，请参阅安装 Azure PowerShell。 若要了解如何迁移到 Az PowerShell 模块，请参阅 将 Azure PowerShell 从 AzureRM 迁移到 Az。

重要

PowerShell Azure 资源管理器模块仍受 Azure SQL 数据库的支持，但所有未来的开发都是针对 Az.Sql 模块的。 若要了解这些 cmdlet，请参阅 AzureRM.Sql。 Az 模块和 AzureRM 模块中的命令参数大体上是相同的。

若要使用 Azure PowerShell 创建并管理托管实例，请使用以下 PowerShell cmdlet。 如果需要安装或升级 PowerShell，请参阅安装 Azure PowerShell 模块。

提示

有关 PowerShell 示例脚本，请参阅快速入门脚本：使用 PowerShell 库创建托管实例。

Cmdlet 说明
New-AzSqlInstance 创建托管实例。
Get-AzSqlInstance 返回有关托管实例的详细信息。
Set-AzSqlInstance 设置托管实例的属性。
Remove-AzSqlInstance 删除托管实例。
Get-AzSqlInstanceOperation 获取对托管实例执行的管理操作的列表或特定操作。
Stop-AzSqlInstanceOperation 取消对托管实例执行的特定管理操作。
New-AzSqlInstanceDatabase 创建 SQL 托管实例数据库。
Get-AzSqlInstanceDatabase 返回有关 SQL 托管实例数据库的信息。
Remove-AzSqlInstanceDatabase 删除 SQL 托管实例数据库。
Restore-AzSqlInstanceDatabase 还原 SQL 托管实例数据库。

Azure CLI：创建和配置托管实例

若要使用 Azure CLI 创建和配置托管实例，请使用以下用于 SQL 托管实例的 Azure CLI 命令。 可以在 macOS、Linux 或 Windows 上安装它。

提示

有关 Azure CLI 快速入门，请参阅使用 Azure CLI 处理 SQL 托管实例。

Cmdlet 说明
az sql mi create 创建托管实例。
az sql mi list 列出可用的托管实例。
az sql mi show 获取托管实例的详细信息。
az sql mi update 更新托管实例。
az sql mi delete 删除托管实例。
az sql mi op list 获取对托管实例执行的管理操作的列表。
az sql mi op show 获取对托管实例执行的特定管理操作。
az sql mi op cancel 取消对托管实例执行的特定管理操作。
az sql midb create 创建托管数据库。
az sql midb list 列出可用的托管数据库。
az sql midb restore 还原托管数据库。
az sql midb delete 删除托管数据库。

Transact-SQL：创建和配置实例数据库

要在创建托管实例后创建和配置实例数据库，请使用以下 T-SQL 命令。 可以使用 Azure 门户、SQL Server Management Studio、Azure Data StudioVisual Studio Code 或可以连接到服务器并传递 Transact-SQL 命令的其他任何程序来发出这些命令。

提示

有关介绍如何使用 Microsoft Windows 上的 SQL Server Management Studio 配置和连接到托管实例的快速入门，请参阅快速入门：配置 Azure VM 以连接到 Azure SQL 托管实例和快速入门：配置从本地到 Azure SQL 托管实例的点到站点连接。

重要

无法使用 Transact-SQL 创建或删除托管实例。

命令 说明
CREATE DATABASE 在 SQL 托管实例中创建新的实例数据库。 你必须连接到 master 数据库才能创建新的数据库。
ALTER DATABASE 修改 SQL 托管实例中的实例数据库。

REST API：创建和配置托管实例

要创建和配置托管实例，请使用以下 REST API 请求。

命令 说明
SQL 托管实例 - 创建或更新 创建或更新托管实例。
SQL 托管实例 - 删除 删除托管实例。
SQL 托管实例 - 获取 获取托管实例。
SQL 托管实例 - 停止 停止托管实例。
SQL 托管实例 - 启动 启动托管实例
SQL 托管实例 - 列出 返回订阅中的托管实例列表。
SQL 托管实例 - 按资源组列出 返回资源组中的托管实例列表。
SQL 托管实例 - 更新 更新托管实例。
SQL 托管实例操作 - 按托管实例列出 获取对托管实例执行的管理操作的列表。
SQL 托管实例操作 - 获取 获取对托管实例执行的特定管理操作。
SQL 托管实例操作 - 取消 取消对托管实例执行的特定管理操作。
SQL 托管实例 - 启动/停止计划 - 创建或更新 创建或更新启动和停止托管实例计划。
SQL 托管实例 - 启动/停止计划 - 获取 获取现有启动和停止托管实例计划。
SQL 托管实例 - 启动/停止计划 - 删除可以删除现有启动和停止托管实例计划。

后续步骤