Sql Pool Operation Results - Get Location Header Result

Reference

Service:: Synapse

API Version:: 2021-06-01

Get SQL pool operation status
Get the status of a SQL pool operation

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/operationResults/{operationId}?api-version=2021-06-01

URI Parameters

Name	In	Required	Type	Description
operationId	path	True	string	Operation ID
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
sqlPoolName	path	True	string	SQL pool name
subscriptionId	path	True	string	The ID of the target subscription.
workspaceName	path	True	string	The name of the workspace.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	SqlPool	OK
201 Created	SqlPool	Created
202 Accepted	SqlPool	Accepted
Other Status Codes	ErrorResponse

Examples

Get the result of an operation on a SQL Analytics pool

Sample Request

GET https://management.azure.com/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/sqlPools/ExampleSqlPool/operationResults/fedcba98-7654-4210-fedc-ba9876543210?api-version=2021-06-01

/** Samples for SqlPoolOperationResults GetLocationHeaderResult. */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetLocationHeaderResultWithSqlPool.json
     */
    /**
     * Sample code: Get the result of an operation on a SQL Analytics pool.
     *
     * @param manager Entry point to SynapseManager.
     */
    public static void getTheResultOfAnOperationOnASQLAnalyticsPool(
        com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager
            .sqlPoolOperationResults()
            .getLocationHeaderResult(
                "ExampleResourceGroup",
                "ExampleWorkspace",
                "ExampleSqlPool",
                "fedcba98-7654-4210-fedc-ba9876543210",
                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

from azure.identity import DefaultAzureCredential
from azure.mgmt.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# USAGE
    python get_location_header_result_with_sql_pool.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SynapseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="01234567-89ab-4def-0123-456789abcdef",
    )

    response = client.sql_pool_operation_results.begin_get_location_header_result(
        resource_group_name="ExampleResourceGroup",
        workspace_name="ExampleWorkspace",
        sql_pool_name="ExampleSqlPool",
        operation_id="fedcba98-7654-4210-fedc-ba9876543210",
    ).result()
    print(response)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetLocationHeaderResultWithSqlPool.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsynapse_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetLocationHeaderResultWithSqlPool.json
func ExampleSQLPoolOperationResultsClient_BeginGetLocationHeaderResult() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLPoolOperationResultsClient().BeginGetLocationHeaderResult(ctx, "ExampleResourceGroup", "ExampleWorkspace", "ExampleSqlPool", "fedcba98-7654-4210-fedc-ba9876543210", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SQLPool = armsynapse.SQLPool{
	// 	Name: to.Ptr("SampleSQLPool"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg_ursa/providers/Microsoft.Synapse/workspaces/ursascaneastus/sqlPools/SampleSQLPool"),
	// 	Location: to.Ptr("eastus"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armsynapse.SQLPoolResourceProperties{
	// 		Collation: to.Ptr("SQL_Latin1_General_CP1_CI_AS"),
	// 		CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-08-25T09:22:46.680Z"); return t}()),
	// 		MaxSizeBytes: to.Ptr[int64](263882790666240),
	// 		Status: to.Ptr("Paused"),
	// 	},
	// 	SKU: &armsynapse.SKU{
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SynapseManagementClient } = require("@azure/arm-synapse");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get the status of a SQL pool operation
 *
 * @summary Get the status of a SQL pool operation
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/GetLocationHeaderResultWithSqlPool.json
 */
async function getTheResultOfAnOperationOnASqlAnalyticsPool() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "01234567-89ab-4def-0123-456789abcdef";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "ExampleResourceGroup";
  const workspaceName = "ExampleWorkspace";
  const sqlPoolName = "ExampleSqlPool";
  const operationId = "fedcba98-7654-4210-fedc-ba9876543210";
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const result = await client.sqlPoolOperationResults.beginGetLocationHeaderResultAndWait(
    resourceGroupName,
    workspaceName,
    sqlPoolName,
    operationId
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "sku": {},
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 263882790666240,
    "status": "Paused",
    "creationDate": "2022-08-25T09:22:46.68Z"
  },
  "location": "eastus",
  "tags": {},
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg_ursa/providers/Microsoft.Synapse/workspaces/ursascaneastus/sqlPools/SampleSQLPool",
  "name": "SampleSQLPool",
  "type": "Microsoft.Synapse/workspaces/sqlPools"
}

Status code:: 202

{
  "sku": {},
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 263882790666240,
    "status": "Paused",
    "creationDate": "2022-08-25T09:22:46.68Z"
  },
  "location": "eastus",
  "tags": {},
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg_ursa/providers/Microsoft.Synapse/workspaces/ursascaneastus/sqlPools/SampleSQLPool",
  "name": "SampleSQLPool",
  "type": "Microsoft.Synapse/workspaces/sqlPools"
}

Status code:: 201

{
  "sku": {},
  "properties": {
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "maxSizeBytes": 263882790666240,
    "status": "Paused",
    "creationDate": "2022-08-25T09:22:46.68Z"
  },
  "location": "eastus",
  "tags": {},
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg_ursa/providers/Microsoft.Synapse/workspaces/ursascaneastus/sqlPools/SampleSQLPool",
  "name": "SampleSQLPool",
  "type": "Microsoft.Synapse/workspaces/sqlPools"
}

Definitions

Name	Description
createMode	Specifies the mode of sql pool creation. Default: regular sql pool creation. PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified. Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore. Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Sku	Sku
SqlPool	SQL pool
StorageAccountType	The storage account type used to store backups for this sql pool.

createMode

Specifies the mode of sql pool creation.

Default: regular sql pool creation.

PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.

Name	Type	Description
Default	string
PointInTimeRestore	string
Recovery	string
Restore	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Sku

Name	Type	Description
capacity	integer	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
name	string	The SKU name
tier	string	The service tier

SqlPool

SQL pool

Name	Type	Default Value	Description
id	string		Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.collation	string		Collation mode
properties.createMode	createMode		Specifies the mode of sql pool creation. Default: regular sql pool creation. PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified. Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore. Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.
properties.creationDate	string		Date the SQL pool was created
properties.maxSizeBytes	integer		Maximum size in bytes
properties.provisioningState	string		Resource state
properties.recoverableDatabaseId	string		Backup database to restore from
properties.restorePointInTime	string		Snapshot time to restore
properties.sourceDatabaseDeletionDate	string		Specifies the time that the sql pool was deleted
properties.sourceDatabaseId	string		Source database to create from
properties.status	string		Resource status
properties.storageAccountType	StorageAccountType	GRS	The storage account type used to store backups for this sql pool.
sku	Sku		Sku SQL pool SKU
tags	object		Resource tags.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

StorageAccountType

The storage account type used to store backups for this sql pool.

Name	Type	Description
GRS	string
LRS	string

Sql Pool Operation Results - Get Location Header Result

URI Parameters

Responses

Examples

Get the result of an operation on a SQL Analytics pool

Sample Request

Sample Response

Definitions

createMode

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Sku

SqlPool

StorageAccountType

Additional resources