Managed Database Sensitivity Labels - Update

サービス:

SQL Database

API バージョン:

2025-01-01

操作バッチを使用して、特定のデータベースの秘密度ラベルを更新します。

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

URI パラメーター

名前	/	必須	型	説明
databaseName	path	True	string	データベースの名前。
managedInstanceName	path	True	string	マネージド インスタンスの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前の大文字と小文字は区別されません。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
operations	SensitivityLabelUpdate[]	秘密度ラベルの更新操作。

応答

名前	型	説明
200 OK		要求は成功しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

Update sensitivity labels of a given database using an operations batch.

要求のサンプル

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

応答のサンプル

状態コード:

200

定義

名前	説明
ClientClassificationSource
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
SensitivityLabel	秘密度ラベル。
SensitivityLabelRank
SensitivityLabelUpdate	秘密度ラベルの更新操作。
SensitivityLabelUpdateKind
SensitivityLabelUpdateList	秘密度ラベルの更新操作の一覧。
systemData	リソースの作成と最後の変更に関連するメタデータ。

ClientClassificationSource

列挙

値	説明
None	なし
Native	Native
Recommended	推奨
MIP	ミップ

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

SensitivityLabel

Object

秘密度ラベル。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
managedBy	string	秘密度ラベルを管理するリソース。
name	string	リソースの名前
properties.clientClassificationSource	ClientClassificationSource
properties.columnName	string	列名。
properties.informationType	string	情報の種類。
properties.informationTypeId	string	情報の種類 ID。
properties.isDisabled	boolean	秘密度の推奨事項が無効になっています。 推奨される秘密度ラベルにのみ適用されます。 この列の秘密度に関する推奨事項を無効 (無視) するかどうかを指定します。
properties.labelId	string	ラベル ID。
properties.labelName	string	ラベル名。
properties.rank	SensitivityLabelRank
properties.schemaName	string	スキーマ名。
properties.tableName	string	テーブル名。
systemData	systemData	create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

SensitivityLabelRank

列挙

値	説明
None	なし
Low	低
Medium	中程度
High	高
Critical	危うい

SensitivityLabelUpdate

Object

秘密度ラベルの更新操作。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.column	string	更新する列名。
properties.op	SensitivityLabelUpdateKind
properties.schema	string	更新する列のスキーマ名。
properties.sensitivityLabel	SensitivityLabel	列に適用する秘密度ラベル情報。
properties.table	string	更新する列のテーブル名。
systemData	systemData	create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

SensitivityLabelUpdateKind

列挙

値	説明
set	設定
remove	削除

SensitivityLabelUpdateList

Object

秘密度ラベルの更新操作の一覧。

名前	型	説明
operations	SensitivityLabelUpdate[]	秘密度ラベルの更新操作。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。