diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/credential.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/credential.json new file mode 100644 index 000000000000..23e4772992d2 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/credential.json @@ -0,0 +1,283 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-12-01", + "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": { + "/credentials": { + "get": { + "tags": [ + "credentials" + ], + "operationId": "Credentials_ListByWorkspace", + "x-ms-examples": { + "Credentials_ListByWorkspace": { + "$ref": "./examples/Credentials_ListByWorkspace.json" + } + }, + "description": "Lists credentials.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/CredentialListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/credentials/{credentialName}": { + "put": { + "tags": [ + "credentials" + ], + "operationId": "Credentials_CreateOrUpdate", + "x-ms-examples": { + "Credentials_Create": { + "$ref": "./examples/Credentials_Create.json" + } + }, + "description": "Creates or updates a credential.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/credentialName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the credential entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "credential", + "description": "Credential resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedIdentityCredentialResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ManagedIdentityCredentialResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "credentials" + ], + "operationId": "Credential_Get", + "x-ms-examples": { + "Datasets_Get": { + "$ref": "./examples/Credentials_Get.json" + } + }, + "description": "Gets a credential.", + "parameters": [ + { + "$ref": "#/parameters/credentialName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the dataset entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ManagedIdentityCredentialResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "credentials" + ], + "operationId": "Credential_Delete", + "x-ms-examples": { + "Credentials_Delete": { + "$ref": "./examples/Credentials_Delete.json" + } + }, + "description": "Deletes a credential.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/credentialName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "CredentialListResponse": { + "description": "A list of credential resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of credentials.", + "items": { + "$ref": "#/definitions/ManagedIdentityCredentialResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "ManagedIdentityCredentialResource": { + "description": "Credential resource type.", + "type": "object", + "allOf": [ + { + "$ref": "artifacts.json#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/Credential.json#/definitions/ManagedIdentityCredential", + "description": "Managed Identity Credential properties." + } + }, + "required": [ + "properties" + ] + } + }, + "parameters": { + "workspaceName": { + "name": "workspaceName", + "description": "The workspace name.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version.", + "x-ms-parameter-location": "method" + }, + "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" + }, + "credentialName": { + "name": "credentialName", + "description": "Credential name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$", + "minLength": 1, + "maxLength": 127, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json index 94797ac53a01..68c5c3399860 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json @@ -2256,10 +2256,7 @@ }, "storedProcedureParameters": { "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } + "type": "object" }, "isolationLevel": { "description": "Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).", @@ -2294,10 +2291,7 @@ }, "storedProcedureParameters": { "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } + "type": "object" }, "isolationLevel": { "description": "Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).", @@ -2336,10 +2330,7 @@ }, "storedProcedureParameters": { "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } + "type": "object" }, "isolationLevel": { "description": "Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).", @@ -2378,10 +2369,7 @@ }, "storedProcedureParameters": { "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } + "type": "object" }, "isolationLevel": { "description": "Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).", @@ -2420,10 +2408,7 @@ }, "storedProcedureParameters": { "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } + "type": "object" }, "isolationLevel": { "description": "Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).", @@ -4154,10 +4139,7 @@ }, "storedProcedureParameters": { "description": "SQL stored procedure parameters.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } + "type": "object" }, "storedProcedureTableTypeParameterName": { "type": "object", @@ -4192,10 +4174,7 @@ }, "storedProcedureParameters": { "description": "SQL stored procedure parameters.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } + "type": "object" }, "storedProcedureTableTypeParameterName": { "type": "object", @@ -4230,10 +4209,7 @@ }, "storedProcedureParameters": { "description": "SQL stored procedure parameters.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } + "type": "object" }, "storedProcedureTableTypeParameterName": { "type": "object", @@ -4268,10 +4244,7 @@ }, "storedProcedureParameters": { "description": "SQL stored procedure parameters.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } + "type": "object" }, "storedProcedureTableTypeParameterName": { "type": "object", @@ -7735,10 +7708,7 @@ }, "storedProcedureParameters": { "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } + "type": "object" } }, "required": [ diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Credentials_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Credentials_Create.json new file mode 100644 index 000000000000..99aa95fbb8e2 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Credentials_Create.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01", + "credentialName": "exampleCredential", + "ifMatch": null, + "credential": { + "properties": { + "type": "ManagedIdentity", + "typeProperties": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1194", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + } + }, + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:34 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1196", + "x-ms-request-id": "b3b336b3-b203-4654-9cb6-a3a8d3a4b5de", + "x-ms-correlation-request-id": "b3b336b3-b203-4654-9cb6-a3a8d3a4b5de" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/credentials/exampleCredential", + "name": "exampleCredential", + "type": "Microsoft.Synapse/workspaces/credentials", + "properties": { + "type": "ManagedIdentity", + "typeProperties": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami" + } + }, + "etag": "0a0062d4-0000-0000-0000-5b245bcf0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Credentials_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Credentials_Delete.json new file mode 100644 index 000000000000..ec2b02b149fe --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Credentials_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "credentialName": "exampleCredential", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Synapse/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2020-12-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Synapse/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2020-12-01" + } + }, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Credentials_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Credentials_Get.json new file mode 100644 index 000000000000..193f35846405 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Credentials_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "credentialName": "exampleCredential", + "ifNoneMatch": "15004c4f-0000-0200-0000-5cbe090e0000", + "api-version": "2020-12-01" + }, + "responses": { + "304": {}, + "200": { + "headers": { + "Date": "Mon, 22 Apr 2019 18:33:48 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11995", + "x-ms-request-id": "99e5d0d9-55e6-45a0-8bd2-cf39210f317c", + "x-ms-correlation-request-id": "99e5d0d9-55e6-45a0-8bd2-cf39210f317c" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/credentials/exampleCredential", + "name": "exampleCredential", + "type": "Microsoft.Synapse/workspaces/credentials", + "properties": { + "type": "ManagedIdentity", + "typeProperties": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami" + }, + "description": "Example description" + }, + "etag": "1500474f-0000-0200-0000-5cbe090d0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Credentials_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Credentials_ListByWorkspace.json new file mode 100644 index 000000000000..165c764589fb --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Credentials_ListByWorkspace.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:40 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14992", + "x-ms-request-id": "341c9ece-5062-448b-be98-3ccbf476ed5d", + "x-ms-correlation-request-id": "341c9ece-5062-448b-be98-3ccbf476ed5d" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/credentials/exampleCredentials", + "name": "exampleCredential", + "type": "Microsoft.Synapse/workspaces/credentials", + "properties": { + "type": "ManagedIdentity", + "typeProperties": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami" + }, + "description": "Example description" + }, + "etag": "0a0064d4-0000-0000-0000-5b245bd00000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/readme.md b/specification/synapse/data-plane/readme.md index 521f7b0c83f5..8f05fc048c21 100644 --- a/specification/synapse/data-plane/readme.md +++ b/specification/synapse/data-plane/readme.md @@ -76,6 +76,7 @@ input-file: - 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/credential.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 @@ -84,6 +85,7 @@ input-file: - 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 + - Microsoft.Synapse/stable/2020-12-01/entityTypes/Credential.json ``` ### Tag: package-artifacts-2021-04-01 @@ -123,6 +125,7 @@ input-file: - 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/credential.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 @@ -160,6 +163,7 @@ input-file: - 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/credential.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 @@ -197,6 +201,7 @@ input-file: - 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/credential.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 @@ -233,6 +238,7 @@ input-file: - 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/credential.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 @@ -268,6 +274,7 @@ input-file: - 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/credential.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 @@ -303,6 +310,7 @@ input-file: - 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/credential.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 @@ -390,6 +398,7 @@ input-file: - 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/credential.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