Sql Pool Restore Points - Create

Reference

Service:: Synapse

API Version:: 2021-06-01

Vytvoří bod obnovení pro datový sklad.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
sqlPoolName	path	True	string	Název fondu SQL
subscriptionId	path	True	string	ID cílového předplatného.
workspaceName	path	True	string	Název pracovního prostoru.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
restorePointLabel	True	string	Popisek bodu obnovení, který se má použít

Odpovědi

Name	Typ	Description
200 OK	RestorePoint	Žádost o bod obnovení se úspěšně vytvořila.
201 Created	RestorePoint	Žádost o bod obnovení se úspěšně vytvořila.
202 Accepted		Přijato
Other Status Codes		Chybové odpovědi: *** 400 FeatureDisabledOnSelectedEdition – uživatel se pokusil použít funkci, která je v aktuální edici databáze zakázaná. 400 BackupNotAllowedOnDeactivatedDatabase – Nelze vytvořit bod obnovení v deaktivované databázi. 400 RestorePointLimitReached – Bod obnovení nelze vytvořit, protože databáze by překročila povolenou kvótu bodů obnovení. 400 RestorePointAttemptToDeleteSystemBackup – Bod obnovení systému nelze odstranit. 404 DatabaseRestorePointNotFound – Nelze najít bod obnovení databáze. 404 SubscriptionDoesNotHaveServer – Požadovaný server se nenašel. 404 DatabaseDoesNotExist – Uživatel zadal název databáze, který na této instanci serveru neexistuje. 408 DatabaseRestorePointTimedOut – Vytvoření bodu obnovení databáze se nezdařilo.

Příklady

Creates Sql pool restore point.

Sample Request

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Synapse/workspaces/testserver/sqlPools/testDatabase/restorePoints?api-version=2021-06-01

{
  "restorePointLabel": "mylabel"
}

import com.azure.resourcemanager.synapse.models.CreateSqlPoolRestorePointDefinition;

/** Samples for SqlPoolRestorePoints Create. */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateSqlPoolRestorePoints.json
     */
    /**
     * Sample code: Creates Sql pool restore point.
     *
     * @param manager Entry point to SynapseManager.
     */
    public static void createsSqlPoolRestorePoint(com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager
            .sqlPoolRestorePoints()
            .create(
                "Default-SQL-SouthEastAsia",
                "testserver",
                "testDatabase",
                new CreateSqlPoolRestorePointDefinition().withRestorePointLabel("mylabel"),
                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 create_sql_pool_restore_points.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="00000000-1111-2222-3333-444444444444",
    )

    response = client.sql_pool_restore_points.begin_create(
        resource_group_name="Default-SQL-SouthEastAsia",
        workspace_name="testserver",
        sql_pool_name="testDatabase",
        parameters={"restorePointLabel": "mylabel"},
    ).result()
    print(response)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateSqlPoolRestorePoints.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/azcore/to"
	"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/CreateSqlPoolRestorePoints.json
func ExampleSQLPoolRestorePointsClient_BeginCreate() {
	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.NewSQLPoolRestorePointsClient().BeginCreate(ctx, "Default-SQL-SouthEastAsia", "testserver", "testDatabase", armsynapse.CreateSQLPoolRestorePointDefinition{
		RestorePointLabel: to.Ptr("mylabel"),
	}, 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.RestorePoint = armsynapse.RestorePoint{
	// 	Name: to.Ptr("131546477590000000"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/restorePoints"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces/testserver/sqlPools/testDatabase/restorePoints/131546477590000000"),
	// 	Location: to.Ptr("japaneast"),
	// 	Properties: &armsynapse.RestorePointProperties{
	// 		RestorePointCreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-10T08:00:00.000Z"); return t}()),
	// 		RestorePointLabel: to.Ptr("mylabel"),
	// 		RestorePointType: to.Ptr(armsynapse.RestorePointTypeDISCRETE),
	// 	},
	// }
}

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 Creates a restore point for a data warehouse.
 *
 * @summary Creates a restore point for a data warehouse.
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateSqlPoolRestorePoints.json
 */
async function createsSqlPoolRestorePoint() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "Default-SQL-SouthEastAsia";
  const workspaceName = "testserver";
  const sqlPoolName = "testDatabase";
  const parameters = {
    restorePointLabel: "mylabel",
  };
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const result = await client.sqlPoolRestorePoints.beginCreateAndWait(
    resourceGroupName,
    workspaceName,
    sqlPoolName,
    parameters
  );
  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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Synapse;
using Azure.ResourceManager.Synapse.Models;

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/CreateSqlPoolRestorePoints.json
// this example is just showing the usage of "SqlPoolRestorePoints_Create" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SynapseSqlPoolResource created on azure
// for more information of creating SynapseSqlPoolResource, please refer to the document of SynapseSqlPoolResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string workspaceName = "testserver";
string sqlPoolName = "testDatabase";
ResourceIdentifier synapseSqlPoolResourceId = SynapseSqlPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, sqlPoolName);
SynapseSqlPoolResource synapseSqlPool = client.GetSynapseSqlPoolResource(synapseSqlPoolResourceId);

// invoke the operation
SqlPoolCreateRestorePointContent content = new SqlPoolCreateRestorePointContent("mylabel");
ArmOperation<SynapseRestorePointResource> lro = await synapseSqlPool.CreateSqlPoolRestorePointAsync(WaitUntil.Completed, content);
SynapseRestorePointResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SynapseRestorePointData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

azure-asyncoperation: https://ms.web.azuresynapse.net

Response Body

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces/testserver/sqlPools/testDatabase/restorePoints/131546477590000000",
  "name": "131546477590000000",
  "type": "Microsoft.Synapse/workspaces/sqlPools/restorePoints",
  "location": "japaneast",
  "properties": {
    "restorePointType": "DISCRETE",
    "restorePointCreationDate": "2017-03-10T08:00:00.000Z",
    "restorePointLabel": "mylabel"
  }
}

Status code:: 201

azure-asyncoperation: https://ms.web.azuresynapse.net

Response Body

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces/testserver/sqlPools/testDatabase/restorePoints/131546477590000000",
  "name": "131546477590000000",
  "type": "Microsoft.Synapse/workspaces/sqlPools/restorePoints",
  "location": "japaneast",
  "properties": {
    "restorePointType": "DISCRETE",
    "restorePointCreationDate": "2017-03-10T08:00:00.000Z",
    "restorePointLabel": "mylabel"
  }
}

Status code:: 202

azure-asyncoperation: https://ms.web.azuresynapse.net

Definice

Name	Description
CreateSqlPoolRestorePointDefinition	Obsahuje informace potřebné k provedení operace vytvoření bodu obnovení fondu SQL.
RestorePoint	Body obnovení databáze.
RestorePointType	Typ bodu obnovení

CreateSqlPoolRestorePointDefinition

Obsahuje informace potřebné k provedení operace vytvoření bodu obnovení fondu SQL.

Name	Typ	Description
restorePointLabel	string	Popisek bodu obnovení, který se má použít

RestorePoint

Body obnovení databáze.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
location	string	Umístění prostředku.
name	string	Název prostředku
properties.earliestRestoreDate	string	Nejstarší čas, do kterého lze tuto databázi obnovit
properties.restorePointCreationDate	string	Čas, kdy bylo zálohování pořízeno
properties.restorePointLabel	string	Popisek bodu obnovení pro žádost uživatele o zálohu
properties.restorePointType	RestorePointType	Typ bodu obnovení
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

RestorePointType

Typ bodu obnovení

Name	Typ	Description
CONTINUOUS	string
DISCRETE	string