Azure SQL Managed Instance のマネージド API リファレンス

適用対象:Azure SQL Managed Instance

Azure SQL Managed Instance のマネージド インスタンスは、Azure portal、PowerShell、Azure CLI、REST API、Transact-SQL を使用して作成および管理できます。 この記事では、マネージド インスタンスの作成と構成に使用できる関数と API の概要を説明します。

Azure portal:マネージド インスタンスを作成する

マネージド インスタンスの作成方法を示したクイックスタートについては、マネージド インスタンスの作成のクイックスタートを参照してください。

PowerShell:マネージド インスタンスを作成して構成する

Note

この記事では、Azure と対話するために推奨される PowerShell モジュールである Azure Az PowerShell モジュールを使用します。 Az PowerShell モジュールの使用を開始するには、「Azure PowerShell をインストールする」を参照してください。 Az PowerShell モジュールに移行する方法については、「AzureRM から Az への Azure PowerShell の移行」を参照してください。

重要

PowerShell Azure Resource Manager モジュールは Azure SQL Database で引き続きサポートされますが、今後の開発はすべて Az.Sql モジュールを対象に行われます。 これらのコマンドレットについては、「AzureRM.Sql」を参照してください。 Az モジュールと AzureRM モジュールのコマンドの引数は実質的に同じです。

Azure PowerShell を使用してマネージド インスタンスを作成および管理するには、次の PowerShell コマンドレットを使用します。 PowerShell をインストールまたはアップグレードする必要がある場合は、Azure PowerShell モジュールのインストールに関する記事を参照してください。

ヒント

PowerShell サンプル スクリプトについては、PowerShell ライブラリを使用したマネージド インスタンスの作成のクイックスタート スクリプトを参照してください。

コマンドレット	説明
New-AzSqlInstance	マネージド インスタンスを作成します。
Get-AzSqlInstance	マネージド インスタンスに関する情報を返します。
Set-AzSqlInstance	マネージド インスタンスのプロパティを設定します。
Remove-AzSqlInstance	マネージド インスタンスを削除します。
Get-AzSqlInstanceOperation	マネージド インスタンスまたは特定の操作で実行された管理操作の一覧を取得します。
Stop-AzSqlInstanceOperation	マネージド インスタンスで実行された特定の管理操作を取り消します。
New-AzSqlInstanceDatabase	SQL Managed Instance データベースを作成します。
Get-AzSqlInstanceDatabase	SQL Managed Instance データベースに関する情報を返します。
Remove-AzSqlInstanceDatabase	SQL Managed Instance データベースを削除します。
Restore-AzSqlInstanceDatabase	SQL Managed Instance データベースを復元します。

Azure CLI:マネージド インスタンスを作成して構成する

Azure CLI でマネージド インスタンスを作成して構成するには、次の SQL Managed Instance 用の Azure CLI コマンドを使用します。 Azure Cloud Shell を使用して Azure CLI をブラウザーで実行することも、macOS、Linux、または Windows にインストールすることもできます。

ヒント

Azure CLI のクイックスタートについては、「Working with SQL Managed Instance using Azure CLI」 (Azure CLI を使用した SQL Managed Instance の操作) を参照してください。

コマンドレット	説明
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 portal、SQL Server Management Studio、Azure Data Studio、Visual Studio Code、またはサーバーに接続して Transact-SQL コマンドを渡すことができるその他のプログラムを使用して実行できます。

ヒント

Microsoft Windows で SQL Server Management Studio を使用して、マネージド インスタンスを構成して接続する方法を示したクイックスタートについては、「クイック スタート: Azure SQL Managed Instance に接続するように Azure VM を構成する」および「クイック スタート: オンプレミスから Azure SQL Managed Instance へのポイント対サイト接続を構成する」を参照してください。

重要

Transact-SQL を使用して、マネージド インスタンスを作成したり、削除したりすることはできません。

コマンド	説明
CREATE DATABASE	SQL Managed Instance に新しいインスタンス データベースを作成します。 新しいデータベースを作成するには、master データベースに接続している必要があります。
ALTER DATABASE	SQL Managed Instance のインスタンス データベースを変更します。

REST API:マネージド インスタンスを作成して構成する

マネージド インスタンスを作成して構成するには、以下の REST API 要求を使用します。

コマンド	説明
SQL Managed Instance - 作成するまたは更新する	マネージド インスタンスを作成または更新します。
SQL Managed Instance - 削除する	マネージド インスタンスを削除します。
SQL Managed Instance - 取得する	マネージド インスタンスを取得します。
SQL Managed Instance - 停止する	マネージド インスタンスを停止します。
SQL Managed Instance - 開始する	マネージド インスタンスを開始する
SQL Managed Instance - リスト	サブスクリプション内のマネージド インスタンスの一覧を返します。
SQL Managed Instance - リソースグループ別リスト	リソース グループ内のマネージド インスタンスの一覧を取得します。
SQL Managed Instance - 更新する	マネージド インスタンスを更新します。
SQL Managed Instance の操作 - マネージド インスタンス別リスト	マネージド インスタンス上で実行された管理操作の一覧を取得します。
SQL Managed Instance の操作 - 取得する	マネージド インスタンスで実行された特定の管理操作を取得します。
SQL Managed Instance の操作 - キャンセルする	マネージド インスタンスで実行された特定の管理操作を取り消します。
SQL Managed Instance - スケジュールを実行する/停止する - 作成するまたは更新する	マネージド インスタンスの開始と停止のスケジュールを作成または更新します。
SQL Managed Instance -スケジュールを実行する/停止する - 取得する	既存のマネージド インスタンスの開始と停止のスケジュールを取得します。
SQL Managed Instance - スケジュールを実行する/停止する - 削除する既存のマネージド インスタンスの開始と停止スケジュールを削除します。

次のステップ

• SQL Server データベースを Azure に移行する方法については、「Azure SQL Database に移行」を参照してください。
• サポートされている機能については、機能に関する記事をご覧ください。