Sensitivity Labels - List Current By Database

Služba:

SQL Database

Verze rozhraní API:

2023-08-01

Získá popisky citlivosti dané databáze.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
databaseName	path	True	string	Název databáze.
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.
$count	query		boolean
$filter	query		string	Výraz filtru OData, který filtruje prvky v kolekci.
$skipToken	query		string

Odpovědi

Name	Typ	Description
200 OK	SensitivityLabelListResult	Popisky citlivosti byly úspěšně načteny.
Other Status Codes	ErrorResponse	Chybové odpovědi: *** 400 DatawarehouseDatabaseIsDeactivated - Nelze spustit operaci klasifikace dat, protože databáze je pozastavena. Obnovte ho prosím. 400 SensitivityLabelsInvalidODataQuery – zadaný dotaz OData není platný nebo se nepodporuje. 404 SubscriptionDoesNotHaveServer – Požadovaný server nebyl nalezen. 404 DatabaseDoesNotExist – Uživatel zadal název databáze, který v této instanci serveru neexistuje. 503 DatabaseUnavailable – Operace selhala, protože databáze není k dispozici.

Příklady

Gets the current sensitivity labels of a given database

Ukázkový požadavek

HTTP

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

dotnet

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/SensitivityLabelsListByDatabaseWithSourceCurrent.json
// this example is just showing the usage of "SensitivityLabels_ListCurrentByDatabase" 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.GetCurrentSensitivityLabelsAsync())
{
    // 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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
ClientClassificationSource
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
SensitivityLabel	Popisek citlivosti.
SensitivityLabelListResult	Seznam popisků citlivosti
SensitivityLabelRank

ClientClassificationSource

Výčet

Hodnota	Description
None
Native
Recommended
MIP

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

SensitivityLabel

Objekt

Popisek citlivosti.

Name	Typ	Description
id	string	ID prostředku.
managedBy	string	Prostředek, který spravuje popisek citlivosti.
name	string	Název prostředku
properties.clientClassificationSource	ClientClassificationSource
properties.columnName	string	Název sloupce.
properties.informationType	string	Typ informací.
properties.informationTypeId	string	ID typu informací.
properties.isDisabled	boolean	Je doporučení citlivosti zakázané. Platí jenom pro doporučený popisek citlivosti. Určuje, jestli je doporučení citlivosti pro tento sloupec zakázané (zamítnuto) nebo ne.
properties.labelId	string	ID popisku.
properties.labelName	string	Název popisku.
properties.rank	SensitivityLabelRank
properties.schemaName	string	Název schématu.
properties.tableName	string	Název tabulky.
type	string	Typ prostředku.

SensitivityLabelListResult

Objekt

Seznam popisků citlivosti

Name	Typ	Description
nextLink	string	Odkaz na načtení další stránky výsledků
value	SensitivityLabel[]	Pole výsledků

SensitivityLabelRank

Výčet

Hodnota	Description
None
Low
Medium
High
Critical