Managed Database Sensitivity Labels - Update

Servizio:

SQL Database

Versione API:

2025-01-01

Aggiornare le etichette di riservatezza di un determinato database usando un batch di operazioni.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/currentSensitivityLabels?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.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
operations	SensitivityLabelUpdate[]	Operazione di aggiornamento delle etichette di riservatezza.

Risposte

Nome	Tipo	Descrizione
200 OK		La richiesta ha avuto esito positivo.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

azure_auth

Azure Active Directory OAuth2 Flow.

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 sensitivity labels of a given database using an operations batch.

Esempio di richiesta

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/currentSensitivityLabels?api-version=2025-01-01

{
  "operations": [
    {
      "properties": {
        "schema": "dbo",
        "column": "column1",
        "op": "set",
        "sensitivityLabel": {
          "properties": {
            "informationType": "Financial",
            "informationTypeId": "1D3652D6-422C-4115-82F1-65DAEBC665C8",
            "labelId": "3A477B16-9423-432B-AA97-6069B481CEC3",
            "labelName": "Highly Confidential"
          }
        },
        "table": "table1"
      }
    },
    {
      "properties": {
        "schema": "dbo",
        "column": "column2",
        "op": "set",
        "sensitivityLabel": {
          "properties": {
            "informationType": "PhoneNumber",
            "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
            "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
            "labelName": "PII"
          }
        },
        "table": "table2"
      }
    },
    {
      "properties": {
        "schema": "dbo",
        "column": "Column3",
        "op": "remove",
        "table": "Table1"
      }
    }
  ]
}

Java

import com.azure.resourcemanager.sql.fluent.models.SensitivityLabelInner;
import com.azure.resourcemanager.sql.fluent.models.SensitivityLabelUpdateInner;
import com.azure.resourcemanager.sql.models.SensitivityLabelUpdateKind;
import com.azure.resourcemanager.sql.models.SensitivityLabelUpdateList;
import java.util.Arrays;

/**
 * Samples for ManagedDatabaseSensitivityLabels Update.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/ManagedDatabaseSensitivityLabelsCurrentUpdate.json
     */
    /**
     * Sample code: Update sensitivity labels of a given database using an operations batch.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void updateSensitivityLabelsOfAGivenDatabaseUsingAnOperationsBatch(
        com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getManagedDatabaseSensitivityLabels().updateWithResponse("myRG",
            "myManagedInstanceName", "myDatabase",
            new SensitivityLabelUpdateList().withOperations(Arrays.asList(
                new SensitivityLabelUpdateInner().withOp(SensitivityLabelUpdateKind.SET).withSchema("dbo")
                    .withTable("table1").withColumn("column1")
                    .withSensitivityLabel(new SensitivityLabelInner().withLabelName("Highly Confidential")
                        .withLabelId("3A477B16-9423-432B-AA97-6069B481CEC3").withInformationType("Financial")
                        .withInformationTypeId("1D3652D6-422C-4115-82F1-65DAEBC665C8")),
                new SensitivityLabelUpdateInner().withOp(SensitivityLabelUpdateKind.SET).withSchema("dbo")
                    .withTable("table2").withColumn("column2")
                    .withSensitivityLabel(new SensitivityLabelInner().withLabelName("PII")
                        .withLabelId("bf91e08c-f4f0-478a-b016-25164b2a65ff").withInformationType("PhoneNumber")
                        .withInformationTypeId("d22fa6e9-5ee4-3bde-4c2b-a409604c4646")),
                new SensitivityLabelUpdateInner().withOp(SensitivityLabelUpdateKind.REMOVE).withSchema("dbo")
                    .withTable("Table1").withColumn("Column3"))),
            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_database_sensitivity_labels_current_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",
    )

    client.managed_database_sensitivity_labels.update(
        resource_group_name="myRG",
        managed_instance_name="myManagedInstanceName",
        database_name="myDatabase",
        parameters={
            "operations": [
                {
                    "properties": {
                        "column": "column1",
                        "op": "set",
                        "schema": "dbo",
                        "sensitivityLabel": {
                            "properties": {
                                "informationType": "Financial",
                                "informationTypeId": "1D3652D6-422C-4115-82F1-65DAEBC665C8",
                                "labelId": "3A477B16-9423-432B-AA97-6069B481CEC3",
                                "labelName": "Highly Confidential",
                            }
                        },
                        "table": "table1",
                    }
                },
                {
                    "properties": {
                        "column": "column2",
                        "op": "set",
                        "schema": "dbo",
                        "sensitivityLabel": {
                            "properties": {
                                "informationType": "PhoneNumber",
                                "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
                                "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
                                "labelName": "PII",
                            }
                        },
                        "table": "table2",
                    }
                },
                {"properties": {"column": "Column3", "op": "remove", "schema": "dbo", "table": "Table1"}},
            ]
        },
    )


# x-ms-original-file: 2025-01-01/ManagedDatabaseSensitivityLabelsCurrentUpdate.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 update sensitivity labels of a given database using an operations batch.
 *
 * @summary update sensitivity labels of a given database using an operations batch.
 * x-ms-original-file: 2025-01-01/ManagedDatabaseSensitivityLabelsCurrentUpdate.json
 */
async function updateSensitivityLabelsOfAGivenDatabaseUsingAnOperationsBatch() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  await client.managedDatabaseSensitivityLabels.update(
    "myRG",
    "myManagedInstanceName",
    "myDatabase",
    {
      operations: [
        {
          schema: "dbo",
          column: "column1",
          op: "set",
          sensitivityLabel: {
            informationType: "Financial",
            informationTypeId: "1D3652D6-422C-4115-82F1-65DAEBC665C8",
            labelId: "3A477B16-9423-432B-AA97-6069B481CEC3",
            labelName: "Highly Confidential",
          },
          table: "table1",
        },
        {
          schema: "dbo",
          column: "column2",
          op: "set",
          sensitivityLabel: {
            informationType: "PhoneNumber",
            informationTypeId: "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
            labelId: "bf91e08c-f4f0-478a-b016-25164b2a65ff",
            labelName: "PII",
          },
          table: "table2",
        },
        { schema: "dbo", column: "Column3", op: "remove", table: "Table1" },
      ],
    },
  );
}

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.Collections.Generic;
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/ManagedDatabaseSensitivityLabelsCurrentUpdate.json
// this example is just showing the usage of "ManagedDatabaseSensitivityLabels_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 ManagedDatabaseResource created on azure
// for more information of creating ManagedDatabaseResource, please refer to the document of ManagedDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "myRG";
string managedInstanceName = "myManagedInstanceName";
string databaseName = "myDatabase";
ResourceIdentifier managedDatabaseResourceId = ManagedDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, databaseName);
ManagedDatabaseResource managedDatabase = client.GetManagedDatabaseResource(managedDatabaseResourceId);

// invoke the operation
SensitivityLabelUpdateList sensitivityLabelUpdateList = new SensitivityLabelUpdateList
{
    Operations = {new SensitivityLabelUpdate
    {
    Op = SensitivityLabelUpdateKind.Set,
    Schema = "dbo",
    Table = "table1",
    Column = "column1",
    SensitivityLabel = new SensitivityLabelData
    {
    LabelName = "Highly Confidential",
    LabelId = "3A477B16-9423-432B-AA97-6069B481CEC3",
    InformationType = "Financial",
    InformationTypeId = "1D3652D6-422C-4115-82F1-65DAEBC665C8",
    },
    }, new SensitivityLabelUpdate
    {
    Op = SensitivityLabelUpdateKind.Set,
    Schema = "dbo",
    Table = "table2",
    Column = "column2",
    SensitivityLabel = new SensitivityLabelData
    {
    LabelName = "PII",
    LabelId = "bf91e08c-f4f0-478a-b016-25164b2a65ff",
    InformationType = "PhoneNumber",
    InformationTypeId = "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
    },
    }, new SensitivityLabelUpdate
    {
    Op = SensitivityLabelUpdateKind.Remove,
    Schema = "dbo",
    Table = "Table1",
    Column = "Column3",
    }},
};
await managedDatabase.UpdateManagedDatabaseSensitivityLabelAsync(sensitivityLabelUpdateList);

Console.WriteLine("Succeeded");

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

Definizioni

Nome	Descrizione
ClientClassificationSource
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
SensitivityLabel	Etichetta di riservatezza.
SensitivityLabelRank
SensitivityLabelUpdate	Operazione di aggiornamento delle etichette di riservatezza.
SensitivityLabelUpdateKind
SensitivityLabelUpdateList	Elenco di operazioni di aggiornamento delle etichette di riservatezza.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

ClientClassificationSource

Enumerazione

Valore	Descrizione
None	Nessuno
Native	Native
Recommended	Raccomandato
MIP	MIP

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.

SensitivityLabel

Oggetto

Etichetta di riservatezza.

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
managedBy	string	Risorsa che gestisce l'etichetta di riservatezza.
name	string	Nome della risorsa
properties.clientClassificationSource	ClientClassificationSource
properties.columnName	string	Nome della colonna.
properties.informationType	string	Tipo di informazioni.
properties.informationTypeId	string	ID del tipo di informazioni.
properties.isDisabled	boolean	Raccomandazione di riservatezza disabilitata. Applicabile solo per l'etichetta di riservatezza consigliata. Specifica se la raccomandazione di riservatezza in questa colonna è disabilitata (ignorata) o meno.
properties.labelId	string	ID etichetta.
properties.labelName	string	Nome dell'etichetta.
properties.rank	SensitivityLabelRank
properties.schemaName	string	Nome dello schema.
properties.tableName	string	Nome della tabella.
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"

SensitivityLabelRank

Enumerazione

Valore	Descrizione
None	Nessuno
Low	Low
Medium	Medium
High	Alto
Critical	Critico

SensitivityLabelUpdate

Oggetto

Operazione di aggiornamento delle etichette di riservatezza.

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.column	string	Nome della colonna da aggiornare.
properties.op	SensitivityLabelUpdateKind
properties.schema	string	Nome dello schema della colonna da aggiornare.
properties.sensitivityLabel	SensitivityLabel	Informazioni sull'etichetta di riservatezza da applicare su una colonna.
properties.table	string	Nome tabella della colonna da aggiornare.
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"

SensitivityLabelUpdateKind

Enumerazione

Valore	Descrizione
set	set
remove	togliere

SensitivityLabelUpdateList

Oggetto

Elenco di operazioni di aggiornamento delle etichette di riservatezza.

Nome	Tipo	Descrizione
operations	SensitivityLabelUpdate[]	Operazione di aggiornamento delle etichette di riservatezza.

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.