Database Extensions - Create Or Update

サービス:

SQL Database

API バージョン:

2021-11-01

データベースインポート、データベースエクスポート、ポリベースインポートなどのデータベース拡張機能操作を実行する

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/extensions/{extensionName}?api-version=2021-11-01

URI パラメーター

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

要求本文

名前	必須	型	説明
properties.operationMode	True	OperationMode	操作の操作モード: インポート、エクスポート、または PolybaseImport。
properties.storageKey	True	string	ストレージ アカウントのストレージ キー。
properties.storageKeyType	True	StorageKeyType	ストレージ キーの種類: StorageAccessKey または SharedAccessKey。
properties.storageUri	True	string	ストレージ アカウントのストレージ URI。
properties.administratorLogin		string	管理者ログイン名。
properties.administratorLoginPassword		string	管理者ログイン パスワード。
properties.authenticationType		string	認証の種類: SQL 認証または AD パスワード。
properties.databaseEdition		string	インポート操作の場合の新しく作成されたデータベースのデータベース エディション。
properties.maxSizeBytes		string	インポート操作の場合、新しく作成されたデータベースのデータベースの最大サイズ (バイト単位)。
properties.networkIsolation		NetworkIsolationSettings	要求のネットワーク分離を有効にするオプションのリソース情報。
properties.serviceObjectiveName		string	インポート操作の場合の、新しく作成されたデータベースのデータベース サービス レベルの目標。

応答

名前	型	説明
200 OK	ImportExportExtensionsOperationResult	インポート/エクスポート操作が正常に完了しました。
202 Accepted		インポート/エクスポート操作が進行中です。
Other Status Codes		エラー応答: *** 400 MissingImportExportInputParameters - ImportExport 入力パラメーターがありません。 400 InvalidImportExportInputParameter - 無効な入力パラメーターが原因でインポート/エクスポート要求が失敗しました。 400 PolybaseImportAuthenticationTypeNotSupported - 認証型パラメーターは PolybaseImport 操作をサポートしていません。 400 DatabaseExtensionsInvalidOperationMode - データベース拡張機能の operationMode パラメーターが無効です。 400 DatabaseExtensionsInvalidStorageKeyType - ストレージ キーの種類は 'StorageAccessKey' である必要があります。 400 DatabaseExtensionsMissingStorageUri - ストレージ URI を空にすることはできません。 400 InvalidSku - ユーザーが無効な SKU を指定しました。 400 InvalidTierSkuCombination - 指定されたレベルは、指定された SKU をサポートしていません。 400 DatabaseInvalidSkuPropertyCombination - 要求された SKU のプロパティに一貫性がありません。 有効な組み合わせが指定されていることをチェックしてください。 詳細については、 https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability をご覧ください。 400 InvalidMaxSizeTierCombination - 指定されたレベルは、指定されたデータベースの最大サイズをサポートしていません。 400 FeatureDisabledOnSelectedEdition - ユーザーが現在のデータベース エディションで無効になっている機能を使用しようとしました。 400 InvalidImportExportParameter - 入力パラメーターが無効なため、インポート/エクスポート要求が失敗しました。 400 InvalidTier - ユーザーが無効なレベルを指定しました。 400 InvalidOperationType - 有効な操作の種類を指定します。 400 ImportExportJobError - ImportExport 操作が失敗しました。 400 BlockedByOutboundFirewall - 送信ファイアウォール規則によって要求がブロックされました。 404 ResourceNotFound - 存在しないリソースを指定する要求が無効です。 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソース グループとサブスクリプションに存在しません。 404 ImportExportOperationIdNotFound - インポートまたはエクスポートの操作 ID が見つかりません。 404 ServerNotInSubscription - 指定されたサブスクリプションに指定されたサーバーが存在しません。 404 OperationIdNotFound - Id を持つ操作が存在しません。 409 ImportExportOperationInProgress - データベースに対してインポートまたはエクスポート操作が進行中です。 409 OperationCancelled - 操作がユーザーによって取り消されました。 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。 操作をやり直してください。 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。

例

Create or Update database extensions.

Export database using database extension.

Import database using database extension.

Create or Update database extensions.

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/a1c0814d-3c18-4e1e-a247-c128c12b1677/resourceGroups/rg_20cbe0f0-c2d9-4522-9177-5469aad53029/providers/Microsoft.Sql/servers/srv_1ffd1cf8-9951-47fb-807d-a9c384763849/databases/878e303f-1ea0-4f17-aa3d-a22ac5e9da08/extensions/polybaseimport?api-version=2021-11-01

{
  "properties": {
    "operationMode": "PolybaseImport",
    "storageKeyType": "StorageAccessKey",
    "storageKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "storageUri": "https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml"
  }
}

Java

import com.azure.resourcemanager.sql.models.DatabaseExtensions;
import com.azure.resourcemanager.sql.models.OperationMode;
import com.azure.resourcemanager.sql.models.StorageKeyType;

/**
 * Samples for DatabaseExtensionsOperation CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CreateOrUpdateDatabaseExtensions.json
     */
    /**
     * Sample code: Create or Update database extensions.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createOrUpdateDatabaseExtensions(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseExtensionsOperations().createOrUpdate(
            "rg_20cbe0f0-c2d9-4522-9177-5469aad53029", "srv_1ffd1cf8-9951-47fb-807d-a9c384763849",
            "878e303f-1ea0-4f17-aa3d-a22ac5e9da08", "polybaseimport",
            new DatabaseExtensions().withOperationMode(OperationMode.POLYBASE_IMPORT)
                .withStorageKeyType(StorageKeyType.STORAGE_ACCESS_KEY).withStorageKey("fakeTokenPlaceholder")
                .withStorageUri("https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml"),
            com.azure.core.util.Context.NONE);
    }
}

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

応答のサンプル

状態コード:

202

状態コード:

200

{
  "properties": {
    "requestId": "10000000-0000-0000-0000-000000000002",
    "requestType": "PolybaseImport",
    "lastModifiedTime": "lastModifiedTime",
    "serverName": "srv_1ffd1cf8-9951-47fb-807d-a9c384763849",
    "databaseName": "878e303f-1ea0-4f17-aa3d-a22ac5e9da08",
    "status": "succeeded"
  },
  "id": "10000000-0000-0000-0000-000000000002",
  "name": "10000000-0000-0000-0000-000000000002",
  "type": "Microsoft.Sql/servers/databases/extensions"
}

Export database using database extension.

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/0ca8cd24-0b47-4ad5-bc7e-d70e35c44adf/resourceGroups/rg_d1ef9eae-044d-4710-ba59-b82e84ad3157/providers/Microsoft.Sql/servers/srv_9243d320-ac4e-4f97-8e06-b1167dae5f4c/databases/db_7fe424c8-23cf-4ac3-bdc3-e21f424bdb68/extensions/Export?api-version=2021-11-01

{
  "properties": {
    "operationMode": "Export",
    "storageKeyType": "StorageAccessKey",
    "storageKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "storageUri": "https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml",
    "administratorLogin": "login",
    "administratorLoginPassword": "password",
    "authenticationType": "Sql"
  }
}

Java

import com.azure.resourcemanager.sql.models.DatabaseExtensions;
import com.azure.resourcemanager.sql.models.OperationMode;
import com.azure.resourcemanager.sql.models.StorageKeyType;

/**
 * Samples for DatabaseExtensionsOperation CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ExportDatabaseUsingDatabaseExtensions
     * .json
     */
    /**
     * Sample code: Export database using database extension.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void exportDatabaseUsingDatabaseExtension(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseExtensionsOperations().createOrUpdate(
            "rg_d1ef9eae-044d-4710-ba59-b82e84ad3157", "srv_9243d320-ac4e-4f97-8e06-b1167dae5f4c",
            "db_7fe424c8-23cf-4ac3-bdc3-e21f424bdb68", "Export",
            new DatabaseExtensions().withOperationMode(OperationMode.EXPORT)
                .withStorageKeyType(StorageKeyType.STORAGE_ACCESS_KEY).withStorageKey("fakeTokenPlaceholder")
                .withStorageUri("https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml")
                .withAdministratorLogin("login").withAdministratorLoginPassword("fakeTokenPlaceholder")
                .withAuthenticationType("Sql"),
            com.azure.core.util.Context.NONE);
    }
}

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": "10000000-0000-0000-0000-000000000002",
    "requestType": "Export",
    "lastModifiedTime": "lastModifiedTime",
    "serverName": "srv_9243d320-ac4e-4f97-8e06-b1167dae5f4c",
    "databaseName": "db_7fe424c8-23cf-4ac3-bdc3-e21f424bdb68",
    "status": "Completed",
    "queuedTime": "09/10/2021 18:35:10",
    "blobUri": "https://teststorage.blob.core.windows.net/testcontainer/samplebacpac.bacpac",
    "privateEndpointConnections": []
  },
  "id": "10000000-0000-0000-0000-000000000002",
  "name": "10000000-0000-0000-0000-000000000002",
  "type": "Microsoft.Sql/servers/databases/extensions"
}

状態コード:

202

Import database using database extension.

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/17ca4d13-bf7d-4c33-a60e-b87a2820a325/resourceGroups/rg_062866bf-c4f4-41f9-abf0-b59132ca7924/providers/Microsoft.Sql/servers/srv_2d6be2d2-26c8-4930-8fb6-82a5e95e0e82/databases/db_2a47e946-e414-4c00-94ac-ed886bb78302/extensions/Import?api-version=2021-11-01

{
  "properties": {
    "operationMode": "Import",
    "storageKeyType": "StorageAccessKey",
    "storageKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "storageUri": "https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml",
    "administratorLogin": "login",
    "administratorLoginPassword": "password",
    "authenticationType": "Sql"
  }
}

Java

import com.azure.resourcemanager.sql.models.DatabaseExtensions;
import com.azure.resourcemanager.sql.models.OperationMode;
import com.azure.resourcemanager.sql.models.StorageKeyType;

/**
 * Samples for DatabaseExtensionsOperation CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ImportDatabaseUsingDatabaseExtensions
     * .json
     */
    /**
     * Sample code: Import database using database extension.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void importDatabaseUsingDatabaseExtension(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseExtensionsOperations().createOrUpdate(
            "rg_062866bf-c4f4-41f9-abf0-b59132ca7924", "srv_2d6be2d2-26c8-4930-8fb6-82a5e95e0e82",
            "db_2a47e946-e414-4c00-94ac-ed886bb78302", "Import",
            new DatabaseExtensions().withOperationMode(OperationMode.IMPORT)
                .withStorageKeyType(StorageKeyType.STORAGE_ACCESS_KEY).withStorageKey("fakeTokenPlaceholder")
                .withStorageUri("https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml")
                .withAdministratorLogin("login").withAdministratorLoginPassword("fakeTokenPlaceholder")
                .withAuthenticationType("Sql"),
            com.azure.core.util.Context.NONE);
    }
}

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": "10000000-0000-0000-0000-000000000002",
    "requestType": "Import",
    "lastModifiedTime": "lastModifiedTime",
    "serverName": "srv_2d6be2d2-26c8-4930-8fb6-82a5e95e0e82",
    "databaseName": "db_2a47e946-e414-4c00-94ac-ed886bb78302",
    "status": "Completed",
    "queuedTime": "09/10/2021 18:35:10",
    "blobUri": "https://teststorage.blob.core.windows.net/testcontainer/samplebacpac.bacpac",
    "privateEndpointConnections": []
  },
  "id": "10000000-0000-0000-0000-000000000002",
  "name": "10000000-0000-0000-0000-000000000002",
  "type": "Microsoft.Sql/servers/databases/extensions"
}

状態コード:

202

定義

名前	説明
DatabaseExtensions	Import、Export、または PolybaseImport リソース。
ImportExportExtensionsOperationResult	拡張機能操作の結果リソース。
NetworkIsolationSettings	プライベート エンドポイント接続を作成する ARM リソースが含まれます。
OperationMode	操作の操作モード: インポート、エクスポート、または PolybaseImport。
PrivateEndpointConnectionRequestStatus	プライベート エンドポイント接続要求の状態を格納します。
StorageKeyType	ストレージ キーの種類: StorageAccessKey または SharedAccessKey。

DatabaseExtensions

Import、Export、または PolybaseImport リソース。

名前	型	説明
id	string	リソースの ID
name	string	リソース名。
properties.administratorLogin	string	管理者ログイン名。
properties.administratorLoginPassword	string	管理者ログイン パスワード。
properties.authenticationType	string	認証の種類: SQL 認証または AD パスワード。
properties.databaseEdition	string	インポート操作の場合の新しく作成されたデータベースのデータベース エディション。
properties.maxSizeBytes	string	インポート操作の場合、新しく作成されたデータベースのデータベースの最大サイズ (バイト単位)。
properties.networkIsolation	NetworkIsolationSettings	要求のネットワーク分離を有効にするオプションのリソース情報。
properties.operationMode	OperationMode	操作の操作モード: インポート、エクスポート、または PolybaseImport。
properties.serviceObjectiveName	string	インポート操作の場合の、新しく作成されたデータベースのデータベース サービス レベルの目標。
properties.storageKey	string	ストレージ アカウントのストレージ キー。
properties.storageKeyType	StorageKeyType	ストレージ キーの種類: StorageAccessKey または SharedAccessKey。
properties.storageUri	string	ストレージ アカウントのストレージ URI。
type	string	リソースの種類。

ImportExportExtensionsOperationResult

拡張機能操作の結果リソース。

名前	型	説明
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	要求 ID。
properties.requestType	string	要求の種類。
properties.serverName	string	サーバー名。
properties.status	string	操作の状態。
type	string	リソースの種類。

NetworkIsolationSettings

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

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

OperationMode

操作の操作モード: インポート、エクスポート、または PolybaseImport。

名前	型	説明
Export	string
Import	string
PolybaseImport	string

PrivateEndpointConnectionRequestStatus

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

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

StorageKeyType

ストレージ キーの種類: StorageAccessKey または SharedAccessKey。

名前	型	説明
SharedAccessKey	string
StorageAccessKey	string