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	Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
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	Указывает, следует ли включать отключенные рекомендации.

Ответы

Имя	Тип	Описание
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	Идентификатор ресурса.
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

Список меток конфиденциальности.

Имя	Тип	Описание
nextLink	string	Ссылка для получения следующей страницы результатов.
value	SensitivityLabel[]	Массив результатов.

SensitivityLabelRank

Имя	Тип	Описание
Critical	string
High	string
Low	string
Medium	string
None	string