Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Sensitivity labels: Disable/Enable recommended sensitivity labels #5083

Merged
merged 7 commits into from
Apr 16, 2019
Merged

Sensitivity labels: Disable/Enable recommended sensitivity labels #5083

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f1340f6
Add Disable/Enable recommended sensitivity label APIs
ranisha2 Jan 24, 2019
6819e90
SensitivityLabels - Update includeDisabledRecommendations parameter n…
ranisha2 Jan 28, 2019
f966068
Sync
ranisha2 Feb 7, 2019
4a91407
Merge branch 'Azure-master2'
ranisha2 Feb 7, 2019
11bd93a
Update sensitivity labels enable/disable APIs
ranisha2 Feb 27, 2019
e18ac59
Merge branch 'master' of https://github.com/Azure/azure-rest-api-spec…
ranisha2 Apr 14, 2019
bb549da
Merge branch 'Azure-master5'
ranisha2 Apr 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions ...oft.Sql/preview/2017-03-01-preview/examples/RecommendedColumnSensitivityLabelDisable.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"parameters": {
"subscriptionId": "00000000-1111-2222-3333-444444444444",
"resourceGroupName": "myRG",
"serverName": "myServer",
"databaseName": "myDatabase",
"schemaName": "dbo",
"tableName": "myTable",
"columnName": "myColumn",
"api-version": "2017-03-01-preview"
},
"responses": {
"200": {}
}
}
15 changes: 15 additions & 0 deletions ...soft.Sql/preview/2017-03-01-preview/examples/RecommendedColumnSensitivityLabelEnable.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"parameters": {
"subscriptionId": "00000000-1111-2222-3333-444444444444",
"resourceGroupName": "myRG",
"serverName": "myServer",
"databaseName": "myDatabase",
"schemaName": "dbo",
"tableName": "myTable",
"columnName": "myColumn",
"api-version": "2017-03-01-preview"
},
"responses": {
"200": {}
}
}
115 changes: 97 additions & 18 deletions ...tion/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,13 @@
{
"$ref": "#/parameters/DatabaseNameParameter"
},
{
"name": "showDisabledRecommendations",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"show" is UI specific. Perhaps "include" or "return" instead

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

"in": "query",
"description": "Specifies whether to return disabled recommendations or not.",
"required": false,
"type": "boolean"
},
{
"name": "$filter",
"in": "query",
Expand Down Expand Up @@ -122,13 +129,13 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sensitivityLabels": {
"get": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/recommended/enable": {
Copy link
Contributor

@sanjaiganesh sanjaiganesh Feb 1, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

[](start = 0, length = 4)

removing this api, is a breaking change and must follow Azure api deprecation policy and would require new api version

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sensitivityLabels"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This API signature will not work. ARM expects resourceType/resourceTypeName segments. Here you have a missing segment. What is "recommended"? Is it a resource type or an instance of sensitivityLabels?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recommended sensitivity label, there are two sources of sensitivity labels, either current or recommended, but these actions are applicable only for recommended sensitivity labels, thus it's hardcoded in the URI (You can see the resource id:
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource})

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it. Can you make this as an enum and the only allowed value in that would be recommended. It will help you in expanding supported values in future.

"post": {
"tags": [
"SensitivityLabels"
],
"description": "Gets the sensitivity labels of a given database",
"operationId": "SensitivityLabels_ListByDatabase",
"description": "Enables sensitivity recommendations on a given column",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add at the end also "(recommendations are enabled by default on all columns)", so it will be clear that there is no need to call this API to enable recommendations

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

"operationId": "SensitivityLabels_Enable",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't be SensitivityLabelsRecommendations_Enable?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or "SensitivityLabels_EnableRecommendation" (like you did in MI)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, will fix

"parameters": [
{
"$ref": "#/parameters/ResourceGroupParameter"
Expand All @@ -140,10 +147,24 @@
"$ref": "#/parameters/DatabaseNameParameter"
},
{
"name": "$filter",
"in": "query",
"description": "An OData filter expression that filters elements in the collection.",
"required": false,
"name": "schemaName",
"in": "path",
"description": "The name of the schema.",
"required": true,
"type": "string"
},
{
"name": "tableName",
"in": "path",
"description": "The name of the table.",
"required": true,
"type": "string"
},
{
"name": "columnName",
"in": "path",
"description": "The name of the column.",
"required": true,
"type": "string"
},
{
Expand All @@ -155,22 +176,75 @@
],
"responses": {
"200": {
"description": "Successfully retrieved the sensitivity labels.",
"schema": {
"$ref": "#/definitions/SensitivityLabelListResult"
}
"description": "Successfully enabled the sensitivity recommendations on the given column."
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance."
"description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance."
}
},
"x-ms-odata": "#/definitions/SensitivityLabel",
"x-ms-pageable": {
"nextLinkName": "nextLink"
"x-ms-examples": {
"Enables sensitivity recommendations on a given column": {
"$ref": "./examples/RecommendedColumnSensitivityLabelEnable.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/recommended/disable": {
"post": {
"tags": [
"SensitivityLabels"
],
"description": "Disables sensitivity recommendations on a given column",
"operationId": "SensitivityLabels_Disable",
"parameters": [
{
"$ref": "#/parameters/ResourceGroupParameter"
},
{
"$ref": "#/parameters/ServerNameParameter"
},
{
"$ref": "#/parameters/DatabaseNameParameter"
},
{
"name": "schemaName",
"in": "path",
"description": "The name of the schema.",
"required": true,
"type": "string"
},
{
"name": "tableName",
"in": "path",
"description": "The name of the table.",
"required": true,
"type": "string"
},
{
"name": "columnName",
"in": "path",
"description": "The name of the column.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully disabled the sensitivity recommendation on the given column."
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance."
}
},
"x-ms-examples": {
"Gets the current and recommended sensitivity labels of a given database": {
"$ref": "./examples/SensitivityLabelsListByDatabase.json"
"Disables sensitivity recommendations on a given column": {
"$ref": "./examples/RecommendedColumnSensitivityLabelDisable.json"
}
}
}
Expand Down Expand Up @@ -436,6 +510,11 @@
"informationTypeId": {
"description": "The information type ID.",
"type": "string"
},
"isDisabled": {
"description": "Applicable for recommended sensitivity label source only. Specifies whether the recommended sensitivity label is disabled or not.",
"type": "boolean",
"readOnly": true
}
}
},
Expand Down
15 changes: 15 additions & 0 deletions .../2018-06-01-preview/examples/ManagedDatabaseRecommendedColumnSensitivityLabelDisable.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"parameters": {
"subscriptionId": "00000000-1111-2222-3333-444444444444",
"resourceGroupName": "myRG",
"managedInstanceName": "myManagedInstanceName",
"databaseName": "myDatabase",
"schemaName": "dbo",
"tableName": "myTable",
"columnName": "myColumn",
"api-version": "2018-06-01-preview"
},
"responses": {
"200": {}
}
}
15 changes: 15 additions & 0 deletions ...w/2018-06-01-preview/examples/ManagedDatabaseRecommendedColumnSensitivityLabelEnable.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"parameters": {
"subscriptionId": "00000000-1111-2222-3333-444444444444",
"resourceGroupName": "myRG",
"managedInstanceName": "myManagedInstanceName",
"databaseName": "myDatabase",
"schemaName": "dbo",
"tableName": "myTable",
"columnName": "myColumn",
"api-version": "2018-06-01-preview"
},
"responses": {
"200": {}
}
}
Loading