Sql Pool Restore Points - Create

Referentie

Service:: Synapse

API-versie:: 2021-06-01

Hiermee maakt u een herstelpunt voor een datawarehouse.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
sqlPoolName	path	True	string	Naam van SQL-pool
subscriptionId	path	True	string	De id van het doelabonnement.
workspaceName	path	True	string	De naam van de werkruimte.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
restorePointLabel	True	string	Het toe te passen herstelpuntlabel

Antwoorden

Name	Type	Description
200 OK	RestorePoint	De aanvraag voor het herstelpunt is gemaakt.
201 Created	RestorePoint	De aanvraag voor het herstelpunt is gemaakt.
202 Accepted		Geaccepteerd
Other Status Codes		Foutreacties: *** 400 FeatureDisabledOnSelectedEdition - Gebruiker heeft geprobeerd een functie te gebruiken die is uitgeschakeld in de huidige database-editie. 400 BackupNotAllowedOnDeactivatedDatabase : kan geen herstelpunt maken voor een gedeactiveerde database. 400 RestorePointLimitReached : er kan geen herstelpunt worden gemaakt omdat de database het toegestane quotum van herstelpunten overschrijdt. 400 RestorePointAttemptToDeleteSystemBackup - Kan systeemherstelpunt niet verwijderen. 404 DatabaseRestorePointNotFound - Kan databaseherstelpunt niet vinden. 404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden 404 DatabaseDoesNotExist - Gebruiker heeft een databasenaam opgegeven die niet bestaat op dit serverexemplaar. 408 DatabaseRestorePointTimedOut - Het maken van een databaseherstelpunt is mislukt.

Voorbeelden

Creates Sql pool restore point.

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 200

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

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

Statuscode:: 201

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

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

Statuscode:: 202

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

Definities

Name	Description
CreateSqlPoolRestorePointDefinition	Bevat de informatie die nodig is om een herstelpuntbewerking voor een SQL-pool te maken.
RestorePoint	Databaseherstelpunten.
RestorePointType	Het type herstelpunt

CreateSqlPoolRestorePointDefinition

Bevat de informatie die nodig is om een herstelpuntbewerking voor een SQL-pool te maken.

Name	Type	Description
restorePointLabel	string	Het toe te passen herstelpuntlabel

RestorePoint

Databaseherstelpunten.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Resourcelocatie.
name	string	De naam van de resource
properties.earliestRestoreDate	string	Het vroegste tijdstip waarop deze database kan worden hersteld
properties.restorePointCreationDate	string	Het tijdstip waarop de back-up is gemaakt
properties.restorePointLabel	string	Het label herstelpunt voor een back-upaanvraag door de gebruiker
properties.restorePointType	RestorePointType	Het type herstelpunt
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

RestorePointType

Het type herstelpunt

Name	Type	Description
CONTINUOUS	string
DISCRETE	string