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

Az.Synapse

参考

本节中的主题介绍了适用于 Azure Synapse Analytics 的 Azure PowerShell cmdlet。

Synapse Analytics

Add-AzSynapseDataFlowDebugSessionPackage	将数据流资源及其依赖项添加到特定的数据流调试会话中。
Add-AzSynapseKustoPoolLanguageExtension	添加可在 KQL 查询中运行的语言扩展列表。
Add-AzSynapseTriggerSubscription	将事件触发器订阅到外部服务事件。
Clear-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline	清除漏洞评估规则基线。
Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan	将漏洞评估扫描结果转换为 Excel 格式。
Disable-AzSynapseActiveDirectoryOnlyAuthentication	为特定的 Synapse 工作区禁用Microsoft仅限条目的身份验证。
Disable-AzSynapseSqlAdvancedDataSecurity	在工作区上禁用高级数据安全。
Disable-AzSynapseSqlPoolSensitivityRecommendation	对 SQL 池中的列禁用（消除）敏感度建议。
Enable-AzSynapseActiveDirectoryOnlyAuthentication	为特定 Synapse 工作区启用Microsoft仅限条目的身份验证。
Enable-AzSynapseSqlAdvancedDataSecurity	在工作区上启用高级数据安全。
Enable-AzSynapseSqlPoolSensitivityRecommendation	对 SQL 池中的所有列启用敏感度建议（默认启用建议）。
Enable-AzSynapseWorkspace	创建 Azure Synapse Analytics 工作区时，可以选择使用客户管理的密钥加密工作区中静态所有数据，该密钥将为工作区提供双重加密。可能需要首先设置加密环境，例如创建启用了清除保护的密钥保管库，并指定密钥保管库的访问策略。然后，使用此 cmdlet 激活使用客户管理的密钥启用双重加密的新 Azure Synapse Analytics 工作区。
Export-AzSynapseKqlScript	导出 KQL 脚本。
Export-AzSynapseNotebook	导出 notbook。
Export-AzSynapseSparkConfiguration	将 Synapse spark 配置导出到输出文件夹。
Export-AzSynapseSqlScript	从 Synapse 工作区导出 sql 脚本。
Get-AzSynapseActiveDirectoryOnlyAuthentication	获取特定 Synapse 工作区的仅条目身份验证Microsoft。
Get-AzSynapseActivityRun	获取有关管道运行的活动运行的信息。
Get-AzSynapseDataFlow	获取有关工作区中的数据流的信息。
Get-AzSynapseDataFlowDebugSession	获取指定 Synapse 工作区中的所有活动数据流调试会话。
Get-AzSynapseDataset	获取有关工作区中的数据集的信息。
Get-AzSynapseDroppedSqlPool	获取 Synapse Sql 池的已删除 Sql 池备份。
Get-AzSynapseFirewallRule	获取 Synapse Analytics 防火墙规则。
Get-AzSynapseIntegrationRuntime	获取有关集成运行时资源的信息。
Get-AzSynapseIntegrationRuntimeKey	获取自承载集成运行时的键。
Get-AzSynapseIntegrationRuntimeMetric	获取集成运行时的指标数据。
Get-AzSynapseIntegrationRuntimeNode	获取集成运行时节点信息。
Get-AzSynapseKqlScript	获取有关工作区中 KQL 脚本的信息。
Get-AzSynapseKustoPool	获取 Kusto 池。
Get-AzSynapseKustoPoolAttachedDatabaseConfiguration	返回附加的数据库配置。
Get-AzSynapseKustoPoolDatabase	返回数据库。
Get-AzSynapseKustoPoolDatabasePrincipalAssignment	获取 Kusto 池数据库 principalAssignment。
Get-AzSynapseKustoPoolDataConnection	返回数据连接。
Get-AzSynapseKustoPoolFollowerDatabase	返回此 Kusto 池拥有的数据库列表，后跟另一个 Kusto 池。
Get-AzSynapseKustoPoolLanguageExtension	返回可在 KQL 查询中运行的语言扩展列表。
Get-AzSynapseKustoPoolPrincipalAssignment	获取 Kusto 池 principalAssignment。
Get-AzSynapseKustoPoolSku	列出 Kusto 池资源的合格 SKU。
Get-AzSynapseLinkConnection	获取有关工作区中的链接连接的信息。
Get-AzSynapseLinkConnectionDetailedStatus	获取有关工作区中链接连接的详细信息状态。
Get-AzSynapseLinkConnectionLinkTable	获取有关链接连接下的链接表的信息。
Get-AzSynapseLinkConnectionLinkTableStatus	获取链接连接下的链接表的状态。
Get-AzSynapseLinkedService	获取有关工作区中链接服务的信息。
Get-AzSynapseManagedIdentitySqlControlSetting	获取托管标识 Sql 控件设置。
Get-AzSynapseManagedPrivateEndpoint	获取有关工作区中管理专用终结点的信息
Get-AzSynapseNotebook	获取有关工作区中的笔记本的信息。
Get-AzSynapsePipeline	获取有关工作区中的管道的信息。
Get-AzSynapsePipelineRun	获取有关管道运行的信息。
Get-AzSynapseRoleAssignment	获取 Synapse Analytics 角色分配。
Get-AzSynapseRoleDefinition	获取 Synapse Analytics 角色定义。
Get-AzSynapseRoleScope	获取 Synapse Analytics 角色范围。
Get-AzSynapseSparkConfiguration	获取有关工作区中的 Spark 配置的信息。
Get-AzSynapseSparkJob	获取 Synapse Analytics Spark 作业。
Get-AzSynapseSparkJobDefinition	获取工作区中的 Spark 作业定义。
Get-AzSynapseSparkPool	获取 Azure Synapse Analytics 中的 Apache Spark 池。
Get-AzSynapseSparkSession	获取 Synapse Analytics Spark 会话。
Get-AzSynapseSparkStatement	获取 Synapse Analytics Spark 语句。
Get-AzSynapseSqlActiveDirectoryAdministrator	获取有关 Synapse Analytics 工作区Microsoft Entra 管理员的信息。
Get-AzSynapseSqlAdvancedDataSecurityPolicy	获取工作区的高级数据安全策略。
Get-AzSynapseSqlAdvancedThreatProtectionSetting	获取工作区的高级威胁防护设置。
Get-AzSynapseSqlAuditSetting	获取 Azure Synapse Analytics 工作区的审核设置。
Get-AzSynapseSqlDatabase	此功能处于有限的预览状态，最初只能访问某些订阅。获取 Synapse Analytics SQL 数据库。
Get-AzSynapseSqlPool	获取 Synapse Analytics SQL 池。
Get-AzSynapseSqlPoolAdvancedThreatProtectionSetting	获取 SQL 池的高级威胁防护设置。
Get-AzSynapseSqlPoolAuditSetting	获取 Azure Synapse Analytics SQL 池的审核设置。
Get-AzSynapseSqlPoolGeoBackup	获取 Sql 池的异地冗余备份。
Get-AzSynapseSqlPoolRestorePoint	检索可从中还原 Synapse Analytics SQL 池的不同还原点。
Get-AzSynapseSqlPoolSensitivityClassification	获取 SQL 池中列的当前信息类型和敏感度标签。
Get-AzSynapseSqlPoolSensitivityRecommendation	获取 SQL 池中列的建议信息类型和敏感度标签。
Get-AzSynapseSqlPoolTransparentDataEncryption	获取 SQL 池的 TDE 状态。
Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline	获取漏洞评估规则基线。
Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord	获取与给定 sql 池关联的所有漏洞评估扫描记录。
Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting	获取 SQL 池的漏洞评估设置。
Get-AzSynapseSqlScript	获取有关 Synapse 工作区中的 sql 脚本的信息。
Get-AzSynapseSqlVulnerabilityAssessmentSetting	获取工作区的漏洞评估设置。
Get-AzSynapseTrigger	获取有关工作区中的触发器的信息。
Get-AzSynapseTriggerRun	返回有关触发器运行的信息。
Get-AzSynapseTriggerSubscriptionStatus	获取事件触发器到指定外部服务事件的订阅的状态。
Get-AzSynapseWorkspace	获取 Synapse Analytics 工作区。
Get-AzSynapseWorkspaceKey	获取工作区密钥。
Get-AzSynapseWorkspacePackage	获取工作区包。
Invoke-AzSynapseDataFlowDebugSessionCommand	在数据流调试会话中调用调试作。
Invoke-AzSynapseDetachKustoPoolFollowerDatabase	分离此 Kusto 池拥有的数据库的所有关注者。
Invoke-AzSynapseIntegrationRuntimeUpgrade	升级自承载集成运行时。
Invoke-AzSynapsePipeline	调用管道以为其启动运行。
Invoke-AzSynapseSparkStatement	调用 Synapse Analytics Spark 语句。
Invoke-AzSynapseTriggerRun	调用触发器运行的另一个实例。
New-AzSynapseFirewallRule	创建 Synapse Analytics 防火墙规则。
New-AzSynapseGitRepositoryConfig	创建 Git 存储库配置。
New-AzSynapseIntegrationRuntimeKey	重新生成自承载集成运行时密钥。
New-AzSynapseKqlScript	在工作区中创建或更新 KQL 脚本。
New-AzSynapseKustoPool	创建或更新 Kusto 池。
New-AzSynapseKustoPoolAttachedDatabaseConfiguration	创建或更新附加的数据库配置。
New-AzSynapseKustoPoolDatabase	创建或更新数据库。
New-AzSynapseKustoPoolDatabasePrincipalAssignment	创建 Kusto 池数据库 principalAssignment。
New-AzSynapseKustoPoolDataConnection	创建或更新数据连接。
New-AzSynapseKustoPoolPrincipalAssignment	创建 Kusto 池 principalAssignment。
New-AzSynapseLinkedServiceEncryptedCredential	使用指定的集成运行时加密链接服务中的凭据。
New-AzSynapseManagedPrivateEndpoint	在工作区中创建或更新托管专用终结点。
New-AzSynapseManagedVirtualNetworkConfig	创建托管虚拟网络配置。
New-AzSynapseRoleAssignment	创建 Synapse Analytics 角色分配。
New-AzSynapseSparkConfiguration	在工作区中创建或更新 Spark 配置。
New-AzSynapseSparkPool	创建 Synapse Analytics Spark 池。
New-AzSynapseSqlDatabase	此功能处于有限的预览状态，最初只能访问某些订阅。创建 Synapse Analytics SQL 数据库。
New-AzSynapseSqlPool	创建 Synapse Analytics SQL 池。
New-AzSynapseSqlPoolRestorePoint	在 Azure Synapse Analytics SQL 池中创建新的还原点。
New-AzSynapseWorkspace	创建 Synapse Analytics 工作区。
New-AzSynapseWorkspaceKey	创建工作区密钥。
New-AzSynapseWorkspacePackage	将本地工作区包文件上传到 Azure Synapse 工作区。
Remove-AzSynapseDataFlow	从工作区中删除数据流。
Remove-AzSynapseDataset	从工作区中删除数据集。
Remove-AzSynapseFirewallRule	删除 Synapse Analytics 防火墙规则。
Remove-AzSynapseIntegrationRuntime	删除集成运行时。
Remove-AzSynapseIntegrationRuntimeNode	删除集成运行时上具有给定名称的节点。
Remove-AzSynapseKqlScript	从工作区中删除 KQL 脚本。
Remove-AzSynapseKustoPool	删除 Kusto 池。
Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration	删除具有给定名称的附加数据库配置。
Remove-AzSynapseKustoPoolDatabase	删除具有给定名称的数据库。
Remove-AzSynapseKustoPoolDatabasePrincipalAssignment	删除 Kusto 池 principalAssignment。
Remove-AzSynapseKustoPoolDataConnection	删除具有给定名称的数据连接。
Remove-AzSynapseKustoPoolLanguageExtension	删除可在 KQL 查询中运行的语言扩展列表。
Remove-AzSynapseKustoPoolPrincipalAssignment	删除 Kusto 池 principalAssignment。
Remove-AzSynapseLinkConnection	从工作区中删除链接连接。
Remove-AzSynapseLinkedService	从工作区中删除链接服务。
Remove-AzSynapseManagedPrivateEndpoint	从工作区中删除托管专用终结点。
Remove-AzSynapseNotebook	从工作区中删除笔记本。
Remove-AzSynapsePipeline	从工作区中删除管道。
Remove-AzSynapseRoleAssignment	删除 Synapse Analytics 角色分配。
Remove-AzSynapseSparkConfiguration	从工作区中删除 Spark 配置。
Remove-AzSynapseSparkJobDefinition	从工作区中删除 Spark 作业定义。
Remove-AzSynapseSparkPool	删除 Azure Synapse Analytics 中的 Apache Spark 池。
Remove-AzSynapseSqlActiveDirectoryAdministrator	删除 Synapse Analytics 工作区的 Microsoft Entra 管理员。
Remove-AzSynapseSqlDatabase	此功能处于有限的预览状态，最初只能访问某些订阅。删除 Synapse Analytics SQL 数据库。
Remove-AzSynapseSqlPool	删除 Synapse Analytics SQL 池。
Remove-AzSynapseSqlPoolRestorePoint	删除 Synapse Analytics SQL 池还原点。
Remove-AzSynapseSqlPoolSensitivityClassification	删除 SQL 池中列的信息类型和敏感度标签。
Remove-AzSynapseSqlScript	从 Synapse 工作区中删除 sql 脚本。
Remove-AzSynapseTrigger	从工作区中删除触发器。
Remove-AzSynapseTriggerSubscription	将事件触发器取消订阅到外部服务事件。
Remove-AzSynapseWorkspace	删除 Synapse Analytics 工作区。
Remove-AzSynapseWorkspaceKey	删除工作区密钥。
Remove-AzSynapseWorkspacePackage	删除工作区包。
Reset-AzSynapseSparkSessionTimeout	重置 Synapse Analytics Spark 会话的超时。
Reset-AzSynapseSqlAdvancedThreatProtectionSetting	从工作区中删除高级威胁防护设置。
Reset-AzSynapseSqlAuditSetting	删除 Azure Synapse Analytics 工作区的审核设置。
Reset-AzSynapseSqlPoolAdvancedThreatProtectionSetting	从 SQL 池中删除高级威胁防护设置。
Reset-AzSynapseSqlPoolAuditSetting	删除 Azure Synapse Analytics SQL 池的审核设置。
Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting	清除 SQL 池的漏洞评估设置。
Reset-AzSynapseSqlVulnerabilityAssessmentSetting	清除工作区的漏洞评估设置。
Restore-AzSynapseSqlPool	还原 Synapse Analytics SQL 池。
Resume-AzSynapseSqlPool	恢复 Synapse Analytics SQL 池。
Set-AzSynapseDataFlow	在工作区中创建或更新数据流。
Set-AzSynapseDataset	在工作区中创建或更新数据集。
Set-AzSynapseIntegrationRuntime	更新集成运行时。
Set-AzSynapseLinkConnection	在工作区中创建或更新链接连接。
Set-AzSynapseLinkConnectionLinkTable	编辑链接连接下的链接表。
Set-AzSynapseLinkedService	将数据存储或云服务链接到工作区。
Set-AzSynapseManagedIdentitySqlControlSetting	将托管标识 SQL 控件设置更新到工作区。
Set-AzSynapseNotebook	在工作区中创建或更新笔记本。
Set-AzSynapsePipeline	在工作区中创建管道。
Set-AzSynapseSparkJobDefinition	在工作区中创建 Spark 作业定义。
Set-AzSynapseSqlActiveDirectoryAdministrator	为 Synapse Analytics SQL 池预配Microsoft Entra 管理员。
Set-AzSynapseSqlAuditSetting	更改 Azure Synapse Analytics 工作区的审核设置。
Set-AzSynapseSqlPoolAuditSetting	更改 Azure Synapse Analytics SQL 池的审核设置。
Set-AzSynapseSqlPoolSensitivityClassification	设置 SQL 池中列的信息类型和敏感度标签。
Set-AzSynapseSqlPoolTransparentDataEncryption	修改 SQL 池的 TDE 属性。
Set-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline	设置漏洞评估规则基线。
Set-AzSynapseSqlScript	在工作区中创建或更新 SQL 脚本。
Set-AzSynapseTrigger	在工作区中创建触发器。
Start-AzSynapseDataFlowDebugSession	在 Synapse 工作区中启动 Synapse Analytics 数据流调试会话。
Start-AzSynapseIntegrationRuntime	启动托管专用集成运行时。
Start-AzSynapseKustoPool	启动 Kusto 池。
Start-AzSynapseLinkConnection	启动链接连接。
Start-AzSynapseSparkSession	启动 Synapse Analytics Spark 会话。
Start-AzSynapseSqlPoolVulnerabilityAssessmentScan	启动漏洞评估扫描。
Start-AzSynapseTrigger	在工作区中启动触发器。
Stop-AzSynapseDataFlowDebugSession	停止工作区中的数据流调试会话。
Stop-AzSynapseIntegrationRuntime	停止托管专用集成运行时。
Stop-AzSynapseKustoPool	停止 Kusto 池。
Stop-AzSynapseLinkConnection	停止链接连接。
Stop-AzSynapsePipelineRun	停止工作区中的管道运行。
Stop-AzSynapseSparkJob	取消 Synapse Analytics Spark 作业。
Stop-AzSynapseSparkSession	停止 Synapse Analytics Spark 会话。
Stop-AzSynapseSparkStatement	取消 Synapse Analytics Spark 语句。
Stop-AzSynapseTrigger	停止工作区中的触发器。
Stop-AzSynapseTriggerRun	停止 synapse 工作区中的触发器运行。
Submit-AzSynapseSparkJob	提交 Synapse Analytics Spark 作业。
Suspend-AzSynapseSqlPool	暂停 Synapse Analytics SQL 池。
Sync-AzSynapseIntegrationRuntimeCredential	在集成运行时节点之间同步凭据。
Test-AzSynapseSparkPool	检查 Synapse Analytics Spark 池是否存在。
Test-AzSynapseSqlDatabase	此功能处于有限的预览状态，最初只能访问某些订阅。检查 Synapse Analytics SQL 数据库是否存在。
Test-AzSynapseSqlPool	检查 Synapse Analytics SQL 池是否存在。
Test-AzSynapseWorkspace	检查 Synapse Analytics 工作区是否存在。
Update-AzSynapseFirewallRule	更新 Synapse Analytics 防火墙规则。
Update-AzSynapseIntegrationRuntime	更新集成运行时。
Update-AzSynapseIntegrationRuntimeNode	更新自承载集成运行时节点。
Update-AzSynapseKustoPool	更新 Kusto Kusto 池。
Update-AzSynapseKustoPoolDatabase	更新数据库。
Update-AzSynapseKustoPoolDataConnection	更新数据连接。
Update-AzSynapseLinkConnectionLandingZoneCredential	更新链接连接的登陆区域凭据。
Update-AzSynapseManagedVirtualNetworkConfig	将托管虚拟网络配置更新到工作区。
Update-AzSynapseSparkPool	更新 Azure Synapse Analytics 中的 Apache Spark 池。
Update-AzSynapseSqlAdvancedThreatProtectionSetting	更新工作区上的高级威胁防护设置。
Update-AzSynapseSqlDatabase	此功能处于有限的预览状态，最初只能访问某些订阅。更新 Synapse Analytics SQL 数据库。
Update-AzSynapseSqlPool	更新 Synapse Analytics SQL 池。
Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting	在 SQL 池上设置高级威胁防护设置。
Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting	更新 SQL 池的漏洞评估设置。
Update-AzSynapseSqlVulnerabilityAssessmentSetting	更新工作区的漏洞评估设置。
Update-AzSynapseWorkspace	更新 Synapse Analytics 工作区。
Wait-AzSynapseSparkJob	等待 Synapse Analytics Spark 作业完成。

通过

Az.Synapse

Synapse Analytics