Database Extensions - Create Or Update

Service:

SQL Database

API-versie:

2021-11-01

Een database-extensiebewerking uitvoeren, zoals databaseimport, database-export of polybase importeren

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

URI-parameters

Name	In	Vereist	Type	Description
databaseName	path	True	string	De naam van de database.
extensionName	path	True	string
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serverName	path	True	string	De naam van de server.
subscriptionId	path	True	string	De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version	query	True	string	De API-versie die moet worden gebruikt voor de aanvraag.

Aanvraagbody

Name	Vereist	Type	Description
properties.operationMode	True	OperationMode	Bewerkingsmodus van de bewerking: Import, Export of PolybaseImport.
properties.storageKey	True	string	Opslagsleutel voor het opslagaccount.
properties.storageKeyType	True	StorageKeyType	Type opslagsleutel: StorageAccessKey of SharedAccessKey.
properties.storageUri	True	string	Opslag-URI voor het opslagaccount.
properties.administratorLogin		string	Aanmeldingsnaam van beheerder.
properties.administratorLoginPassword		string	Aanmeldingswachtwoord voor beheerder.
properties.authenticationType		string	Verificatietype: SQL-verificatie of AD-wachtwoord.
properties.databaseEdition		string	Database-editie voor de zojuist gemaakte database in het geval van een importbewerking.
properties.maxSizeBytes		string	Maximale grootte van de database in bytes voor de zojuist gemaakte database in het geval van een importbewerking.
properties.networkIsolation		NetworkIsolationSettings	Optionele resourcegegevens voor het inschakelen van netwerkisolatie voor aanvragen.
properties.serviceObjectiveName		string	Serviceniveaudoelstelling voor de database voor de zojuist gemaakte database in het geval van een importbewerking.

Antwoorden

Name	Type	Description
200 OK	ImportExportExtensionsOperationResult	De import-/exportbewerking is voltooid.
202 Accepted		De import-/exportbewerking wordt uitgevoerd.
Other Status Codes		Foutreacties: *** 400 MissingImportExportInputParameters - Ontbrekende ImportExport invoerparameters. 400 InvalidImportExportInputParameter: de import-/exportaanvraag is mislukt vanwege een ongeldige invoerparameter. 400 PolybaseImportAuthenticationTypeNotSupported - Parameter verificatietype wordt niet ondersteund voor PolybaseImport bewerking. 400 DatabaseExtensionsInvalidOperationMode - Ongeldige operationMode-parameter voor database-extensie. 400 DatabaseExtensionsInvalidStorageKeyType - Het opslagsleuteltype moet op 'StorageAccessKey' worden uitgevoerd. 400 DatabaseExtensionsMissingStorageUri - Opslag-URI mag niet leeg zijn. 400 InvalidSku: de gebruiker heeft een ongeldige SKU opgegeven. 400 InvalidTierSkuCombination : de opgegeven laag biedt geen ondersteuning voor de opgegeven SKU. 400 DatabaseInvalidSkuPropertyCombination : de eigenschappen van de aangevraagde SKU zijn inconsistent. Controleer of er een geldige combinatie is opgegeven. Zie https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability voor meer informatie. 400 InvalidMaxSizeTierCombination - De opgegeven laag biedt geen ondersteuning voor de opgegeven maximale grootte van de database. 400 FeatureDisabledOnSelectedEdition - Gebruiker heeft geprobeerd een functie te gebruiken die is uitgeschakeld voor de huidige database-editie. 400 InvalidImportExportParameter: de import-/exportaanvraag is mislukt vanwege een ongeldige invoerparameter. 400 InvalidTier : de gebruiker heeft een ongeldige laag opgegeven. 400 InvalidOperationType - Geef een geldig bewerkingstype op. 400 ImportExportJobError : de bewerking ImportExport is mislukt. 400 BlockedByOutboundFirewall: de uitgaande firewallregels hebben de aanvraag geblokkeerd. 404 ResourceNotFound - Ongeldige aanvraag die een niet-bestaande resource aangeeft. 404 ServerNotInSubscriptionResourceGroup : de opgegeven server bestaat niet in de opgegeven resourcegroep en het opgegeven abonnement. 404 ImportExportOperationIdNotFound : de bewerkings-id voor importeren of exporteren kan niet worden gevonden. 404 ServerNotInSubscription : de opgegeven server bestaat niet in het opgegeven abonnement. 404 OperationIdNotFound - De bewerking met id bestaat niet. 409 ImportExportOperationInProgress : er wordt een import- of exportbewerking uitgevoerd op de database. 409 OperationCancelled : de bewerking is geannuleerd door de gebruiker. 409 Bewerking onderbroken: de bewerking op de resource kan niet worden voltooid omdat deze is onderbroken door een andere bewerking op dezelfde resource. 429 SubscriptionTooManyCreateUpdateRequests - Aanvragen die verder gaan dan het maximumaantal aanvragen dat kan worden verwerkt door beschikbare resources. 429 SubscriptionTooManyRequests - Aanvragen die verder gaan dan het maximumaantal aanvragen dat kan worden verwerkt door beschikbare resources. 500 OperationTimedOut: er is een time-out opgetreden voor de bewerking en deze is automatisch teruggedraaid. Probeer de bewerking opnieuw uit te voeren. 503 TooManyRequests: aanvragen die verder gaan dan het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources.

Voorbeelden

Create or Update database extensions.

Export database using database extension.

Import database using database extension.

Create or Update database extensions.

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

202

Statuscode:

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.

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Statuscode:

202

Import database using database extension.

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Statuscode:

202

Definities

Name	Description
DatabaseExtensions	Een import-, export- of PolybaseImport-resource.
ImportExportExtensionsOperationResult	Een resource met resultaat van extensiebewerking.
NetworkIsolationSettings	Bevat de ARM-resources waarvoor een privé-eindpuntverbinding moet worden gemaakt.
OperationMode	Bewerkingsmodus van de bewerking: Import, Export of PolybaseImport.
PrivateEndpointConnectionRequestStatus	Bevat de status van de verbindingsaanvragen van het privé-eindpunt.
StorageKeyType	Type opslagsleutel: StorageAccessKey of SharedAccessKey.

DatabaseExtensions

Object

Een import-, export- of PolybaseImport-resource.

Name	Type	Description
id	string	Resource-id.
name	string	Resourcenaam.
properties.administratorLogin	string	Aanmeldingsnaam van beheerder.
properties.administratorLoginPassword	string	Aanmeldingswachtwoord voor beheerder.
properties.authenticationType	string	Verificatietype: SQL-verificatie of AD-wachtwoord.
properties.databaseEdition	string	Database-editie voor de zojuist gemaakte database in het geval van een importbewerking.
properties.maxSizeBytes	string	Maximale grootte van de database in bytes voor de zojuist gemaakte database in het geval van een importbewerking.
properties.networkIsolation	NetworkIsolationSettings	Optionele resourcegegevens voor het inschakelen van netwerkisolatie voor aanvragen.
properties.operationMode	OperationMode	Bewerkingsmodus van de bewerking: Import, Export of PolybaseImport.
properties.serviceObjectiveName	string	Serviceniveaudoelstelling voor de database voor de zojuist gemaakte database in het geval van een importbewerking.
properties.storageKey	string	Opslagsleutel voor het opslagaccount.
properties.storageKeyType	StorageKeyType	Type opslagsleutel: StorageAccessKey of SharedAccessKey.
properties.storageUri	string	Opslag-URI voor het opslagaccount.
type	string	Resourcetype.

ImportExportExtensionsOperationResult

Object

Een resource met resultaat van extensiebewerking.

Name	Type	Description
id	string	Resource-id.
name	string	Resourcenaam.
properties.blobUri	string	Blob-URI.
properties.databaseName	string	Databasenaam.
properties.errorMessage	string	Foutbericht.
properties.lastModifiedTime	string	Tijdstip van laatste wijziging.
properties.privateEndpointConnections	PrivateEndpointConnectionRequestStatus[]	Hiermee wordt de status opgehaald van privé-eindpunten die aan deze aanvraag zijn gekoppeld.
properties.queuedTime	string	Tijd in de wachtrij.
properties.requestId	string	Aanvraag-id.
properties.requestType	string	Aanvraagtype.
properties.serverName	string	Servernaam.
properties.status	string	Bewerkingsstatus.
type	string	Resourcetype.

NetworkIsolationSettings

Object

Bevat de ARM-resources waarvoor een privé-eindpuntverbinding moet worden gemaakt.

Name	Type	Description
sqlServerResourceId	string	De resource-id voor de SQL-server die het doel van deze aanvraag is. Als dit is ingesteld, wordt er een privé-eindpuntverbinding gemaakt voor de SQL-server. Moet overeenkomen met de server die het doel van de bewerking is.
storageAccountResourceId	string	De resource-id voor het opslagaccount dat wordt gebruikt om het BACPAC-bestand op te slaan. Als dit is ingesteld, wordt er een privé-eindpuntverbinding gemaakt voor het opslagaccount. Moet overeenkomen met het opslagaccount dat wordt gebruikt voor de parameter StorageUri.

OperationMode

Enumeration

Bewerkingsmodus van de bewerking: Import, Export of PolybaseImport.

Waarde	Description
Export
Import
PolybaseImport

PrivateEndpointConnectionRequestStatus

Object

Bevat de status van de verbindingsaanvragen van het privé-eindpunt.

Name	Type	Description
privateEndpointConnectionName	string	De verbindingsnaam voor het privé-eindpunt.
privateLinkServiceId	string	Resource-id waarvoor het privé-eindpunt is gemaakt.
status	string	Status van deze privé-eindpuntverbinding.

StorageKeyType

Enumeration

Type opslagsleutel: StorageAccessKey of SharedAccessKey.

Waarde	Description
SharedAccessKey
StorageAccessKey