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

適用対象: Azure SQL Managed Instance

Azure SQL Managed Instance のマネージド インスタンスは、Azure portal、PowerShell、Azure CLI、REST API、Transact-SQL を使用して作成および管理できます。You can create and configure managed instances of Azure SQL Managed Instance using the Azure portal, PowerShell, Azure CLI, REST API, and Transact-SQL. この記事では、マネージド インスタンスの作成と構成に使用できる関数と API の概要を説明します。In this article, you can find an overview of the functions and the API that you can use to create and configure managed instances.

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

マネージド インスタンスの作成方法を示したクイックスタートについては、マネージド インスタンスの作成のクイックスタートを参照してください。For a quickstart showing you how to create a managed instance, see Quickstart: Create a managed instance.

PowerShell:マネージド インスタンスを作成して構成するPowerShell: Create and configure managed instances

注意

この記事は、Azure Az PowerShell モジュールを使用するように更新されています。This article has been updated to use the Azure Az PowerShell module. Az PowerShell モジュールは、Azure と対話するために推奨される PowerShell モジュールです。The Az PowerShell module is the recommended PowerShell module for interacting with Azure. Az PowerShell モジュールの使用を開始するには、「Azure PowerShell をインストールする」を参照してください。To get started with the Az PowerShell module, see Install Azure PowerShell. Az PowerShell モジュールに移行する方法については、「AzureRM から Az への Azure PowerShell の移行」を参照してください。To learn how to migrate to the Az PowerShell module, see Migrate Azure PowerShell from AzureRM to Az.

重要

PowerShell Azure Resource Manager モジュールは Azure SQL Database で引き続きサポートされますが、今後の開発はすべて Az.Sql モジュールを対象に行われます。The PowerShell Azure Resource Manager module is still supported by Azure SQL Database, but all future development is for the Az.Sql module. これらのコマンドレットについては、「AzureRM.Sql」を参照してください。For these cmdlets, see AzureRM.Sql. Az モジュールと AzureRM モジュールのコマンドの引数は実質的に同じです。The arguments for the commands in the Az module and in the AzureRM modules are substantially identical.

Azure PowerShell を使用してマネージド インスタンスを作成および管理するには、次の PowerShell コマンドレットを使用します。To create and manage managed instances with Azure PowerShell, use the following PowerShell cmdlets. PowerShell をインストールまたはアップグレードする必要がある場合は、Azure PowerShell モジュールのインストールに関する記事を参照してください。If you need to install or upgrade PowerShell, see Install the Azure PowerShell module.

ヒント

PowerShell サンプル スクリプトについては、PowerShell ライブラリを使用したマネージド インスタンスの作成のクイックスタート スクリプトを参照してください。For PowerShell example scripts, see Quickstart script: Create a managed instance using a PowerShell library.

コマンドレットCmdlet 説明Description
New-AzSqlInstanceNew-AzSqlInstance マネージド インスタンスを作成します。Creates a managed instance.
Get-AzSqlInstanceGet-AzSqlInstance マネージド インスタンスに関する情報を返します。Returns information about a managed instance.
Set-AzSqlInstanceSet-AzSqlInstance マネージド インスタンスのプロパティを設定します。Sets properties for a managed instance.
Remove-AzSqlInstanceRemove-AzSqlInstance マネージド インスタンスを削除します。Removes a managed instance.
Get-AzSqlInstanceOperationGet-AzSqlInstanceOperation マネージド インスタンスまたは特定の操作で実行された管理操作の一覧を取得します。Gets a list of management operations performed on the managed instance or specific operation.
Stop-AzSqlInstanceOperationStop-AzSqlInstanceOperation マネージド インスタンスで実行された特定の管理操作を取り消します。Cancels the specific management operation performed on the managed instance.
New-AzSqlInstanceDatabaseNew-AzSqlInstanceDatabase SQL Managed Instance データベースを作成します。Creates a SQL Managed Instance database.
Get-AzSqlInstanceDatabaseGet-AzSqlInstanceDatabase SQL Managed Instance データベースに関する情報を返します。Returns information about a SQL Managed Instance database.
Remove-AzSqlInstanceDatabaseRemove-AzSqlInstanceDatabase SQL Managed Instance データベースを削除します。Removes a SQL Managed Instance database.
Restore-AzSqlInstanceDatabaseRestore-AzSqlInstanceDatabase SQL Managed Instance データベースを復元します。Restores a SQL Managed Instance database.

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

Azure CLI でマネージド インスタンスを作成して構成するには、次の SQL Managed Instance 用の Azure CLI コマンドを使用します。To create and configure managed instances with Azure CLI, use the following Azure CLI commands for SQL Managed Instance. Azure Cloud Shell を使用して CLI をブラウザーで実行することも、macOS、Linux、または Windows にインストールすることもできます。Use Azure Cloud Shell to run the CLI in your browser, or install it on macOS, Linux, or Windows.

ヒント

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

コマンドレットCmdlet 説明Description
az sql mi createaz sql mi create マネージド インスタンスを作成します。Creates a managed instance.
az sql mi listaz sql mi list 使用可能なマネージド インスタンスを一覧表示します。Lists available managed instances.
az sql mi showaz sql mi show マネージド インスタンスの詳細を取得します。Gets the details for a managed instance.
az sql mi updateaz sql mi update マネージド インスタンスを更新します。Updates a managed instance.
az sql mi deleteaz sql mi delete マネージド インスタンスを削除します。Removes a managed instance.
az sql mi op listaz sql mi op list マネージド インスタンス上で実行された管理操作の一覧を取得します。Gets a list of management operations performed on the managed instance.
az sql mi op showaz sql mi op show マネージド インスタンスで実行された特定の管理操作を取得します。Gets the specific management operation performed on the managed instance.
az sql mi op cancelaz sql mi op cancel マネージド インスタンスで実行された特定の管理操作を取り消します。Cancels the specific management operation performed on the managed instance.
az sql midb createaz sql midb create マネージド データベースを作成します。Creates a managed database.
az sql midb listaz sql midb list 使用可能なマネージド データベースを一覧表示します。Lists available managed databases.
az sql midb restoreaz sql midb restore マネージド データベースを復元します。Restores a managed database.
az sql midb deleteaz sql midb delete マネージド データベースを削除します。Removes a managed database.

Transact-SQL:インスタンス データベースを作成して構成するTransact-SQL: Create and configure instance databases

マネージド インスタンスの作成後、インスタンス データベースを作成して構成するには、次の T-SQL コマンドを使用します。To create and configure instance databases after the managed instance is created, use the following T-SQL commands. これらのコマンドは、Azure portal、SQL Server Management StudioAzure Data StudioVisual Studio Code、またはサーバーに接続して Transact-SQL コマンドを渡すことができるその他のプログラムを使用して実行できます。You can issue these commands using the Azure portal, SQL Server Management Studio, Azure Data Studio, Visual Studio Code, or any other program that can connect to a server and pass Transact-SQL commands.

ヒント

Microsoft Windows で SQL Server Management Studio を使用して、マネージド インスタンスを構成して接続する方法を示したクイックスタートについては、「クイック スタート: Azure SQL Managed Instance に接続するように Azure VM を構成する」および「クイック スタート: オンプレミスから Azure SQL Managed Instance へのポイント対サイト接続を構成する」を参照してください。For quickstarts showing you how to configure and connect to a managed instance using SQL Server Management Studio on Microsoft Windows, see Quickstart: Configure Azure VM to connect to Azure SQL Managed Instance and Quickstart: Configure a point-to-site connection to Azure SQL Managed Instance from on-premises.

重要

Transact-SQL を使用して、マネージド インスタンスを作成したり、削除したりすることはできません。You cannot create or delete a managed instance using Transact-SQL.

コマンドCommand 説明Description
CREATE DATABASECREATE DATABASE SQL Managed Instance に新しいインスタンス データベースを作成します。Creates a new instance database in SQL Managed Instance. 新しいデータベースを作成するには、master データベースに接続している必要があります。You must be connected to the master database to create a new database.
ALTER DATABASEALTER DATABASE SQL Managed Instance のインスタンス データベースを変更します。Modifies an instance database in SQL Managed Instance.

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

マネージド インスタンスを作成して構成するには、以下の REST API 要求を使用します。To create and configure managed instances, use these REST API requests.

コマンドCommand 説明Description
Managed Instances - Create Or UpdateManaged Instances - Create Or Update マネージド インスタンスを作成または更新します。Creates or updates a managed instance.
Managed Instances - DeleteManaged Instances - Delete マネージド インスタンスを削除します。Deletes a managed instance.
Managed Instances - GetManaged Instances - Get マネージド インスタンスを取得します。Gets a managed instance.
Managed Instances - ListManaged Instances - List サブスクリプション内のマネージド インスタンスの一覧を返します。Returns a list of managed instances in a subscription.
Managed Instances - List By Resource GroupManaged Instances - List By Resource Group リソース グループ内のマネージド インスタンスの一覧を取得します。Returns a list of managed instances in a resource group.
Managed Instances - UpdateManaged Instances - Update マネージド インスタンスを更新します。Updates a managed instance.
Managed Instance の操作 - Managed Instance 別に一覧表示Managed Instance Operations - List By Managed Instance マネージド インスタンス上で実行された管理操作の一覧を取得します。Gets a list of management operations performed on the managed instance.
Managed Instance の操作 - 取得Managed Instance Operations - Get マネージド インスタンスで実行された特定の管理操作を取得します。Gets the specific management operation performed on the managed instance.
Managed Instance の操作 - キャンセルManaged Instance Operations - Cancel マネージド インスタンスで実行された特定の管理操作を取り消します。Cancels the specific management operation performed on the managed instance.

次のステップNext steps

  • SQL Server データベースを Azure に移行する方法については、「Azure SQL Database に移行」を参照してください。To learn about migrating a SQL Server database to Azure, see Migrate to Azure SQL Database.
  • サポートされている機能については、機能に関する記事をご覧ください。For information about supported features, see Features.