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

az synapse sql pool

参考

管理 SQL 池。

命令

名称	说明	类型	状态
az synapse sql pool audit-policy	管理 SQL 池的审核策略。	核心	GA
az synapse sql pool audit-policy show	获取 SQL 池的审核策略。	核心	GA
az synapse sql pool audit-policy update	更新 SQL 池的审核策略。	核心	GA
az synapse sql pool classification	管理敏感度分类。	核心	GA
az synapse sql pool classification create	创建列的敏感度分类。	核心	GA
az synapse sql pool classification delete	删除给定列的敏感度分类。	核心	GA
az synapse sql pool classification list	获取给定 SQL 池的敏感度分类。	核心	GA
az synapse sql pool classification recommendation	管理敏感度分类建议。	核心	GA
az synapse sql pool classification recommendation disable	禁用给定列的敏感度建议（默认情况下对所有列启用建议）。	核心	GA
az synapse sql pool classification recommendation enable	为给定列启用敏感度建议（默认情况下对所有列启用建议）。	核心	GA
az synapse sql pool classification recommendation list	列出给定 SQL 池的建议敏感度分类。	核心	GA
az synapse sql pool classification show	获取给定列的敏感度分类。	核心	GA
az synapse sql pool classification update	更新列的敏感度分类。	核心	GA
az synapse sql pool create	创建 SQL 池。	核心	GA
az synapse sql pool delete	删除 SQL 池。	核心	GA
az synapse sql pool list	列出所有 SQL 池。	核心	GA
az synapse sql pool list-deleted	列出所有已删除的 SQL 池。	核心	GA
az synapse sql pool pause	暂停 SQL 池。	核心	GA
az synapse sql pool restore	通过从备份还原创建新的 SQL 池。	核心	GA
az synapse sql pool resume	恢复 SQL 池。	核心	GA
az synapse sql pool show	获取 SQL 池。	核心	GA
az synapse sql pool show-connection-string	生成 SQL 池的连接字符串。	核心	GA
az synapse sql pool tde	管理 SQL 池的透明数据加密。	核心	GA
az synapse sql pool tde set	设置 SQL 池的透明数据加密配置。	核心	GA
az synapse sql pool tde show	获取 SQL 池的透明数据加密配置。	核心	GA
az synapse sql pool threat-policy	管理 SQL 池的威胁检测策略。	核心	GA
az synapse sql pool threat-policy show	获取 SQL 池的威胁检测策略。	核心	GA
az synapse sql pool threat-policy update	更新 SQL 池的威胁检测策略。	核心	GA
az synapse sql pool update	更新 SQL 池。	核心	GA
az synapse sql pool wait	将 CLI 置于等待状态，直到满足 SQL 池的条件。	核心	GA

az synapse sql pool create

编辑

创建 SQL 池。

az synapse sql pool create --name
                           --performance-level
                           --resource-group
                           --workspace-name
                           [--collation]
                           [--no-wait]
                           [--storage-type {GRS, LRS}]
                           [--tags]

示例

创建 SQL 池。

az synapse sql pool create --name sqlpool --performance-level "DW1000c" \
--workspace-name testsynapseworkspace --resource-group rg --collation "SQL_Latin1_General_CP1_CS_AS"

必需参数

--name -n

SQL 池名称。

--performance-level

性能级别。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name

工作区名称。

可选参数

--collation

排序规则定义了数据的排序和比较规则，在 SQL 池创建后无法更改。默认排序规则为“SQL_Latin1_General_CP1_CI_AS”。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--storage-type

存储帐户类型。

接受的值: GRS, LRS

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az synapse sql pool delete

编辑

删除 SQL 池。

az synapse sql pool delete [--ids]
                           [--name]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]
                           [--workspace-name]
                           [--yes]

示例

删除 SQL 池。

az synapse sql pool delete --name sqlpool --workspace-name testsynapseworkspace --resource-group rg

可选参数

--ids

一个或多个资源 ID（空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--name -n

SQL 池名称。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--workspace-name

工作区名称。

--yes -y

不提示确认。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az synapse sql pool list

编辑

列出所有 SQL 池。

az synapse sql pool list --resource-group
                         --workspace-name

示例

列出 SQL 池。

az synapse sql pool list --workspace-name testsynapseworkspace --resource-group rg

必需参数

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name

工作区名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az synapse sql pool list-deleted

编辑

列出所有已删除的 SQL 池。

az synapse sql pool list-deleted --resource-group
                                 --workspace-name

示例

列出已删除的 SQL 池。

az synapse sql pool list-deleted --workspace-name testsynapseworkspace --resource-group rg

必需参数

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name

工作区名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az synapse sql pool pause

编辑

暂停 SQL 池。

az synapse sql pool pause [--ids]
                          [--name]
                          [--resource-group]
                          [--subscription]
                          [--workspace-name]

示例

暂停 SQL 池。

az synapse sql pool pause --name sqlpool --workspace-name testsynapseworkspace --resource-group rg

可选参数

--ids

一个或多个资源 ID（空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--name -n

SQL 池名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--workspace-name

工作区名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az synapse sql pool restore

编辑

通过从备份还原创建新的 SQL 池。

az synapse sql pool restore --dest-name
                            [--deleted-time]
                            [--ids]
                            [--name]
                            [--performance-level]
                            [--resource-group]
                            [--storage-type {GRS, LRS}]
                            [--subscription]
                            [--tags]
                            [--time]
                            [--workspace-name]

示例

通过还原现有 SQL 池的还原点创建新的 SQL 池。

az synapse sql pool restore --name sqlpool --workspace-name testsynapseworkspace --resource-group rg \
--dest-name newsqlpool --time 2020-11-25T02:47:37

必需参数

--dest-name --destination-name

将创建为还原目标的 sql 池的名称。

可选参数

--deleted-time

如果指定，请从已删除的数据库而不是从现有数据库还原。必须与同一服务器中删除的数据库的已删除时间匹配。必须指定 --time 或 --deleted-time（或两者）。时间应采用以下格式：“YYYY-MM-DDTHH：MM：SS”。

--ids

一个或多个资源 ID（空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--name -n

SQL 池名称。

--performance-level

性能级别。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--storage-type

存储帐户类型。

接受的值: GRS, LRS

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--time -t

将还原以创建新数据库的源数据库的时间点。必须大于或等于源数据库的最早RestoreDate 值。必须指定 --time 或 --deleted-time（或两者）。时间应采用以下格式：“YYYY-MM-DDTHH：MM：SS”。

--workspace-name

工作区名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az synapse sql pool resume

编辑

恢复 SQL 池。

az synapse sql pool resume [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]
                           [--workspace-name]

示例

恢复 SQL 池。

az synapse sql pool resume --name sqlpool --workspace-name testsynapseworkspace --resource-group rg

可选参数

--ids

一个或多个资源 ID（空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--name -n

SQL 池名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--workspace-name

工作区名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az synapse sql pool show

编辑

获取 SQL 池。

az synapse sql pool show [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]
                         [--workspace-name]

示例

获取 SQL 池。

az synapse sql pool show --name sqlpool --workspace-name testsynapseworkspace --resource-group rg

可选参数

--ids

一个或多个资源 ID（空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--name -n

SQL 池名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--workspace-name

工作区名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az synapse sql pool show-connection-string

编辑

生成 SQL 池的连接字符串。

az synapse sql pool show-connection-string --client {ado.net, jdbc, odbc, php, php_pdo}
                                           [--auth-type {ADIntegrated, ADPassword, SqlPassword}]
                                           [--ids]
                                           [--name]
                                           [--subscription]
                                           [--workspace-name]

示例

为 ado.net 生成连接字符串

az synapse sql pool show-connection-string --name sqlpool --workspace-name testsynapseworkspace -c ado.net

必需参数

--client -c

客户端连接提供程序的类型。

接受的值: ado.net, jdbc, odbc, php, php_pdo

可选参数

--auth-type -a

身份验证的类型。

接受的值: ADIntegrated, ADPassword, SqlPassword

默认值: SqlPassword

--ids

一个或多个资源 ID（空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--name -n

SQL 池名称。

默认值: <sql pool name>

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--workspace-name

工作区名称。

默认值: <workspace name>

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az synapse sql pool update

编辑

更新 SQL 池。

az synapse sql pool update [--ids]
                           [--name]
                           [--performance-level]
                           [--resource-group]
                           [--subscription]
                           [--tags]
                           [--workspace-name]

示例

更新 SQL 池。

az synapse sql pool update --name sqlpool --workspace-name testsynapseworkspace --resource-group rg \
--tags key1=value1

可选参数

--ids

一个或多个资源 ID（空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--name -n

SQL 池名称。

--performance-level

性能级别。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--workspace-name

工作区名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az synapse sql pool wait

编辑

将 CLI 置于等待状态，直到满足 SQL 池的条件。

az synapse sql pool wait --sql-pool-name
                         [--created]
                         [--custom]
                         [--deleted]
                         [--exists]
                         [--ids]
                         [--interval]
                         [--resource-group]
                         [--subscription]
                         [--timeout]
                         [--updated]
                         [--workspace-name]

必需参数

--sql-pool-name

SQL 池名称。

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

一个或多个资源 ID（空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--interval

轮询间隔（以秒为单位）。

默认值: 30

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False

--workspace-name

工作区名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

通过

az synapse sql pool

命令

az synapse sql pool create

示例

必需参数

可选参数

az synapse sql pool delete

示例

可选参数

az synapse sql pool list

示例

必需参数

az synapse sql pool list-deleted

示例

必需参数

az synapse sql pool pause

示例

可选参数

az synapse sql pool restore

示例

必需参数

可选参数

az synapse sql pool resume

示例

可选参数

az synapse sql pool show

示例

可选参数

az synapse sql pool show-connection-string

示例

必需参数

可选参数

az synapse sql pool update

示例

可选参数

az synapse sql pool wait

必需参数

可选参数

其他资源