Workspace Managed Sql Server Encryption Protector - Create Or Update

Servicio:

Synapse

Versión de la API:

2021-06-01

Actualiza el protector de cifrado del servidor del área de trabajo.
Actualiza el protector de cifrado de sql Server administrado por el área de trabajo.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
encryptionProtectorName	path	True	EncryptionProtectorName	Nombre del protector de cifrado.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
workspaceName	path	True	string	Nombre del área de trabajo.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.serverKeyType	True	ServerKeyType	El tipo de protector de cifrado como "ServiceManaged", "AzureKeyVault".
properties.serverKeyName		string	Nombre de la clave de servidor.

Respuestas

Nombre	Tipo	Description
200 OK	EncryptionProtector	Protector de cifrado recuperado correctamente.
202 Accepted		Aceptado
Other Status Codes	ErrorResponse	Respuestas de error: *** 400 InvalidKeyName: se ha proporcionado un valor no válido para el nombre de clave del servidor. 400 InvalidKeyType: no se admite el tipo de clave de servidor create. 400 InvalidUpsertKeyType: Azure SQL administra las claves de tipo administrado por el servicio. Este tipo de clave no admite la creación o actualización por parte del usuario. 400 InvalidKeyUpsertRequest: la solicitud de creación de clave de servidor no existe o no tiene ningún objeto properties. 400 InvalidEncryptionProtectorName: no se admite el nombre de la clave del protector de cifrado. 400 SecurityAzureKeyVaultGeoChainError: no se admite la creación de una base de datos secundaria (un proceso conocido como encadenamiento) al habilitar el cifrado de datos transparente mediante Azure Key Vault (BYOK). 400 AzureKeyVaultInvalidExpirationDate: no se pudo completar la operación porque la fecha de expiración de la clave de Azure Key Vault no es válida. 400 SecurityAzureKeyVaultUrlNullOrEmpty: no se pudo completar la operación porque el URI de Azure Key Vault es nulo o está vacío. 400 AzureKeyVaultInvalidUri: una respuesta no válida de Azure Key Vault. Use un URI de Azure Key Vault válido. 400 SecurityAzureKeyVaultInvalidKeyName: no se pudo completar la operación debido a un nombre de clave de servidor no válido. 400 AzureKeyVaultMalformedVaultUri: el URI proporcionado de Key Vault no es válido. 400 SecurityAdalPrincipalCertExpiredError: no se pudo completar la operación porque el certificado de entidad de seguridad de Azure Key Vault ha expirado. 400 SecurityInvalidAzureKeyVaultRecoveryLevel: el URI proporcionado de Key Vault no es válido. 400 KeyMaterialNotFoundOnRemoteServer: el servidor remoto no tiene acceso al material de clave usado como protector TDE. 400 AzureKeyVaultMismatchError: región inesperada de Key Vault que se encuentra en la respuesta http. 400 AzureKeyVaultRsaKeyNotSupported: el almacén de claves proporcionado usa el tamaño de clave RSA o el tipo de clave RSA no admitidos. El tamaño de clave RSA admitido es 2048 y el tipo de clave es RSA. 401 AzureKeyVaultKeyDisabled: no se pudo completar la operación en el servidor porque la clave de Azure Key Vault está deshabilitada. 401 AzureKeyVaultNoServerIdentity: la identidad del servidor no está configurada correctamente. 401 AzureKeyVaultMissingPermissions: faltan permisos necesarios en el servidor de Azure Key Vault. 401 AdalGenericError: no se pudo completar la operación porque se encontró un error de Azure Active Directory. 401 AdalServicePrincipalNotFound: no se pudo completar la operación porque no se encontró un error en la entidad de servicio de la biblioteca de Azure Active Directory. 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado. 404 ResourceNotFound: no se encontró el recurso solicitado. 404 ServerKeyNotFound: no se encontró la clave de servidor solicitada en la suscripción actual. 409 ServerKeyNameAlreadyExists: la clave de servidor ya existe en el servidor. 409 ServerKeyUriAlreadyExists: el URI de la clave de servidor ya existe en el servidor. 409 ServerKeyDoesNotExists: la clave del servidor no existe. 409 AzureKeyVaultKeyNameNotFound: no se pudo completar la operación porque el nombre de la clave de Azure Key Vault no existe. 409 AzureKeyVaultKeyInUse: el servidor usa actualmente la clave. 409 NosupportedWorkspaceType: operación no admitida para el tipo de área de trabajo. 500 InternalServerError: algo salió mal. 503 AzureKeyVaultConnectionFailed: no se pudo completar la operación en el servidor porque se ha producido un error al intentar conectarse a Azure Key Vault 503 AzureKeyVaultGenericConnectionError: no se pudo completar la operación porque se encontró un error al intentar recuperar información de Key Vault.

Ejemplos

Update the encryption protector to key vault

Update the encryption protector to service managed

Update the encryption protector to key vault

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/encryptionProtector/current?api-version=2021-06-01

{
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "serverKeyName": "someVault_someKey_01234567890123456789012345678901"
  }
}

Java

import com.azure.resourcemanager.synapse.models.EncryptionProtector;
import com.azure.resourcemanager.synapse.models.EncryptionProtectorName;
import com.azure.resourcemanager.synapse.models.ServerKeyType;

/**
 * Samples for WorkspaceManagedSqlServerEncryptionProtector CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/
     * WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateKeyVault.json
     */
    /**
     * Sample code: Update the encryption protector to key vault.
     * 
     * @param manager Entry point to SynapseManager.
     */
    public static void
        updateTheEncryptionProtectorToKeyVault(com.azure.resourcemanager.synapse.SynapseManager manager) {
        EncryptionProtector resource
            = manager.workspaceManagedSqlServerEncryptionProtectors().getWithResponse("wsg-7398", "testWorkspace",
                EncryptionProtectorName.CURRENT, com.azure.core.util.Context.NONE).getValue();
        resource.update().withServerKeyName("someVault_someKey_01234567890123456789012345678901")
            .withServerKeyType(ServerKeyType.AZURE_KEY_VAULT).apply();
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# USAGE
    python workspace_managed_sql_server_encryption_protector_create_or_update_key_vault.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_encryption_protector.begin_create_or_update(
        resource_group_name="wsg-7398",
        workspace_name="testWorkspace",
        encryption_protector_name="current",
        parameters={
            "properties": {
                "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
                "serverKeyType": "AzureKeyVault",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateKeyVault.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

Go

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/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateKeyVault.json
func ExampleWorkspaceManagedSQLServerEncryptionProtectorClient_BeginCreateOrUpdate_updateTheEncryptionProtectorToKeyVault() {
	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.NewWorkspaceManagedSQLServerEncryptionProtectorClient().BeginCreateOrUpdate(ctx, "wsg-7398", "testWorkspace", armsynapse.EncryptionProtectorNameCurrent, armsynapse.EncryptionProtector{
		Properties: &armsynapse.EncryptionProtectorProperties{
			ServerKeyName: to.Ptr("someVault_someKey_01234567890123456789012345678901"),
			ServerKeyType: to.Ptr(armsynapse.ServerKeyTypeAzureKeyVault),
		},
	}, 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.EncryptionProtector = armsynapse.EncryptionProtector{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/encryptionProtector"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/encryptionProtector/current"),
	// 	Kind: to.Ptr("azurekeyvault"),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armsynapse.EncryptionProtectorProperties{
	// 		ServerKeyName: to.Ptr("someVault_someKey_01234567890123456789012345678901"),
	// 		ServerKeyType: to.Ptr(armsynapse.ServerKeyTypeAzureKeyVault),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Updates workspace managed sql server's encryption protector.
 *
 * @summary Updates workspace managed sql server's encryption protector.
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateKeyVault.json
 */
async function updateTheEncryptionProtectorToKeyVault() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "wsg-7398";
  const workspaceName = "testWorkspace";
  const encryptionProtectorName = "current";
  const parameters = {
    serverKeyName: "someVault_someKey_01234567890123456789012345678901",
    serverKeyType: "AzureKeyVault",
  };
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const result =
    await client.workspaceManagedSqlServerEncryptionProtector.beginCreateOrUpdateAndWait(
      resourceGroupName,
      workspaceName,
      encryptionProtectorName,
      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

dotnet

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

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateKeyVault.json
// this example is just showing the usage of "WorkspaceManagedSqlServerEncryptionProtector_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 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 = "wsg-7398";
string workspaceName = "testWorkspace";
ResourceIdentifier synapseWorkspaceResourceId = SynapseWorkspaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName);
SynapseWorkspaceResource synapseWorkspace = client.GetSynapseWorkspaceResource(synapseWorkspaceResourceId);

// get the collection of this SynapseEncryptionProtectorResource
SynapseEncryptionProtectorCollection collection = synapseWorkspace.GetSynapseEncryptionProtectors();

// invoke the operation
SynapseEncryptionProtectorName encryptionProtectorName = SynapseEncryptionProtectorName.Current;
SynapseEncryptionProtectorData data = new SynapseEncryptionProtectorData
{
    ServerKeyName = "someVault_someKey_01234567890123456789012345678901",
    ServerKeyType = SynapseServerKeyType.AzureKeyVault,
};
ArmOperation<SynapseEncryptionProtectorResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, encryptionProtectorName, data);
SynapseEncryptionProtectorResource 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
SynapseEncryptionProtectorData 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

Respuesta de muestra

status code:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Synapse/workspaces/encryptionProtector",
  "location": "West US",
  "kind": "azurekeyvault",
  "properties": {
    "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
    "serverKeyType": "AzureKeyVault"
  }
}

status code:

202

Update the encryption protector to service managed

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/encryptionProtector/current?api-version=2021-06-01

{
  "properties": {
    "serverKeyType": "ServiceManaged",
    "serverKeyName": "ServiceManaged"
  }
}

Java

import com.azure.resourcemanager.synapse.models.EncryptionProtector;
import com.azure.resourcemanager.synapse.models.EncryptionProtectorName;
import com.azure.resourcemanager.synapse.models.ServerKeyType;

/**
 * Samples for WorkspaceManagedSqlServerEncryptionProtector CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/
     * WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateServiceManaged.json
     */
    /**
     * Sample code: Update the encryption protector to service managed.
     * 
     * @param manager Entry point to SynapseManager.
     */
    public static void
        updateTheEncryptionProtectorToServiceManaged(com.azure.resourcemanager.synapse.SynapseManager manager) {
        EncryptionProtector resource
            = manager.workspaceManagedSqlServerEncryptionProtectors().getWithResponse("wsg-7398", "testWorkspace",
                EncryptionProtectorName.CURRENT, com.azure.core.util.Context.NONE).getValue();
        resource.update().withServerKeyName("ServiceManaged").withServerKeyType(ServerKeyType.SERVICE_MANAGED).apply();
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# USAGE
    python workspace_managed_sql_server_encryption_protector_create_or_update_service_managed.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_encryption_protector.begin_create_or_update(
        resource_group_name="wsg-7398",
        workspace_name="testWorkspace",
        encryption_protector_name="current",
        parameters={"properties": {"serverKeyName": "ServiceManaged", "serverKeyType": "ServiceManaged"}},
    ).result()
    print(response)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateServiceManaged.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

Go

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/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateServiceManaged.json
func ExampleWorkspaceManagedSQLServerEncryptionProtectorClient_BeginCreateOrUpdate_updateTheEncryptionProtectorToServiceManaged() {
	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.NewWorkspaceManagedSQLServerEncryptionProtectorClient().BeginCreateOrUpdate(ctx, "wsg-7398", "testWorkspace", armsynapse.EncryptionProtectorNameCurrent, armsynapse.EncryptionProtector{
		Properties: &armsynapse.EncryptionProtectorProperties{
			ServerKeyName: to.Ptr("ServiceManaged"),
			ServerKeyType: to.Ptr(armsynapse.ServerKeyTypeServiceManaged),
		},
	}, 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.EncryptionProtector = armsynapse.EncryptionProtector{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/encryptionProtector"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/encryptionProtector/current"),
	// 	Kind: to.Ptr("servicemanaged"),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armsynapse.EncryptionProtectorProperties{
	// 		ServerKeyName: to.Ptr("ServiceManaged"),
	// 		ServerKeyType: to.Ptr(armsynapse.ServerKeyTypeServiceManaged),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Updates workspace managed sql server's encryption protector.
 *
 * @summary Updates workspace managed sql server's encryption protector.
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateServiceManaged.json
 */
async function updateTheEncryptionProtectorToServiceManaged() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "wsg-7398";
  const workspaceName = "testWorkspace";
  const encryptionProtectorName = "current";
  const parameters = {
    serverKeyName: "ServiceManaged",
    serverKeyType: "ServiceManaged",
  };
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const result =
    await client.workspaceManagedSqlServerEncryptionProtector.beginCreateOrUpdateAndWait(
      resourceGroupName,
      workspaceName,
      encryptionProtectorName,
      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

dotnet

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

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateServiceManaged.json
// this example is just showing the usage of "WorkspaceManagedSqlServerEncryptionProtector_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 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 = "wsg-7398";
string workspaceName = "testWorkspace";
ResourceIdentifier synapseWorkspaceResourceId = SynapseWorkspaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName);
SynapseWorkspaceResource synapseWorkspace = client.GetSynapseWorkspaceResource(synapseWorkspaceResourceId);

// get the collection of this SynapseEncryptionProtectorResource
SynapseEncryptionProtectorCollection collection = synapseWorkspace.GetSynapseEncryptionProtectors();

// invoke the operation
SynapseEncryptionProtectorName encryptionProtectorName = SynapseEncryptionProtectorName.Current;
SynapseEncryptionProtectorData data = new SynapseEncryptionProtectorData
{
    ServerKeyName = "ServiceManaged",
    ServerKeyType = SynapseServerKeyType.ServiceManaged,
};
ArmOperation<SynapseEncryptionProtectorResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, encryptionProtectorName, data);
SynapseEncryptionProtectorResource 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
SynapseEncryptionProtectorData 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

Respuesta de muestra

status code:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Synapse/workspaces/encryptionProtector",
  "location": "West US",
  "kind": "servicemanaged",
  "properties": {
    "serverKeyName": "ServiceManaged",
    "serverKeyType": "ServiceManaged"
  }
}

status code:

202

Definiciones

Nombre	Description
EncryptionProtector	Protector de cifrado del servidor.
EncryptionProtectorName	Nombre del protector de cifrado.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ServerKeyType	El tipo de protector de cifrado como "ServiceManaged", "AzureKeyVault".

EncryptionProtector

Object

Protector de cifrado del servidor.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	Tipo de protector de cifrado. Estos son los metadatos que se usan para la experiencia de Azure Portal.
location	string	Ubicación del recurso.
name	string	Nombre del recurso
properties.serverKeyName	string	Nombre de la clave de servidor.
properties.serverKeyType	ServerKeyType	El tipo de protector de cifrado como "ServiceManaged", "AzureKeyVault".
properties.subregion	string	Subdivisión del protector de cifrado.
properties.thumbprint	string	Huella digital de la clave del servidor.
properties.uri	string	Identificador URI de la clave del servidor.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

EncryptionProtectorName

Enumeración

Nombre del protector de cifrado.

Valor	Description
current

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ServerKeyType

Enumeración

El tipo de protector de cifrado como "ServiceManaged", "AzureKeyVault".

Valor	Description
AzureKeyVault
ServiceManaged