Geo Backup Policies - Create Or Update

Reference

Service:: SQL Database

API Version:: 2014-04-01

Updates a database geo backup policy.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/geoBackupPolicies/Default?api-version=2014-04-01

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database.
geoBackupPolicyName	path	True	GeoBackupPolicyName	The name of the geo backup policy.
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Request Body

Name	Required	Type	Description
properties.state	True	GeoBackupPolicyState	The state of the geo backup policy.

Responses

Name	Type	Description
200 OK	GeoBackupPolicy	OK
201 Created	GeoBackupPolicy	Created

Examples

Update geo backup policy

Sample request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/testdw/geoBackupPolicies/Default?api-version=2014-04-01

{
  "properties": {
    "state": "Enabled"
  }
}

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.GeoBackupPolicyInner;
import com.azure.resourcemanager.sql.models.GeoBackupPolicyName;
import com.azure.resourcemanager.sql.models.GeoBackupPolicyState;

/** Samples for GeoBackupPolicies CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/GeoBackupPoliciesCreateOrUpdate.json
     */
    /**
     * Sample code: Update geo backup policy.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateGeoBackupPolicy(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .sqlServers()
            .manager()
            .serviceClient()
            .getGeoBackupPolicies()
            .createOrUpdateWithResponse(
                "sqlcrudtest-4799",
                "sqlcrudtest-5961",
                "testdw",
                GeoBackupPolicyName.DEFAULT,
                new GeoBackupPolicyInner().withState(GeoBackupPolicyState.ENABLED),
                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.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python geo_backup_policies_create_or_update.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 = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.geo_backup_policies.create_or_update(
        resource_group_name="sqlcrudtest-4799",
        server_name="sqlcrudtest-5961",
        database_name="testdw",
        geo_backup_policy_name="Default",
        parameters={"properties": {"state": "Enabled"}},
    )
    print(response)


# x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/GeoBackupPoliciesCreateOrUpdate.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 armsql_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/sql/armsql/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/a3913f4b26467aed413cdc907116e99894f08994/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/GeoBackupPoliciesCreateOrUpdate.json
func ExampleGeoBackupPoliciesClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsql.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewGeoBackupPoliciesClient().CreateOrUpdate(ctx, "sqlcrudtest-4799", "sqlcrudtest-5961", "testdw", armsql.GeoBackupPolicyNameDefault, armsql.GeoBackupPolicy{
		Properties: &armsql.GeoBackupPolicyProperties{
			State: to.Ptr(armsql.GeoBackupPolicyStateEnabled),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.GeoBackupPolicy = armsql.GeoBackupPolicy{
	// 	Name: to.Ptr("Default"),
	// 	Type: to.Ptr("Microsoft.Sql/servers/databases/geoBackupPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/testdw/geoBackupPolicies/Default"),
	// 	Properties: &armsql.GeoBackupPolicyProperties{
	// 		State: to.Ptr(armsql.GeoBackupPolicyStateEnabled),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Updates a database geo backup policy.
 *
 * @summary Updates a database geo backup policy.
 * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/GeoBackupPoliciesCreateOrUpdate.json
 */
async function updateGeoBackupPolicy() {
  const subscriptionId =
    process.env["SQL_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SQL_RESOURCE_GROUP"] || "sqlcrudtest-4799";
  const serverName = "sqlcrudtest-5961";
  const databaseName = "testdw";
  const geoBackupPolicyName = "Default";
  const parameters = { state: "Enabled" };
  const credential = new DefaultAzureCredential();
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.geoBackupPolicies.createOrUpdate(
    resourceGroupName,
    serverName,
    databaseName,
    geoBackupPolicyName,
    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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/GeoBackupPoliciesCreateOrUpdate.json
// this example is just showing the usage of "GeoBackupPolicies_CreateOrUpdate" 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 GeoBackupPolicyResource created on azure
// for more information of creating GeoBackupPolicyResource, please refer to the document of GeoBackupPolicyResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-4799";
string serverName = "sqlcrudtest-5961";
string databaseName = "testdw";
GeoBackupPolicyName geoBackupPolicyName = GeoBackupPolicyName.Default;
ResourceIdentifier geoBackupPolicyResourceId = GeoBackupPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, geoBackupPolicyName);
GeoBackupPolicyResource geoBackupPolicy = client.GetGeoBackupPolicyResource(geoBackupPolicyResourceId);

// invoke the operation
GeoBackupPolicyData data = new GeoBackupPolicyData(GeoBackupPolicyState.Enabled);
ArmOperation<GeoBackupPolicyResource> lro = await geoBackupPolicy.UpdateAsync(WaitUntil.Completed, data);
GeoBackupPolicyResource 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
GeoBackupPolicyData 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

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/testdw/geoBackupPolicies/Default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/databases/geoBackupPolicies",
  "location": null,
  "kind": null,
  "properties": {
    "state": "Enabled",
    "storageType": null
  }
}

Status code:: 201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/testdw/geoBackupPolicies/Default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/databases/geoBackupPolicies",
  "location": null,
  "kind": null,
  "properties": {
    "state": "Enabled",
    "storageType": null
  }
}

Definitions

Name	Description
GeoBackupPolicy	A database geo backup policy.
GeoBackupPolicyName	The name of the geo backup policy.
GeoBackupPolicyState	The state of the geo backup policy.

GeoBackupPolicy

A database geo backup policy.

Name	Type	Description
id	string	Resource ID.
kind	string	Kind of geo backup policy. This is metadata used for the Azure portal experience.
location	string	Backup policy location.
name	string	Resource name.
properties.state	GeoBackupPolicyState	The state of the geo backup policy.
properties.storageType	string	The storage type of the geo backup policy.
type	string	Resource type.

GeoBackupPolicyName

The name of the geo backup policy.

Name	Type	Description
Default	string

GeoBackupPolicyState

The state of the geo backup policy.

Name	Type	Description
Disabled	string
Enabled	string