Sensitivity Labels - List Recommended By Database

Service:

SQL Database

API Version:

2021-11-01

指定されたデータベースの秘密度ラベルを取得します

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/recommendedSensitivityLabels?$skipToken={$skipToken}&includeDisabledRecommendations={includeDisabledRecommendations}&$filter={$filter}&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 のバージョン。
$filter	query		string	コレクション内の要素をフィルター処理する OData フィルター式。
$skipToken	query		string
includeDisabledRecommendations	query		boolean	無効な推奨事項を含めるかどうかを指定します。

応答

名前	型	説明
200 OK	SensitivityLabelListResult	秘密度ラベルが正常に取得されました。
Other Status Codes		エラー応答: *** 400 DatawarehouseDatabaseIsDeactivated - データベースが一時停止しているため、データ分類操作を実行できませんでした。 再開してください。 400 SensitivityLabelsInvalidODataQuery - 指定された OData クエリが無効であるか、サポートされていません 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 DatabaseDoesNotExist - ユーザーがこのサーバー インスタンスに存在しないデータベース名を指定しました。 503 DatabaseUnavailable - データベースが使用できないため、操作に失敗しました。

例

Gets the recommended sensitivity labels of a given database

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for SensitivityLabels ListRecommendedByDatabase. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * SensitivityLabelsListByDatabaseWithSourceRecommended.json
     */
    /**
     * Sample code: Gets the recommended sensitivity labels of a given database.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getsTheRecommendedSensitivityLabelsOfAGivenDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSensitivityLabels().listRecommendedByDatabase("myRG",
            "myServer", "myDatabase", null, null, null, 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

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/recommended",
      "name": "recommended",
      "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels",
      "properties": {
        "schemaName": "dbo",
        "tableName": "myTable",
        "columnName": "myColumn",
        "informationType": "Financial",
        "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
        "labelId": "05e6eaa1-075a-4fb4-a732-a92215a2444a",
        "labelName": "Sensitive"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn2/sensitivityLabels/recommended",
      "name": "recommended",
      "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels",
      "properties": {
        "schemaName": "dbo",
        "tableName": "myTable",
        "columnName": "myColumn2",
        "informationType": "Email",
        "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
        "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
        "labelName": "PII"
      }
    }
  ]
}

定義

名前	説明
SensitivityLabel	秘密度ラベル。
SensitivityLabelListResult	秘密度ラベルの一覧。
SensitivityLabelRank

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	リソースの種類。

SensitivityLabelListResult

秘密度ラベルの一覧。

名前	型	説明
nextLink	string	結果の次のページを取得するためのリンク。
value	SensitivityLabel[]	結果の配列。

SensitivityLabelRank

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