[Synapse]Sync Credential CRUD From DataFactory To Synapse

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"
+    }
+  }
+}