Sensitivity Labels - List Recommended By Database

Dienst:: SQL Database

API-Version:: 2023-08-01

Ruft die Vertraulichkeitsbezeichnungen einer bestimmten Datenbank ab.

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

Mit optionalen Parametern:

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=2023-08-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
databaseName	path	True	string	Der Name der Datenbank.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
serverName	path	True	string	Der Name des Servers.
subscriptionId	path	True	string	Die Abonnement-ID, die ein Azure-Abonnement identifiziert.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll.
$filter	query		string	Ein OData-Filterausdruck, der Elemente in der Auflistung filtert.
$skipToken	query		string
includeDisabledRecommendations	query		boolean	Gibt an, ob deaktivierte Empfehlungen eingeschlossen werden sollen.

Antworten

Name	Typ	Beschreibung
200 OK	SensitivityLabelListResult	Die Vertraulichkeitsbezeichnungen wurden erfolgreich abgerufen.
Other Status Codes	ErrorResponse	Fehlerantworten: *** 400 DatawarehouseDatabaseIsDeactivated – Der Datenklassifizierungsvorgang konnte nicht ausgeführt werden, da die Datenbank angehalten wurde. Bitte setzen Sie sie fort. 400 SensitivityLabelsInvalidODataQuery – Die angegebene OData-Abfrage ist entweder ungültig oder nicht unterstützt. 404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden. 404 DatabaseDoesNotExist – Der Benutzer hat einen Datenbanknamen angegeben, der in dieser Serverinstanz nicht vorhanden ist. 503 DatabaseUnavailable – Fehler beim Vorgang, weil die Datenbank nicht verfügbar ist.

Name

Typ

Beschreibung

200 OK

SensitivityLabelListResult

Die Vertraulichkeitsbezeichnungen wurden erfolgreich abgerufen.

Other Status Codes

ErrorResponse

Fehlerantworten: ***

400 DatawarehouseDatabaseIsDeactivated – Der Datenklassifizierungsvorgang konnte nicht ausgeführt werden, da die Datenbank angehalten wurde. Bitte setzen Sie sie fort.
400 SensitivityLabelsInvalidODataQuery – Die angegebene OData-Abfrage ist entweder ungültig oder nicht unterstützt.
404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden.
404 DatabaseDoesNotExist – Der Benutzer hat einen Datenbanknamen angegeben, der in dieser Serverinstanz nicht vorhanden ist.
503 DatabaseUnavailable – Fehler beim Vorgang, weil die Datenbank nicht verfügbar ist.

Beispiele

Gets the recommended sensitivity labels of a given database

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/SensitivityLabelsListByDatabaseWithSourceRecommended.json
// this example is just showing the usage of "SensitivityLabels_ListRecommendedByDatabase" 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 SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "myRG";
string serverName = "myServer";
string databaseName = "myDatabase";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation and iterate over the result
await foreach (SqlDatabaseSensitivityLabelResource item in sqlDatabase.GetRecommendedSensitivityLabelsAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SensitivityLabelData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Beispiel für eine Antwort

Statuscode:: 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"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
ClientClassificationSource
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
SensitivityLabel	Eine Vertraulichkeitsbezeichnung.
SensitivityLabelListResult	Eine Liste der Vertraulichkeitsbezeichnungen.
SensitivityLabelRank

ClientClassificationSource

Enumeration

Wert	Beschreibung
None
Native
Recommended
MIP

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

SensitivityLabel

Objekt

Eine Vertraulichkeitsbezeichnung.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
managedBy	string	Ressource, die die Vertraulichkeitsbezeichnung verwaltet.
name	string	Ressourcenname.
properties.clientClassificationSource	ClientClassificationSource
properties.columnName	string	Der Spaltenname.
properties.informationType	string	Der Informationstyp.
properties.informationTypeId	string	Die Informationstyp-ID.
properties.isDisabled	boolean	Ist die Vertraulichkeitsempfehlung deaktiviert. Gilt nur für empfohlene Vertraulichkeitsbezeichnungen. Gibt an, ob die Vertraulichkeitsempfehlung für diese Spalte deaktiviert (geschlossen) ist oder nicht.
properties.labelId	string	Die Bezeichnungs-ID.
properties.labelName	string	Der Bezeichnungsname.
properties.rank	SensitivityLabelRank
properties.schemaName	string	Der Schemaname.
properties.tableName	string	Der Tabellenname.
type	string	Ressourcentyp.

SensitivityLabelListResult

Objekt

Eine Liste der Vertraulichkeitsbezeichnungen.

Name	Typ	Beschreibung
nextLink	string	Link zum Abrufen der nächsten Seite mit Ergebnissen.
value	SensitivityLabel[]	Array von Ergebnissen.

SensitivityLabelRank

Enumeration

Wert	Beschreibung
None
Low
Medium
High
Critical

Freigeben über

Sensitivity Labels - List Recommended By Database

URI-Parameter

Antworten

Beispiele

Gets the recommended sensitivity labels of a given database

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ClientClassificationSource

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SensitivityLabel

SensitivityLabelListResult

SensitivityLabelRank