Sensitivity Labels - Update

Service:

SQL Database

API Version:

2021-11-01

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

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/currentSensitivityLabels?api-version=2021-11-01

URI パラメーター

名前	/	必須	型	説明
databaseName	path	True	string	データベースの名前。
resourceGroupName	path	True	string	リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求で使用する API のバージョン。

要求本文

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

応答

名前	型	説明
200 OK		秘密度ラベルが正常に更新されました。
Other Status Codes		エラー応答: *** 400 DatawarehouseDatabaseIsDeactivated - データベースが一時停止しているため、データ分類操作を実行できませんでした。 再開してください。 400 DatawarehouseDatabaseIsDeactivated - データベースが一時停止しているため、データ分類操作を実行できませんでした。 再開してください。 400 SensitivityLabelSourceNameNotSupported - 指定された秘密度ラベル ソースが無効です 400 InvalidSensitivityLabelsBatch - 指定された秘密度ラベルバッチが無効です。 バッチ操作を指定してください 400 SensitivityLabelsMissingSchema - Operation[{0}]: スキーマ情報がありません 400 SensitivityLabelsMissingTable - Operation[{0}]: テーブル情報がありません 400 SensitivityLabelsMissingColumn - Operation[{0}]: 列情報がありません 400 SensitivityLabelsUpdateSameColumnMoreThanOnce - 1 つのコマンドで列 {0} を複数回更新することはできません 400 InvalidSensitivityLabelResource - 指定された秘密度ラベル リソースが無効です 400 SensitivityLabelLabelNameAndInfoTypeNotProvided - LabelName と InformationType の少なくとも 1 つを指定する必要があります 400 LabelNameTooLong - ラベル名は文字を超 {0} えることはできません 400 InformationTypeTooLong - 情報の種類が文字を超 {0} えることはできません 400 LabelIdMustBeGuid - 指定された 'labelId' が無効です。 値は GUID である必要があります 400 InformationTypeIdMustBeGuid - 指定された 'informationTypeId' が無効です。 値は GUID である必要があります 400 LabelMissing - ラベルが必要です。 'labelName' または 'labelId' の少なくとも 1 つを指定する必要があります 400 InformationTypeMissing - 情報の種類が必要です。 'informationType' または 'informationTypeId' の少なくとも 1 つを指定する必要があります 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 DatabaseDoesNotExist - ユーザーがこのサーバー インスタンスに存在しないデータベース名を指定しました。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 DatabaseDoesNotExist - ユーザーがこのサーバー インスタンスに存在しないデータベース名を指定しました。 404 SensitivityLabelsLabelNotFound - 指定された秘密度ラベルが見つかりませんでした 404 SensitivityLabelsSchemaNotFound - スキーマ {0} が見つかりませんでした 404 SensitivityLabelsTableNotFound - テーブル {0} がスキーマで見つかりませんでした {1} 404 SensitivityLabelsColumnNotFound - テーブル {2}に列{0}が見つかりませんでした。{1} 501 SensitivityLabelRecommendedSourceNameNotSupported - "推奨" 秘密度ラベル ソースはまだサポートされていません 501 SensitivityLabelRecommendedSourceNameNotSupported - "推奨" 秘密度ラベル ソースはまだサポートされていません 503 DatabaseUnavailable - データベースが使用できないため、操作に失敗しました。

例

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

Sample Request

HTTP

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

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

Java

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

/** Samples for SensitivityLabels Update. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SensitivityLabelsCurrentUpdate.json
     */
    /**
     * Sample code: Update sensitivity labels of a given database using an operations batch.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateSensitivityLabelsOfAGivenDatabaseUsingAnOperationsBatch(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSensitivityLabels().updateWithResponse("myRG", "myServer",
            "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").withRank(SensitivityLabelRank.LOW)),
                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")
                        .withRank(SensitivityLabelRank.CRITICAL)),
                new SensitivityLabelUpdateInner().withOp(SensitivityLabelUpdateKind.REMOVE).withSchema("dbo")
                    .withTable("Table1").withColumn("Column3"))),
            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

Sample Response

Status code:

200

定義

名前	説明
SensitivityLabel	秘密度ラベル。
SensitivityLabelRank
SensitivityLabelUpdate	秘密度ラベルの更新操作。
SensitivityLabelUpdateKind
SensitivityLabelUpdateList	秘密度ラベルの更新操作の一覧。

SensitivityLabel

秘密度ラベル。

名前	型	説明
id	string	リソースの ID
managedBy	string	秘密度ラベルを管理するリソース。
name	string	リソース名。
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	テーブル名。
type	string	リソースの種類。

SensitivityLabelRank

名前	型	説明
Critical	string
High	string
Low	string
Medium	string
None	string

SensitivityLabelUpdate

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

名前	型	説明
id	string	リソースの ID
name	string	リソース名。
properties.column	string	更新する列名。
properties.op	SensitivityLabelUpdateKind
properties.schema	string	更新する列のスキーマ名。
properties.sensitivityLabel	SensitivityLabel	列に適用する秘密度ラベル情報。
properties.table	string	更新する列のテーブル名。
type	string	リソースの種類。

SensitivityLabelUpdateKind

名前	型	説明
remove	string
set	string

SensitivityLabelUpdateList

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

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