Database Extensions - Create Or Update

Service:: SQL Database

Versione API:: 2025-01-01

Eseguire un'operazione di estensione del database, ad esempio l'importazione di database, l'esportazione di database o l'importazione polybase

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
databaseName	path	True	string	Nome del database.
extensionName	path	True	string
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
serverName	path	True	string	Il nome del server.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties.operationMode	True	OperationMode	Modalità operativa dell'operazione: Importazione, Esportazione o PolybaseImport.
properties.storageKey	True	string	Chiave di archiviazione per l'account di archiviazione. Se StorageKeyType è ManagedIdentity, questo campo deve specificare l'ID risorsa dell'identità gestita.
properties.storageKeyType	True	StorageKeyType	Tipo di chiave di archiviazione: StorageAccessKey, SharedAccessKey o ManagedIdentity.
properties.storageUri	True	string	URI di archiviazione per l'account di archiviazione.
properties.administratorLogin		string	Nome di accesso dell'amministratore. Se AuthenticationType è ManagedIdentity, questo campo deve specificare l'ID risorsa dell'identità gestita.
properties.administratorLoginPassword		string (password)	Password di accesso dell'amministratore. Se AuthenticationType è ManagedIdentity, questo campo non deve essere specificato.
properties.authenticationType		string	Tipo di autenticazione usato per accedere a SQL: Sql, ADPassword o ManagedIdentity.
properties.databaseEdition		string	Edizione di database per il database appena creato nel caso di un'operazione di importazione.
properties.maxSizeBytes		string	Dimensioni massime del database in byte per il database appena creato nel caso di un'operazione di importazione.
properties.networkIsolation		NetworkIsolationSettings	Informazioni facoltative sulle risorse per abilitare l'isolamento di rete per la richiesta.
properties.serviceObjectiveName		string	Obiettivo del livello di servizio del database per il database appena creato nel caso di un'operazione di importazione.

Risposte

Nome	Tipo	Descrizione
200 OK	ImportExportExtensionsOperationResult	Risorsa 'ImportExportExtensionsOperationResult' con successo
202 Accepted		Operazione sulle risorse accettata. Intestazioni Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Nome

Tipo

Descrizione

200 OK

ImportExportExtensionsOperationResult

Risorsa 'ImportExportExtensionsOperationResult' con successo

202 Accepted

Operazione sulle risorse accettata.

Intestazioni

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Risposta di errore imprevista.

Sicurezza

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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.

Esempio di richiesta

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


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: 2025-01-01/CreateOrUpdateDatabaseExtensions.json
     */
    /**
     * Sample code: Create or Update database extensions.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void createOrUpdateDatabaseExtensions(com.azure.resourcemanager.sql.SqlServerManager manager) {
        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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python create_or_update_database_extensions.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.database_extensions.begin_create_or_update(
        resource_group_name="rg_20cbe0f0-c2d9-4522-9177-5469aad53029",
        server_name="srv_1ffd1cf8-9951-47fb-807d-a9c384763849",
        database_name="878e303f-1ea0-4f17-aa3d-a22ac5e9da08",
        extension_name="polybaseimport",
        parameters={
            "properties": {
                "operationMode": "PolybaseImport",
                "storageKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
                "storageKeyType": "StorageAccessKey",
                "storageUri": "https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/CreateOrUpdateDatabaseExtensions.json
if __name__ == "__main__":
    main()

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

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to perform a database extension operation, like database import, database export, or polybase import
 *
 * @summary perform a database extension operation, like database import, database export, or polybase import
 * x-ms-original-file: 2025-01-01/CreateOrUpdateDatabaseExtensions.json
 */
async function createOrUpdateDatabaseExtensions() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "a1c0814d-3c18-4e1e-a247-c128c12b1677";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.databaseExtensionsOperations.createOrUpdate(
    "rg_20cbe0f0-c2d9-4522-9177-5469aad53029",
    "srv_1ffd1cf8-9951-47fb-807d-a9c384763849",
    "878e303f-1ea0-4f17-aa3d-a22ac5e9da08",
    "polybaseimport",
    {
      operationMode: "PolybaseImport",
      storageKey:
        "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      storageKeyType: "StorageAccessKey",
      storageUri: "https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml",
    },
  );
  console.log(result);
}

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

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/CreateOrUpdateDatabaseExtensions.json
// this example is just showing the usage of "DatabaseExtensions_CreateOrUpdate" 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 = "a1c0814d-3c18-4e1e-a247-c128c12b1677";
string resourceGroupName = "rg_20cbe0f0-c2d9-4522-9177-5469aad53029";
string serverName = "srv_1ffd1cf8-9951-47fb-807d-a9c384763849";
string databaseName = "878e303f-1ea0-4f17-aa3d-a22ac5e9da08";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation
string extensionName = "polybaseimport";
SqlDatabaseExtension sqlDatabaseExtension = new SqlDatabaseExtension
{
    OperationMode = DatabaseExtensionOperationMode.PolybaseImport,
    StorageKeyType = StorageKeyType.StorageAccessKey,
    StorageKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    StorageUri = new Uri("https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml"),
};
ArmOperation<ImportExportExtensionsOperationResult> lro = await sqlDatabase.CreateOrUpdateDatabaseExtensionAsync(WaitUntil.Completed, extensionName, sqlDatabaseExtension);
ImportExportExtensionsOperationResult 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

Risposta di esempio

Codice di stato:: 200

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

Codice di stato:: 202

Export database using database extension with Managed Identity.

Esempio di richiesta

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


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: 2025-01-01/ExportDatabaseUsingDatabaseExtensionsWithManagedIdentity.json
     */
    /**
     * Sample code: Export database using database extension with Managed Identity.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void exportDatabaseUsingDatabaseExtensionWithManagedIdentity(
        com.azure.resourcemanager.sql.SqlServerManager manager) {
        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.MANAGED_IDENTITY).withStorageKey("fakeTokenPlaceholder")
                .withStorageUri("https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml")
                .withAdministratorLogin(
                    "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName")
                .withAuthenticationType("ManagedIdentity"),
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python export_database_using_database_extensions_with_managed_identity.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.database_extensions.begin_create_or_update(
        resource_group_name="rg_d1ef9eae-044d-4710-ba59-b82e84ad3157",
        server_name="srv_9243d320-ac4e-4f97-8e06-b1167dae5f4c",
        database_name="db_7fe424c8-23cf-4ac3-bdc3-e21f424bdb68",
        extension_name="Export",
        parameters={
            "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",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/ExportDatabaseUsingDatabaseExtensionsWithManagedIdentity.json
if __name__ == "__main__":
    main()

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

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to perform a database extension operation, like database import, database export, or polybase import
 *
 * @summary perform a database extension operation, like database import, database export, or polybase import
 * x-ms-original-file: 2025-01-01/ExportDatabaseUsingDatabaseExtensionsWithManagedIdentity.json
 */
async function exportDatabaseUsingDatabaseExtensionWithManagedIdentity() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "0ca8cd24-0b47-4ad5-bc7e-d70e35c44adf";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.databaseExtensionsOperations.createOrUpdate(
    "rg_d1ef9eae-044d-4710-ba59-b82e84ad3157",
    "srv_9243d320-ac4e-4f97-8e06-b1167dae5f4c",
    "db_7fe424c8-23cf-4ac3-bdc3-e21f424bdb68",
    "Export",
    {
      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",
    },
  );
  console.log(result);
}

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

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/ExportDatabaseUsingDatabaseExtensionsWithManagedIdentity.json
// this example is just showing the usage of "DatabaseExtensions_CreateOrUpdate" 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 = "0ca8cd24-0b47-4ad5-bc7e-d70e35c44adf";
string resourceGroupName = "rg_d1ef9eae-044d-4710-ba59-b82e84ad3157";
string serverName = "srv_9243d320-ac4e-4f97-8e06-b1167dae5f4c";
string databaseName = "db_7fe424c8-23cf-4ac3-bdc3-e21f424bdb68";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation
string extensionName = "Export";
SqlDatabaseExtension sqlDatabaseExtension = new SqlDatabaseExtension
{
    OperationMode = DatabaseExtensionOperationMode.Export,
    StorageKeyType = StorageKeyType.ManagedIdentity,
    StorageKey = "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName",
    StorageUri = new Uri("https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml"),
    AdministratorLogin = "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName",
    AuthenticationType = "ManagedIdentity",
};
ArmOperation<ImportExportExtensionsOperationResult> lro = await sqlDatabase.CreateOrUpdateDatabaseExtensionAsync(WaitUntil.Completed, extensionName, sqlDatabaseExtension);
ImportExportExtensionsOperationResult 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

Risposta di esempio

Codice di stato:: 200

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

Codice di stato:: 202

Export database using database extension.

Esempio di richiesta

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


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: 2025-01-01/ExportDatabaseUsingDatabaseExtensions.json
     */
    /**
     * Sample code: Export database using database extension.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void exportDatabaseUsingDatabaseExtension(com.azure.resourcemanager.sql.SqlServerManager manager) {
        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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python export_database_using_database_extensions.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.database_extensions.begin_create_or_update(
        resource_group_name="rg_d1ef9eae-044d-4710-ba59-b82e84ad3157",
        server_name="srv_9243d320-ac4e-4f97-8e06-b1167dae5f4c",
        database_name="db_7fe424c8-23cf-4ac3-bdc3-e21f424bdb68",
        extension_name="Export",
        parameters={
            "properties": {
                "administratorLogin": "login",
                "administratorLoginPassword": "password",
                "authenticationType": "Sql",
                "operationMode": "Export",
                "storageKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
                "storageKeyType": "StorageAccessKey",
                "storageUri": "https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/ExportDatabaseUsingDatabaseExtensions.json
if __name__ == "__main__":
    main()

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

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to perform a database extension operation, like database import, database export, or polybase import
 *
 * @summary perform a database extension operation, like database import, database export, or polybase import
 * x-ms-original-file: 2025-01-01/ExportDatabaseUsingDatabaseExtensions.json
 */
async function exportDatabaseUsingDatabaseExtension() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "0ca8cd24-0b47-4ad5-bc7e-d70e35c44adf";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.databaseExtensionsOperations.createOrUpdate(
    "rg_d1ef9eae-044d-4710-ba59-b82e84ad3157",
    "srv_9243d320-ac4e-4f97-8e06-b1167dae5f4c",
    "db_7fe424c8-23cf-4ac3-bdc3-e21f424bdb68",
    "Export",
    {
      administratorLogin: "login",
      administratorLoginPassword: "password",
      authenticationType: "Sql",
      operationMode: "Export",
      storageKey:
        "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      storageKeyType: "StorageAccessKey",
      storageUri: "https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml",
    },
  );
  console.log(result);
}

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

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/ExportDatabaseUsingDatabaseExtensions.json
// this example is just showing the usage of "DatabaseExtensions_CreateOrUpdate" 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 = "0ca8cd24-0b47-4ad5-bc7e-d70e35c44adf";
string resourceGroupName = "rg_d1ef9eae-044d-4710-ba59-b82e84ad3157";
string serverName = "srv_9243d320-ac4e-4f97-8e06-b1167dae5f4c";
string databaseName = "db_7fe424c8-23cf-4ac3-bdc3-e21f424bdb68";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation
string extensionName = "Export";
SqlDatabaseExtension sqlDatabaseExtension = new SqlDatabaseExtension
{
    OperationMode = DatabaseExtensionOperationMode.Export,
    StorageKeyType = StorageKeyType.StorageAccessKey,
    StorageKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    StorageUri = new Uri("https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml"),
    AdministratorLogin = "login",
    AdministratorLoginPassword = "password",
    AuthenticationType = "Sql",
};
ArmOperation<ImportExportExtensionsOperationResult> lro = await sqlDatabase.CreateOrUpdateDatabaseExtensionAsync(WaitUntil.Completed, extensionName, sqlDatabaseExtension);
ImportExportExtensionsOperationResult 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

Risposta di esempio

Codice di stato:: 200

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

Codice di stato:: 202

Import database using database extension.

Esempio di richiesta

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


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: 2025-01-01/ImportDatabaseUsingDatabaseExtensions.json
     */
    /**
     * Sample code: Import database using database extension.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void importDatabaseUsingDatabaseExtension(com.azure.resourcemanager.sql.SqlServerManager manager) {
        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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python import_database_using_database_extensions.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.database_extensions.begin_create_or_update(
        resource_group_name="rg_062866bf-c4f4-41f9-abf0-b59132ca7924",
        server_name="srv_2d6be2d2-26c8-4930-8fb6-82a5e95e0e82",
        database_name="db_2a47e946-e414-4c00-94ac-ed886bb78302",
        extension_name="Import",
        parameters={
            "properties": {
                "administratorLogin": "login",
                "administratorLoginPassword": "password",
                "authenticationType": "Sql",
                "operationMode": "Import",
                "storageKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
                "storageKeyType": "StorageAccessKey",
                "storageUri": "https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/ImportDatabaseUsingDatabaseExtensions.json
if __name__ == "__main__":
    main()

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

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to perform a database extension operation, like database import, database export, or polybase import
 *
 * @summary perform a database extension operation, like database import, database export, or polybase import
 * x-ms-original-file: 2025-01-01/ImportDatabaseUsingDatabaseExtensions.json
 */
async function importDatabaseUsingDatabaseExtension() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "17ca4d13-bf7d-4c33-a60e-b87a2820a325";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.databaseExtensionsOperations.createOrUpdate(
    "rg_062866bf-c4f4-41f9-abf0-b59132ca7924",
    "srv_2d6be2d2-26c8-4930-8fb6-82a5e95e0e82",
    "db_2a47e946-e414-4c00-94ac-ed886bb78302",
    "Import",
    {
      administratorLogin: "login",
      administratorLoginPassword: "password",
      authenticationType: "Sql",
      operationMode: "Import",
      storageKey:
        "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      storageKeyType: "StorageAccessKey",
      storageUri: "https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml",
    },
  );
  console.log(result);
}

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

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/ImportDatabaseUsingDatabaseExtensions.json
// this example is just showing the usage of "DatabaseExtensions_CreateOrUpdate" 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 = "17ca4d13-bf7d-4c33-a60e-b87a2820a325";
string resourceGroupName = "rg_062866bf-c4f4-41f9-abf0-b59132ca7924";
string serverName = "srv_2d6be2d2-26c8-4930-8fb6-82a5e95e0e82";
string databaseName = "db_2a47e946-e414-4c00-94ac-ed886bb78302";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation
string extensionName = "Import";
SqlDatabaseExtension sqlDatabaseExtension = new SqlDatabaseExtension
{
    OperationMode = DatabaseExtensionOperationMode.Import,
    StorageKeyType = StorageKeyType.StorageAccessKey,
    StorageKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    StorageUri = new Uri("https://teststorage.blob.core.windows.net/testcontainer/Manifest.xml"),
    AdministratorLogin = "login",
    AdministratorLoginPassword = "password",
    AuthenticationType = "Sql",
};
ArmOperation<ImportExportExtensionsOperationResult> lro = await sqlDatabase.CreateOrUpdateDatabaseExtensionAsync(WaitUntil.Completed, extensionName, sqlDatabaseExtension);
ImportExportExtensionsOperationResult 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

Risposta di esempio

Codice di stato:: 200

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

Codice di stato:: 202

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
DatabaseExtensions	Risorsa Import, Export o PolybaseImport.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
ImportExportExtensionsOperationResult	Risorsa risultato dell'operazione di estensione.
NetworkIsolationSettings	Contiene le risorse arm per le quali creare una connessione all'endpoint privato.
OperationMode	Modalità operativa dell'operazione: Importazione, Esportazione o PolybaseImport.
PrivateEndpointConnectionRequestStatus	Contiene lo stato delle richieste di connessione dell'endpoint privato.
StorageKeyType	Tipo di chiave di archiviazione: StorageAccessKey, SharedAccessKey o ManagedIdentity.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key