Database Extensions - Create Or Update

Služba:

SQL Database

Verze rozhraní API:

2021-11-01

Provedení operace rozšíření databáze, jako je import databáze, export databáze nebo import polybase

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
databaseName	path	True	string	Název databáze.
extensionName	path	True	string
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.operationMode	True	OperationMode	Režim operace: Import, Export nebo PolybaseImport.
properties.storageKey	True	string	Klíč úložiště pro účet úložiště.
properties.storageKeyType	True	StorageKeyType	Typ klíče úložiště: StorageAccessKey nebo SharedAccessKey.
properties.storageUri	True	string	Identifikátor URI úložiště pro účet úložiště.
properties.administratorLogin		string	Přihlašovací jméno správce.
properties.administratorLoginPassword		string	Přihlašovací heslo správce.
properties.authenticationType		string	Typ ověřování: Ověřování SQL nebo heslo AD.
properties.databaseEdition		string	Edice databáze pro nově vytvořenou databázi v případě operace importu
properties.maxSizeBytes		string	Maximální velikost databáze v bajtech pro nově vytvořenou databázi v případě operace importu
properties.networkIsolation		NetworkIsolationSettings	Volitelné informace o prostředcích pro povolení izolace sítě pro požadavek.
properties.serviceObjectiveName		string	Cíl na úrovni databázové služby pro nově vytvořenou databázi v případě operace importu.

Odpovědi

Name	Typ	Description
200 OK	ImportExportExtensionsOperationResult	Operace importu a exportu byla úspěšně dokončena.
202 Accepted		Probíhá operace importu nebo exportu.
Other Status Codes		Chybové odpovědi: *** 400 MissingImportExportInputParameters – Chybí vstupní parametry ImportExport. 400 InvalidImportExportInputParameter – Požadavek na import/export selhal kvůli neplatnému vstupnímu parametru. 400 PolybaseImportAuthenticationTypeNotSupported – Parametr typu ověřování nepodporuje operaci PolybaseImport. 400 DatabaseExtensionsInvalidOperationMode – neplatný parametr operationMode pro rozšíření databáze. 400 DatabaseExtensionsInvalidStorageKeyType – Typ klíče úložiště musí obsahovat StorageAccessKey. 400 DatabaseExtensionsMissingStorageUri – Identifikátor URI úložiště nemůže být prázdný. 400 InvalidSku – uživatel zadal neplatnou skladovou položku. 400 InvalidTierSkuCombination – zadaná úroveň nepodporuje zadanou skladovou položku. 400 DatabaseInvalidSkuPropertyCombination – vlastnosti požadované skladové položky jsou nekonzistentní. Zkontrolujte, jestli je zadaná platná kombinace. Další podrobnosti najdete v https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability. 400 InvalidMaxSizeTierCombination – zadaná úroveň nepodporuje zadanou maximální velikost databáze. 400 FeatureDisabledOnSelectedEdition – Uživatel se pokusil použít funkci, která je v aktuální edici databáze zakázaná. 400 InvalidImportExportParameter – Požadavek importu/exportu selhal kvůli neplatnému vstupnímu parametru. 400 InvalidTier – Uživatel zadal neplatnou úroveň. 400 InvalidOperationType – Zadejte platný typ operace. 400 ImportExportJobError – Operace ImportExport selhala. 400 BlockedByOutboundFirewall – pravidla odchozí brány firewall zablokovala požadavek. 404 ResourceNotFound – Neplatný požadavek určující neexistující prostředek. 404 ServerNotInSubscriptionResourceGroup – Zadaný server neexistuje v zadané skupině prostředků a předplatném. 404 ImportExportOperationIdNotFound – ID operace pro import nebo export nelze najít. 404 ServerNotInSubscription – Zadaný server v zadaném předplatném neexistuje. 404 OperationIdNotFound – operace s ID neexistuje. 409 ImportExportOperationInProgress – Probíhá operace importu nebo exportu v databázi. 409 OperationCancelled - Operace byla zrušena uživatelem. 409 OperationInterrupted – operaci s prostředkem nebylo možné dokončit, protože byla přerušena jinou operací na stejném prostředku. 429 SubscriptionTooManyCreateUpdateRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 429 SubscriptionTooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 500 OperationTimedOut – Vypršel časový limit operace a automaticky se vrátil zpět. Zkuste operaci zopakovat. 503 TooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky.

Příklady

Create or Update database extensions.

Export database using database extension.

Import database using database extension.

Create or Update database extensions.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

202

Stavový kód:

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.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

202

Import database using database extension.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

202

Definice

Name	Description
DatabaseExtensions	Prostředek Import, Export nebo PolybaseImport.
ImportExportExtensionsOperationResult	Prostředek výsledku operace rozšíření.
NetworkIsolationSettings	Obsahuje prostředky ARM, pro které se má vytvořit připojení privátního koncového bodu.
OperationMode	Režim operace: Import, Export nebo PolybaseImport.
PrivateEndpointConnectionRequestStatus	Obsahuje stav žádostí o připojení privátního koncového bodu.
StorageKeyType	Typ klíče úložiště: StorageAccessKey nebo SharedAccessKey.

DatabaseExtensions

Objekt

Prostředek Import, Export nebo PolybaseImport.

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku
properties.administratorLogin	string	Přihlašovací jméno správce.
properties.administratorLoginPassword	string	Přihlašovací heslo správce.
properties.authenticationType	string	Typ ověřování: Ověřování SQL nebo heslo AD.
properties.databaseEdition	string	Edice databáze pro nově vytvořenou databázi v případě operace importu
properties.maxSizeBytes	string	Maximální velikost databáze v bajtech pro nově vytvořenou databázi v případě operace importu
properties.networkIsolation	NetworkIsolationSettings	Volitelné informace o prostředcích pro povolení izolace sítě pro požadavek.
properties.operationMode	OperationMode	Režim operace: Import, Export nebo PolybaseImport.
properties.serviceObjectiveName	string	Cíl na úrovni databázové služby pro nově vytvořenou databázi v případě operace importu.
properties.storageKey	string	Klíč úložiště pro účet úložiště.
properties.storageKeyType	StorageKeyType	Typ klíče úložiště: StorageAccessKey nebo SharedAccessKey.
properties.storageUri	string	Identifikátor URI úložiště pro účet úložiště.
type	string	Typ zdroje.

ImportExportExtensionsOperationResult

Objekt

Prostředek výsledku operace rozšíření.

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku
properties.blobUri	string	Identifikátor URI objektu blob
properties.databaseName	string	Název databáze.
properties.errorMessage	string	Zpráva o chybě.
properties.lastModifiedTime	string	Čas poslední změny
properties.privateEndpointConnections	PrivateEndpointConnectionRequestStatus[]	Získá stav privátních koncových bodů přidružených k tomuto požadavku.
properties.queuedTime	string	Čas zařazený do fronty
properties.requestId	string (uuid)	ID požadavku.
properties.requestType	string	Typ požadavku.
properties.serverName	string	Název serveru.
properties.status	string	Stav operace.
type	string	Typ zdroje.

NetworkIsolationSettings

Objekt

Obsahuje prostředky ARM, pro které se má vytvořit připojení privátního koncového bodu.

Name	Typ	Description
sqlServerResourceId	string (arm-id)	ID prostředku pro SQL Server, který je cílem tohoto požadavku. Pokud je tato možnost nastavená, vytvoří se pro SQL Server připojení privátního koncového bodu. Musí odpovídat serveru, který je cílem operace.
storageAccountResourceId	string (arm-id)	ID prostředku účtu úložiště použitého k uložení souboru BACPAC. Pokud je tato možnost nastavená, vytvoří se pro účet úložiště připojení privátního koncového bodu. Musí odpovídat účtu úložiště použitému pro parametr StorageUri.

OperationMode

Výčet

Režim operace: Import, Export nebo PolybaseImport.

Hodnota	Description
Export
Import
PolybaseImport

PrivateEndpointConnectionRequestStatus

Objekt

Obsahuje stav žádostí o připojení privátního koncového bodu.

Name	Typ	Description
privateEndpointConnectionName	string	Název připojení privátního koncového bodu.
privateLinkServiceId	string	ID prostředku, pro který se vytvoří privátní koncový bod.
status	string	Stav tohoto připojení privátního koncového bodu

StorageKeyType

Výčet

Typ klíče úložiště: StorageAccessKey nebo SharedAccessKey.

Hodnota	Description
SharedAccessKey
StorageAccessKey