Sensitivity Labels - Get

Služba:

SQL Database

Verze rozhraní API:

2023-08-01

Získá popisek citlivosti daného sloupce.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}?api-version=2023-08-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
columnName	path	True	string	Název sloupce.
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.
schemaName	path	True	string	Název schématu.
sensitivityLabelSource	path	True	SensitivityLabelSource	Zdroj popisku citlivosti.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
tableName	path	True	string	Název tabulky.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.

Odpovědi

Name	Typ	Description
200 OK	SensitivityLabel	Popisek citlivosti se úspěšně načetl.
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 SensitivityLabelSourceNameNotSupported – Zadaný zdroj popisku citlivosti není platný. 404 SubscriptionDoesNotHaveServer – Požadovaný server nebyl nalezen. 404 SensitivityLabelsSchemaNotFound – schéma {0} nebylo nalezeno. 404 SensitivityLabelsTableNotFound – v {0} schématu nebyla nalezena tabulka {1} 404 SensitivityLabelsColumnNotFound - Sloupec {0} nebyl nalezen v tabulce {2}.{1} 404 DatabaseDoesNotExist – Uživatel zadal název databáze, který v této instanci serveru neexistuje. 404 SensitivityLabelsLabelsLabelNotFound – zadaný popisek citlivosti nebyl nalezen. 501 SensitivityLabelRecommendedSourceNameNotSupported – Doporučený zdroj popisků citlivosti se zatím nepodporuje. 501 SensitivityLabelRecommendedSourceNameNotSupported – Doporučený zdroj popisků citlivosti se zatím nepodporuje.

Příklady

Gets the sensitivity label of a given column

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/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current?api-version=2023-08-01

dotnet

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ColumnSensitivityLabelGet.json
// this example is just showing the usage of "SensitivityLabels_Get" 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 SqlDatabaseSensitivityLabelResource created on azure
// for more information of creating SqlDatabaseSensitivityLabelResource, please refer to the document of SqlDatabaseSensitivityLabelResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "myRG";
string serverName = "myServer";
string databaseName = "myDatabase";
string schemaName = "dbo";
string tableName = "myTable";
string columnName = "myColumn";
SensitivityLabelSource sensitivityLabelSource = SensitivityLabelSource.Current;
ResourceIdentifier sqlDatabaseSensitivityLabelResourceId = SqlDatabaseSensitivityLabelResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, schemaName, tableName, columnName, sensitivityLabelSource);
SqlDatabaseSensitivityLabelResource sqlDatabaseSensitivityLabel = client.GetSqlDatabaseSensitivityLabelResource(sqlDatabaseSensitivityLabelResourceId);

// invoke the operation
SqlDatabaseSensitivityLabelResource result = await sqlDatabaseSensitivityLabel.GetAsync();

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels",
  "properties": {
    "schemaName": "dbo",
    "tableName": "myTable",
    "columnName": "myColumn",
    "informationType": "PhoneNumber",
    "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
    "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
    "labelName": "PII",
    "rank": "High"
  }
}

Definice

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

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.

SensitivityLabelRank

Výčet

Hodnota	Description
None
Low
Medium
High
Critical

SensitivityLabelSource

Výčet

Zdroj popisku citlivosti.

Hodnota	Description
current
recommended