Az.Synapse

The topics in this section document the Azure PowerShell cmdlets for Azure Synapse Analytics.

Synapse Analytics

Add-AzSynapseDataFlowDebugSessionPackage

Add data flow resource and its dependencies into specific data flow debug session.

Add-AzSynapseKustoPoolLanguageExtension

Add a list of language extensions that can run within KQL queries.

Add-AzSynapseTriggerSubscription

Subscribe the event trigger to external service events.

Clear-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline

Clears the vulnerability assessment rule baseline.

Convert-AzSynapseSqlPoolVulnerabilityAssessmentScan

Converts a vulnerability assessment scan results to Excel format.

Disable-AzSynapseActiveDirectoryOnlyAuthentication

Disables Microsoft Entra-only authentication for a specific Synapse workspace.

Disable-AzSynapseSqlAdvancedDataSecurity

Disables Advanced Data Security on a workspace.

Disable-AzSynapseSqlPoolSensitivityRecommendation

Disables (dismisses) sensitivity recommendations on columns in the SQL pool.

Enable-AzSynapseActiveDirectoryOnlyAuthentication

Enables Microsoft Entra-only authentication for a specific Synapse workspace.

Enable-AzSynapseSqlAdvancedDataSecurity

Enables Advanced Data Security on a workspace.

Enable-AzSynapseSqlPoolSensitivityRecommendation

Enables sensitivity recommendations on columns (recommendations are enabled by default on all columns) in the SQL pool.

Enable-AzSynapseWorkspace

When creating an Azure Synapse Analytics workspace, you can choose to encrypt all data at rest in the workspace `with a customer-managed key which will provide double encryption to the workspace.You may need to set up the encryption environment firstly, such as to create a key vault with purge protection enable and specify Access Polices to the key vault. Then use this cmdlet to activate the new Azure Synapse Analytics workspace which double encryption is enabled using a customer-managed key.

Export-AzSynapseKqlScript

Exports KQL script.

Export-AzSynapseNotebook

Exports notbooks.

Export-AzSynapseSparkConfiguration

Exports a Synapse spark configuration to an output folder.

Export-AzSynapseSqlScript

Exports a sql script from a Synapse workspace.

Get-AzSynapseActiveDirectoryOnlyAuthentication

Gets Microsoft Entra-only authentication for a specific Synapse workspace.

Get-AzSynapseActivityRun

Gets information about activity runs for a pipeline run.

Get-AzSynapseDataFlow

Gets information about data flows in workspace.

Get-AzSynapseDataFlowDebugSession

Get all active data flow debug sessions in specified Synapse workspace.

Get-AzSynapseDataset

Gets information about datasets in workspace.

Get-AzSynapseDroppedSqlPool

Gets a dropped Sql pool backup of a Synapse Sql Pool.

Get-AzSynapseFirewallRule

Gets a Synapse Analytics Firewall Rule.

Get-AzSynapseIntegrationRuntime

Gets information about integration runtime resources.

Get-AzSynapseIntegrationRuntimeKey

Gets keys for a self-hosted integration runtime.

Get-AzSynapseIntegrationRuntimeMetric

Gets metric data for an integration runtime.

Get-AzSynapseIntegrationRuntimeNode

Gets an integration runtime node information.

Get-AzSynapseKqlScript

Gets information about KQL scripts in a workspace.

Get-AzSynapseKustoPool

Gets a Kusto pool.

Get-AzSynapseKustoPoolAttachedDatabaseConfiguration

Returns an attached database configuration.

Get-AzSynapseKustoPoolDatabase

Returns a database.

Get-AzSynapseKustoPoolDatabasePrincipalAssignment

Gets a Kusto pool database principalAssignment.

Get-AzSynapseKustoPoolDataConnection

Returns a data connection.

Get-AzSynapseKustoPoolFollowerDatabase

Returns a list of databases that are owned by this Kusto Pool and were followed by another Kusto Pool.

Get-AzSynapseKustoPoolLanguageExtension

Returns a list of language extensions that can run within KQL queries.

Get-AzSynapseKustoPoolPrincipalAssignment

Gets a Kusto pool principalAssignment.

Get-AzSynapseKustoPoolSku

Lists eligible SKUs for Kusto Pool resource.

Get-AzSynapseLinkConnection

Gets information about link connections in workspace.

Get-AzSynapseLinkConnectionDetailedStatus

Gets detail status about a link connection in workspace.

Get-AzSynapseLinkConnectionLinkTable

Gets information about link tables under a link connection.

Get-AzSynapseLinkConnectionLinkTableStatus

Gets status of link tables under a link connection.

Get-AzSynapseLinkedService

Gets information about linked services in workspace.

Get-AzSynapseManagedIdentitySqlControlSetting

Gets Managed Identity Sql Control Settings.

Get-AzSynapseManagedPrivateEndpoint

Gets information about mananged private endpoints in a workspace

Get-AzSynapseNotebook

Gets information about notebooks in a workspace.

Get-AzSynapsePipeline

Gets information about pipelines in workspace.

Get-AzSynapsePipelineRun

Gets information about pipeline runs.

Get-AzSynapseRoleAssignment

Gets a Synapse Analytics role assignment.

Get-AzSynapseRoleDefinition

Gets a Synapse Analytics role definition.

Get-AzSynapseRoleScope

Gets a Synapse Analytics role scope.

Get-AzSynapseSparkConfiguration

Gets information about spark configurations in a workspace.

Get-AzSynapseSparkJob

Gets a Synapse Analytics Spark job.

Get-AzSynapseSparkJobDefinition

Gets a Spark job definition in workspace.

Get-AzSynapseSparkPool

Gets a Apache Spark pool in Azure Synapse Analytics.

Get-AzSynapseSparkSession

Gets a Synapse Analytics Spark session.

Get-AzSynapseSparkStatement

Gets a Synapse Analytics Spark statement.

Get-AzSynapseSqlActiveDirectoryAdministrator

Gets information about a Microsoft Entra administrator for Synapse Analytics Workspace.

Get-AzSynapseSqlAdvancedDataSecurityPolicy

Gets Advanced Data Security policy of a workspace.

Get-AzSynapseSqlAdvancedThreatProtectionSetting

Gets the advanced threat protection settings for a workspace.

Get-AzSynapseSqlAuditSetting

Gets the auditing settings of an Azure Synapse Analytics Workspace.

Get-AzSynapseSqlDatabase

This feature is in a limited preview, initially accessible only to certain subscriptions. Gets a Synapse Analytics SQL database.

Get-AzSynapseSqlPool

Gets a Synapse Analytics SQL pool.

Get-AzSynapseSqlPoolAdvancedThreatProtectionSetting

Gets the advanced threat protection settings for a SQL pool.

Get-AzSynapseSqlPoolAuditSetting

Gets the auditing settings of an Azure Synapse Analytics SQL pool.

Get-AzSynapseSqlPoolGeoBackup

Gets a geo-redundant backup of a Sql Pool.

Get-AzSynapseSqlPoolRestorePoint

Retrieves the distinct restore points from which a Synapse Analytics SQL pool can be restored.

Get-AzSynapseSqlPoolSensitivityClassification

Gets the current information types and sensitivity labels of columns in the SQL pool.

Get-AzSynapseSqlPoolSensitivityRecommendation

Gets the recommended information types and sensitivity labels of columns in the SQL pool.

Get-AzSynapseSqlPoolTransparentDataEncryption

Gets the TDE state for a SQL pool.

Get-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline

Gets the vulnerability assessment rule baseline.

Get-AzSynapseSqlPoolVulnerabilityAssessmentScanRecord

Gets all vulnerability assessment scan record(s) associated with a given sql pool.

Get-AzSynapseSqlPoolVulnerabilityAssessmentSetting

Gets the vulnerability assessment settings of a SQL pool.

Get-AzSynapseSqlScript

Gets information about sql scripts in a Synapse workspace.

Get-AzSynapseSqlVulnerabilityAssessmentSetting

Gets the vulnerability assessment settings of a workspace.

Get-AzSynapseTrigger

Gets information about triggers in a workspace.

Get-AzSynapseTriggerRun

Returns information about trigger runs.

Get-AzSynapseTriggerSubscriptionStatus

Get the status of the subscription for the event trigger to the specified external service events.

Get-AzSynapseWorkspace

Gets a Synapse Analytics workspace.

Get-AzSynapseWorkspaceKey

Gets a workspace key.

Get-AzSynapseWorkspacePackage

Gets a workspace package.

Invoke-AzSynapseDataFlowDebugSessionCommand

Invoke debug action in data flow debug session.

Invoke-AzSynapseDetachKustoPoolFollowerDatabase

Detaches all followers of a database owned by this Kusto Pool.

Invoke-AzSynapseIntegrationRuntimeUpgrade

Upgrades self-hosted integration runtime.

Invoke-AzSynapsePipeline

Invokes a pipeline to start a run for it.

Invoke-AzSynapseSparkStatement

Invokes a Synapse Analytics Spark statement.

Invoke-AzSynapseTriggerRun

Invokes another instance of a trigger run.

New-AzSynapseFirewallRule

Creates a Synapse Analytics Firewall Rule.

New-AzSynapseGitRepositoryConfig

Creates Git repository configuration.

New-AzSynapseIntegrationRuntimeKey

Regenerate self-hosted integration runtime key.

New-AzSynapseKqlScript

Creates or updates a KQL script in a workspace.

New-AzSynapseKustoPool

Create or update a Kusto pool.

New-AzSynapseKustoPoolAttachedDatabaseConfiguration

Creates or updates an attached database configuration.

New-AzSynapseKustoPoolDatabase

Creates or updates a database.

New-AzSynapseKustoPoolDatabasePrincipalAssignment

Creates a Kusto pool database principalAssignment.

New-AzSynapseKustoPoolDataConnection

Creates or updates a data connection.

New-AzSynapseKustoPoolPrincipalAssignment

Create a Kusto pool principalAssignment.

New-AzSynapseLinkedServiceEncryptedCredential

Encrypt credential in linked service with specified integration runtime.

New-AzSynapseManagedPrivateEndpoint

Creates or updates a managed private endpoint in a workspace.

New-AzSynapseManagedVirtualNetworkConfig

Creates managed virtual network configuration.

New-AzSynapseRoleAssignment

Creates a Synapse Analytics role assignment.

New-AzSynapseSparkConfiguration

Creates or updates a spark configuration in a workspace.

New-AzSynapseSparkPool

Creates a Synapse Analytics Spark pool.

New-AzSynapseSqlDatabase

This feature is in a limited preview, initially accessible only to certain subscriptions. Creates a Synapse Analytics SQL database.

New-AzSynapseSqlPool

Creates a Synapse Analytics SQL pool.

New-AzSynapseSqlPoolRestorePoint

Creates a new restore point in an Azure Synapse Analytics SQL pool.

New-AzSynapseWorkspace

Creates a Synapse Analytics workspace.

New-AzSynapseWorkspaceKey

Creates a workspace key.

New-AzSynapseWorkspacePackage

Uploads a local workspace package file to an Azure Synapse workspace.

Remove-AzSynapseDataFlow

Removes a data flow from workspace.

Remove-AzSynapseDataset

Removes a dataset from workspace.

Remove-AzSynapseFirewallRule

Deletes a Synapse Analytics Firewall Rule.

Remove-AzSynapseIntegrationRuntime

Removes an integration runtime.

Remove-AzSynapseIntegrationRuntimeNode

Remove a node with the given name on an integration runtime.

Remove-AzSynapseKqlScript

Removes a KQL script from a workspace.

Remove-AzSynapseKustoPool

Deletes a Kusto pool.

Remove-AzSynapseKustoPoolAttachedDatabaseConfiguration

Deletes the attached database configuration with the given name.

Remove-AzSynapseKustoPoolDatabase

Deletes the database with the given name.

Remove-AzSynapseKustoPoolDatabasePrincipalAssignment

Deletes a Kusto pool principalAssignment.

Remove-AzSynapseKustoPoolDataConnection

Deletes the data connection with the given name.

Remove-AzSynapseKustoPoolLanguageExtension

Remove a list of language extensions that can run within KQL queries.

Remove-AzSynapseKustoPoolPrincipalAssignment

Deletes a Kusto pool principalAssignment.

Remove-AzSynapseLinkConnection

Deletes a link connection from workspace.

Remove-AzSynapseLinkedService

Removes a linked service from workspace.

Remove-AzSynapseManagedPrivateEndpoint

Removes a managed private endpoint from a workspace.

Remove-AzSynapseNotebook

Removes a notebook from a workspace.

Remove-AzSynapsePipeline

Removes a pipeline from workspace.

Remove-AzSynapseRoleAssignment

Deletes a Synapse Analytics role assignment.

Remove-AzSynapseSparkConfiguration

Removes a spark configuration from a workspace.

Remove-AzSynapseSparkJobDefinition

Removes a Spark job definition from workspace.

Remove-AzSynapseSparkPool

Deletes a Apache Spark pool in Azure Synapse Analytics.

Remove-AzSynapseSqlActiveDirectoryAdministrator

Removes a Microsoft Entra administrator for Synapse Analytics Workspace.

Remove-AzSynapseSqlDatabase

This feature is in a limited preview, initially accessible only to certain subscriptions. Deletes a Synapse Analytics SQL database.

Remove-AzSynapseSqlPool

Deletes a Synapse Analytics SQL pool.

Remove-AzSynapseSqlPoolRestorePoint

Deletes a Synapse Analytics SQL pool restore point.

Remove-AzSynapseSqlPoolSensitivityClassification

Removes the information types and sensitivity labels of columns in the SQL pool.

Remove-AzSynapseSqlScript

Removes a sql script from a Synapse workspace.

Remove-AzSynapseTrigger

Removes a trigger from a workspace.

Remove-AzSynapseTriggerSubscription

Unsubscribe the event trigger to external service events.

Remove-AzSynapseWorkspace

Deletes a Synapse Analytics workspace.

Remove-AzSynapseWorkspaceKey

Deletes a workspace key.

Remove-AzSynapseWorkspacePackage

Deletes a workspace package.

Reset-AzSynapseSparkSessionTimeout

Resets timeout of a Synapse Analytics Spark session.

Reset-AzSynapseSqlAdvancedThreatProtectionSetting

Removes the advanced threat protection settings from a workspace.

Reset-AzSynapseSqlAuditSetting

Removes the auditing settings of an Azure Synapse Analytics Workspace.

Reset-AzSynapseSqlPoolAdvancedThreatProtectionSetting

Removes the advanced threat protection settings from a SQL pool.

Reset-AzSynapseSqlPoolAuditSetting

Removes the auditing settings of an Azure Synapse Analytics SQL pool.

Reset-AzSynapseSqlPoolVulnerabilityAssessmentSetting

Clears the vulnerability assessment settings of a SQL pool.

Reset-AzSynapseSqlVulnerabilityAssessmentSetting

Clears the vulnerability assessment settings of a workspace.

Restore-AzSynapseSqlPool

Restores a Synapse Analytics SQL pool.

Resume-AzSynapseSqlPool

Resumes a Synapse Analytics SQL pool.

Set-AzSynapseDataFlow

Creates or updates a data flow in workspace.

Set-AzSynapseDataset

Creates or updates a dataset in workspace.

Set-AzSynapseIntegrationRuntime

Updates an integration runtime.

Set-AzSynapseLinkConnection

Creates or updates a link connection in workspace.

Set-AzSynapseLinkConnectionLinkTable

Edits link tables under a link connection.

Set-AzSynapseLinkedService

Links a data store or a cloud service to workspace.

Set-AzSynapseManagedIdentitySqlControlSetting

Updates managed identity SQL control settings to workspace.

Set-AzSynapseNotebook

Creates or updates a notebook in a workspace.

Set-AzSynapsePipeline

Creates a pipeline in workspace.

Set-AzSynapseSparkJobDefinition

Creates a Spark job definition in workspace.

Set-AzSynapseSqlActiveDirectoryAdministrator

Provisions a Microsoft Entra administrator for Synapse Analytics SQL pool.

Set-AzSynapseSqlAuditSetting

Changes the auditing settings of an Azure Synapse Analytics Workspace.

Set-AzSynapseSqlPoolAuditSetting

Changes the auditing settings for an Azure Synapse Analytics SQL pool.

Set-AzSynapseSqlPoolSensitivityClassification

Sets the information types and sensitivity labels of columns in the SQL pool.

Set-AzSynapseSqlPoolTransparentDataEncryption

Modifies TDE property for a SQL pool.

Set-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline

Sets the vulnerability assessment rule baseline.

Set-AzSynapseSqlScript

Creates or updates a SQL script in a workspace.

Set-AzSynapseTrigger

Creates a trigger in a workspace.

Start-AzSynapseDataFlowDebugSession

Starts a Synapse Analytics data flow debug session in Synapse Workspace.

Start-AzSynapseIntegrationRuntime

Starts a managed dedicated integration runtime.

Start-AzSynapseKustoPool

Starts a Kusto pool.

Start-AzSynapseLinkConnection

Starts a link connection.

Start-AzSynapseSparkSession

Starts a Synapse Analytics Spark session.

Start-AzSynapseSqlPoolVulnerabilityAssessmentScan

Starts a vulnerability assessment scan.

Start-AzSynapseTrigger

Starts a trigger in a workspace.

Stop-AzSynapseDataFlowDebugSession

Stops a data flow debug session in a workspace.

Stop-AzSynapseIntegrationRuntime

Stops a managed dedicated integration runtime.

Stop-AzSynapseKustoPool

Stops a Kusto pool.

Stop-AzSynapseLinkConnection

Stops a link connection.

Stop-AzSynapsePipelineRun

Stops a pipeline run in a workspace.

Stop-AzSynapseSparkJob

Cancels a Synapse Analytics Spark job.

Stop-AzSynapseSparkSession

Stops a Synapse Analytics Spark session.

Stop-AzSynapseSparkStatement

Cancels a Synapse Analytics Spark statement.

Stop-AzSynapseTrigger

Stops a trigger in a workspace.

Stop-AzSynapseTriggerRun

Stops a trigger run in a synapse workspace.

Submit-AzSynapseSparkJob

Submits a Synapse Analytics Spark job.

Suspend-AzSynapseSqlPool

Suspends a Synapse Analytics SQL pool.

Sync-AzSynapseIntegrationRuntimeCredential

Synchronizes credentials among integration runtime nodes.

Test-AzSynapseSparkPool

Checks for the existence of a Synapse Analytics Spark pool.

Test-AzSynapseSqlDatabase

This feature is in a limited preview, initially accessible only to certain subscriptions. Checks for the existence of a Synapse Analytics SQL database.

Test-AzSynapseSqlPool

Checks for the existence of a Synapse Analytics SQL pool.

Test-AzSynapseWorkspace

Checks for the existence of a Synapse Analytics workspace.

Update-AzSynapseFirewallRule

Updates a Synapse Analytics Firewall Rule.

Update-AzSynapseIntegrationRuntime

Updates an integration runtime.

Update-AzSynapseIntegrationRuntimeNode

Updates self-hosted integration runtime node.

Update-AzSynapseKustoPool

Update a Kusto Kusto Pool.

Update-AzSynapseKustoPoolDatabase

Updates a database.

Update-AzSynapseKustoPoolDataConnection

Updates a data connection.

Update-AzSynapseLinkConnectionLandingZoneCredential

Updates the landing zone credential of a link connection.

Update-AzSynapseManagedVirtualNetworkConfig

Updates managed virtual network configuration to workspace.

Update-AzSynapseSparkPool

Updates a Apache Spark pool in Azure Synapse Analytics.

Update-AzSynapseSqlAdvancedThreatProtectionSetting

Updates an advanced threat protection settings on a workspace.

Update-AzSynapseSqlDatabase

This feature is in a limited preview, initially accessible only to certain subscriptions. Updates a Synapse Analytics SQL database.

Update-AzSynapseSqlPool

Updates a Synapse Analytics SQL pool.

Update-AzSynapseSqlPoolAdvancedThreatProtectionSetting

Sets a advanced threat protection settings on a SQL pool.

Update-AzSynapseSqlPoolVulnerabilityAssessmentSetting

Updates the vulnerability assessment settings of a SQL pool.

Update-AzSynapseSqlVulnerabilityAssessmentSetting

Updates the vulnerability assessment settings of a workspace.

Update-AzSynapseWorkspace

Updates a Synapse Analytics workspace.

Wait-AzSynapseSparkJob

Waits for a Synapse Analytics Spark job to complete.