Database Extensions - Create Or Update

Служба:

SQL Database

Версия API:

2021-11-01

Выполнение операции расширения базы данных, например импорт базы данных, экспорт базы данных или импорт polybase

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
databaseName	path	True	string	Имя базы данных.
extensionName	path	True	string
resourceGroupName	path	True	string	Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования в запросе.

Текст запроса

Имя	Обязательно	Тип	Описание
properties.operationMode	True	OperationMode	Режим работы операции: Import, Export или PolybaseImport.
properties.storageKey	True	string	Ключ хранилища для учетной записи хранения.
properties.storageKeyType	True	StorageKeyType	Тип ключа хранилища: StorageAccessKey или SharedAccessKey.
properties.storageUri	True	string	URI хранилища для учетной записи хранения.
properties.administratorLogin		string	Имя входа администратора.
properties.administratorLoginPassword		string	Пароль для входа администратора.
properties.authenticationType		string	Тип проверки подлинности: проверка подлинности SQL или пароль AD.
properties.databaseEdition		string	Выпуск Базы данных для вновь созданной базы данных в случае операции импорта.
properties.maxSizeBytes		string	Максимальный размер базы данных в байтах для созданной базы данных в случае операции импорта.
properties.networkIsolation		NetworkIsolationSettings	Необязательные сведения о ресурсе для включения сетевой изоляции для запроса.
properties.serviceObjectiveName		string	Цель уровня обслуживания базы данных для вновь созданной базы данных в случае операции импорта.

Ответы

Имя	Тип	Описание
200 OK	ImportExportExtensionsOperationResult	Операция импорта и экспорта успешно завершена.
202 Accepted		Выполняется операция импорта и экспорта.
Other Status Codes		Ответы об ошибках: *** 400 MissingImportExportInputParameters — отсутствуют входные параметры ImportExport. 400 InvalidImportExportInputParameter — сбой запроса на импорт и экспорт из-за недопустимого входного параметра. 400 PolybaseImportAuthenticationTypeNotSupported — параметр типа проверки подлинности не поддерживает операцию PolybaseImport. 400 DatabaseExtensionsInvalidOperationMode — недопустимый параметр operationMode для расширения базы данных. 400 DatabaseExtensionsInvalidStorageKeyType — тип ключа хранилища должен иметь значение StorageAccessKey. 400 DatabaseExtensionsMissingStorageUri — URI хранилища не может быть пустым. 400 InvalidSku — пользователь указал недопустимый номер SKU. 400 InvalidTierSkuCombination — указанный уровень не поддерживает указанный номер SKU. 400 DatabaseInvalidSkuPropertyCombination — свойства запрошенного номера SKU несогласованы. Пожалуйста, проверка, что указано допустимое сочетание. Дополнительные сведения см. в статье https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability. 400 InvalidMaxSizeTierCombination — указанный уровень не поддерживает указанный максимальный размер базы данных. 400 FeatureDisabledOnSelectedEdition — пользователь попытался использовать функцию, которая отключена в текущем выпуске базы данных. 400 InvalidImportExportParameter — сбой запроса импорта и экспорта из-за недопустимого входного параметра. 400 InvalidTier — пользователь указал недопустимый уровень. 400 InvalidOperationType — укажите допустимый тип операции. 400 ImportExportJobError — сбой операции ImportExport. 400 BlockedByOutboundFirewall — правила брандмауэра для исходящего трафика заблокировали запрос. 404 ResourceNotFound — недопустимый запрос, указывающий несуществующий ресурс. 404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке. 404 ImportExportOperationIdNotFound — не удается найти идентификатор операции для импорта или экспорта. 404 ServerNotInSubscription — указанный сервер не существует в указанной подписке. 404 OperationIdNotFound — операция с идентификатором не существует. 409 ImportExportOperationInProgress — в базе данных выполняется операция импорта или экспорта. 409 OperationCancelled — операция была отменена пользователем. 409 OperationInterrupted — не удалось завершить операцию с ресурсом, так как она была прервана другой операцией с тем же ресурсом. 429 SubscriptionTooManyCreateUpdateRequests — запросы сверх максимального количества запросов, которые могут быть обработаны доступными ресурсами. 429 SubscriptionTooManyRequests — запросы, превышающие максимальное количество запросов, которые могут быть обработаны доступными ресурсами. 500 OperationTimedOut — время ожидания операции истекло и автоматически откатывается. Повторите операцию. 503 TooManyRequests — запросы сверх максимального числа запросов, которые могут быть обработаны доступными ресурсами.

Примеры

Create or Update database extensions.

Export database using database extension.

Import database using database extension.

Create or Update database extensions.

Образец запроса

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

Пример ответа

Код состояния:

202

Код состояния:

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.

Образец запроса

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

Пример ответа

Код состояния:

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

Код состояния:

202

Import database using database extension.

Образец запроса

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

Пример ответа

Код состояния:

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

Код состояния:

202

Определения

Имя	Описание
DatabaseExtensions	Ресурс Import, Export или PolybaseImport.
ImportExportExtensionsOperationResult	Ресурс результата операции расширения.
NetworkIsolationSettings	Содержит ресурсы ARM, для которых необходимо создать подключение к частной конечной точке.
OperationMode	Режим работы операции: Import, Export или PolybaseImport.
PrivateEndpointConnectionRequestStatus	Содержит состояние запросов на подключение к частной конечной точке.
StorageKeyType	Тип ключа хранилища: StorageAccessKey или SharedAccessKey.

DatabaseExtensions

Ресурс Import, Export или PolybaseImport.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.administratorLogin	string	Имя входа администратора.
properties.administratorLoginPassword	string	Пароль для входа администратора.
properties.authenticationType	string	Тип проверки подлинности: проверка подлинности SQL или пароль AD.
properties.databaseEdition	string	Выпуск Базы данных для вновь созданной базы данных в случае операции импорта.
properties.maxSizeBytes	string	Максимальный размер базы данных в байтах для созданной базы данных в случае операции импорта.
properties.networkIsolation	NetworkIsolationSettings	Необязательные сведения о ресурсе для включения сетевой изоляции для запроса.
properties.operationMode	OperationMode	Режим работы операции: Import, Export или PolybaseImport.
properties.serviceObjectiveName	string	Цель уровня обслуживания базы данных для вновь созданной базы данных в случае операции импорта.
properties.storageKey	string	Ключ хранилища для учетной записи хранения.
properties.storageKeyType	StorageKeyType	Тип ключа хранилища: StorageAccessKey или SharedAccessKey.
properties.storageUri	string	URI хранилища для учетной записи хранения.
type	string	Тип ресурса.

ImportExportExtensionsOperationResult

Ресурс результата операции расширения.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.blobUri	string	URI большого двоичного объекта.
properties.databaseName	string	имя базы данных.
properties.errorMessage	string	Сообщение об ошибке.
properties.lastModifiedTime	string	Время последнего изменения.
properties.privateEndpointConnections	PrivateEndpointConnectionRequestStatus[]	Возвращает состояние частных конечных точек, связанных с этим запросом.
properties.queuedTime	string	Время постановки в очередь.
properties.requestId	string	Идентификатор запроса.
properties.requestType	string	Тип запроса.
properties.serverName	string	Имя сервера.
properties.status	string	Состояние операции.
type	string	Тип ресурса.

NetworkIsolationSettings

Содержит ресурсы ARM, для которых необходимо создать подключение к частной конечной точке.

Имя	Тип	Описание
sqlServerResourceId	string	Идентификатор ресурса для сервера SQL Server, который является целевым объектом этого запроса. Если задано значение , для сервера SQL Server будет создано подключение к частной конечной точке. Должен соответствовать серверу, который является целевым объектом операции.
storageAccountResourceId	string	Идентификатор ресурса для учетной записи хранения, используемой для хранения BACPAC-файла. Если этот параметр задан, для учетной записи хранения будет создано подключение к частной конечной точке. Должен соответствовать учетной записи хранения, используемой для параметра StorageUri.

OperationMode

Режим работы операции: Import, Export или PolybaseImport.

Имя	Тип	Описание
Export	string
Import	string
PolybaseImport	string

PrivateEndpointConnectionRequestStatus

Содержит состояние запросов на подключение к частной конечной точке.

Имя	Тип	Описание
privateEndpointConnectionName	string	Имя подключения для частной конечной точки.
privateLinkServiceId	string	Идентификатор ресурса, для которого создается частная конечная точка.
status	string	Состояние этого подключения к частной конечной точке.

StorageKeyType

Тип ключа хранилища: StorageAccessKey или SharedAccessKey.

Имя	Тип	Описание
SharedAccessKey	string
StorageAccessKey	string