Database Extensions - Create Or Update

Serviço:

SQL Database

Versão da API:

2021-11-01

Executar uma operação de extensão de banco de dados, como importação de banco de dados, exportação de banco de dados ou importação de polybase

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
databaseName	path	True	string	O nome do banco de dados.
extensionName	path	True	string
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.operationMode	True	OperationMode	Modo de operação da operação: Importar, Exportar ou PolybaseImport.
properties.storageKey	True	string	Chave de armazenamento para a conta de armazenamento.
properties.storageKeyType	True	StorageKeyType	Tipo de chave de armazenamento: StorageAccessKey ou SharedAccessKey.
properties.storageUri	True	string	URI de armazenamento para a conta de armazenamento.
properties.administratorLogin		string	Nome de logon do administrador.
properties.administratorLoginPassword		string	Senha de logon do administrador.
properties.authenticationType		string	Tipo de autenticação: autenticação sql ou senha do AD.
properties.databaseEdition		string	Edição de banco de dados para o banco de dados recém-criado no caso de uma operação de importação.
properties.maxSizeBytes		string	Tamanho máximo do banco de dados em bytes para o banco de dados recém-criado no caso de uma operação de importação.
properties.networkIsolation		NetworkIsolationSettings	Informações de recurso opcionais para habilitar o isolamento de rede para solicitação.
properties.serviceObjectiveName		string	Objetivo de nível de serviço de banco de dados para o banco de dados recém-criado no caso de uma operação de importação.

Respostas

Nome	Tipo	Description
200 OK	ImportExportExtensionsOperationResult	Operação de importação/exportação concluída com êxito.
202 Accepted		A operação de importação/exportação está em andamento.
Other Status Codes		Respostas de erro: *** 400 MissingImportExportInputParameters – Parâmetros de entrada ImportExport ausentes. 400 InvalidImportExportInputParameter - Falha na solicitação de importação/exportação devido a um parâmetro de entrada inválido. 400 PolybaseImportAuthenticationTypeNotSupported - O parâmetro de tipo de autenticação não é compatível com a operação PolybaseImport. 400 DatabaseExtensionsInvalidOperationMode - Parâmetro operationMode inválido para a extensão de banco de dados. 400 DatabaseExtensionsInvalidStorageKeyType - O tipo de chave de armazenamento deve ser 'StorageAccessKey'. 400 DatabaseExtensionsMissingStorageUri – O URI de armazenamento não pode estar vazio. 400 InvalidSku - O usuário especificou um sku inválido. 400 InvalidTierSkuCombination - A camada especificada não dá suporte ao sku especificado. 400 DatabaseInvalidSkuPropertyCombination – as propriedades do sku solicitado são inconsistentes. Marcar que uma combinação válida seja especificada. Consulte https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability para obter mais detalhes. 400 InvalidMaxSizeTierCombination – a camada especificada não dá suporte ao tamanho máximo do banco de dados especificado. 400 FeatureDisabledOnSelectedEdition - O usuário tentou usar um recurso que está desabilitado na edição atual do banco de dados. 400 InvalidImportExportParameter - Falha na solicitação de Importação/Exportação devido a um parâmetro de entrada inválido. 400 InvalidTier - O usuário especificou uma camada inválida. 400 InvalidOperationType - Forneça um tipo de operação válido. 400 ImportExportJobError - A operação ImportExport falhou. 400 BlockedByOutboundFirewall - As regras de firewall de saída bloquearam a solicitação. 404 ResourceNotFound - Solicitação inválida que especifica um recurso inexistente. 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na assinatura especificados. 404 ImportExportOperationIdNotFound - A ID da operação para importação ou exportação não pode ser encontrada. 404 ServerNotInSubscription – O servidor especificado não existe na assinatura especificada. 404 OperationIdNotFound - A operação com Id não existe. 409 ImportExportOperationInProgress - Há uma operação de importação ou exportação em andamento no banco de dados. 409 OperationCancelled - A operação foi cancelada pelo usuário. 409 OperationInterrupted - A operação no recurso não pôde ser concluída porque foi interrompida por outra operação no mesmo recurso. 429 SubscriptionTooManyCreateUpdateRequests - Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis. 429 SubscriptionTooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis. 500 OperationTimedOut - A operação atingiu o tempo limite e foi revertida automaticamente. Tente executar a operação novamente. 503 TooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis.

Exemplos

Create or Update database extensions.

Export database using database extension.

Import database using database extension.

Create or Update database extensions.

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

202

Código de status:

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.

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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

Código de status:

202

Import database using database extension.

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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

Código de status:

202

Definições

Nome	Description
DatabaseExtensions	Um recurso Importar, Exportar ou PolybaseImport.
ImportExportExtensionsOperationResult	Um recurso de resultado da operação de extensão.
NetworkIsolationSettings	Contém os recursos do ARM para os quais criar uma conexão de ponto de extremidade privado.
OperationMode	Modo de operação da operação: Importar, Exportar ou PolybaseImport.
PrivateEndpointConnectionRequestStatus	Contém as solicitações de conexão de ponto de extremidade privado status.
StorageKeyType	Tipo de chave de armazenamento: StorageAccessKey ou SharedAccessKey.

DatabaseExtensions

Um recurso Importar, Exportar ou PolybaseImport.

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.administratorLogin	string	Nome de logon do administrador.
properties.administratorLoginPassword	string	Senha de logon do administrador.
properties.authenticationType	string	Tipo de autenticação: autenticação sql ou senha do AD.
properties.databaseEdition	string	Edição de banco de dados para o banco de dados recém-criado no caso de uma operação de importação.
properties.maxSizeBytes	string	Tamanho máximo do banco de dados em bytes para o banco de dados recém-criado no caso de uma operação de importação.
properties.networkIsolation	NetworkIsolationSettings	Informações de recurso opcionais para habilitar o isolamento de rede para solicitação.
properties.operationMode	OperationMode	Modo de operação da operação: Importar, Exportar ou PolybaseImport.
properties.serviceObjectiveName	string	Objetivo de nível de serviço de banco de dados para o banco de dados recém-criado no caso de uma operação de importação.
properties.storageKey	string	Chave de armazenamento para a conta de armazenamento.
properties.storageKeyType	StorageKeyType	Tipo de chave de armazenamento: StorageAccessKey ou SharedAccessKey.
properties.storageUri	string	URI de armazenamento para a conta de armazenamento.
type	string	Tipo de recurso.

ImportExportExtensionsOperationResult

Um recurso de resultado da operação de extensão.

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.blobUri	string	URI do blob.
properties.databaseName	string	nome do banco de dados.
properties.errorMessage	string	Mensagem de erro.
properties.lastModifiedTime	string	Hora da última modificação.
properties.privateEndpointConnections	PrivateEndpointConnectionRequestStatus[]	Obtém o status de pontos de extremidade privados associados a essa solicitação.
properties.queuedTime	string	Tempo na fila.
properties.requestId	string	ID da solicitação.
properties.requestType	string	Tipo de solicitação.
properties.serverName	string	Nome de servidor.
properties.status	string	Status da operação.
type	string	Tipo de recurso.

NetworkIsolationSettings

Contém os recursos do ARM para os quais criar uma conexão de ponto de extremidade privado.

Nome	Tipo	Description
sqlServerResourceId	string	A ID do recurso para o SQL Server que é o destino dessa solicitação. Se definido, a conexão de ponto de extremidade privado será criada para o SQL Server. Deve corresponder ao servidor que é o destino da operação.
storageAccountResourceId	string	A ID do recurso da conta de armazenamento usada para armazenar o arquivo BACPAC. Se definido, a conexão de ponto de extremidade privado será criada para a conta de armazenamento. Deve corresponder à conta de armazenamento usada para o parâmetro StorageUri.

OperationMode

Modo de operação da operação: Importar, Exportar ou PolybaseImport.

Nome	Tipo	Description
Export	string
Import	string
PolybaseImport	string

PrivateEndpointConnectionRequestStatus

Contém as solicitações de conexão de ponto de extremidade privado status.

Nome	Tipo	Description
privateEndpointConnectionName	string	O nome da conexão para o ponto de extremidade privado.
privateLinkServiceId	string	ID do recurso para o qual o ponto de extremidade privado é criado.
status	string	Status dessa conexão de ponto de extremidade privado.

StorageKeyType

Tipo de chave de armazenamento: StorageAccessKey ou SharedAccessKey.

Nome	Tipo	Description
SharedAccessKey	string
StorageAccessKey	string