Sensitivity Labels - Create Or Update

Odwołanie

Usługa:: SQL Database

Wersja interfejsu API:: 2023-08-01

Tworzy lub aktualizuje etykietę poufności danej kolumny

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
columnName	path	True	string	Nazwa kolumny.
databaseName	path	True	string	Nazwa bazy danych.
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
schemaName	path	True	string	Nazwa schematu.
sensitivityLabelSource	path	True	CurrentSensitivityLabelSource	Źródło etykiety poufności.
serverName	path	True	string	Nazwa serwera.
subscriptionId	path	True	string	Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
tableName	path	True	string	Nazwa tabeli.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania.

Treść żądania

Nazwa	Typ	Opis
properties.clientClassificationSource	ClientClassificationSource
properties.informationType	string	Typ informacji.
properties.informationTypeId	string	Identyfikator typu informacji.
properties.labelId	string	Identyfikator etykiety.
properties.labelName	string	Nazwa etykiety.
properties.rank	SensitivityLabelRank

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SensitivityLabel	Pomyślnie zaktualizowano etykietę poufności.
201 Created	SensitivityLabel	Pomyślnie utworzono etykietę poufności.
Other Status Codes	ErrorResponse	Odpowiedzi na błędy: *** 400 DatawarehouseDatabaseIsDeactivated — nie można wykonać operacji klasyfikacji danych, ponieważ baza danych jest wstrzymana. Wznów. 400 SensitivityLabelSourceNameNotSupported — określone źródło etykiety poufności jest nieprawidłowe 400 InvalidSensitivityLabelResource — określony zasób etykiety poufności jest nieprawidłowy 400 SensitivityLabelLabelNameAndInfoTypeNotProvided — należy określić co najmniej jedną z wartości LabelName i InformationType 400 LabelNameTooLong — nazwa etykiety nie może przekraczać {0} znaków 400 InformationTypeTooLong — typ informacji nie może przekraczać {0} znaków 400 LabelIdMustBeGuid — podany identyfikator "labelId" jest nieprawidłowy. Wartość musi być identyfikatorem GUID 400 InformationTypeIdMustBeGuid — podany identyfikator "informationTypeId" jest nieprawidłowy. Wartość musi być identyfikatorem GUID 400 LabelMissing — etykieta jest wymagana. Należy podać co najmniej jedną z wartości "labelName" lub "labelId" 400 InformationTypeMissing — wymagany jest typ informacji. Należy podać co najmniej jeden z parametrów "informationTypeId" lub "informationTypeId" 404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera 404 SensitivityLabelsSchemaNotFound — nie można odnaleźć {0} schematu 404 SensitivityLabelsTableNotFound — nie można odnaleźć tabeli {0} w schemacie {1} 404 SensitivityLabelsColumnNotFound — nie można odnaleźć kolumny {0} w tabeli {2}.{1} 404 DatabaseDoesNotExist — użytkownik określił nazwę bazy danych, która nie istnieje w tym wystąpieniu serwera. 404 SensitivityLabelsLabelNotFound — nie można odnaleźć określonej etykiety poufności 501 SensitivityLabelRecommendedSourceNameNotSupported — źródło etykiet poufności "Zalecane" nie jest jeszcze obsługiwane 501 SensitivityLabelRecommendedSourceNameNotSupported — źródło etykiet poufności "Zalecane" nie jest jeszcze obsługiwane

Nazwa

Typ

Opis

200 OK

SensitivityLabel

Pomyślnie zaktualizowano etykietę poufności.

201 Created

SensitivityLabel

Pomyślnie utworzono etykietę poufności.

Other Status Codes

ErrorResponse

Odpowiedzi na błędy: ***

400 DatawarehouseDatabaseIsDeactivated — nie można wykonać operacji klasyfikacji danych, ponieważ baza danych jest wstrzymana. Wznów.
400 SensitivityLabelSourceNameNotSupported — określone źródło etykiety poufności jest nieprawidłowe
400 InvalidSensitivityLabelResource — określony zasób etykiety poufności jest nieprawidłowy
400 SensitivityLabelLabelNameAndInfoTypeNotProvided — należy określić co najmniej jedną z wartości LabelName i InformationType
400 LabelNameTooLong — nazwa etykiety nie może przekraczać {0} znaków
400 InformationTypeTooLong — typ informacji nie może przekraczać {0} znaków
400 LabelIdMustBeGuid — podany identyfikator "labelId" jest nieprawidłowy. Wartość musi być identyfikatorem GUID
400 InformationTypeIdMustBeGuid — podany identyfikator "informationTypeId" jest nieprawidłowy. Wartość musi być identyfikatorem GUID
400 LabelMissing — etykieta jest wymagana. Należy podać co najmniej jedną z wartości "labelName" lub "labelId"
400 InformationTypeMissing — wymagany jest typ informacji. Należy podać co najmniej jeden z parametrów "informationTypeId" lub "informationTypeId"
404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera
404 SensitivityLabelsSchemaNotFound — nie można odnaleźć {0} schematu
404 SensitivityLabelsTableNotFound — nie można odnaleźć tabeli {0} w schemacie {1}
404 SensitivityLabelsColumnNotFound — nie można odnaleźć kolumny {0} w tabeli {2}.{1}
404 DatabaseDoesNotExist — użytkownik określił nazwę bazy danych, która nie istnieje w tym wystąpieniu serwera.
404 SensitivityLabelsLabelNotFound — nie można odnaleźć określonej etykiety poufności
501 SensitivityLabelRecommendedSourceNameNotSupported — źródło etykiet poufności "Zalecane" nie jest jeszcze obsługiwane
501 SensitivityLabelRecommendedSourceNameNotSupported — źródło etykiet poufności "Zalecane" nie jest jeszcze obsługiwane

Przykłady

Updates the sensitivity label of a given column with all parameters

Przykładowe żądanie

HTTP

PUT 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

{
  "properties": {
    "informationType": "PhoneNumber",
    "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
    "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
    "labelName": "PII",
    "rank": "Low",
    "clientClassificationSource": "Native"
  }
}

Przykładowa odpowiedź

Kod stanu:: 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": "Medium"
  }
}

Kod stanu:: 201

{
  "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": {
    "informationType": "PhoneNumber",
    "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
    "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
    "labelName": "PII",
    "rank": "High"
  }
}

Definicje

Nazwa	Opis
ClientClassificationSource
CurrentSensitivityLabelSource	Źródło etykiety poufności.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
SensitivityLabel	Etykieta poufności.
SensitivityLabelRank

ClientClassificationSource

Wyliczanie

Wartość	Opis
MIP
Native
None
Recommended

CurrentSensitivityLabelSource

Wyliczanie

Źródło etykiety poufności.

Wartość	Opis
current

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

SensitivityLabel

Objekt

Etykieta poufności.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
managedBy	string	Zasób, który zarządza etykietą poufności.
name	string	Nazwa zasobu.
properties.clientClassificationSource	ClientClassificationSource
properties.columnName	string	Nazwa kolumny.
properties.informationType	string	Typ informacji.
properties.informationTypeId	string	Identyfikator typu informacji.
properties.isDisabled	boolean	Czy zalecenie dotyczące poufności jest wyłączone. Dotyczy tylko zalecanej etykiety poufności. Określa, czy zalecenie dotyczące poufności w tej kolumnie jest wyłączone (odrzucone) czy nie.
properties.labelId	string	Identyfikator etykiety.
properties.labelName	string	Nazwa etykiety.
properties.rank	SensitivityLabelRank
properties.schemaName	string	Nazwa schematu.
properties.tableName	string	Nazwa tabeli.
type	string	Typ zasobu.

SensitivityLabelRank

Wyliczanie

Wartość	Opis
Critical
High
Low
Medium
None

Udostępnij za pośrednictwem

Sensitivity Labels - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Przykłady

Updates the sensitivity label of a given column with all parameters

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ClientClassificationSource

CurrentSensitivityLabelSource

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SensitivityLabel

SensitivityLabelRank

Dodatkowe zasoby