Sensitivity Labels - Create Or Update

Szolgáltatás:

SQL Database

API-verzió:

2025-01-01

Egy adott oszlop bizalmassági címkéjének létrehozása vagy frissítése

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/current?api-version=2025-01-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
columnName	path	True	string	Az oszlop neve.
databaseName	path	True	string	Az adatbázis 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.
schemaName	path	True	string	A séma neve.
sensitivityLabelSource	path	True	CurrentSensitivityLabelSource	A bizalmassági címke forrása.
serverName	path	True	string	A kiszolgáló neve.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
tableName	path	True	string	A tábla neve.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Kérelem törzse

Name	Típus	Description
properties.clientClassificationSource	ClientClassificationSource
properties.informationType	string	Az információ típusa.
properties.informationTypeId	string	Az információtípus azonosítója.
properties.labelId	string	A címke azonosítója.
properties.labelName	string	A címke neve.
properties.rank	SensitivityLabelRank

Válaszok

Name	Típus	Description
200 OK	SensitivityLabel	Az erőforrás 'SensitivityLabel' frissítési művelete sikeres
201 Created	SensitivityLabel	Resource 'SensitivityLabel' létrehozása művelet sikeres
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory Oauth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Updates the sensitivity label of a given column with all parameters

Mintakérelem

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current?api-version=2025-01-01

{
  "properties": {
    "clientClassificationSource": "Native",
    "informationType": "PhoneNumber",
    "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
    "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
    "labelName": "PII",
    "rank": "Low"
  }
}

Java

import com.azure.resourcemanager.sql.fluent.models.SensitivityLabelInner;
import com.azure.resourcemanager.sql.models.ClientClassificationSource;
import com.azure.resourcemanager.sql.models.CurrentSensitivityLabelSource;
import com.azure.resourcemanager.sql.models.SensitivityLabelRank;

/**
 * Samples for SensitivityLabels CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/ColumnSensitivityLabelCreateMax.json
     */
    /**
     * Sample code: Updates the sensitivity label of a given column with all parameters.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void updatesTheSensitivityLabelOfAGivenColumnWithAllParameters(
        com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getSensitivityLabels().createOrUpdateWithResponse("myRG", "myServer", "myDatabase",
            "dbo", "myTable", "myColumn", CurrentSensitivityLabelSource.CURRENT,
            new SensitivityLabelInner().withLabelName("PII").withLabelId("bf91e08c-f4f0-478a-b016-25164b2a65ff")
                .withInformationType("PhoneNumber").withInformationTypeId("d22fa6e9-5ee4-3bde-4c2b-a409604c4646")
                .withRank(SensitivityLabelRank.LOW).withClientClassificationSource(ClientClassificationSource.NATIVE),
            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 column_sensitivity_label_create_max.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.sensitivity_labels.create_or_update(
        resource_group_name="myRG",
        server_name="myServer",
        database_name="myDatabase",
        schema_name="dbo",
        table_name="myTable",
        column_name="myColumn",
        parameters={
            "properties": {
                "clientClassificationSource": "Native",
                "informationType": "PhoneNumber",
                "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
                "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
                "labelName": "PII",
                "rank": "Low",
            }
        },
    )
    print(response)


# x-ms-original-file: 2025-01-01/ColumnSensitivityLabelCreateMax.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 creates or updates the sensitivity label of a given column
 *
 * @summary creates or updates the sensitivity label of a given column
 * x-ms-original-file: 2025-01-01/ColumnSensitivityLabelCreateMax.json
 */
async function updatesTheSensitivityLabelOfAGivenColumnWithAllParameters() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.sensitivityLabels.createOrUpdate(
    "myRG",
    "myServer",
    "myDatabase",
    "dbo",
    "myTable",
    "myColumn",
    {
      clientClassificationSource: "Native",
      informationType: "PhoneNumber",
      informationTypeId: "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
      labelId: "bf91e08c-f4f0-478a-b016-25164b2a65ff",
      labelName: "PII",
      rank: "Low",
    },
  );
  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

Mintaválasz

Állapotkód:

200

{
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current",
  "properties": {
    "columnName": "myColumn",
    "informationType": "PhoneNumber",
    "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
    "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
    "labelName": "PII",
    "rank": "Medium",
    "schemaName": "dbo",
    "tableName": "myTable"
  }
}

Állapotkód:

201

{
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current",
  "properties": {
    "informationType": "PhoneNumber",
    "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
    "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
    "labelName": "PII",
    "rank": "High"
  }
}

Definíciók

Name	Description
ClientClassificationSource
createdByType	Az erőforrást létrehozó identitás típusa.
CurrentSensitivityLabelSource	A bizalmassági címke forrása.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
SensitivityLabel	Bizalmassági címke.
SensitivityLabelRank
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

ClientClassificationSource

Felsorolás

Érték	Description
None	Nincs
Native	Native
Recommended	Ajánlott
MIP	MIP

createdByType

Felsorolás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

CurrentSensitivityLabelSource

Felsorolás

A bizalmassági címke forrása.

Érték	Description
current	aktuális

ErrorAdditionalInfo

Tárgy

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

Tárgy

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 hiba célpontja.

ErrorResponse

Tárgy

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

SensitivityLabel

Tárgy

Bizalmassági címke.

Name	Típus	Description
id	string (arm-id)	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
managedBy	string	A bizalmassági címkét kezelő erőforrás.
name	string	Az erőforrás neve
properties.clientClassificationSource	ClientClassificationSource
properties.columnName	string	Az oszlop neve.
properties.informationType	string	Az információ típusa.
properties.informationTypeId	string	Az információtípus azonosítója.
properties.isDisabled	boolean	A bizalmassági javaslat le van tiltva. Csak az ajánlott bizalmassági címke esetén alkalmazható. Megadja, hogy az oszlop bizalmassági ajánlása le van-e tiltva (elvetve) vagy sem.
properties.labelId	string	A címke azonosítója.
properties.labelName	string	A címke neve.
properties.rank	SensitivityLabelRank
properties.schemaName	string	A séma neve.
properties.tableName	string	A tábla neve.
systemData	systemData	Azure Resource Manager metaadat, amely createdBy és modifiedBy információkat tartalmaz.
type	string	Az erőforrás típusa. Például: "Microsoft. Compute/virtualMachines" vagy "Microsoft. Tárhely/tárolásFiókok"

SensitivityLabelRank

Felsorolás

Érték	Description
None	Nincs
Low	Alacsony
Medium	Medium
High	Magas
Critical	Létfontosságú

systemData

Tárgy

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.