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.

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

Added missing APIs in Synapse Swagger. #12424

Merged
merged 9 commits into from
Jan 16, 2021
Merged
Changes from 1 commit
Commits
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
Next Next commit
Added missing APIs in Synapse Swagger.
  • Loading branch information
Amogh Natu committed Jan 13, 2021
commit 827bf4d781e4cc2a3ab4373304c7aae8f1b95fcb
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"parameters": {
"subscriptionId": "00000000-1111-2222-3333-444444444444",
"resourceGroupName": "samplerg",
"workspaceName": "testworkspace",
"sqlPoolName": "testsp",
"maintenanceWindowName": "current",
"api-version": "2019-06-01-preview",
"parameters": {
"properties": {
"timeRanges": [
{
"dayOfWeek": "Saturday",
"startTime": "00:00:00",
"duration": "PT60M"
}
]
}
}
},
"responses": {
"200": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"parameters": {
"subscriptionId": "00000000-1111-2222-3333-444444444444",
"resourceGroupName": "samplerg",
"workspaceName": "testworkspace",
"sqlPoolName": "testsp",
"maintenanceWindowOptionsName": "current",
"api-version": "2019-06-01-preview"
},
"responses": {
"200": {
"body": {
"properties": {
"isEnabled": true,
"maintenanceWindowCycles": [
{
"dayOfWeek": "Saturday",
"startTime": "00:00:00",
"duration": "PT60M"
}
],
"minDurationInMinutes": 60,
"defaultDurationInMinutes": 120,
"minCycles": 2,
"timeGranularityInMinutes": 5,
"allowMultipleMaintenanceWindowsPerCycle": true
},
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/samplerg/providers/Microsoft.Synapse/workspaces/testworkspace/sqlPools/testsp/maintenanceWindowOptions/current",
"name": "current",
"type": "Microsoft.Synapse/workspaces/sqlPools/maintenanceWindowOptions"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"parameters": {
"subscriptionId": "00000000-1111-2222-3333-444444444444",
"resourceGroupName": "samplerg",
"workspaceName": "testworkspace",
"sqlPoolName": "testsp",
"maintenanceWindowName": "current",
"api-version": "2019-06-01-preview"
},
"responses": {
"200": {
"body": {
"properties": {
"timeRanges": [
{
"dayOfWeek": "Saturday",
"startTime": "00:00:00",
"duration": "PT60M"
}
]
},
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/samplerg/providers/Microsoft.Synapse/workspaces/testworkspace/sqlPools/testsp/maintenancewindows/current",
"name": "current",
"type": "Microsoft.Synapse/workspaces/sqlPools/maintenancewindows"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -1090,6 +1090,187 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/maintenancewindows/current": {
"get": {
"operationId": "SqlPoolMaintenanceWindows_Get",
"summary": "Get a SQL pool's Maintenance Windows.",
"description": "Get a SQL pool's Maintenance Windows.",
"tags": [
"SqlPools, MaintenanceWindows"
],
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./workspace.json#/parameters/workspaceNameParameter"
},
{
"type": "string",
"in": "path",
"name": "sqlPoolName",
"description": "SQL pool name",
"required": true
},
{
"name": "maintenanceWindowName",
"in": "query",
"description": "Maintenance window name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MaintenanceWindows"
}
},
"default": {
"schema": {
"$ref": "../../../../common/v1/types.json#/definitions/ErrorContract"
},
"description": ""
}
},
"consumes": [],
"produces": [
"application/json"
],
"x-ms-examples": {
"Gets maintenance window settings for a selected SQL Analytics pool.": {
"$ref": "./examples/GetMaintenanceWindows.json"
}
}
},
"put": {
"operationId": "SqlPoolMaintenanceWindows_CreateOrUpdate",
"summary": "Creates or updates a Sql pool's maintenance windows settings.",
"description": "Creates or updates a Sql pool's maintenance windows settings.",
"tags": [
"SqlPools, MaintenanceWindows"
],
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./workspace.json#/parameters/workspaceNameParameter"
},
{
"type": "string",
"in": "path",
"name": "sqlPoolName",
"description": "SQL pool name",
"required": true
},
{
"name": "maintenanceWindowName",
"in": "query",
"description": "Maintenance window name.",
"required": true,
"type": "string"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MaintenanceWindows"
},
"description": "The required parameters for creating or updating Maintenance Windows settings"
}
],
"responses": {
"200": {
"description": "Successfully set maintenance windows settings."
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 InvalidMaintenanceWindowSelection - Invalid maintenance window selection."
}
},
"consumes": [],
"produces": [
"application/json"
],
"x-ms-examples": {
"Sets maintenance window settings for a selected SQL Analytics Pool.": {
"$ref": "./examples/CreateOrUpdateMaintenanceWindows.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/maintenanceWindowOptions/current": {
"get": {
"operationId": "SqlPoolMaintenanceWindowOptions_Get",
"summary": "SQL pool's available maintenance windows.",
"description": "Get list of SQL pool's available maintenance windows.",
"tags": [
"SqlPools, MaintenanceWindowOptions"
],
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./workspace.json#/parameters/workspaceNameParameter"
},
{
"type": "string",
"in": "path",
"name": "sqlPoolName",
"description": "SQL pool name",
"required": true
},
{
"name": "maintenanceWindowOptionsName",
"in": "query",
"description": "Maintenance window options name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successfully retrieved the list of maintenance windows options.",
"schema": {
"$ref": "#/definitions/MaintenanceWindowOptions"
}
},
"default": {
"description": "*** Error Responses: ***"
}
},
"consumes": [],
"produces": [
"application/json"
],
"x-ms-examples": {
"Get list of transparent data encryption configurations of a SQL Analytics pool": {
"$ref": "./examples/GetMaintenanceWindowOptions.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/transparentDataEncryption/{transparentDataEncryptionName}": {
"get": {
"operationId": "SqlPoolTransparentDataEncryptions_Get",
@@ -5380,6 +5561,122 @@
},
"description": "Represents the response to a List Sql pool replication link request."
},
"MaintenanceWindowOptionsProperties": {
Copy link
Contributor

Choose a reason for hiding this comment

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

"description": "Maintenance window options properties.",
"type": "object",
"properties": {
"isEnabled": {
"description": "Whether maintenance windows are enabled for the database.",
"type": "boolean"
},
"maintenanceWindowCycles": {
"description": "Available maintenance cycles e.g. {Saturday, 0, 48*60}, {Wednesday, 0, 24*60}.",
"type": "array",
"items": {
"$ref": "#/definitions/MaintenanceWindowTimeRange"
}
},
"minDurationInMinutes": {
"format": "int32",
"description": "Minimum duration of maintenance window.",
"type": "integer"
},
"defaultDurationInMinutes": {
"format": "int32",
"description": "Default duration for maintenance window.",
"type": "integer"
},
"minCycles": {
"format": "int32",
"description": "Minimum number of maintenance windows cycles to be set on the database.",
"type": "integer"
},
"timeGranularityInMinutes": {
"format": "int32",
"description": "Time granularity in minutes for maintenance windows.",
"type": "integer"
},
"allowMultipleMaintenanceWindowsPerCycle": {
"description": "Whether we allow multiple maintenance windows per cycle.",
"type": "boolean"
}
}
},
"MaintenanceWindowOptions": {
"description": "Maintenance window options.",
"type": "object",
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
}
],
"properties": {
"properties": {
"$ref": "#/definitions/MaintenanceWindowOptionsProperties",
"description": "Resource properties.",
"x-ms-client-flatten": true
}
}
},
"MaintenanceWindowsProperties": {
"description": "Maintenance windows resource properties.",
"type": "object",
"properties": {
"timeRanges": {
"type": "array",
"items": {
"$ref": "#/definitions/MaintenanceWindowTimeRange"
}
}
}
},
"MaintenanceWindowTimeRange": {
"description": "Maintenance window time range.",
"type": "object",
"properties": {
"dayOfWeek": {
"description": "Day of maintenance window.",
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"type": "string",
"x-ms-enum": {
"name": "DayOfWeek",
"modelAsString": true
}
},
"startTime": {
"description": "Start time minutes offset from 12am.",
"type": "string"
},
"duration": {
"description": "Duration of maintenance window in minutes.",
"type": "string"
}
}
},
"MaintenanceWindows": {
"description": "Maintenance windows.",
"type": "object",
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource"
}
],
"properties": {
"properties": {
"$ref": "#/definitions/MaintenanceWindowsProperties",
"description": "Resource properties.",
"x-ms-client-flatten": true
}
}
},
"TransparentDataEncryptionProperties": {
"properties": {
"status": {