你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Sql Script - Get Sql Scripts By Workspace

Lists sql 脚本。

GET {endpoint}/sqlScripts?api-version=2020-12-01

URI 参数

名称 必需 类型 说明
endpoint
path True

string

uri

工作区开发终结点,例如 https://myworkspace.dev.azuresynapse.net

api-version
query True

string

Synapse 客户端 API 版本。

响应

名称 类型 说明
200 OK

SqlScriptsListResponse

没问题。

Other Status Codes

CloudError

从Azure Synapse服务收到的错误响应。

示例

SqlScripts_ListByWorkspace

示例请求

GET exampleWorkspace.dev.azuresynapse.net/sqlScripts?api-version=2020-12-01

示例响应

Date: Sat, 16 Jun 2018 00:37:43 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14990
x-ms-request-id: 92292250-c10f-4c47-8eb6-b886b361add7
x-ms-correlation-request-id: 92292250-c10f-4c47-8eb6-b886b361add7
{
  "value": [
    {
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sqlscripts/exampleSqlScript",
      "name": "exampleSqlScript",
      "type": "Microsoft.Synapse/workspaces/sqlscripts",
      "properties": {
        "description": "Covers the data transformation and LDW scenarios in one brief e2e story",
        "content": {
          "query": "SELECT TOP 100 * FROM example_table_name;",
          "currentConnection": {
            "name": "master",
            "type": "SqlOnDemand"
          },
          "metadata": {
            "language": "sql"
          }
        },
        "type": "SqlQuery"
      },
      "etag": "1500504f-0000-0200-0000-5cbe090f0000"
    }
  ]
}

定义

名称 说明
CloudError

定义Azure Synapse错误响应结构的对象。

Folder

此 SQL 脚本位于的文件夹。 如果未指定,此 SQL 脚本将显示在根级别。

SqlConnection

用于执行 SQL 脚本的连接。

SqlConnectionType

连接的类型。

SqlScript

SQL 脚本

SqlScriptContent

SQL 脚本的内容。

SqlScriptMetadata

SQL 脚本的元数据。

SqlScriptResource

Sql 脚本资源类型。

SqlScriptsListResponse

sql 脚本资源的列表。

SqlScriptType

SQL 脚本的类型。

CloudError

定义Azure Synapse错误响应结构的对象。

名称 类型 说明
error.code

string

错误代码。

error.details

CloudError[]

包含其他错误详细信息的数组。

error.message

string

错误消息。

error.target

string

与错误关联的请求中的属性名称/路径。

Folder

此 SQL 脚本位于的文件夹。 如果未指定,此 SQL 脚本将显示在根级别。

名称 类型 说明
name

string

此 SQL 脚本位于的文件夹的名称。

SqlConnection

用于执行 SQL 脚本的连接。

名称 类型 说明
databaseName

string

SQL 池 v3) 支持 (关联的数据库名称

name

string

连接的标识符。

poolName

string

SQL 池 v3 (支持的关联 SQL 池名称)

type

SqlConnectionType

连接的类型。

SqlConnectionType

连接的类型。

名称 类型 说明
SqlOnDemand

string

SqlPool

string

SqlScript

SQL 脚本

名称 类型 说明
content

SqlScriptContent

SQL 脚本的内容。

description

string

SQL 脚本的说明。

folder

Folder

此 SQL 脚本位于的文件夹。 如果未指定,此 SQL 脚本将显示在根级别。

type

SqlScriptType

SQL 脚本的类型。

SqlScriptContent

SQL 脚本的内容。

名称 类型 说明
currentConnection

SqlConnection

用于执行 SQL 脚本的连接。

metadata

SqlScriptMetadata

SQL 脚本的元数据。

query

string

要执行的 SQL 查询。

resultLimit

integer

结果限制,“-1”代表无限制。

SqlScriptMetadata

SQL 脚本的元数据。

名称 类型 说明
language

string

SQL 脚本的语言。

SqlScriptResource

Sql 脚本资源类型。

名称 类型 说明
etag

string

资源 Etag。

id

string

资源的完全限定资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties

SqlScript

sql 脚本的属性。

type

string

资源类型。 Ex- Microsoft.Compute/virtualMachines 或 Microsoft.Storage/storageAccounts。

SqlScriptsListResponse

sql 脚本资源的列表。

名称 类型 说明
nextLink

string

指向下一页结果的链接(如果存在任何剩余结果)。

value

SqlScriptResource[]

sql 脚本列表。

SqlScriptType

SQL 脚本的类型。

名称 类型 说明
SqlQuery

string