Database Extensions - Create Or Update

Service:

SQL Database

Version d'API:

2021-11-01

Effectuer une opération d’extension de base de données, comme l’importation de base de données, l’exportation de base de données ou l’importation polybase

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
databaseName	path	True	string	Nom de la base de données.
extensionName	path	True	string
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.operationMode	True	OperationMode	Mode d’opération de l’opération : Importer, Exporter ou PolybaseImport.
properties.storageKey	True	string	Clé de stockage pour le compte de stockage.
properties.storageKeyType	True	StorageKeyType	Type de clé de stockage : StorageAccessKey ou SharedAccessKey.
properties.storageUri	True	string	URI de stockage pour le compte de stockage.
properties.administratorLogin		string	Nom de connexion administrateur.
properties.administratorLoginPassword		string	Mot de passe de connexion administrateur.
properties.authenticationType		string	Type d’authentification : Authentification SQL ou mot de passe AD.
properties.databaseEdition		string	Édition de base de données pour la base de données nouvellement créée dans le cas d’une opération d’importation.
properties.maxSizeBytes		string	Taille maximale de la base de données en octets pour la base de données nouvellement créée dans le cas d’une opération d’importation.
properties.networkIsolation		NetworkIsolationSettings	Informations de ressource facultatives pour activer l’isolation réseau pour la demande.
properties.serviceObjectiveName		string	Objectif de niveau de service de base de données pour la base de données nouvellement créée dans le cas d’une opération d’importation.

Réponses

Nom	Type	Description
200 OK	ImportExportExtensionsOperationResult	Opération d’importation/exportation réussie.
202 Accepted		L’opération d’importation/exportation est en cours.
Other Status Codes		Réponses d’erreur : *** 400 MissingImportExportInputParameters : paramètres d’entrée ImportExport manquants. 400 InvalidImportExportInputParameter : la demande d’importation/exportation a échoué en raison d’un paramètre d’entrée non valide. 400 PolybaseImportAuthenticationTypeNotSupported : le paramètre de type d’authentification n’est pas pris en charge pour l’opération PolybaseImport. 400 DatabaseExtensionsInvalidOperationMode : paramètre operationMode non valide pour l’extension de base de données. 400 DatabaseExtensionsInvalidStorageKeyType : le type de clé de stockage doit être défini sur « StorageAccessKey ». 400 DatabaseExtensionsMissingStorageUri : l’URI de stockage ne peut pas être vide. 400 InvalidSku : l’utilisateur a spécifié une référence SKU non valide. 400 InvalidTierSkuCombination : le niveau spécifié ne prend pas en charge la référence SKU spécifiée. 400 DatabaseInvalidSkuPropertyCombination : les propriétés de la référence SKU demandée sont incohérentes. Veuillez case activée qu’une combinaison valide est spécifiée. Consultez https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability pour plus d’informations. 400 InvalidMaxSizeTierCombination : le niveau spécifié ne prend pas en charge la taille maximale de base de données spécifiée. 400 FeatureDisabledOnSelectedEdition : l’utilisateur a tenté d’utiliser une fonctionnalité désactivée sur l’édition actuelle de la base de données. 400 InvalidImportExportParameter : la demande d’importation/exportation a échoué en raison d’un paramètre d’entrée non valide. 400 InvalidTier : l’utilisateur a spécifié un niveau non valide. 400 InvalidOperationType : fournissez un type d’opération valide. 400 ImportExportJobError : l’opération ImportExport a échoué. 400 BlockedByOutboundFirewall : les règles de pare-feu de trafic sortant ont bloqué la demande. 404 ResourceNotFound : requête non valide spécifiant une ressource inexistante. 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés. 404 ImportExportOperationIdNotFound : l’ID d’opération pour l’importation ou l’exportation est introuvable. 404 ServerNotInSubscription : le serveur spécifié n’existe pas dans l’abonnement spécifié. 404 OperationIdNotFound : l’opération avec ID n’existe pas. 409 ImportExportOperationInProgress : une opération d’importation ou d’exportation est en cours sur la base de données. 409 OperationCancelled : l’opération a été annulée par l’utilisateur. 409 Opération interrompue : l’opération sur la ressource n’a pas pu être terminée, car elle a été interrompue par une autre opération sur la même ressource. 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles. 429 SubscriptionTooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles. 500 OperationTimedOut : l’opération a expiré et a été automatiquement restaurée. Réessayez l’opération. 503 TooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.

Exemples

Create or Update database extensions.

Export database using database extension.

Import database using database extension.

Create or Update database extensions.

Exemple de requête

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

Exemple de réponse

Code d’état:

202

Code d’état:

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.

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Code d’état:

202

Import database using database extension.

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Code d’état:

202

Définitions

Nom	Description
DatabaseExtensions	Une ressource Import, Export ou PolybaseImport.
ImportExportExtensionsOperationResult	Une ressource de résultat de l’opération d’extension.
NetworkIsolationSettings	Contient les ressources ARM pour lesquelles créer une connexion de point de terminaison privé.
OperationMode	Mode d’opération de l’opération : Importer, Exporter ou PolybaseImport.
PrivateEndpointConnectionRequestStatus	Contient les demandes de connexion de point de terminaison privé status.
StorageKeyType	Type de clé de stockage : StorageAccessKey ou SharedAccessKey.

DatabaseExtensions

Object

Une ressource Import, Export ou PolybaseImport.

Nom	Type	Description
id	string	ID de la ressource
name	string	Nom de la ressource.
properties.administratorLogin	string	Nom de connexion administrateur.
properties.administratorLoginPassword	string	Mot de passe de connexion administrateur.
properties.authenticationType	string	Type d’authentification : Authentification SQL ou mot de passe AD.
properties.databaseEdition	string	Édition de base de données pour la base de données nouvellement créée dans le cas d’une opération d’importation.
properties.maxSizeBytes	string	Taille maximale de la base de données en octets pour la base de données nouvellement créée dans le cas d’une opération d’importation.
properties.networkIsolation	NetworkIsolationSettings	Informations de ressource facultatives pour activer l’isolation réseau pour la demande.
properties.operationMode	OperationMode	Mode d’opération de l’opération : Importer, Exporter ou PolybaseImport.
properties.serviceObjectiveName	string	Objectif de niveau de service de base de données pour la base de données nouvellement créée dans le cas d’une opération d’importation.
properties.storageKey	string	Clé de stockage pour le compte de stockage.
properties.storageKeyType	StorageKeyType	Type de clé de stockage : StorageAccessKey ou SharedAccessKey.
properties.storageUri	string	URI de stockage pour le compte de stockage.
type	string	Type de ressource.

ImportExportExtensionsOperationResult

Object

Une ressource de résultat de l’opération d’extension.

Nom	Type	Description
id	string	ID de la ressource
name	string	Nom de la ressource.
properties.blobUri	string	URI d’objet blob.
properties.databaseName	string	Nom de la base de données.
properties.errorMessage	string	Message d’erreur.
properties.lastModifiedTime	string	Heure de la dernière modification.
properties.privateEndpointConnections	PrivateEndpointConnectionRequestStatus[]	Obtient le status des points de terminaison privés associés à cette demande.
properties.queuedTime	string	Heure mise en file d’attente.
properties.requestId	string	ID de demande.
properties.requestType	string	Type de la demande.
properties.serverName	string	Nom du serveur.
properties.status	string	État de l’opération.
type	string	Type de ressource.

NetworkIsolationSettings

Object

Contient les ressources ARM pour lesquelles créer une connexion de point de terminaison privé.

Nom	Type	Description
sqlServerResourceId	string	ID de ressource pour le serveur SQL qui est la cible de cette requête. Si elle est définie, la connexion de point de terminaison privé est créée pour le serveur SQL. Doit correspondre au serveur cible de l’opération.
storageAccountResourceId	string	ID de ressource du compte de stockage utilisé pour stocker le fichier BACPAC. Si cette option est définie, la connexion de point de terminaison privé est créée pour le compte de stockage. Doit correspondre au compte de stockage utilisé pour le paramètre StorageUri.

OperationMode

Enumeration

Mode d’opération de l’opération : Importer, Exporter ou PolybaseImport.

Valeur	Description
Export
Import
PolybaseImport

PrivateEndpointConnectionRequestStatus

Object

Contient les demandes de connexion de point de terminaison privé status.

Nom	Type	Description
privateEndpointConnectionName	string	Nom de connexion pour le point de terminaison privé.
privateLinkServiceId	string	ID de ressource pour lequel le point de terminaison privé est créé.
status	string	État de cette connexion de point de terminaison privé.

StorageKeyType

Enumeration

Type de clé de stockage : StorageAccessKey ou SharedAccessKey.

Valeur	Description
SharedAccessKey
StorageAccessKey