Workspace Managed Sql Server Dedicated SQL Minimal Tls Settings - Update

Serviço:: Synapse

Versão da API:: 2021-06-01

Atualize as configurações tls do servidor.
Atualize as configurações mínimas de tls do SQL Server gerenciado pelo espaço de trabalho.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
dedicatedSQLminimalTlsSettingsName	path	True	DedicatedSQLMinimalTlsSettingsName	O nome das configurações dedicadas do sql minimal tls.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
workspaceName	path	True	string	O nome do espaço de trabalho.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Tipo	Description
properties.minimalTlsVersion	string	A versão tls mínima do servidor sql.

Respostas

Name

Tipo

Description

200 OK

DedicatedSQLminimalTlsSettings

Atualizado com sucesso configurações dedicadas sql minimal tls.

202 Accepted

Aceito

Other Status Codes

Respostas de erro: ***

404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado.
404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na assinatura especificados.
409 UnsupportedWorkspaceType - Operação sem suporte para o tipo de espaço de trabalho.
500 InternalServerError - Algo correu mal.

Exemplos

Update tls version of the workspace managed sql server

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
  }
}

Código de estado:: 202

Definições

Name	Description
DedicatedSQLminimalTlsSettings	Informações sobre configurações dedicadas do Sql Minimal Tls
DedicatedSQLMinimalTlsSettingsName	O nome das configurações dedicadas do sql minimal tls.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro

DedicatedSQLminimalTlsSettings

Object

Informações sobre configurações dedicadas do Sql Minimal Tls

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Localização do recurso.
name	string	O nome do recurso
properties.minimalTlsVersion	string	A versão tls mínima do servidor sql.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

DedicatedSQLMinimalTlsSettingsName

Enumeração

O nome das configurações dedicadas do sql minimal tls.

Valor	Description
default

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.