Workspace Managed Sql Server Dedicated SQL Minimal Tls Settings - Update

Reference

Service:: Synapse

API Version:: 2021-06-01

Update server's tls settings.
Update workspace managed sql server's minimal tls settings.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/dedicatedSQLminimalTlsSettings/default?api-version=2021-06-01

URI Parameters

Name	In	Required	Type	Description
dedicatedSQLminimalTlsSettingsName	path	True	DedicatedSQLMinimalTlsSettingsName	The name of the dedicated sql minimal tls settings.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
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.

Request Body

Name	Type	Description
properties.minimalTlsVersion	string	The minimal tls version of the sql server.

Responses

Name

Type

Description

200 OK

DedicatedSQLminimalTlsSettings

Successfully updated dedicated sql minimal tls settings.

202 Accepted

Accepted

Other Status Codes

*** Error Responses: ***

404 SubscriptionDoesNotHaveServer - The requested server was not found.
404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.
409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.
500 InternalServerError - Something went wrong.

Examples

Update tls version of the workspace managed sql server

Sample request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/dedicatedSQLminimalTlsSettings/default?api-version=2021-06-01

{
  "properties": {
    "minimalTlsVersion": "1.1"
  }
}


import com.azure.resourcemanager.synapse.fluent.models.DedicatedSQLminimalTlsSettingsInner;
import com.azure.resourcemanager.synapse.models.DedicatedSqlMinimalTlsSettingsName;

/**
 * Samples for WorkspaceManagedSqlServerDedicatedSqlMinimalTlsSettings Update.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/
     * UpdateWorkspaceManagedSqlServerDedicatedSQLminimalTlsSettings.json
     */
    /**
     * Sample code: Update tls version of the workspace managed sql server.
     * 
     * @param manager Entry point to SynapseManager.
     */
    public static void
        updateTlsVersionOfTheWorkspaceManagedSqlServer(com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager.workspaceManagedSqlServerDedicatedSqlMinimalTlsSettings().update("workspace-6852", "workspace-2080",
            DedicatedSqlMinimalTlsSettingsName.DEFAULT,
            new DedicatedSQLminimalTlsSettingsInner().withMinimalTlsVersion("1.1"), 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 update_workspace_managed_sql_server_dedicated_sq_lminimal_tls_settings.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.workspace_managed_sql_server_dedicated_sql_minimal_tls_settings.begin_update(
        resource_group_name="workspace-6852",
        workspace_name="workspace-2080",
        dedicated_sq_lminimal_tls_settings_name="default",
        parameters={"properties": {"minimalTlsVersion": "1.1"}},
    ).result()
    print(response)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/UpdateWorkspaceManagedSqlServerDedicatedSQLminimalTlsSettings.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/UpdateWorkspaceManagedSqlServerDedicatedSQLminimalTlsSettings.json
func ExampleWorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient_BeginUpdate() {
	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.NewWorkspaceManagedSQLServerDedicatedSQLMinimalTLSSettingsClient().BeginUpdate(ctx, "workspace-6852", "workspace-2080", armsynapse.DedicatedSQLMinimalTLSSettingsNameDefault, armsynapse.DedicatedSQLminimalTLSSettings{
		Properties: &armsynapse.DedicatedSQLminimalTLSSettingsProperties{
			MinimalTLSVersion: to.Ptr("1.1"),
		},
	}, 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.DedicatedSQLminimalTLSSettings = armsynapse.DedicatedSQLminimalTLSSettings{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/dedicatedSQLminimalTlsSettings"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/dedicatedSQLminimalTlsSettings/default"),
	// 	Properties: &armsynapse.DedicatedSQLminimalTLSSettingsProperties{
	// 		MinimalTLSVersion: to.Ptr("1.1"),
	// 	},
	// }
}

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 Update workspace managed sql server's minimal tls settings.
 *
 * @summary Update workspace managed sql server's minimal tls settings.
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/UpdateWorkspaceManagedSqlServerDedicatedSQLminimalTlsSettings.json
 */
async function updateTlsVersionOfTheWorkspaceManagedSqlServer() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "workspace-6852";
  const workspaceName = "workspace-2080";
  const dedicatedSQLminimalTlsSettingsName = "default";
  const parameters = {
    minimalTlsVersion: "1.1",
  };
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const result =
    await client.workspaceManagedSqlServerDedicatedSQLMinimalTlsSettings.beginUpdateAndWait(
      resourceGroupName,
      workspaceName,
      dedicatedSQLminimalTlsSettingsName,
      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/UpdateWorkspaceManagedSqlServerDedicatedSQLminimalTlsSettings.json
// this example is just showing the usage of "WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettings_Update" 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 SynapseWorkspaceResource created on azure
// for more information of creating SynapseWorkspaceResource, please refer to the document of SynapseWorkspaceResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "workspace-6852";
string workspaceName = "workspace-2080";
ResourceIdentifier synapseWorkspaceResourceId = SynapseWorkspaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName);
SynapseWorkspaceResource synapseWorkspace = client.GetSynapseWorkspaceResource(synapseWorkspaceResourceId);

// get the collection of this SynapseDedicatedSqlMinimalTlsSettingResource
SynapseDedicatedSqlMinimalTlsSettingCollection collection = synapseWorkspace.GetSynapseDedicatedSqlMinimalTlsSettings();

// invoke the operation
SynapseDedicatedSqlMinimalTlsSettingName dedicatedSQLminimalTlsSettingsName = SynapseDedicatedSqlMinimalTlsSettingName.Default;
SynapseDedicatedSqlMinimalTlsSettingData data = new SynapseDedicatedSqlMinimalTlsSettingData()
{
    MinimalTlsVersion = "1.1",
};
ArmOperation<SynapseDedicatedSqlMinimalTlsSettingResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, dedicatedSQLminimalTlsSettingsName, data);
SynapseDedicatedSqlMinimalTlsSettingResource 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
SynapseDedicatedSqlMinimalTlsSettingData 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/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/dedicatedSQLminimalTlsSettings/default",
  "name": "default",
  "type": "Microsoft.Synapse/workspaces/dedicatedSQLminimalTlsSettings",
  "properties": {
    "minimalTlsVersion": "1.1"
  }
}

Status code:: 202

Definitions

Name	Description
DedicatedSQLminimalTlsSettings	Dedicated Sql Minimal Tls Settings Info
DedicatedSQLMinimalTlsSettingsName	The name of the dedicated sql minimal tls settings.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

DedicatedSQLminimalTlsSettings

Dedicated Sql Minimal Tls Settings Info

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Resource location.
name	string	The name of the resource
properties.minimalTlsVersion	string	The minimal tls version of the sql server.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

DedicatedSQLMinimalTlsSettingsName

The name of the dedicated sql minimal tls settings.

Name	Type	Description
default	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.