Database Extensions - Create Or Update

Usługa:

SQL Database

Wersja interfejsu API:

2021-11-01

Wykonywanie operacji rozszerzenia bazy danych, takich jak importowanie bazy danych, eksportowanie bazy danych lub importowanie programu 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 identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
databaseName	path	True	string	Nazwa bazy danych.
extensionName	path	True	string
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
serverName	path	True	string	Nazwa serwera.
subscriptionId	path	True	string	Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania.

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties.operationMode	True	OperationMode	Tryb działania operacji: Import, Export lub PolybaseImport.
properties.storageKey	True	string	Klucz magazynu dla konta magazynu.
properties.storageKeyType	True	StorageKeyType	Typ klucza magazynu: StorageAccessKey lub SharedAccessKey.
properties.storageUri	True	string	Identyfikator URI magazynu dla konta magazynu.
properties.administratorLogin		string	Nazwa logowania administratora.
properties.administratorLoginPassword		string	Hasło logowania administratora.
properties.authenticationType		string	Typ uwierzytelniania: uwierzytelnianie SQL lub hasło usługi AD.
properties.databaseEdition		string	Wersja bazy danych dla nowo utworzonej bazy danych w przypadku operacji importowania.
properties.maxSizeBytes		string	Maksymalny rozmiar bazy danych w bajtach dla nowo utworzonej bazy danych w przypadku operacji importowania.
properties.networkIsolation		NetworkIsolationSettings	Opcjonalne informacje o zasobach umożliwiające izolację sieci dla żądania.
properties.serviceObjectiveName		string	Cel poziomu usługi bazy danych dla nowo utworzonej bazy danych w przypadku operacji importowania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ImportExportExtensionsOperationResult	Pomyślnie ukończono operację importowania/eksportowania.
202 Accepted		Trwa operacja importowania/eksportowania.
Other Status Codes		Odpowiedzi na błędy: *** 400 MissingImportExportInputParameters — brak parametrów wejściowych ImportExport. 400 InvalidImportExportInputParameter — żądanie importu/eksportu nie powiodło się z powodu nieprawidłowego parametru wejściowego. 400 PolybaseImportAuthenticationTypeNotSupported — parametr typu uwierzytelniania nie jest obsługiwany dla operacji PolybaseImport. 400 DatabaseExtensionsInvalidOperationMode — nieprawidłowy parametr operationMode dla rozszerzenia bazy danych. 400 DatabaseExtensionsInvalidStorageKeyType — typ klucza magazynu musi mieć wartość "StorageAccessKey". 400 DatabaseExtensionsMissingStorageUri — identyfikator URI magazynu nie może być pusty. 400 InvalidSku — użytkownik określił nieprawidłową jednostkę SKU. 400 InvalidTierSkuCombination — określona warstwa nie obsługuje określonej jednostki SKU. 400 DatabaseInvalidSkuPropertyCombination — właściwości żądanej jednostki SKU są niespójne. Sprawdź, czy określono prawidłową kombinację. Zobacz https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability , aby uzyskać więcej informacji. 400 InvalidMaxSizeTierCombination — określona warstwa nie obsługuje określonego maksymalnego rozmiaru bazy danych. 400 FeatureDisabledOnSelectedEdition — użytkownik próbował użyć funkcji wyłączonej w bieżącej wersji bazy danych. 400 InvalidImportExportParameter — żądanie importu/eksportu nie powiodło się z powodu nieprawidłowego parametru wejściowego. 400 InvalidTier — użytkownik określił nieprawidłową warstwę. 400 InvalidOperationType — podaj prawidłowy typ operacji. 400 ImportExportJobError — operacja ImportExport nie powiodła się. 400 BlockedByOutboundFirewall — reguły zapory ruchu wychodzącego zablokowały żądanie. 404 ResourceNotFound — nieprawidłowe żądanie określające nieistniejący zasób. 404 ServerNotInSubscriptionResourceGroup — określony serwer nie istnieje w określonej grupie zasobów i subskrypcji. 404 ImportExportOperationIdNotFound — nie można odnaleźć identyfikatora operacji importowania lub eksportu. 404 ServerNotInSubscription — określony serwer nie istnieje w określonej subskrypcji. 404 OperationIdNotFound — operacja o identyfikatorze nie istnieje. 409 ImportExportOperationInProgress — trwa operacja importowania lub eksportowania w bazie danych. 409 OperationCancelled — operacja została anulowana przez użytkownika. 409 Operacja przerwana — nie można ukończyć operacji na zasobie, ponieważ została przerwana przez inną operację na tym samym zasobie. 429 SubscriptionTooManyCreateUpdateRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby. 429 SubscriptionTooManyRequests — żądania wykraczające poza maksymalną liczbę żądań, które mogą być przetwarzane przez dostępne zasoby. 500 OperationTimedOut — upłynął limit czasu operacji i automatycznie wycofano. Ponów próbę wykonania operacji. 503 TooManyRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby.

Przykłady

Create or Update database extensions.

Export database using database extension.

Import database using database extension.

Create or Update database extensions.

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

202

Kod stanu:

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.

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

202

Import database using database extension.

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

202

Definicje

Nazwa	Opis
DatabaseExtensions	Zasób Import, Export lub PolybaseImport.
ImportExportExtensionsOperationResult	Zasób wyniku operacji rozszerzenia.
NetworkIsolationSettings	Zawiera zasoby usługi ARM, dla których ma zostać utworzone połączenie prywatnego punktu końcowego.
OperationMode	Tryb działania operacji: Import, Export lub PolybaseImport.
PrivateEndpointConnectionRequestStatus	Zawiera stan żądań połączenia prywatnego punktu końcowego.
StorageKeyType	Typ klucza magazynu: StorageAccessKey lub SharedAccessKey.

DatabaseExtensions

Zasób Import, Export lub PolybaseImport.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.administratorLogin	string	Nazwa logowania administratora.
properties.administratorLoginPassword	string	Hasło logowania administratora.
properties.authenticationType	string	Typ uwierzytelniania: uwierzytelnianie SQL lub hasło usługi AD.
properties.databaseEdition	string	Wersja bazy danych dla nowo utworzonej bazy danych w przypadku operacji importowania.
properties.maxSizeBytes	string	Maksymalny rozmiar bazy danych w bajtach dla nowo utworzonej bazy danych w przypadku operacji importowania.
properties.networkIsolation	NetworkIsolationSettings	Opcjonalne informacje o zasobach umożliwiające izolację sieci dla żądania.
properties.operationMode	OperationMode	Tryb działania operacji: Import, Export lub PolybaseImport.
properties.serviceObjectiveName	string	Cel poziomu usługi bazy danych dla nowo utworzonej bazy danych w przypadku operacji importowania.
properties.storageKey	string	Klucz magazynu dla konta magazynu.
properties.storageKeyType	StorageKeyType	Typ klucza magazynu: StorageAccessKey lub SharedAccessKey.
properties.storageUri	string	Identyfikator URI magazynu dla konta magazynu.
type	string	Typ zasobu.

ImportExportExtensionsOperationResult

Zasób wyniku operacji rozszerzenia.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.blobUri	string	Identyfikator URI obiektu blob.
properties.databaseName	string	Nazwa bazy danych.
properties.errorMessage	string	Komunikat o błędzie.
properties.lastModifiedTime	string	Czas ostatniej modyfikacji.
properties.privateEndpointConnections	PrivateEndpointConnectionRequestStatus[]	Pobiera stan prywatnych punktów końcowych skojarzonych z tym żądaniem.
properties.queuedTime	string	Czas w kolejce.
properties.requestId	string	Identyfikator żądania.
properties.requestType	string	Typ żądania.
properties.serverName	string	Nazwa serwera.
properties.status	string	Stan operacji.
type	string	Typ zasobu.

NetworkIsolationSettings

Zawiera zasoby usługi ARM, dla których ma zostać utworzone połączenie prywatnego punktu końcowego.

Nazwa	Typ	Opis
sqlServerResourceId	string	Identyfikator zasobu serwera SQL, który jest obiektem docelowym tego żądania. W przypadku ustawienia zostanie utworzone połączenie prywatnego punktu końcowego dla serwera SQL. Musi być zgodny z serwerem docelowym operacji.
storageAccountResourceId	string	Identyfikator zasobu konta magazynu używanego do przechowywania pliku BACPAC. W przypadku ustawienia dla konta magazynu zostanie utworzone połączenie prywatnego punktu końcowego. Musi być zgodne z kontem magazynu używanym dla parametru StorageUri.

OperationMode

Tryb działania operacji: Import, Export lub PolybaseImport.

Nazwa	Typ	Opis
Export	string
Import	string
PolybaseImport	string

PrivateEndpointConnectionRequestStatus

Zawiera stan żądań połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
privateEndpointConnectionName	string	Nazwa połączenia prywatnego punktu końcowego.
privateLinkServiceId	string	Identyfikator zasobu, dla którego jest tworzony prywatny punkt końcowy.
status	string	Stan tego połączenia prywatnego punktu końcowego.

StorageKeyType

Typ klucza magazynu: StorageAccessKey lub SharedAccessKey.

Nazwa	Typ	Opis
SharedAccessKey	string
StorageAccessKey	string