Database Extensions - Create Or Update

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

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

URI パラメーター

名前 / 必須 説明
databaseName
path True

string

データベースの名前。

extensionName
path True

string

resourceGroupName
path True

string

minLength: 1
maxLength: 90

リソース グループの名前。 名前の大文字と小文字は区別されません。

serverName
path True

string

サーバーの名前。

subscriptionId
path True

string (uuid)

ターゲット サブスクリプションの ID。 値は UUID である必要があります。

api-version
query True

string

minLength: 1

この操作に使用する API バージョン。

要求本文

名前 必須 説明
properties.operationMode True

OperationMode

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

properties.storageKey True

string

ストレージ アカウントのストレージ キー。 StorageKeyType が ManagedIdentity の場合、このフィールドにはマネージド ID のリソース ID を指定する必要があります。

properties.storageKeyType True

StorageKeyType

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

properties.storageUri True

string

ストレージ アカウントのストレージ URI。

properties.administratorLogin

string

管理者ログイン名。 AuthenticationType が ManagedIdentity の場合、このフィールドにはマネージド ID のリソース ID を指定する必要があります。

properties.administratorLoginPassword

string (password)

管理者ログイン パスワード。 AuthenticationType が ManagedIdentity の場合、このフィールドは指定しないでください。

properties.authenticationType

string

SQL にアクセスするために使用される認証の種類: Sql、ADPassword、または ManagedIdentity。

properties.databaseEdition

string

インポート操作の場合の新しく作成されたデータベースのデータベース エディション。

properties.maxSizeBytes

string

インポート操作の場合の新しく作成されたデータベースのデータベースの最大サイズ (バイト単位)。

properties.networkIsolation

NetworkIsolationSettings

要求のネットワーク分離を有効にするオプションのリソース情報。

properties.serviceObjectiveName

string

インポート操作の場合の、新しく作成されたデータベースのデータベース サービス レベルの目標。

応答

名前 説明
200 OK

ImportExportExtensionsOperationResult

リソース「ImportExportExtensionsOperationResult」更新操作が成功しました

202 Accepted

リソース操作が受け入れられます。

ヘッダー

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

Create or Update database extensions.
Export database using database extension with Managed Identity.
Export database using database extension.
Import database using database extension.

Create or Update database extensions.

要求のサンプル

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=2025-01-01

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

応答のサンプル

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

Export database using database extension with Managed Identity.

要求のサンプル

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=2025-01-01

{
  "properties": {
    "administratorLogin": "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName",
    "authenticationType": "ManagedIdentity",
    "operationMode": "Export",
    "storageKey": "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName",
    "storageKeyType": "ManagedIdentity",
    "storageUri": "https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml"
  }
}

応答のサンプル

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

Export database using database extension.

要求のサンプル

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=2025-01-01

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

応答のサンプル

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

Import database using database extension.

要求のサンプル

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=2025-01-01

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

応答のサンプル

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

定義

名前 説明
createdByType

リソースを作成した ID の種類。

DatabaseExtensions

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

ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

ImportExportExtensionsOperationResult

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

NetworkIsolationSettings

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

OperationMode

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

PrivateEndpointConnectionRequestStatus

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

StorageKeyType

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

systemData

リソースの作成と最後の変更に関連するメタデータ。

createdByType

リソースを作成した ID の種類。

説明
User
Application
ManagedIdentity
Key

DatabaseExtensions

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

名前 説明
id

string (arm-id)

リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

リソースの名前

properties.administratorLogin

string

管理者ログイン名。 AuthenticationType が ManagedIdentity の場合、このフィールドにはマネージド ID のリソース ID を指定する必要があります。

properties.administratorLoginPassword

string (password)

管理者ログイン パスワード。 AuthenticationType が ManagedIdentity の場合、このフィールドは指定しないでください。

properties.authenticationType

string

SQL にアクセスするために使用される認証の種類: Sql、ADPassword、または ManagedIdentity。

properties.databaseEdition

string

インポート操作の場合の新しく作成されたデータベースのデータベース エディション。

properties.maxSizeBytes

string

インポート操作の場合の新しく作成されたデータベースのデータベースの最大サイズ (バイト単位)。

properties.networkIsolation

NetworkIsolationSettings

要求のネットワーク分離を有効にするオプションのリソース情報。

properties.operationMode

OperationMode

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

properties.serviceObjectiveName

string

インポート操作の場合の、新しく作成されたデータベースのデータベース サービス レベルの目標。

properties.storageKey

string

ストレージ アカウントのストレージ キー。 StorageKeyType が ManagedIdentity の場合、このフィールドにはマネージド ID のリソース ID を指定する必要があります。

properties.storageKeyType

StorageKeyType

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

properties.storageUri

string

ストレージ アカウントのストレージ URI。

systemData

systemData

create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。

type

string

リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細。

message

string

エラー メッセージ。

target

string

エラーターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

エラー オブジェクト。

ImportExportExtensionsOperationResult

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

名前 説明
id

string (arm-id)

リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

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

操作の状態。

systemData

systemData

create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。

type

string

リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

NetworkIsolationSettings

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

名前 説明
sqlServerResourceId

string (arm-id)

この要求のターゲットである SQL サーバーのリソース ID。 設定すると、SQL サーバーのプライベート エンドポイント接続が作成されます。 操作のターゲットであるサーバーと一致する必要があります。

storageAccountResourceId

string (arm-id)

BACPAC ファイルの格納に使用するストレージ アカウントのリソース ID。 設定すると、ストレージ アカウントのプライベート エンドポイント接続が作成されます。 StorageUri パラメーターに使用されるストレージ アカウントと一致する必要があります。

OperationMode

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

説明
PolybaseImport

Polybaseインポート

Import

Import

Export

輸出

PrivateEndpointConnectionRequestStatus

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

名前 説明
privateEndpointConnectionName

string

プライベート エンドポイントの接続名。

privateLinkServiceId

string

プライベート エンドポイントが作成されるリソース ID。

status

string

このプライベート エンドポイント接続の状態。

StorageKeyType

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

説明
SharedAccessKey

共有アクセスキー

StorageAccessKey

StorageAccessKey

ManagedIdentity

ManagedIdentity

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前 説明
createdAt

string (date-time)

リソース作成のタイムスタンプ (UTC)。

createdBy

string

リソースを作成した ID。

createdByType

createdByType

リソースを作成した ID の種類。

lastModifiedAt

string (date-time)

リソースの最終変更のタイムスタンプ (UTC)

lastModifiedBy

string

リソースを最後に変更した ID。

lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。