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 參數

名稱	位於	必要	類型	Description
databaseName	path	True	string	資料庫的名稱。
resourceGroupName	path	True	string	包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	可識別 Azure 訂用帳戶的訂用帳戶識別碼。
api-version	query	True	string	要用於要求的 API 版本。
$filter	query		string	篩選集合中元素的 OData 篩選表示式。
$skipToken	query		string
includeDisabledRecommendations	query		boolean	指定是否要包含已停用的建議。

回應

名稱	類型	Description
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"
      }
    }
  ]
}

定義

名稱	Description
SensitivityLabel	敏感度標籤。
SensitivityLabelListResult	敏感度標籤的清單。
SensitivityLabelRank

SensitivityLabel

敏感度標籤。

名稱	類型	Description
id	string	資源識別碼。
managedBy	string	管理敏感度標籤的資源。
name	string	資源名稱。
properties.columnName	string	資料行名稱。
properties.informationType	string	信息類型。
properties.informationTypeId	string	資訊類型標識碼。
properties.isDisabled	boolean	是否停用敏感度建議。 僅適用於建議的敏感度標籤。 指定是否停用此數據行上的敏感度建議， (關閉) 。
properties.labelId	string	標籤識別碼。
properties.labelName	string	標籤名稱。
properties.rank	SensitivityLabelRank
properties.schemaName	string	結構描述名稱。
properties.tableName	string	資料表名稱。
type	string	資源類型。

SensitivityLabelListResult

敏感度標籤的清單。

名稱	類型	Description
nextLink	string	連結以擷取下一頁的結果。
value	SensitivityLabel[]	結果陣列。

SensitivityLabelRank

名稱	類型	Description
Critical	string
High	string
Low	string
Medium	string
None	string