Database Extensions - Create Or Update

Dienst:

SQL Database

API-Version:

2021-11-01

Ausführen eines Datenbankerweiterungsvorgangs, z. B. Datenbankimport, Datenbankexport oder Polybase-Import

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
databaseName	path	True	string	Der Name der Datenbank.
extensionName	path	True	string
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.operationMode	True	OperationMode	Vorgangsmodus des Vorgangs: Import, Export oder PolybaseImport.
properties.storageKey	True	string	Speicherschlüssel für das Speicherkonto.
properties.storageKeyType	True	StorageKeyType	Speicherschlüsseltyp: StorageAccessKey oder SharedAccessKey.
properties.storageUri	True	string	Speicher-URI für das Speicherkonto.
properties.administratorLogin		string	Administratoranmeldungsname.
properties.administratorLoginPassword		string	Administratoranmeldekennwort.
properties.authenticationType		string	Authentifizierungstyp: SQL-Authentifizierung oder AD-Kennwort.
properties.databaseEdition		string	Datenbankedition für die neu erstellte Datenbank im Fall eines Importvorgangs.
properties.maxSizeBytes		string	Maximale Datenbankgröße in Bytes für die neu erstellte Datenbank im Falle eines Importvorgangs.
properties.networkIsolation		NetworkIsolationSettings	Optionale Ressourceninformationen zum Aktivieren der Netzwerkisolation für Die Anforderung.
properties.serviceObjectiveName		string	Datenbank-Servicelevelziel für die neu erstellte Datenbank im Fall eines Importvorgangs.

Antworten

Name	Typ	Beschreibung
200 OK	ImportExportExtensionsOperationResult	Import-/Exportvorgang erfolgreich abgeschlossen.
202 Accepted		Der Import/Export-Vorgang wird ausgeführt.
Other Status Codes		Fehlerantworten: *** 400 MissingImportExportInputParameters : Fehlende ImportExport-Eingabeparameter. 400 InvalidImportExportInputParameter: Fehler bei der Import-/Exportanforderung aufgrund eines ungültigen Eingabeparameters. 400 PolybaseImportAuthenticationTypeNotSupported: Der Authentifizierungstypparameter wird für den PolybaseImport-Vorgang nicht unterstützt. 400 DatabaseExtensionsInvalidOperationMode : Ungültiger operationMode-Parameter für die Datenbankerweiterung. 400 DatabaseExtensionsInvalidStorageKeyType: Der Speicherschlüsseltyp muss nach "StorageAccessKey" angegeben werden. 400 DatabaseExtensionsMissingStorageUri: Der Speicher-URI darf nicht leer sein. 400 InvalidSku: Der Benutzer hat eine ungültige SKU angegeben. 400 InvalidTierSkuCombination: Die angegebene Ebene unterstützt die angegebene SKU nicht. 400 DatabaseInvalidSkuPropertyCombination: Die Eigenschaften der angeforderten SKU sind inkonsistent. Überprüfen Sie, ob eine gültige Kombination angegeben ist. Weitere Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability. 400 InvalidMaxSizeTierCombination: Die angegebene Ebene unterstützt die angegebene maximale Datenbankgröße nicht. 400 FeatureDisabledOnSelectedEdition: Der Benutzer hat versucht, ein Feature zu verwenden, das in der aktuellen Datenbankedition deaktiviert ist. 400 InvalidImportExportParameter: Fehler bei der Import/Export-Anforderung aufgrund eines ungültigen Eingabeparameters. 400 InvalidTier: Der Benutzer hat einen ungültigen Tarif angegeben. 400 InvalidOperationType: Geben Sie einen gültigen Vorgangstyp an. 400 ImportExportJobError: Fehler beim ImportExport-Vorgang. 400 BlockedByOutboundFirewall: Die Firewallregeln für ausgehenden Datenverkehr blockierten die Anforderung. 404 ResourceNotFound: Ungültige Anforderung, die eine nicht vorhandene Ressource angibt. 404 ServerNotInSubscriptionResourceGroup: Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden. 404 ImportExportOperationIdNotFound: Die Vorgangs-ID für den Import oder Export wurde nicht gefunden. 404 ServerNotInSubscription: Der angegebene Server ist im angegebenen Abonnement nicht vorhanden. 404 OperationIdNotFound: Der Vorgang mit der ID ist nicht vorhanden. 409 ImportExportOperationInProgress: Es wird ein Import- oder Exportvorgang für die Datenbank ausgeführt. 409 OperationCancelled: Der Vorgang wurde vom Benutzer abgebrochen. 409 OperationInterrupted: Der Vorgang für die Ressource konnte nicht abgeschlossen werden, da er durch einen anderen Vorgang für dieselbe Ressource unterbrochen wurde. 429 SubscriptionTooManyCreateUpdateRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können. 429 SubscriptionTooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können. 500 OperationTimedOut: Timeout des Vorgangs und automatisches Rollback. Wiederholen Sie den Vorgang. 503 TooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können.

Beispiele

Create or Update database extensions.

Export database using database extension.

Import database using database extension.

Create or Update database extensions.

Beispielanforderung

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

Beispiel für eine Antwort

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.

Beispielanforderung

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

Beispiel für eine Antwort

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.

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
DatabaseExtensions	Eine Import-, Export- oder PolybaseImport-Ressource.
ImportExportExtensionsOperationResult	Ergebnisressource eines Erweiterungsvorgangs.
NetworkIsolationSettings	Enthält die ARM-Ressourcen, für die eine private Endpunktverbindung erstellt werden soll.
OperationMode	Vorgangsmodus des Vorgangs: Import, Export oder PolybaseImport.
PrivateEndpointConnectionRequestStatus	Enthält die verbindungsanforderungen des privaten Endpunkts status.
StorageKeyType	Speicherschlüsseltyp: StorageAccessKey oder SharedAccessKey.

DatabaseExtensions

Eine Import-, Export- oder PolybaseImport-Ressource.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Name der Ressource.
properties.administratorLogin	string	Administratoranmeldungsname.
properties.administratorLoginPassword	string	Administratoranmeldekennwort.
properties.authenticationType	string	Authentifizierungstyp: SQL-Authentifizierung oder AD-Kennwort.
properties.databaseEdition	string	Datenbankedition für die neu erstellte Datenbank im Fall eines Importvorgangs.
properties.maxSizeBytes	string	Maximale Datenbankgröße in Bytes für die neu erstellte Datenbank im Falle eines Importvorgangs.
properties.networkIsolation	NetworkIsolationSettings	Optionale Ressourceninformationen zum Aktivieren der Netzwerkisolation für Die Anforderung.
properties.operationMode	OperationMode	Vorgangsmodus des Vorgangs: Import, Export oder PolybaseImport.
properties.serviceObjectiveName	string	Datenbank-Servicelevelziel für die neu erstellte Datenbank im Fall eines Importvorgangs.
properties.storageKey	string	Speicherschlüssel für das Speicherkonto.
properties.storageKeyType	StorageKeyType	Speicherschlüsseltyp: StorageAccessKey oder SharedAccessKey.
properties.storageUri	string	Speicher-URI für das Speicherkonto.
type	string	Der Ressourcentyp.

ImportExportExtensionsOperationResult

Ergebnisressource eines Erweiterungsvorgangs.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Name der Ressource.
properties.blobUri	string	Blob-URI.
properties.databaseName	string	Datenbankname.
properties.errorMessage	string	Fehlermeldung.
properties.lastModifiedTime	string	Zeitpunkt der letzten Änderung.
properties.privateEndpointConnections	PrivateEndpointConnectionRequestStatus[]	Ruft die status der privaten Endpunkte ab, die dieser Anforderung zugeordnet sind.
properties.queuedTime	string	Zeit in der Warteschlange.
properties.requestId	string	Anforderungs-ID.
properties.requestType	string	Der Anforderungstyp.
properties.serverName	string	Servername.
properties.status	string	Vorgangsstatus
type	string	Der Ressourcentyp.

NetworkIsolationSettings

Enthält die ARM-Ressourcen, für die eine private Endpunktverbindung erstellt werden soll.

Name	Typ	Beschreibung
sqlServerResourceId	string	Die Ressourcen-ID für den SQL Server, der das Ziel dieser Anforderung ist. Wenn festgelegt, wird eine private Endpunktverbindung für den SQL Server erstellt. Muss mit dem Server übereinstimmen, der das Ziel des Vorgangs ist.
storageAccountResourceId	string	Die Ressourcen-ID für das Speicherkonto, das zum Speichern der BACPAC-Datei verwendet wird. Wenn festgelegt, wird eine private Endpunktverbindung für das Speicherkonto erstellt. Muss mit dem Speicherkonto übereinstimmen, das für den StorageUri-Parameter verwendet wird.

OperationMode

Vorgangsmodus des Vorgangs: Import, Export oder PolybaseImport.

Name	Typ	Beschreibung
Export	string
Import	string
PolybaseImport	string

PrivateEndpointConnectionRequestStatus

Enthält die verbindungsanforderungen des privaten Endpunkts status.

Name	Typ	Beschreibung
privateEndpointConnectionName	string	Der Verbindungsname für den privaten Endpunkt.
privateLinkServiceId	string	Ressourcen-ID, für die der private Endpunkt erstellt wird.
status	string	Status dieser Privaten Endpunktverbindung.

StorageKeyType

Speicherschlüsseltyp: StorageAccessKey oder SharedAccessKey.

Name	Typ	Beschreibung
SharedAccessKey	string
StorageAccessKey	string