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

Databases - Export

服务:: SQL Database

API 版本:: 2023-08-01

导出数据库。

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

URI 参数

名称	在	必需	类型	说明
databaseName	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 版本。

请求正文

名称	必需	类型	说明
administratorLogin	True	string	管理员登录名。
administratorLoginPassword	True	string	管理员登录密码。
storageKey	True	string	存储密钥。
storageKeyType	True	StorageKeyType	存储密钥类型。
storageUri	True	string	存储 URI。
authenticationType		string	身份验证类型。
networkIsolation		NetworkIsolationSettings	用于为请求启用网络隔离的可选资源信息。

响应

名称	类型	说明
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 - ImportExport作失败，因为 sql 身份验证类型无效 400 BlobAlreadyExist - ImportExport作失败，因为存储 Blob 已存在 400 InvalidImportExportOperationResourceLocks - 由于专用链接资源的锁定，导入/导出请求无效。 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 - ImportExport作失败，因为存储 URI 无效 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 - ImportExport作失败，因为 sql 身份验证类型无效
400 BlobAlreadyExist - ImportExport作失败，因为存储 Blob 已存在
400 InvalidImportExportOperationResourceLocks - 由于专用链接资源的锁定，导入/导出请求无效。
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 - ImportExport作失败，因为存储 URI 无效
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 - 请求超出可用资源可以处理的最大请求数。

示例

Exports a database, using private link to communicate with SQL server and storage account.

Exports a database.

Exports a database, using private link to communicate with 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/databases/testdb/export?api-version=2023-08-01

{
  "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.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ExportDatabaseWithNetworkIsolation.json
// this example is just showing the usage of "Databases_Export" 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://free.blessedness.top/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 SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
string databaseName = "testdb";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation
DatabaseExportDefinition databaseExportDefinition = new DatabaseExportDefinition(StorageKeyType.StorageAccessKey, "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==", new Uri("https://test.blob.core.windows.net/test.bacpac"), "login", "password")
{
    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 sqlDatabase.ExportAsync(WaitUntil.Completed, databaseExportDefinition);
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": "Export",
    "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: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Sql/locations/japaneast/importExportOperationResults/00000000-0000-0000-0000-000000000000

Exports a database.

示例请求

HTTP
dotnet

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

{
  "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.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ExportDatabase.json
// this example is just showing the usage of "Databases_Export" 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://free.blessedness.top/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 SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
string databaseName = "testdb";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation
DatabaseExportDefinition databaseExportDefinition = new DatabaseExportDefinition(StorageKeyType.StorageAccessKey, "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==", new Uri("https://test.blob.core.windows.net/test.bacpac"), "login", "password")
{
    AuthenticationType = "Sql",
};
ArmOperation<ImportExportOperationResult> lro = await sqlDatabase.ExportAsync(WaitUntil.Completed, databaseExportDefinition);
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": "Export",
    "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: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Sql/locations/japaneast/importExportOperationResults/00000000-0000-0000-0000-000000000000

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ExportDatabaseDefinition	包含执行导出数据库作所需的信息。
ImportExportOperationResult	ImportExport作结果资源。
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	错误对象。

ExportDatabaseDefinition

Object

包含执行导出数据库作所需的信息。

名称	类型	说明
administratorLogin	string	管理员登录名。
administratorLoginPassword	string	管理员登录密码。
authenticationType	string	身份验证类型。
networkIsolation	NetworkIsolationSettings	用于为请求启用网络隔离的可选资源信息。
storageKey	string	存储密钥。
storageKeyType	StorageKeyType	存储密钥类型。
storageUri	string	存储 URI。

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	资源类型。

NetworkIsolationSettings

Object

包含要为其创建专用终结点连接的 ARM 资源。

名称	类型	说明
sqlServerResourceId	string (arm-id)	SQL Server 的资源 ID，这是此请求的目标。如果设置，将为 SQL Server 创建专用终结点连接。必须与作的目标服务器匹配。
storageAccountResourceId	string (arm-id)	用于存储 BACPAC 文件的存储帐户的资源 ID。如果设置，将为存储帐户创建专用终结点连接。必须与用于 StorageUri 参数的存储帐户匹配。

PrivateEndpointConnectionRequestStatus

Object

包含专用终结点连接请求状态。

名称	类型	说明
privateEndpointConnectionName	string	专用终结点的连接名称。
privateLinkServiceId	string	为其创建专用终结点的资源 ID。
status	string	此专用终结点连接的状态。

StorageKeyType

枚举

存储密钥类型。

值	说明
SharedAccessKey
StorageAccessKey

通过

Databases - Export

URI 参数

请求正文

响应

示例

Exports a database, using private link to communicate with SQL server and storage account.

示例请求

示例响应

Exports a database.

示例请求

示例响应

定义

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExportDatabaseDefinition

ImportExportOperationResult

NetworkIsolationSettings

PrivateEndpointConnectionRequestStatus

StorageKeyType