Databases - Export

服務:

SQL Database

API 版本:

2025-01-01

匯出資料庫。

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

URI 參數

名稱	位於	必要	類型	Description
databaseName	path	True	string	資料庫的名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
administratorLogin	True	string	系統管理員登入名稱。 如果 AuthenticationType 是 ManagedIdentity，此欄位應該指定受控識別的資源識別碼。
storageKey	True	string	儲存體帳戶的記憶體金鑰。 如果 StorageKeyType 是 ManagedIdentity，此欄位應該指定受控識別的資源標識符。
storageKeyType	True	StorageKeyType	儲存器密鑰類型：StorageAccessKey、SharedAccessKey 或 ManagedIdentity。
storageUri	True	string	儲存體 Uri。
administratorLoginPassword		string (password)	系統管理員登入密碼。 如果 AuthenticationType 是 ManagedIdentity，則不應該指定此字段。
authenticationType		string	提供給存取目標 SQL Server 的認證類型：SQL、ADPassword 或 ManagedIdentity。
networkIsolation		NetworkIsolationSettings	選擇性的資源資訊，可啟用要求的網路隔離。

回應

名稱	類型	Description
200 OK	ImportExportOperationResult	Azure 運作順利完成。
202 Accepted		已接受資源作業。 標題 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow.

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Exports a database, using Managed Identity to communicate with SQL server and storage account.

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

Exports a database.

Exports a database, using Managed Identity to communicate with SQL server and storage account.

範例要求

HTTP

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

{
  "administratorLogin": "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName",
  "authenticationType": "ManagedIdentity",
  "storageKey": "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName",
  "storageKeyType": "ManagedIdentity",
  "storageUri": "https://test.blob.core.windows.net/test.bacpac"
}

dotnet

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/SQL/stable/2025-01-01/examples/ExportDatabaseWithManagedIdentity.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://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 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.ManagedIdentity, "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", new Uri("https://test.blob.core.windows.net/test.bacpac"), "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName")
{
    AuthenticationType = "ManagedIdentity",
};
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

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

狀態碼:

202

Location: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Sql/locations/japaneast/importExportOperationResults/00000000-0000-0000-0000-000000000000

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

範例要求

HTTP

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

{
  "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"
  },
  "storageKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx==",
  "storageKeyType": "StorageAccessKey",
  "storageUri": "https://test.blob.core.windows.net/test.bacpac"
}

dotnet

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/SQL/stable/2025-01-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://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 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")
{
    AdministratorLoginPassword = "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

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

狀態碼:

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

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

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

dotnet

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/SQL/stable/2025-01-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://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 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")
{
    AdministratorLoginPassword = "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

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

狀態碼:

202

Location: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Sql/locations/japaneast/importExportOperationResults/00000000-0000-0000-0000-000000000000

定義

名稱	Description
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤附加資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	錯誤回應
ExportDatabaseDefinition	包含執行匯出資料庫作業所需的資訊。
ImportExportOperationResult	ImportExport 作業結果資源。
NetworkIsolationSettings	包含用來建立私人端點連線的 ARM 資源。
PrivateEndpointConnectionRequestStatus	包含私人端點連線要求狀態。
StorageKeyType	儲存器密鑰類型：StorageAccessKey、SharedAccessKey 或 ManagedIdentity。
systemData	與建立和上次修改資源相關的元數據。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

資源管理錯誤附加資訊。

名稱	類型	Description
info	object	附加資訊。
type	string	其他資訊類型。

ErrorDetail

Object

錯誤詳細資料。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤附加資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

ExportDatabaseDefinition

Object

包含執行匯出資料庫作業所需的資訊。

名稱	類型	Description
administratorLogin	string	系統管理員登入名稱。 如果 AuthenticationType 是 ManagedIdentity，此欄位應該指定受控識別的資源識別碼。
administratorLoginPassword	string (password)	系統管理員登入密碼。 如果 AuthenticationType 是 ManagedIdentity，則不應該指定此字段。
authenticationType	string	提供給存取目標 SQL Server 的認證類型：SQL、ADPassword 或 ManagedIdentity。
networkIsolation	NetworkIsolationSettings	選擇性的資源資訊，可啟用要求的網路隔離。
storageKey	string	儲存體帳戶的記憶體金鑰。 如果 StorageKeyType 是 ManagedIdentity，此欄位應該指定受控識別的資源標識符。
storageKeyType	StorageKeyType	儲存器密鑰類型：StorageAccessKey、SharedAccessKey 或 ManagedIdentity。
storageUri	string	儲存體 Uri。

ImportExportOperationResult

Object

ImportExport 作業結果資源。

名稱	類型	Description
id	string (arm-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)	要求標識碼。
properties.requestType	string	要求類型。
properties.serverName	string	伺服器名稱。
properties.status	string	作業狀態。
systemData	systemData	Azure Resource Manager 包含 createdBy 與 modifiedBy 資訊的元資料。
type	string	資源的類型。 例如：「Microsoft。運算/虛擬機器」或「Microsoft」。儲存/儲存帳號」

NetworkIsolationSettings

Object

包含用來建立私人端點連線的 ARM 資源。

名稱	類型	Description
sqlServerResourceId	string (arm-id)	SQL Server 的資源標識碼，這是此要求的目標。 如果設定，將會為 SQL Server 建立私人端點連線。 必須符合作業目標的伺服器。
storageAccountResourceId	string (arm-id)	用來儲存 BACPAC 檔案之記憶體帳戶的資源識別碼。 如果設定，將會為記憶體帳戶建立私人端點連線。 必須符合 StorageUri 參數所使用的記憶體帳戶。

PrivateEndpointConnectionRequestStatus

Object

包含私人端點連線要求狀態。

名稱	類型	Description
privateEndpointConnectionName	string	私人端點的連接名稱。
privateLinkServiceId	string	建立私人端點的資源標識碼。
status	string	此私人端點連線的狀態。

StorageKeyType

列舉型別

儲存器密鑰類型：StorageAccessKey、SharedAccessKey 或 ManagedIdentity。

值	Description
SharedAccessKey	共用存取金鑰
StorageAccessKey	StorageAccessKey
ManagedIdentity	ManagedIdentity

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	資源上次修改的時間戳記 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。