Workspace Managed Sql Server Encryption Protector - Create Or Update

Szolgáltatás:

Synapse

API-verzió:

2021-06-01

Frissíti a munkaterület-kiszolgáló titkosítási védőjét.
Frissíti a munkaterület által felügyelt SQL Server titkosítási védőjét.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
encryptionProtectorName	path	True	EncryptionProtectorName	A titkosítási védő neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
workspaceName	path	True	string	A munkaterület neve.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
properties.serverKeyType	True	ServerKeyType	A titkosítási védő típusa, például "ServiceManaged", "AzureKeyVault".
properties.serverKeyName		string	A kiszolgálókulcs neve.

Válaszok

Name	Típus	Description
200 OK	EncryptionProtector	Sikeresen lekért titkosítási védő.
202 Accepted		Elfogadott
Other Status Codes	ErrorResponse	Hibaválaszok: *** 400 InvalidKeyName – Érvénytelen érték lett megadva a kiszolgálókulcs nevéhez. 400 InvalidKeyType – A kiszolgálókulcs létrehozása nem támogatott. 400 InvalidUpsertKeyType – A szolgáltatás által felügyelt típuskulcsokat az Azure SQL kezeli. Ez a kulcstípus nem támogatja a felhasználó általi létrehozást vagy frissítést. 400 InvalidKeyUpsertRequest – A kiszolgálókulcs létrehozása nem létezik, vagy nincs tulajdonságobjektuma. 400 InvalidEncryptionProtectorName – A titkosítási védőkulcs neve nem támogatott. 400 SecurityAzureKeyVaultGeoChainError – A másodlagos (láncolásnak nevezett) folyamat másodlagos létrehozása nem támogatott az Transzparens adattitkosítás Azure Key Vault (BYOK) használatával történő engedélyezésekor. 400 AzureKeyVaultInvalidExpirationDate – A művelet nem hajtható végre, mert az Azure Key Vault kulcs lejárati dátuma érvénytelen. 400 SecurityAzureKeyVaultUrlNullOrEmpty – A művelet nem hajtható végre, mert az Azure Key Vault Uri értéke null értékű vagy üres. 400 AzureKeyVaultInvalidUri – Érvénytelen válasz az Azure Key Vaulttól. Használjon érvényes Azure Key Vault URI-t. 400 SecurityAzureKeyVaultInvalidKeyName – Érvénytelen kiszolgálókulcsnév miatt nem sikerült végrehajtani a műveletet. 400 AzureKeyVaultMalformedVaultUri – A megadott Key Vault uri érvénytelen. 400 SecurityAdalPrincipalCertExpiredError – A művelet nem hajtható végre, mert az Azure Key Vault főtanúsítványa lejárt. 400 SecurityInvalidAzureKeyVaultRecoveryLevel – A megadott Key Vault URI érvénytelen. 400 KeyMaterialNotFoundOnRemoteServer – A távoli kiszolgáló nem rendelkezik hozzáféréssel a TDE-védőként használt kulcsanyagokhoz. 400 AzureKeyVaultMismatchError – Váratlan Key Vault-régió található a http-válaszban. 400 AzureKeyVaultRsaKeyNotSupported – A megadott kulcstartó nem támogatott RSA-kulcsméretet vagy kulcstípust használ. A támogatott RSA-kulcsméret 2048, a kulcstípus pedig RSA. 401 AzureKeyVaultKeyDisabled – A művelet nem hajtható végre a kiszolgálón, mert az Azure Key Vault-kulcs le van tiltva. 401 AzureKeyVaultNoServerIdentity – A kiszolgálóidentitás nincs megfelelően konfigurálva. 401 AzureKeyVaultMissingPermissions – A kiszolgáló nem rendelkezik szükséges engedélyekkel az Azure Key Vaultban. 401 AdalGenericError – A művelet nem hajtható végre, mert hiba történt az Azure Active Directoryban. 401 AdalServicePrincipalNotFound – A művelet nem hajtható végre, mert egy Azure Active Directory-kódtár szolgáltatásnév nem talált hibát. 404 ServerNotInSubscriptionResourceGroup – A megadott kiszolgáló nem létezik a megadott erőforráscsoportban és -előfizetésben. 404 SubscriptionDoesNotHaveServer – A kért kiszolgáló nem található 404 ResourceNotFound – A kért erőforrás nem található. 404 ServerKeyNotFound – A kért kiszolgálókulcs nem található az aktuális előfizetésben. 409 ServerKeyNameAlreadyExists – A kiszolgálókulcs már létezik a kiszolgálón. 409 ServerKeyUriAlreadyExists – A kiszolgálókulcs URI-ja már létezik a kiszolgálón. 409 ServerKeyDoesNotExists – A kiszolgálókulcs nem létezik. 409 AzureKeyVaultKeyNameNotFound – A művelet nem hajtható végre, mert az Azure Key Vault kulcsneve nem létezik. 409 AzureKeyVaultKeyInUse – A kulcsot jelenleg a kiszolgáló használja. 409 UnsupportedWorkspaceType – A munkaterülettípus nem támogatott művelete. 500 InternalServerError – Hiba történt. 503 AzureKeyVaultConnectionFailed – A művelet nem hajtható végre a kiszolgálón, mert sikertelen volt az Azure Key Vaulthoz való kapcsolódási kísérlet 503 AzureKeyVaultGenericConnectionError – A művelet nem hajtható végre, mert hiba történt a Key Vault adatainak lekérésekor.

Példák

Update the encryption protector to key vault

Update the encryption protector to service managed

Update the encryption protector to key vault

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Állapotkód:

202

Update the encryption protector to service managed

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Állapotkód:

202

Definíciók

Name	Description
EncryptionProtector	A kiszolgálótitkosítási védő.
EncryptionProtectorName	A titkosítási védő neve.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
ServerKeyType	A titkosítási védő típusa, például "ServiceManaged", "AzureKeyVault".

EncryptionProtector

Objektum

A kiszolgálótitkosítási védő.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	Egyfajta titkosítási védő. Ez az Azure Portal felhasználói élményéhez használt metaadatok.
location	string	Erőforrás helye.
name	string	Az erőforrás neve
properties.serverKeyName	string	A kiszolgálókulcs neve.
properties.serverKeyType	ServerKeyType	A titkosítási védő típusa, például "ServiceManaged", "AzureKeyVault".
properties.subregion	string	A titkosítási védő alrégiója.
properties.thumbprint	string	A kiszolgálókulcs ujjlenyomata.
properties.uri	string	A kiszolgálókulcs URI-ja.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

EncryptionProtectorName

Enumerálás

A titkosítási védő neve.

Érték	Description
current

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

ServerKeyType

Enumerálás

A titkosítási védő típusa, például "ServiceManaged", "AzureKeyVault".

Érték	Description
AzureKeyVault
ServiceManaged