From 60409c88873e5bad6c4e598f5dbde8f6d4e35b96 Mon Sep 17 00:00:00 2001 From: jingzhong-MS <131136533+jingzhong-MS@users.noreply.github.com> Date: Tue, 23 May 2023 00:03:04 +0800 Subject: [PATCH] create 2023-04-18-preview to add actionOnExistingTargetTable property (#23670) * remove dropExistingTargetTableOnStart properties * add actionOnExistingTargetTable properties Co-authored-by: jingjingzhong123 <131136533+jingjingzhong123@users.noreply.github.com> --- .../LinkConnection_CreateOrUpdate.json | 87 ++ .../examples/LinkConnection_Delete.json | 11 + .../examples/LinkConnection_EditTables.json | 32 + .../examples/LinkConnection_Get.json | 45 + .../LinkConnection_GetDetailedStatus.json | 26 + .../LinkConnection_ListLinkTables.json | 33 + .../examples/LinkConnection_Pause.json | 10 + .../LinkConnection_QueryTableStatus.json | 30 + .../examples/LinkConnection_Resume.json | 10 + .../examples/LinkConnection_Start.json | 10 + .../examples/LinkConnection_Stop.json | 10 + ...onnection_UpdateLandingZoneCredential.json | 16 + .../LinkConnections_ListByWorkspace.json | 49 + .../2023-04-18-preview/linkConnections.json | 1070 +++++++++++++++++ specification/synapse/data-plane/readme.md | 38 +- 15 files changed, 1476 insertions(+), 1 deletion(-) create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_CreateOrUpdate.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Delete.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_EditTables.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Get.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_GetDetailedStatus.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_ListLinkTables.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Pause.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_QueryTableStatus.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Resume.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Start.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Stop.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_UpdateLandingZoneCredential.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnections_ListByWorkspace.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_CreateOrUpdate.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_CreateOrUpdate.json new file mode 100644 index 000000000000..785ae846ea71 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_CreateOrUpdate.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "linkConnectionName": "testLinkConnection", + "api-version": "2023-04-18-preview", + "linkConnection": { + "description": "linkconnection description", + "properties": { + "compute": { + "coreCount": 8, + "computeType": "General", + "dataProcessIntervalMinutes": 60 + }, + "sourceDatabase": { + "linkedService": { + "referenceName": "exampleSourceLinkedService", + "type": "LinkedServiceReference" + }, + "typeProperties": { + "resourceId": "/subscriptions/99c6ec47-aacb-485c-863c-018be33b9000/resourceGroups/testResourceGroup/providers/Microsoft.Sql/servers/testAzureSql", + "principalId": "fcf4d3a4-35b5-4c02-8b57-502cd6456d0b" + } + }, + "targetDatabase": { + "linkedService": { + "referenceName": "exampleTargetLinkedService", + "type": "LinkedServiceReference" + }, + "typeProperties": { + "crossTableTransaction": false, + "dropExistingTargetTableOnStart": false, + "actionOnExistingTargetTable": "DropAndRecreateTable" + } + }, + "landingZone": { + "linkedService": { + "referenceName": "exampleLandingZoneLinkedService", + "type": "LinkedServiceReference" + }, + "fileSystem": "exampleFileSystem", + "folderPath": "exampleFolderPath", + "sasToken": { + "type": "SecureString", + "value": "exampleSasToken" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/99c6ec47-aacb-485c-863c-018be33b9000/resourceGroups/testResourceGroup/providers/Microsoft.Synapse/workspaces/testWs/linkConnections/testLinkConnection", + "name": "testLinkConnection", + "type": "Microsoft.Synapse/workspaces/linkConnections", + "description": "linkconnection description", + "properties": { + "compute": { + "coreCount": 8, + "computeType": "General", + "dataProcessIntervalMinutes": 60 + }, + "sourceDatabase": { + "linkedService": { + "referenceName": "exampleSourceLinkedService", + "type": "LinkedServiceReference" + }, + "typeProperties": { + "resourceId": "/subscriptions/99c6ec47-aacb-485c-863c-018be33b9000/resourceGroups/testResourceGroup/providers/Microsoft.Sql/servers/testAzureSql", + "principalId": "fcf4d3a4-35b5-4c02-8b57-502cd6456d0b" + } + }, + "targetDatabase": { + "linkedService": { + "referenceName": "exampleTargetLinkedService", + "type": "LinkedServiceReference" + }, + "typeProperties": { + "crossTableTransaction": false, + "actionOnExistingTargetTable": "DropAndRecreateTable" + } + } + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Delete.json new file mode 100644 index 000000000000..91da349b337f --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "linkConnectionName": "testLinkConnection", + "api-version": "2023-04-18-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_EditTables.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_EditTables.json new file mode 100644 index 000000000000..e9802ba5473e --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_EditTables.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "linkConnectionName": "testLinkConnection", + "api-version": "2023-04-18-preview", + "editTablesRequest": { + "linkTables": [ + { + "id": "33f01131-553b-4b97-83a8-0db255a66901", + "source": { + "tableName": "exampleSourceTable", + "schemaName": "exampleSourceSchema" + }, + "target": { + "tableName": "exampleTargetTable", + "schemaName": "exampleTargetSchema", + "distributionOptions": { + "type": "Round_RoBin" + }, + "structureOptions": { + "type": "Clustered_ColumnStore" + } + }, + "operationType": "Add" + } + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Get.json new file mode 100644 index 000000000000..f105b495fd66 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "linkConnectionName": "testLinkConnection", + "api-version": "2023-04-18-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/99c6ec47-aacb-485c-863c-018be33b9000/resourceGroups/testResourceGroup/providers/Microsoft.Synapse/workspaces/testWs/linkConnections/testLinkConnection", + "name": "testLinkConnection", + "type": "Microsoft.Synapse/workspaces/linkConnections", + "description": "linkconnection description", + "properties": { + "compute": { + "coreCount": 8, + "computeType": "General", + "dataProcessIntervalMinutes": 60 + }, + "sourceDatabase": { + "linkedService": { + "referenceName": "exampleSourceLinkedService", + "type": "LinkedServiceReference" + }, + "typeProperties": { + "resourceId": "/subscriptions/99c6ec47-aacb-485c-863c-018be33b9000/resourceGroups/testResourceGroup/providers/Microsoft.Sql/servers/testAzureSql", + "principalId": "fcf4d3a4-35b5-4c02-8b57-502cd6456d0b" + } + }, + "targetDatabase": { + "linkedService": { + "referenceName": "exampleTargetLinkedService", + "type": "LinkedServiceReference" + }, + "typeProperties": { + "crossTableTransaction": false, + "dropExistingTargetTableOnStart": false, + "actionOnExistingTargetTable": "DropAndRecreateTable" + } + } + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_GetDetailedStatus.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_GetDetailedStatus.json new file mode 100644 index 000000000000..94abab52da6c --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_GetDetailedStatus.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "linkConnectionName": "testLinkConnection", + "api-version": "2023-04-18-preview" + }, + "responses": { + "200": { + "body": { + "id": "d20e417b-b5d1-4d5c-b2d6-4a581575c5b1", + "name": "testLinkConnection", + "isApplyingChanges": false, + "isPartiallyFailed": false, + "startTime": "2021-10-28T08:09:32.2976822Z", + "status": "Running", + "stopTime": "2021-10-28T09:24:47.2415789Z", + "continuousRunId": "23ded02c-056b-45e7-8852-a2fdb8d250dc", + "refreshStatus": { + "refreshStatus": "Failed", + "errorMessage": "sampleErrorMessage" + }, + "landingZoneCredentialExpireTime": "2022-12-31T05:30:00.0000000Z" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_ListLinkTables.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_ListLinkTables.json new file mode 100644 index 000000000000..3cd88dd1340c --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_ListLinkTables.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "linkConnectionName": "testLinkConnection", + "api-version": "2023-04-18-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "7bbb9091983b48f59808cb322a30e1e1", + "name": "testLinkConnection", + "source": { + "tableName": "exampleSourceTable", + "schemaName": "exampleSourceSchema" + }, + "target": { + "tableName": "exampleTargetTable", + "schemaName": "exampleTargetSchema", + "distributionOptions": { + "type": "Round_RoBin" + }, + "structureOptions": { + "type": "Clustered_ColumnStore" + } + } + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Pause.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Pause.json new file mode 100644 index 000000000000..45eab0b34460 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Pause.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "linkConnectionName": "testLinkConnection", + "api-version": "2023-04-18-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_QueryTableStatus.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_QueryTableStatus.json new file mode 100644 index 000000000000..e4a1fde0b859 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_QueryTableStatus.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "linkConnectionName": "testLinkConnection", + "api-version": "2023-04-18-preview", + "queryTableStatusRequest": { + "maxSegmentCount": 50 + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "8bbb9091983b48f59808cb322a30e1e1", + "startTime": "2021-10-28T08:09:32.2976822Z", + "status": "Replicating", + "stopTime": "2021-10-28T09:24:47.2415789Z", + "errorMessage": "sampleErrorMessage", + "linkTableId": "10c1bb52-6a70-4ece-953a-fc15df0460e2", + "errorCode": "sampleErrorCode", + "lastProcessedData": "2022-07-27T15:19:32.473Z", + "lastTransactionCommitTime": "2022-07-27T15:19:32.473Z" + } + ], + "continuationToken": null + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Resume.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Resume.json new file mode 100644 index 000000000000..45eab0b34460 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Resume.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "linkConnectionName": "testLinkConnection", + "api-version": "2023-04-18-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Start.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Start.json new file mode 100644 index 000000000000..45eab0b34460 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Start.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "linkConnectionName": "testLinkConnection", + "api-version": "2023-04-18-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Stop.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Stop.json new file mode 100644 index 000000000000..45eab0b34460 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_Stop.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "linkConnectionName": "testLinkConnection", + "api-version": "2023-04-18-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_UpdateLandingZoneCredential.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_UpdateLandingZoneCredential.json new file mode 100644 index 000000000000..d20788512b3e --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnection_UpdateLandingZoneCredential.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "linkConnectionName": "testLinkConnection", + "api-version": "2023-04-18-preview", + "updateLandingZoneCredentialRequest": { + "sasToken": { + "type": "SecureString", + "value": "exampleSasToken" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnections_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnections_ListByWorkspace.json new file mode 100644 index 000000000000..f3e4cb30b47d --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/examples/LinkConnections_ListByWorkspace.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "api-version": "2023-04-18-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/99c6ec47-aacb-485c-863c-018be33b9000/resourceGroups/testResourceGroup/providers/Microsoft.Synapse/workspaces/testWs/linkConnections/testLinkConnection", + "name": "testLinkConnection", + "type": "Microsoft.Synapse/workspaces/linkConnections", + "description": "linkconnection description", + "properties": { + "compute": { + "coreCount": 8, + "computeType": "General", + "dataProcessIntervalMinutes": 60 + }, + "sourceDatabase": { + "linkedService": { + "referenceName": "exampleSourceLinkedService", + "type": "LinkedServiceReference" + }, + "typeProperties": { + "resourceId": "/subscriptions/99c6ec47-aacb-485c-863c-018be33b9000/resourceGroups/testResourceGroup/providers/Microsoft.Sql/servers/testAzureSql", + "principalId": "fcf4d3a4-35b5-4c02-8b57-502cd6456d0b" + } + }, + "targetDatabase": { + "linkedService": { + "referenceName": "exampleTargetLinkedService", + "type": "LinkedServiceReference" + }, + "typeProperties": { + "crossTableTransaction": false, + "dropExistingTargetTableOnStart": false, + "actionOnExistingTargetTable": "DropAndRecreateTable" + } + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json new file mode 100644 index 000000000000..32913ddd99cc --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json @@ -0,0 +1,1070 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-04-18-preview", + "title": "ArtifactsClient", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/linkconnections": { + "get": { + "tags": [ + "linkConnections" + ], + "operationId": "LinkConnection_ListByWorkspace", + "description": "List link connections", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LinkConnectionListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LinkConnections_ListByWorkspace": { + "$ref": "./examples/LinkConnections_ListByWorkspace.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/linkconnections/{linkConnectionName}": { + "put": { + "tags": [ + "linkConnections" + ], + "operationId": "LinkConnection_CreateOrUpdate", + "description": "Creates or updates a link connection", + "parameters": [ + { + "$ref": "#/parameters/LinkConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "linkConnection", + "description": "Link connection resource definition", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkConnectionResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LinkConnectionResource" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LinkConnection_CreateOrUpdate": { + "$ref": "./examples/LinkConnection_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "linkConnections" + ], + "operationId": "LinkConnection_Get", + "description": "Get a link connection", + "parameters": [ + { + "$ref": "#/parameters/LinkConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LinkConnectionResource" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LinkConnection_Get": { + "$ref": "./examples/LinkConnection_Get.json" + } + } + }, + "delete": { + "tags": [ + "linkConnections" + ], + "operationId": "LinkConnection_Delete", + "description": "Delete a link connection", + "parameters": [ + { + "$ref": "#/parameters/LinkConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LinkConnection_Delete": { + "$ref": "./examples/LinkConnection_Delete.json" + } + } + } + }, + "/linkconnections/{linkConnectionName}/edittables": { + "post": { + "tags": [ + "linkConnections" + ], + "operationId": "LinkConnection_EditTables", + "description": "Edit tables for a link connection", + "parameters": [ + { + "$ref": "#/parameters/LinkConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "editTablesRequest", + "description": "Edit tables request", + "required": true, + "schema": { + "$ref": "#/definitions/EditTablesRequest" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LinkConnection_EditTables": { + "$ref": "./examples/LinkConnection_EditTables.json" + } + } + } + }, + "/linkconnections/{linkConnectionName}/start": { + "post": { + "tags": [ + "linkConnections" + ], + "operationId": "LinkConnection_Start", + "description": "Start a link connection. It may take a few minutes from Starting to Running, monitor the status with LinkConnection_GetDetailedStatus.", + "parameters": [ + { + "$ref": "#/parameters/LinkConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LinkConnection_Start": { + "$ref": "./examples/LinkConnection_Start.json" + } + } + } + }, + "/linkconnections/{linkConnectionName}/stop": { + "post": { + "tags": [ + "linkConnections" + ], + "operationId": "LinkConnection_Stop", + "description": "Stop a link connection. It may take a few minutes from Stopping to stopped, monitor the status with LinkConnection_GetDetailedStatus.", + "parameters": [ + { + "$ref": "#/parameters/LinkConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LinkConnection_Stop": { + "$ref": "./examples/LinkConnection_Stop.json" + } + } + } + }, + "/linkconnections/{linkConnectionName}/detailedstatus": { + "get": { + "tags": [ + "linkConnections" + ], + "operationId": "LinkConnection_GetDetailedStatus", + "description": "Get the detailed status of a link connection", + "parameters": [ + { + "$ref": "#/parameters/LinkConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LinkConnectionDetailedStatus" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LinkConnection_GetDetailedStatus": { + "$ref": "./examples/LinkConnection_GetDetailedStatus.json" + } + } + } + }, + "/linkconnections/{linkConnectionName}/linktables": { + "get": { + "tags": [ + "linkConnections" + ], + "operationId": "LinkConnection_ListLinkTables", + "description": "List the link tables of a link connection", + "parameters": [ + { + "$ref": "#/parameters/LinkConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LinkTableListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LinkConnection_ListLinkTables": { + "$ref": "./examples/LinkConnection_ListLinkTables.json" + } + } + } + }, + "/linkconnections/{linkConnectionName}/querytablestatus": { + "post": { + "tags": [ + "linkConnections" + ], + "operationId": "LinkConnection_QueryTableStatus", + "description": "Query the link table status of a link connection", + "parameters": [ + { + "$ref": "#/parameters/LinkConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "queryTableStatusRequest", + "description": "Query table status request", + "required": true, + "schema": { + "$ref": "#/definitions/QueryTableStatusRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LinkConnectionQueryTableStatus" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LinkConnection_QueryTableStatus": { + "$ref": "./examples/LinkConnection_QueryTableStatus.json" + } + } + } + }, + "/linkconnections/{linkConnectionName}/updateLandingZoneCredential": { + "post": { + "tags": [ + "linkConnections" + ], + "operationId": "LinkConnection_UpdateLandingZoneCredential", + "description": "Update landing zone credential of a link connection", + "parameters": [ + { + "$ref": "#/parameters/LinkConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "updateLandingZoneCredentialRequest", + "description": "update landing zone credential request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateLandingZoneCredential" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LinkConnection_UpdateLandingZoneCredential": { + "$ref": "./examples/LinkConnection_UpdateLandingZoneCredential.json" + } + } + } + }, + "/linkconnections/{linkConnectionName}/pause": { + "post": { + "tags": [ + "linkConnections" + ], + "operationId": "LinkConnection_Pause", + "description": "Pause a link connection. It may take a few minutes from Pausing to Paused, monitor the status with LinkConnection_GetDetailedStatus.", + "parameters": [ + { + "$ref": "#/parameters/LinkConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LinkConnection_Pause": { + "$ref": "./examples/LinkConnection_Pause.json" + } + } + } + }, + "/linkconnections/{linkConnectionName}/resume": { + "post": { + "tags": [ + "linkConnections" + ], + "operationId": "LinkConnection_Resume", + "description": "Resume a link connection. It may take a few minutes from Resuming to Running, monitor the status with LinkConnection_GetDetailedStatus.", + "parameters": [ + { + "$ref": "#/parameters/LinkConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LinkConnection_Resume": { + "$ref": "./examples/LinkConnection_Resume.json" + } + } + } + } + }, + "definitions": { + "LinkConnectionListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List link connection value", + "items": { + "$ref": "#/definitions/LinkConnectionResource" + } + }, + "nextLink": { + "type": "string", + "description": "List link connections next link" + } + }, + "required": [ + "value" + ] + }, + "LinkTableListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List link table value", + "items": { + "$ref": "#/definitions/LinkTableResource" + } + } + } + }, + "LinkConnectionResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Link connection id" + }, + "name": { + "type": "string", + "description": "Link connection name" + }, + "type": { + "type": "string", + "description": "Link connection type" + }, + "properties": { + "$ref": "#/definitions/LinkConnection", + "description": "Properties of link connection" + }, + "description": { + "type": "string", + "description": "Link connection description" + } + }, + "required": [ + "properties" + ] + }, + "LinkTableResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Link table id" + }, + "name": { + "type": "string", + "description": "Link table name" + }, + "source": { + "$ref": "#/definitions/LinkTableRequestSource", + "description": "Source table properties for link table request" + }, + "target": { + "$ref": "#/definitions/LinkTableRequestTarget", + "description": "Target table properties for link table request" + } + } + }, + "LinkConnection": { + "type": "object", + "properties": { + "sourceDatabase": { + "$ref": "#/definitions/LinkConnectionSourceDatabase", + "description": "Properties of link connection's source database" + }, + "targetDatabase": { + "$ref": "#/definitions/LinkConnectionTargetDatabase", + "description": "Properties of link connection's target database" + }, + "landingZone": { + "$ref": "#/definitions/LinkConnectionLandingZone", + "description": "Properties of link connection's landing zone" + }, + "compute": { + "$ref": "#/definitions/LinkConnectionCompute", + "description": "Properties of link connection's compute" + } + } + }, + "LinkConnectionSourceDatabase": { + "type": "object", + "properties": { + "linkedService": { + "$ref": "#/definitions/LinkedServiceReference", + "description": "Linked service reference" + }, + "typeProperties": { + "$ref": "#/definitions/LinkConnectionSourceDatabaseTypeProperties", + "description": "Source database type properties" + } + } + }, + "LinkConnectionSourceDatabaseTypeProperties": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Link connection source database server's resource id" + }, + "principalId": { + "type": "string", + "description": "Link connection source database server's principal id" + } + } + }, + "LinkConnectionTargetDatabase": { + "type": "object", + "properties": { + "linkedService": { + "$ref": "#/definitions/LinkedServiceReference", + "description": "Linked service reference" + }, + "typeProperties": { + "$ref": "#/definitions/LinkConnectionTargetDatabaseTypeProperties", + "description": "Target database type properties" + } + } + }, + "LinkConnectionTargetDatabaseTypeProperties": { + "type": "object", + "properties": { + "crossTableTransaction": { + "type": "boolean", + "description": "Enable cross table transaction consistency on target database" + }, + "dropExistingTargetTableOnStart": { + "type": "boolean", + "description": "Drop and recreate same existing target table on link connection target database" + }, + "actionOnExistingTargetTable": { + "type": "string", + "enum": [ + "FailOnNonEmptyTable", + "DropAndRecreateTable", + "MergeWithExistingData" + ], + "x-ms-enum": { + "name": "actionOnExistingTargetTable", + "values": [ + { + "value": "FailOnNonEmptyTable", + "description": "Same existing tables on target database will be Failed." + }, + { + "value": "DropAndRecreateTable", + "description": "Same existing tables on target database will be dropped and recreated." + }, + { + "value": "MergeWithExistingData", + "description": "Same existing tables on target database will be Merged together." + } + ], + "modelAsString": true + }, + "description": "Action on existing target table. If not specified, 'FailOnNonEmptyTable' action is used." + } + } + }, + "LinkConnectionLandingZone": { + "type": "object", + "properties": { + "linkedService": { + "$ref": "#/definitions/LinkedServiceReference", + "description": "Linked service reference" + }, + "fileSystem": { + "type": "string", + "description": "Landing zone's file system name" + }, + "folderPath": { + "type": "string", + "description": "Landing zone's folder path name" + }, + "sasToken": { + "$ref": "#/definitions/SecureString", + "description": "Landing zone's sas token" + } + } + }, + "LinkConnectionCompute": { + "type": "object", + "properties": { + "coreCount": { + "type": "integer", + "description": "Compute core count used by the link connection", + "format": "int32" + }, + "computeType": { + "type": "string", + "description": "Link connection's compute type" + }, + "dataProcessIntervalMinutes": { + "type": "integer", + "description": "Link connection's data process interval in minutes", + "minimum": 20, + "maximum": 60, + "format": "int32" + } + } + }, + "EditTablesRequest": { + "type": "object", + "properties": { + "linkTables": { + "type": "array", + "description": "Edit link tables request", + "items": { + "$ref": "#/definitions/LinkTableRequest" + } + } + } + }, + "LinkTableRequest": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Link table id" + }, + "source": { + "$ref": "#/definitions/LinkTableRequestSource", + "description": "Source table properties for link table request" + }, + "target": { + "$ref": "#/definitions/LinkTableRequestTarget", + "description": "Target table properties for link table request" + }, + "operationType": { + "type": "string", + "description": "Link table operation type" + } + } + }, + "LinkTableRequestSource": { + "type": "object", + "properties": { + "tableName": { + "type": "string", + "description": "Source table table name" + }, + "schemaName": { + "type": "string", + "description": "Source table schema name" + } + } + }, + "LinkTableRequestTarget": { + "type": "object", + "properties": { + "tableName": { + "type": "string", + "description": "Target table table name" + }, + "schemaName": { + "type": "string", + "description": "Target table schema name" + }, + "distributionOptions": { + "$ref": "#/definitions/LinkTableRequestTargetDistributionOptions", + "description": "Target table distribution options for link table request" + }, + "structureOptions": { + "$ref": "#/definitions/LinkTableRequestTargetStructureOptions", + "description": "Target table structure options for link table request" + } + } + }, + "LinkTableRequestTargetDistributionOptions": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Target table distribution type" + }, + "distributionColumn": { + "type": "string", + "description": "Target table distribution column" + } + } + }, + "LinkTableRequestTargetStructureOptions": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Target table structure type" + } + } + }, + "LinkConnectionDetailedStatus": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Link connection id" + }, + "name": { + "type": "string", + "description": "Link connection name" + }, + "isApplyingChanges": { + "type": "boolean", + "description": "Is link connection applying changes" + }, + "isPartiallyFailed": { + "type": "boolean", + "description": "Is link connection partially failed" + }, + "startTime": { + "type": "object", + "description": "Link connection start time" + }, + "stopTime": { + "type": "object", + "description": "Link connection stop time" + }, + "status": { + "type": "string", + "description": "Link connection status, please refer to this [articles](https://learn.microsoft.com/azure/synapse-analytics/synapse-link/sql-database-synapse-link#monitoring) for details." + }, + "continuousRunId": { + "type": "string", + "description": "Link connection's corresponding continuous run id" + }, + "error": { + "type": "object", + "description": "Link connection error" + }, + "refreshStatus": { + "$ref": "#/definitions/LinkConnectionRefreshStatus", + "description": "Link connection refresh status" + }, + "landingZoneCredentialExpireTime": { + "type": "string", + "description": "Link connection landing zone credential expire time", + "format": "date-time" + } + } + }, + "LinkConnectionQueryTableStatus": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Link tables' status", + "items": { + "$ref": "#/definitions/LinkTableStatus" + } + }, + "continuationToken": { + "type": "object", + "description": "Continuation token to query table status" + } + } + }, + "LinkTableStatus": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID provided by the client" + }, + "status": { + "type": "string", + "description": "Link table status, please refer to this [articles](https://learn.microsoft.com/azure/synapse-analytics/synapse-link/sql-database-synapse-link#monitoring) for details." + }, + "errorMessage": { + "type": "string", + "description": "Link table error message" + }, + "startTime": { + "type": "object", + "description": "Link table start time" + }, + "stopTime": { + "type": "object", + "description": "Link table stop time" + }, + "linkTableId": { + "type": "string", + "description": "Link table ID" + }, + "errorCode": { + "type": "string", + "description": "Link table error code" + }, + "lastProcessedData": { + "type": "string", + "description": "Link table last processed data time", + "format": "date-time" + }, + "lastTransactionCommitTime": { + "type": "string", + "description": "Link table last transaction commit time", + "format": "date-time" + } + } + }, + "QueryTableStatusRequest": { + "type": "object", + "properties": { + "maxSegmentCount": { + "type": "integer", + "description": "Max segment count to query table status", + "format": "int32", + "maximum": 1000 + }, + "continuationToken": { + "type": "object", + "description": "Continuation token to query table status" + } + } + }, + "UpdateLandingZoneCredential": { + "type": "object", + "properties": { + "sasToken": { + "$ref": "#/definitions/SecureString", + "description": "Landing zone's sas token" + } + } + }, + "LinkConnectionRefreshStatus": { + "type": "object", + "properties": { + "refreshStatus": { + "type": "string", + "description": "Link connection refresh status", + "readOnly": true + }, + "errorMessage": { + "type": "string", + "description": "Link connection refresh error message", + "readOnly": true + } + } + }, + "SecureString": { + "x-ms-discriminator-value": "SecureString", + "description": "Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretBase" + } + ], + "properties": { + "value": { + "type": "string", + "description": "Value of secure string." + } + }, + "required": [ + "value" + ] + }, + "SecretBase": { + "description": "The base definition of a secret type.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the secret." + } + }, + "required": [ + "type" + ] + }, + "LinkedServiceReference": { + "description": "Linked service reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Linked service reference type.", + "enum": [ + "LinkedServiceReference" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference LinkedService name." + }, + "parameters": { + "$ref": "#/definitions/ParameterValueSpecification", + "description": "Arguments for LinkedService." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "ParameterValueSpecification": { + "description": "An object mapping parameter names to argument values.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version.", + "x-ms-parameter-location": "client" + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client", + "format": "url" + }, + "LinkConnectionName": { + "name": "linkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The link connection name", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/data-plane/readme.md b/specification/synapse/data-plane/readme.md index e353bba177b5..085fc34bbf50 100644 --- a/specification/synapse/data-plane/readme.md +++ b/specification/synapse/data-plane/readme.md @@ -34,7 +34,7 @@ tag: package-spark-2020-12-01 ``` ``` yaml $(package-artifacts) -tag: package-artifacts-composite-v6 +tag: package-artifacts-composite-v7 ``` ``` yaml $(package-access-control) @@ -49,6 +49,42 @@ tag: package-vnet-2020-12-01 tag: package-monitoring-2020-12-01 ``` +### Tag: package-artifacts-composite-v7 + +These settings apply only when `--tag=package-artifacts-composite-v7` is specified on the command line. + +``` yaml $(tag) == 'package-artifacts-composite-v7' +input-file: + - Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json + - Microsoft.Synapse/preview/2021-11-01-preview/kqlScripts.json + - Microsoft.Synapse/preview/2021-07-01-preview/symsSync.json + - Microsoft.Synapse/preview/2021-06-01-preview/sparkConfigurations.json + - Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/SparkConfiguration.json + - Microsoft.Synapse/stable/2020-12-01/artifacts.json + - Microsoft.Synapse/stable/2020-12-01/bigDataPools.json + - Microsoft.Synapse/stable/2020-12-01/dataflows.json + - Microsoft.Synapse/stable/2020-12-01/datasets.json + - Microsoft.Synapse/stable/2020-12-01/gitintegration.json + - Microsoft.Synapse/stable/2020-12-01/integrationRuntimes.json + - Microsoft.Synapse/stable/2020-12-01/library.json + - Microsoft.Synapse/stable/2020-12-01/linkedServices.json + - Microsoft.Synapse/stable/2020-12-01/notebooks.json + - Microsoft.Synapse/stable/2020-12-01/pipelines.json + - Microsoft.Synapse/stable/2020-12-01/sparkJobDefinitions.json + - Microsoft.Synapse/stable/2020-12-01/sqlPools.json + - Microsoft.Synapse/stable/2020-12-01/sqlScripts.json + - Microsoft.Synapse/stable/2020-12-01/triggers.json + - Microsoft.Synapse/stable/2020-12-01/workspace.json + - Microsoft.Synapse/stable/2020-12-01/entityTypes/DataFlow.json + - Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json + - Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json + - Microsoft.Synapse/stable/2020-12-01/entityTypes/Notebook.json + - Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json + - Microsoft.Synapse/stable/2020-12-01/entityTypes/SparkJobDefinition.json + - Microsoft.Synapse/stable/2020-12-01/entityTypes/SqlScript.json + - Microsoft.Synapse/stable/2020-12-01/entityTypes/Trigger.json +``` + ### Tag: package-artifacts-composite-v6 These settings apply only when `--tag=package-artifacts-composite-v6` is specified on the command line.