Database Extensions - Create Or Update

Servicio:

SQL Database

Versión de la API:

2021-11-01

Realizar una operación de extensión de base de datos, como importación de base de datos, exportación de base de datos o importación de polybase

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
databaseName	path	True	string	El nombre de la base de datos.
extensionName	path	True	string
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
serverName	path	True	string	El nombre del servidor.
subscriptionId	path	True	string	El id. de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	La versión de API que se usará para la solicitud.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.operationMode	True	OperationMode	Modo de operación de la operación: Import, Export o PolybaseImport.
properties.storageKey	True	string	Clave de almacenamiento para la cuenta de almacenamiento.
properties.storageKeyType	True	StorageKeyType	Tipo de clave de almacenamiento: StorageAccessKey o SharedAccessKey.
properties.storageUri	True	string	Uri de almacenamiento para la cuenta de almacenamiento.
properties.administratorLogin		string	Nombre de inicio de sesión del administrador.
properties.administratorLoginPassword		string	Contraseña de inicio de sesión del administrador.
properties.authenticationType		string	Tipo de autenticación: autenticación de SQL o contraseña de AD.
properties.databaseEdition		string	Edición de base de datos para la base de datos recién creada en el caso de una operación de importación.
properties.maxSizeBytes		string	Tamaño máximo de la base de datos en bytes para la base de datos recién creada en el caso de una operación de importación.
properties.networkIsolation		NetworkIsolationSettings	Información de recursos opcional para habilitar el aislamiento de red para la solicitud.
properties.serviceObjectiveName		string	Objetivo de nivel de servicio de base de datos para la base de datos recién creada en el caso de una operación de importación.

Respuestas

Nombre	Tipo	Description
200 OK	ImportExportExtensionsOperationResult	Se completó correctamente la operación de importación y exportación.
202 Accepted		La operación de importación y exportación está en curso.
Other Status Codes		Respuestas de error: *** 400 MissingImportExportInputParameters: faltan parámetros de entrada ImportExport. 400 InvalidImportExportInputParameter: se produjo un error en la solicitud import/export debido a un parámetro de entrada no válido. 400 PolybaseImportAuthenticationTypeNotSupported: el parámetro de tipo de autenticación no es compatible con la operación PolybaseImport. 400 DatabaseExtensionsInvalidOperationMode: parámetro operationMode no válido para la extensión de base de datos. 400 DatabaseExtensionsInvalidStorageKeyType: el tipo de clave de almacenamiento debe ser "StorageAccessKey". 400 DatabaseExtensionsMissingStorageUri: el URI de almacenamiento no puede estar vacío. 400 InvalidSku: el usuario especificó una SKU no válida. 400 InvalidTierSkuCombination: el nivel especificado no admite la SKU especificada. 400 DatabaseInvalidSkuPropertyCombination: las propiedades de la SKU solicitada son incoherentes. Compruebe que se especifica una combinación válida. Para obtener más información, consulte https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability. 400 InvalidMaxSizeTierCombination: el nivel especificado no admite el tamaño máximo de la base de datos especificado. 400 FeatureDisabledOnSelectedEdition: el usuario intentó usar una característica que está deshabilitada en la edición actual de la base de datos. 400 InvalidImportExportParameter: error en la solicitud Import/Export debido a un parámetro de entrada no válido. 400 InvalidTier: el usuario especificó un nivel no válido. 400 InvalidOperationType: proporcione un tipo de operación válido. 400 ImportExportJobError: error en la operación ImportExport. 400 BlockedByOutboundFirewall: las reglas de firewall de salida bloquean la solicitud. 404 ResourceNotFound: solicitud no válida que especifica un recurso inexistente. 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados. 404 ImportExportOperationIdNotFound: no se encuentra el identificador de operación para la importación o exportación. 404 ServerNotInSubscription: el servidor especificado no existe en la suscripción especificada. 404 OperationIdNotFound: la operación con id. no existe. 409 ImportExportOperationInProgress: hay una operación de importación o exportación en curso en la base de datos. 409 OperationCancelled: el usuario canceló la operación. 409 OperationInterrupted: no se pudo completar la operación en el recurso porque se interrumpió por otra operación en el mismo recurso. 429 SuscripciónTooManyCreateUpdateRequests: solicitudes más allá del número máximo de solicitudes que pueden procesar los recursos disponibles. 429 SubscriptionTooManyRequests: solicitudes más allá del número máximo de solicitudes que pueden procesar los recursos disponibles. 500 OperationTimedOut: se agota el tiempo de espera de la operación y se revierte automáticamente. Vuelva a intentar la operación y, 503 TooManyRequests: solicitudes más allá del número máximo de solicitudes que se pueden procesar mediante recursos disponibles.

Ejemplos

Create or Update database extensions.

Export database using database extension.

Import database using database extension.

Create or Update database extensions.

Solicitud de ejemplo

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.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"),
            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

Respuesta de muestra

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.

Solicitud de ejemplo

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.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"),
            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

Respuesta de muestra

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.

Solicitud de ejemplo

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.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"),
            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

Respuesta de muestra

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

Definiciones

Nombre	Description
DatabaseExtensions	Un recurso Import, Export o PolybaseImport.
ImportExportExtensionsOperationResult	Un recurso de resultado de la operación de extensión.
NetworkIsolationSettings	Contiene los recursos de ARM para los que se va a crear una conexión de punto de conexión privado.
OperationMode	Modo de operación de la operación: Import, Export o PolybaseImport.
PrivateEndpointConnectionRequestStatus	Contiene el estado de las solicitudes de conexión de punto de conexión privado.
StorageKeyType	Tipo de clave de almacenamiento: StorageAccessKey o SharedAccessKey.

DatabaseExtensions

Un recurso Import, Export o PolybaseImport.

Nombre	Tipo	Description
id	string	Identificador del recurso.
name	string	Nombre del recurso.
properties.administratorLogin	string	Nombre de inicio de sesión del administrador.
properties.administratorLoginPassword	string	Contraseña de inicio de sesión del administrador.
properties.authenticationType	string	Tipo de autenticación: autenticación de SQL o contraseña de AD.
properties.databaseEdition	string	Edición de base de datos para la base de datos recién creada en el caso de una operación de importación.
properties.maxSizeBytes	string	Tamaño máximo de la base de datos en bytes para la base de datos recién creada en el caso de una operación de importación.
properties.networkIsolation	NetworkIsolationSettings	Información de recursos opcional para habilitar el aislamiento de red para la solicitud.
properties.operationMode	OperationMode	Modo de operación de la operación: Import, Export o PolybaseImport.
properties.serviceObjectiveName	string	Objetivo de nivel de servicio de base de datos para la base de datos recién creada en el caso de una operación de importación.
properties.storageKey	string	Clave de almacenamiento para la cuenta de almacenamiento.
properties.storageKeyType	StorageKeyType	Tipo de clave de almacenamiento: StorageAccessKey o SharedAccessKey.
properties.storageUri	string	Uri de almacenamiento para la cuenta de almacenamiento.
type	string	Tipo de recurso.

ImportExportExtensionsOperationResult

Un recurso de resultado de la operación de extensión.

Nombre	Tipo	Description
id	string	Identificador del recurso.
name	string	Nombre del recurso.
properties.blobUri	string	URI de blob.
properties.databaseName	string	nombre de base de datos.
properties.errorMessage	string	Mensaje de error.
properties.lastModifiedTime	string	Hora de la última modificación.
properties.privateEndpointConnections	PrivateEndpointConnectionRequestStatus[]	Obtiene el estado de los puntos de conexión privados asociados a esta solicitud.
properties.queuedTime	string	Tiempo en cola.
properties.requestId	string	Id. de solicitud.
properties.requestType	string	Tipo de solicitud.
properties.serverName	string	Nombre de servidor.
properties.status	string	Estado de la operación.
type	string	Tipo de recurso.

NetworkIsolationSettings

Contiene los recursos de ARM para los que se va a crear una conexión de punto de conexión privado.

Nombre	Tipo	Description
sqlServerResourceId	string	Identificador de recurso del servidor SQL Server que es el destino de esta solicitud. Si se establece, se creará una conexión de punto de conexión privado para el servidor SQL Server. Debe coincidir con el servidor que es el destino de la operación.
storageAccountResourceId	string	Identificador de recurso de la cuenta de almacenamiento que se usa para almacenar el archivo BACPAC. Si se establece, se creará una conexión de punto de conexión privado para la cuenta de almacenamiento. Debe coincidir con la cuenta de almacenamiento usada para el parámetro StorageUri.

OperationMode

Modo de operación de la operación: Import, Export o PolybaseImport.

Nombre	Tipo	Description
Export	string
Import	string
PolybaseImport	string

PrivateEndpointConnectionRequestStatus

Contiene el estado de las solicitudes de conexión de punto de conexión privado.

Nombre	Tipo	Description
privateEndpointConnectionName	string	Nombre de conexión del punto de conexión privado.
privateLinkServiceId	string	Identificador de recurso para el que se crea el punto de conexión privado.
status	string	Estado de esta conexión de punto de conexión privado.

StorageKeyType

Tipo de clave de almacenamiento: StorageAccessKey o SharedAccessKey.

Nombre	Tipo	Description
SharedAccessKey	string
StorageAccessKey	string