你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Database Extensions - Create Or Update

Service:

SQL Database

API Version:

2021-11-01

执行数据库扩展操作，例如数据库导入、数据库导出或 polybase 导入

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 操作中断 - 无法完成对资源的操作，因为它被同一资源上的另一个操作中断。 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.

Sample Request

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.core.util.Context;
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"),
            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

Sample Response

Status code:

202

Status code:

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.

Sample Request

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.core.util.Context;
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"),
            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

Sample Response

Status code:

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"
}

Status code:

202

Import database using database extension.

Sample Request

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.core.util.Context;
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"),
            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

Sample Response

Status code:

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"
}

Status code:

202

定义

名称	说明
DatabaseExtensions	导入、导出或 PolybaseImport 资源。
ImportExportExtensionsOperationResult	扩展操作结果资源。
NetworkIsolationSettings	包含要为其创建专用终结点连接的 ARM 资源。
OperationMode	操作的操作模式：导入、导出或 PolybaseImport。
PrivateEndpointConnectionRequestStatus	包含专用终结点连接请求状态。
StorageKeyType	存储密钥类型：StorageAccessKey 或 SharedAccessKey。

DatabaseExtensions

导入、导出或 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 Server 的资源 ID，该服务器是此请求的目标。 如果设置，将为 SQL Server 创建专用终结点连接。 必须与操作的目标服务器匹配。
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