Managed Database Transparent Data Encryption - Create Or Update

Servizio:

SQL Database

Versione API:

2025-01-01

Aggiorna la configurazione transparent data encryption di un database.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/transparentDataEncryption/current?api-version=2025-01-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
databaseName	path	True	string	Nome del database.
managedInstanceName	path	True	string	Nome dell'istanza gestita.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
tdeName	path	True	TransparentDataEncryptionName	Nome della configurazione di Transparent Data Encryption.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties.state	True	TransparentDataEncryptionState	Specifica lo stato di Transparent Data Encryption.

Risposte

Nome	Tipo	Descrizione
200 OK	ManagedTransparentDataEncryption	Operazione di aggiornamento 'ManagedTransparentDataEncryption' della risorsa riuscita
201 Created	ManagedTransparentDataEncryption	Risorsa 'ManagedTransparentDataEncryption' crea operazione con successo
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Update a database's Transparent Data Encryption state with minimal parameters

Esempio di richiesta

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securitytde-42-rg/providers/Microsoft.Sql/managedInstances/securitytde-42/databases/testdb/transparentDataEncryption/current?api-version=2025-01-01

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

Java

import com.azure.resourcemanager.sql.fluent.models.ManagedTransparentDataEncryptionInner;
import com.azure.resourcemanager.sql.models.TransparentDataEncryptionName;
import com.azure.resourcemanager.sql.models.TransparentDataEncryptionState;

/**
 * Samples for ManagedDatabaseTransparentDataEncryption CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/ManagedTransparentDataEncryptionUpdate.json
     */
    /**
     * Sample code: Update a database's Transparent Data Encryption state with minimal parameters.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void updateADatabaseSTransparentDataEncryptionStateWithMinimalParameters(
        com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getManagedDatabaseTransparentDataEncryptions().createOrUpdateWithResponse(
            "securitytde-42-rg", "securitytde-42", "testdb", TransparentDataEncryptionName.CURRENT,
            new ManagedTransparentDataEncryptionInner().withState(TransparentDataEncryptionState.ENABLED),
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python managed_transparent_data_encryption_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="SUBSCRIPTION_ID",
    )

    response = client.managed_database_transparent_data_encryption.create_or_update(
        resource_group_name="securitytde-42-rg",
        managed_instance_name="securitytde-42",
        database_name="testdb",
        tde_name="current",
        parameters={"properties": {"state": "Enabled"}},
    )
    print(response)


# x-ms-original-file: 2025-01-01/ManagedTransparentDataEncryptionUpdate.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

JavaScript

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

/**
 * This sample demonstrates how to updates a database's transparent data encryption configuration.
 *
 * @summary updates a database's transparent data encryption configuration.
 * x-ms-original-file: 2025-01-01/ManagedTransparentDataEncryptionUpdate.json
 */
async function updateADatabaseTransparentDataEncryptionStateWithMinimalParameters() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.managedDatabaseTransparentDataEncryption.createOrUpdate(
    "securitytde-42-rg",
    "securitytde-42",
    "testdb",
    "current",
    { state: "Enabled" },
  );
  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.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/ManagedTransparentDataEncryptionUpdate.json
// this example is just showing the usage of "ManagedDatabaseTransparentDataEncryption_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 ManagedTransparentDataEncryptionResource created on azure
// for more information of creating ManagedTransparentDataEncryptionResource, please refer to the document of ManagedTransparentDataEncryptionResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "securitytde-42-rg";
string managedInstanceName = "securitytde-42";
string databaseName = "testdb";
TransparentDataEncryptionName tdeName = TransparentDataEncryptionName.Current;
ResourceIdentifier managedTransparentDataEncryptionResourceId = ManagedTransparentDataEncryptionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, databaseName, tdeName);
ManagedTransparentDataEncryptionResource managedTransparentDataEncryption = client.GetManagedTransparentDataEncryptionResource(managedTransparentDataEncryptionResourceId);

// invoke the operation
ManagedTransparentDataEncryptionData data = new ManagedTransparentDataEncryptionData
{
    State = TransparentDataEncryptionState.Enabled,
};
ArmOperation<ManagedTransparentDataEncryptionResource> lro = await managedTransparentDataEncryption.UpdateAsync(WaitUntil.Completed, data);
ManagedTransparentDataEncryptionResource 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
ManagedTransparentDataEncryptionData 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

Risposta di esempio

Codice di stato:

200

{
  "name": "current",
  "type": "Microsoft.Sql/managedInstances/databases/transparentDataEncryption",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securitytde-42-rg/providers/Microsoft.Sql/managedInstances/securitytde-42/databases/testdb/transparentDataEncryption/current",
  "properties": {
    "state": "Enabled"
  }
}

Codice di stato:

201

{
  "name": "current",
  "type": "Microsoft.Sql/managedInstances/databases/transparentDataEncryption",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securitytde-42-rg/providers/Microsoft.Sql/managedInstances/securitytde-42/databases/testdb/transparentDataEncryption/current",
  "properties": {
    "state": "Enabled"
  }
}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
ManagedTransparentDataEncryption	Uno stato transparent data encryption del database gestito.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
TransparentDataEncryptionName	Nome della configurazione di Transparent Data Encryption.
TransparentDataEncryptionState	Specifica lo stato di Transparent Data Encryption.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

ManagedTransparentDataEncryption

Oggetto

Uno stato transparent data encryption del database gestito.

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nome della risorsa
properties.state	TransparentDataEncryptionState	Specifica lo stato di Transparent Data Encryption.
systemData	systemData	Azure Resource Manager metadati contenenti informazioni createBy e modifiedBy.
type	string	Tipo di risorsa. Ad esempio: "Microsoft. Compute/virtualMachines" oppure "Microsoft. Storage/storageAccounts"

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Il timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

TransparentDataEncryptionName

Enumerazione

Nome della configurazione di Transparent Data Encryption.

Valore	Descrizione
current	corrente

TransparentDataEncryptionState

Enumerazione

Specifica lo stato di Transparent Data Encryption.

Valore	Descrizione
Enabled	Enabled
Disabled	Disattivato