Servers - Import Database

サービス:: SQL Database

API バージョン:: 2023-08-01

bacpac を新しいデータベースにインポートします。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/import?api-version=2023-08-01

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースを含むリソースグループの名前。この値は、Azure Resource Manager API またはポータルから取得できます。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求に使用する API バージョン。

要求本文

名前	必須	型	説明
administratorLogin	True	string	管理者ログイン名。
administratorLoginPassword	True	string	管理者ログインパスワード。
storageKey	True	string	ストレージキー。
storageKeyType	True	StorageKeyType	ストレージキーの種類。
storageUri	True	string	ストレージ URI。
authenticationType		string	認証の種類。
databaseName		string	インポートデータベースの名前。
edition		string	インポートデータベースのエディション。
maxSizeBytes		string	インポートデータベースの最大サイズ (バイト単位)。
networkIsolation		NetworkIsolationSettings	要求のネットワーク分離を有効にするオプションのリソース情報。
serviceObjectiveName		string	インポートデータベースのサービスレベル目標名。

応答

名前	型	説明
200 OK	ImportExportOperationResult	データベースが正常にインポートされました。
202 Accepted		データベースのインポートが進行中です。ヘッダー Location: string
Other Status Codes	ErrorResponse	エラー応答: *** 400 MissingImportExportInputParameters - ImportExport 入力パラメーターがありません。 400 InvalidImportExportInputParameter - 無効な入力パラメーターが原因でインポート/エクスポート要求が失敗しました。 400 PolybaseImportAuthenticationTypeNotSupported - 認証の種類のパラメーターは、PolybaseImport 操作をサポートしていません。 400 DatabaseExtensionsInvalidOperationMode - データベース拡張機能の operationMode パラメーターが無効です。 400 DatabaseExtensionsInvalidStorageKeyType - ストレージキーの種類は 'StorageAccessKey' である必要があります。 400 DatabaseExtensionsMissingStorageUri - ストレージ URI を空にすることはできません。 400 SQLPasswordSpecifiedWithManagedIdentity - authenticationType が ManagedIdentity の場合は、administratorLoginPassword を指定しないでください。 400 InvalidSqlAuthType - SQL 認証の種類が無効であるため、ImportExport 操作が失敗しました 400 BlobAlreadyExist - ストレージ BLOB が既に存在するため、ImportExport 操作に失敗しました 400 InvalidImportExportOperationResourceLocks - Private Link リソースのロックにより、インポート/エクスポート要求が無効です。 400 DatabaseInvalidSkuPropertyCombination - 要求された SKU のプロパティに一貫性がありません。有効な組み合わせが指定されていることを確認してください。詳細については、https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability を参照してください。 400 ImportExportJobError - ImportExport 操作が失敗しました。 400 BlockedByOutboundFirewall - 送信ファイアウォール規則によって要求がブロックされました。 400 InvalidOperationType - 有効な操作の種類を指定します。 400 InvalidMaxSizeTierCombination - 指定されたレベルでは、指定したデータベースの最大サイズはサポートされていません。 400 InvalidTier - ユーザーが無効なレベルを指定しました。 400 CannotUseReservedDatabaseName - この操作で予約済みデータベース名を使用できません。 400 InvalidImportExportParameter - 無効な入力パラメーターが原因でインポート/エクスポート要求が失敗しました。 400 InvalidSku - ユーザーが無効な SKU を指定しました。 400 InvalidTierSkuCombination - 指定されたレベルは、指定された SKU をサポートしていません。 400 InvalidImportExportStorageCredentials - 無効なストレージ資格情報が原因でインポート/エクスポート操作に失敗しました 400 InvalidImportExportStorageAuthType - ストレージ認証の種類が無効なため、インポート/エクスポート操作に失敗しました 400 InvalidImportExportStorageKeyFormat - 無効なストレージキー形式が原因でインポート/エクスポート操作が失敗しました 400 LongImportExportStorageUri - 長いストレージ URI が原因でインポート/エクスポート操作に失敗しました 400 LargeExportDatabaseSize - データベースがサポートされている最大サイズより大きいため、エクスポート操作に失敗しました 400 FeatureDisabledOnSelectedEdition - ユーザーは、現在のデータベースエディションで無効になっている機能を使用しようとしました。 400 UnSupportedImportExportEdition - ImportExport 操作が無効なエディションを対象としているために失敗しました 400 InvalidImportExportStorageURI - ストレージ URI が無効であるため、ImportExport 操作が失敗しました 404 DatabaseDoesNotExist - ユーザーがこのサーバーインスタンスに存在しないデータベース名を指定しました。 404 ServerNotInSubscription - 指定されたサーバーが指定されたサブスクリプションに存在しません。 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。 404 ResourceNotFound - 存在しないリソースを指定する要求が無効です。 404 ImportExportOperationIdNotFound - インポートまたはエクスポートの操作 ID が見つかりません。 404 OperationIdNotFound - Id を持つ操作が存在しません。 409 ImportExportOperationInProgress - データベースに対してインポートまたはエクスポート操作が進行中です。 409 CannotCancelOperation - 管理操作が取り消すことができない状態です。 409 OperationCancelled - 操作がユーザーによって取り消されました。 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。操作を再試行してください。 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

名前

型

説明

200 OK

ImportExportOperationResult

データベースが正常にインポートされました。

202 Accepted

データベースのインポートが進行中です。

ヘッダー

Location: string

Other Status Codes

ErrorResponse

エラー応答: ***

400 MissingImportExportInputParameters - ImportExport 入力パラメーターがありません。
400 InvalidImportExportInputParameter - 無効な入力パラメーターが原因でインポート/エクスポート要求が失敗しました。
400 PolybaseImportAuthenticationTypeNotSupported - 認証の種類のパラメーターは、PolybaseImport 操作をサポートしていません。
400 DatabaseExtensionsInvalidOperationMode - データベース拡張機能の operationMode パラメーターが無効です。
400 DatabaseExtensionsInvalidStorageKeyType - ストレージキーの種類は 'StorageAccessKey' である必要があります。
400 DatabaseExtensionsMissingStorageUri - ストレージ URI を空にすることはできません。
400 SQLPasswordSpecifiedWithManagedIdentity - authenticationType が ManagedIdentity の場合は、administratorLoginPassword を指定しないでください。
400 InvalidSqlAuthType - SQL 認証の種類が無効であるため、ImportExport 操作が失敗しました
400 BlobAlreadyExist - ストレージ BLOB が既に存在するため、ImportExport 操作に失敗しました
400 InvalidImportExportOperationResourceLocks - Private Link リソースのロックにより、インポート/エクスポート要求が無効です。
400 DatabaseInvalidSkuPropertyCombination - 要求された SKU のプロパティに一貫性がありません。有効な組み合わせが指定されていることを確認してください。詳細については、https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability を参照してください。
400 ImportExportJobError - ImportExport 操作が失敗しました。
400 BlockedByOutboundFirewall - 送信ファイアウォール規則によって要求がブロックされました。
400 InvalidOperationType - 有効な操作の種類を指定します。
400 InvalidMaxSizeTierCombination - 指定されたレベルでは、指定したデータベースの最大サイズはサポートされていません。
400 InvalidTier - ユーザーが無効なレベルを指定しました。
400 CannotUseReservedDatabaseName - この操作で予約済みデータベース名を使用できません。
400 InvalidImportExportParameter - 無効な入力パラメーターが原因でインポート/エクスポート要求が失敗しました。
400 InvalidSku - ユーザーが無効な SKU を指定しました。
400 InvalidTierSkuCombination - 指定されたレベルは、指定された SKU をサポートしていません。
400 InvalidImportExportStorageCredentials - 無効なストレージ資格情報が原因でインポート/エクスポート操作に失敗しました
400 InvalidImportExportStorageAuthType - ストレージ認証の種類が無効なため、インポート/エクスポート操作に失敗しました
400 InvalidImportExportStorageKeyFormat - 無効なストレージキー形式が原因でインポート/エクスポート操作が失敗しました
400 LongImportExportStorageUri - 長いストレージ URI が原因でインポート/エクスポート操作に失敗しました
400 LargeExportDatabaseSize - データベースがサポートされている最大サイズより大きいため、エクスポート操作に失敗しました
400 FeatureDisabledOnSelectedEdition - ユーザーは、現在のデータベースエディションで無効になっている機能を使用しようとしました。
400 UnSupportedImportExportEdition - ImportExport 操作が無効なエディションを対象としているために失敗しました
400 InvalidImportExportStorageURI - ストレージ URI が無効であるため、ImportExport 操作が失敗しました
404 DatabaseDoesNotExist - ユーザーがこのサーバーインスタンスに存在しないデータベース名を指定しました。
404 ServerNotInSubscription - 指定されたサーバーが指定されたサブスクリプションに存在しません。
404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。
404 ResourceNotFound - 存在しないリソースを指定する要求が無効です。
404 ImportExportOperationIdNotFound - インポートまたはエクスポートの操作 ID が見つかりません。
404 OperationIdNotFound - Id を持つ操作が存在しません。
409 ImportExportOperationInProgress - データベースに対してインポートまたはエクスポート操作が進行中です。
409 CannotCancelOperation - 管理操作が取り消すことができない状態です。
409 OperationCancelled - 操作がユーザーによって取り消されました。
409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。
429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求を超える要求。
429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。
500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。操作を再試行してください。
503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

例

Imports to a new database, using private link for the SQL server and storage account.

Imports to a new database.

Imports to a new database, using private link for the SQL server and storage account.

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/import?api-version=2023-08-01

{
  "databaseName": "testdb",
  "storageKeyType": "StorageAccessKey",
  "storageKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==",
  "storageUri": "https://test.blob.core.windows.net/test.bacpac",
  "administratorLogin": "login",
  "administratorLoginPassword": "password",
  "authenticationType": "Sql",
  "networkIsolation": {
    "sqlServerResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr",
    "storageAccountResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Storage/storageAccounts/test-privatelink"
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ImportNewDatabaseWithNetworkIsolation.json
// this example is just showing the usage of "Servers_ImportDatabase" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// invoke the operation
DatabaseImportDefinition databaseImportDefinition = new DatabaseImportDefinition(StorageKeyType.StorageAccessKey, "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==", new Uri("https://test.blob.core.windows.net/test.bacpac"), "login", "password")
{
    DatabaseName = "testdb",
    AuthenticationType = "Sql",
    NetworkIsolation = new NetworkIsolationSettings
    {
        StorageAccountResourceId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Storage/storageAccounts/test-privatelink"),
        SqlServerResourceId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr"),
    },
};
ArmOperation<ImportExportOperationResult> lro = await sqlServer.ImportDatabaseAsync(WaitUntil.Completed, databaseImportDefinition);
ImportExportOperationResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "properties": {
    "requestId": "9d9a794a-5cec-4f23-af70-d29511b522a4",
    "requestType": "Import",
    "queuedTime": "2/2/2020 8:33:27 PM",
    "lastModifiedTime": "2/2/2020 8:34:47 PM",
    "blobUri": "https://test.blob.core.windows.net/test.bacpac",
    "serverName": "testsvr.database.windows.net",
    "databaseName": "testdb",
    "status": "Completed"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/importExportOperationResults/9d9a794a-5cec-4f23-af70-d29511b522a4",
  "name": "9d9a794a-5cec-4f23-af70-d29511b522a4",
  "type": "Microsoft.Sql/servers/databases/importExportOperationResults"
}

状態コード:: 202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Sql/locations/japaneast/importExportOperationResults/00000000-0000-0000-0000-000000000000?api-version=2022-08-01

Imports to a new database.

要求のサンプル

HTTP
dotnet

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/import?api-version=2023-08-01

{
  "databaseName": "testdb",
  "storageKeyType": "StorageAccessKey",
  "storageKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==",
  "storageUri": "https://test.blob.core.windows.net/test.bacpac",
  "administratorLogin": "login",
  "administratorLoginPassword": "password",
  "authenticationType": "Sql"
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ImportNewDatabase.json
// this example is just showing the usage of "Servers_ImportDatabase" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// invoke the operation
DatabaseImportDefinition databaseImportDefinition = new DatabaseImportDefinition(StorageKeyType.StorageAccessKey, "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==", new Uri("https://test.blob.core.windows.net/test.bacpac"), "login", "password")
{
    DatabaseName = "testdb",
    AuthenticationType = "Sql",
};
ArmOperation<ImportExportOperationResult> lro = await sqlServer.ImportDatabaseAsync(WaitUntil.Completed, databaseImportDefinition);
ImportExportOperationResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "properties": {
    "requestId": "9d9a794a-5cec-4f23-af70-d29511b522a4",
    "requestType": "Import",
    "queuedTime": "2/2/2020 8:33:27 PM",
    "lastModifiedTime": "2/2/2020 8:34:47 PM",
    "blobUri": "https://test.blob.core.windows.net/test.bacpac",
    "serverName": "testsvr.database.windows.net",
    "databaseName": "testdb",
    "status": "Completed"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/importExportOperationResults/9d9a794a-5cec-4f23-af70-d29511b522a4",
  "name": "9d9a794a-5cec-4f23-af70-d29511b522a4",
  "type": "Microsoft.Sql/servers/databases/importExportOperationResults"
}

状態コード:: 202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Sql/locations/japaneast/importExportOperationResults/00000000-0000-0000-0000-000000000000?api-version=2022-08-01

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ImportExportOperationResult	ImportExport 操作の結果リソース。
ImportNewDatabaseDefinition	新しいデータベースのインポート操作を実行するために必要な情報を格納します。
NetworkIsolationSettings	プライベートエンドポイント接続を作成する ARM リソースが含まれています。
PrivateEndpointConnectionRequestStatus	プライベートエンドポイント接続要求の状態を格納します。
StorageKeyType	ストレージキーの種類。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

ImportExportOperationResult

Object

ImportExport 操作の結果リソース。

名前	型	説明
id	string	リソース ID。
name	string	リソース名。
properties.blobUri	string	BLOB URI。
properties.databaseName	string	データベース名。
properties.errorMessage	string	エラーメッセージ。
properties.lastModifiedTime	string	最終変更時刻。
properties.privateEndpointConnections	PrivateEndpointConnectionRequestStatus[]	この要求に関連付けられているプライベートエンドポイントの状態を取得します。
properties.queuedTime	string	キューに入った時刻。
properties.requestId	string (uuid)	要求 ID。
properties.requestType	string	要求の種類。
properties.serverName	string	サーバー名。
properties.status	string	操作の状態。
type	string	リソースの種類。

ImportNewDatabaseDefinition

Object

新しいデータベースのインポート操作を実行するために必要な情報を格納します。

名前	型	説明
administratorLogin	string	管理者ログイン名。
administratorLoginPassword	string	管理者ログインパスワード。
authenticationType	string	認証の種類。
databaseName	string	インポートデータベースの名前。
edition	string	インポートデータベースのエディション。
maxSizeBytes	string	インポートデータベースの最大サイズ (バイト単位)。
networkIsolation	NetworkIsolationSettings	要求のネットワーク分離を有効にするオプションのリソース情報。
serviceObjectiveName	string	インポートデータベースのサービスレベル目標名。
storageKey	string	ストレージキー。
storageKeyType	StorageKeyType	ストレージキーの種類。
storageUri	string	ストレージ URI。

NetworkIsolationSettings

Object

プライベートエンドポイント接続を作成する ARM リソースが含まれています。

名前	型	説明
sqlServerResourceId	string (arm-id)	この要求のターゲットである SQL サーバーのリソース ID。設定すると、SQL サーバーのプライベートエンドポイント接続が作成されます。操作のターゲットであるサーバーと一致する必要があります。
storageAccountResourceId	string (arm-id)	BACPAC ファイルの格納に使用するストレージアカウントのリソース ID。設定すると、ストレージアカウントのプライベートエンドポイント接続が作成されます。 StorageUri パラメーターに使用されるストレージアカウントと一致する必要があります。

PrivateEndpointConnectionRequestStatus

Object

プライベートエンドポイント接続要求の状態を格納します。

名前	型	説明
privateEndpointConnectionName	string	プライベートエンドポイントの接続名。
privateLinkServiceId	string	プライベートエンドポイントが作成されるリソース ID。
status	string	このプライベートエンドポイント接続の状態。

StorageKeyType

列挙

ストレージキーの種類。

値	説明
SharedAccessKey
StorageAccessKey

次の方法で共有

Servers - Import Database

URI パラメーター

要求本文

応答

例

Imports to a new database, using private link for the SQL server and storage account.

要求のサンプル

応答のサンプル

Imports to a new database.

要求のサンプル

応答のサンプル

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ImportExportOperationResult

ImportNewDatabaseDefinition

NetworkIsolationSettings

PrivateEndpointConnectionRequestStatus

StorageKeyType