Az.Synapse

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

Synapse Analytics

Add-AzSynapseTriggerSubscription

Subscribe the event trigger to external service events.

Clear-AzSynapseSqlPoolVulnerabilityAssessmentRuleBaseline

Clears the vulnerability assessment rule baseline.

Disable-AzSynapseSqlAdvancedDataSecurity

Disables Advanced Data Security on a workspace.

Disable-AzSynapseSqlPoolSensitivityRecommendation

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

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.

Export-AzSynapseNotebook

Exports notbooks.

Get-AzSynapseActivityRun

Gets information about activity runs for a pipeline run.

Get-AzSynapseDataFlow

Gets information about data flows in workspace.

Get-AzSynapseDataset

Gets information about datasets in workspace.

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-AzSynapseLinkedService

Gets information about linked services in 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-AzSynapseSparkJob

Gets a Synapse Analytics Spark job.

Get-AzSynapseSparkPool

Gets a Synapse Analytics Spark pool.

Get-AzSynapseSparkSession

Gets a Synapse Analytics Spark session.

Get-AzSynapseSparkStatement

Gets a Synapse Analytics Spark statement.

Get-AzSynapseSqlActiveDirectoryAdministrator

Gets information about an Azure AD 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

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-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-AzSynapseSqlPoolVulnerabilityAssessmentSetting

Gets the vulnerability assessment settings of a SQL pool.

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.

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.

New-AzSynapseFirewallRule

Creates a Synapse Analytics Firewall Rule.

New-AzSynapseIntegrationRuntimeKey

Regenerate self-hosted integration runtime key.

New-AzSynapseRoleAssignment

Creates a Synapse Analytics role assignment.

New-AzSynapseSparkPool

Creates a Synapse Analytics Spark pool.

New-AzSynapseSqlDatabase

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.

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-AzSynapseLinkedService

Removes a linked service from 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-AzSynapseSparkPool

Deletes a Synapse Analytics Spark pool.

Remove-AzSynapseSqlActiveDirectoryAdministrator

Removes an Azure AD administrator for Synapse Analytics Workspace.

Remove-AzSynapseSqlDatabase

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-AzSynapseTrigger

Removes a trigger from a workspace.

Remove-AzSynapseTriggerSubscription

Unsubscribe the event trigger to external service events.

Remove-AzSynapseWorkspace

Deletes a Synapse Analytics workspace.

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-AzSynapseLinkedService

Links a data store or a cloud service to workspace.

Set-AzSynapseNotebook

Creates or updates a notebook in a workspace.

Set-AzSynapsePipeline

Creates a pipeline in workspace.

Set-AzSynapseSqlActiveDirectoryAdministrator

Provisions an Azure AD 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-AzSynapseTrigger

Creates a trigger in a workspace.

Start-AzSynapseSparkSession

Starts a Synapse Analytics Spark session.

Start-AzSynapseTrigger

Starts a trigger in a workspace.

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.

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

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-AzSynapseSparkPool

Updates a Synapse Analytics Spark pool.

Update-AzSynapseSqlAdvancedThreatProtectionSetting

Updates an advanced threat protection settings on a workspace.

Update-AzSynapseSqlDatabase

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.