Share via


az synapse

Manage and operate Synapse Workspace, Spark Pool, SQL Pool.

Commands

Name Description Type Status
az synapse activity-run

Synapse activity-run.

Core GA
az synapse activity-run query-by-pipeline-run

Query activity runs based on input filter conditions.

Core GA
az synapse ad-only-auth

Manage Azure Active Directly only Authentication settings for this Synapse workspace.

Core GA
az synapse ad-only-auth disable

Disable Azure Active Directly only Authentication for this Synapse workspace.

Core GA
az synapse ad-only-auth enable

Enable Azure Active Directly only Authentication for this Synapse workspace.

Core GA
az synapse ad-only-auth get

Get a specific Azure Active Directly only Authentication property.

Core GA
az synapse data-flow

Manage Synapse's data flows.

Core GA
az synapse data-flow create

Create a data flow.

Core GA
az synapse data-flow delete

Delete a data flow.

Core GA
az synapse data-flow list

List data flows.

Core GA
az synapse data-flow set

Set an exist data flow.

Core GA
az synapse data-flow show

Get a data flow.

Core GA
az synapse dataset

Manage Synapse's datasets.

Core GA
az synapse dataset create

Create a dataset.

Core GA
az synapse dataset delete

Delete a dataset.

Core GA
az synapse dataset list

List datasets.

Core GA
az synapse dataset set

Update an exist dataset.

Core Deprecated
az synapse dataset show

Get a dataset.

Core GA
az synapse dataset update

Update an exist dataset.

Core GA
az synapse integration-runtime

Manage Synapse's integration runtimes.

Core GA
az synapse integration-runtime-node

Manage Synapse's self-hosted integration runtime nodes.

Core GA
az synapse integration-runtime-node delete

Remove a self-hosted integration runtime node.

Core GA
az synapse integration-runtime-node get-ip-address

Get self-hosted integration runtime node ip.

Core GA
az synapse integration-runtime-node show

Get self-hosted integration runtime node information.

Core GA
az synapse integration-runtime-node update

Update self-hosted integration runtime node.

Core GA
az synapse integration-runtime create

Create an integration runtime.

Core Deprecated
az synapse integration-runtime delete

Delete an integration runtime.

Core GA
az synapse integration-runtime get-connection-info

Get the integration runtime connection infomation.

Core GA
az synapse integration-runtime get-monitoring-data

Get metric data for a self-hosted integration runtime.

Core GA
az synapse integration-runtime get-status

Gets detailed status information for an integration runtime.

Core GA
az synapse integration-runtime list

List integration runtimes.

Core GA
az synapse integration-runtime list-auth-key

Get keys for a self-hosted integration runtime.

Core GA
az synapse integration-runtime managed

Manage integration runtime with synapse sub group managed.

Core GA
az synapse integration-runtime managed create

Create an managed integration runtime.

Core GA
az synapse integration-runtime regenerate-auth-key

Regenerate self-hosted integration runtime key.

Core GA
az synapse integration-runtime self-hosted

Manage integration runtime with synapse sub group self-hosted.

Core GA
az synapse integration-runtime self-hosted create

Create an self-hosted integration runtime.

Core GA
az synapse integration-runtime show

Get an integration runtime.

Core GA
az synapse integration-runtime start

Start an SSIS integration runtime.

Core GA
az synapse integration-runtime stop

Stop an SSIS integration runtime.

Core GA
az synapse integration-runtime sync-credentials

Synchronize credentials among integration runtime nodes.

Core GA
az synapse integration-runtime update

Update an integration runtime.

Core GA
az synapse integration-runtime upgrade

Upgrade self-hosted integration runtime.

Core GA
az synapse integration-runtime wait

Place the CLI in a waiting state until a condition of a integration runtime is met.

Core GA
az synapse kql-script

Manage script with kusto.

Core GA
az synapse kql-script create

Creates a KQL script.

Core GA
az synapse kql-script delete

Deletes a KQL script.

Core GA
az synapse kql-script export

Export KQL scripts.

Core GA
az synapse kql-script import

Creates a KQL script.

Core GA
az synapse kql-script list

List KQL scripts.

Core GA
az synapse kql-script show

Gets a KQL script.

Core GA
az synapse kql-script wait

Place the CLI in a waiting state until a condition of a KQL script is met.

Core GA
az synapse kusto

Manage synapse kusto.

Core GA
az synapse kusto-operation

Manage kusto operation with synapse.

Core Experimental
az synapse kusto-operation list

Lists available operations for the Kusto sub-resources inside Microsoft.Synapse provider.

Core Experimental
az synapse kusto attached-database-configuration

Manage kusto pool attached database configuration with synapse.

Core Experimental
az synapse kusto attached-database-configuration create

Create an attached database configuration.

Core Experimental
az synapse kusto attached-database-configuration delete

Deletes the attached database configuration with the given name.

Core Experimental
az synapse kusto attached-database-configuration list

Returns the list of attached database configurations of the given Kusto Pool.

Core Experimental
az synapse kusto attached-database-configuration show

Returns an attached database configuration.

Core Experimental
az synapse kusto attached-database-configuration update

Update an attached database configuration.

Core Experimental
az synapse kusto attached-database-configuration wait

Place the CLI in a waiting state until a condition of the synapse kusto attached-database-configuration is met.

Core Experimental
az synapse kusto data-connection

Manage kusto pool data connection with synapse.

Core Experimental
az synapse kusto data-connection delete

Deletes the data connection with the given name.

Core Experimental
az synapse kusto data-connection event-grid

Manage kusto pool data connection with synapse sub group event-grid.

Core Experimental
az synapse kusto data-connection event-grid create

Create a data connection.

Core Experimental
az synapse kusto data-connection event-grid update

Updates a data connection.

Core Experimental
az synapse kusto data-connection event-hub

Manage kusto pool data connection with synapse sub group event-hub.

Core Experimental
az synapse kusto data-connection event-hub create

Create a data connection.

Core Experimental
az synapse kusto data-connection event-hub update

Updates a data connection.

Core Experimental
az synapse kusto data-connection iot-hub

Manage kusto pool data connection with synapse sub group iot-hub.

Core Experimental
az synapse kusto data-connection iot-hub create

Create a data connection.

Core Experimental
az synapse kusto data-connection iot-hub update

Updates a data connection.

Core Experimental
az synapse kusto data-connection list

Returns the list of data connections of the given Kusto pool database.

Core Experimental
az synapse kusto data-connection show

Returns a data connection.

Core Experimental
az synapse kusto data-connection wait

Place the CLI in a waiting state until a condition of the synapse kusto data-connection is met.

Core Experimental
az synapse kusto database

Manage kusto pool database with synapse.

Core Experimental
az synapse kusto database-principal-assignment

Manage kusto pool database principal assignment with synapse.

Core Experimental
az synapse kusto database-principal-assignment create

Creates a Kusto pool database principalAssignment.

Core Experimental
az synapse kusto database-principal-assignment delete

Deletes a Kusto pool principalAssignment.

Core Experimental
az synapse kusto database-principal-assignment list

Lists all Kusto pool database principalAssignments.

Core Experimental
az synapse kusto database-principal-assignment show

Gets a Kusto pool database principalAssignment.

Core Experimental
az synapse kusto database-principal-assignment update

Update a Kusto pool database principalAssignment.

Core Experimental
az synapse kusto database-principal-assignment wait

Place the CLI in a waiting state until a condition of the synapse kusto database-principal-assignment is met.

Core Experimental
az synapse kusto database create

Create a database.

Core Experimental
az synapse kusto database delete

Deletes the database with the given name.

Core Experimental
az synapse kusto database list

Returns the list of databases of the given Kusto pool.

Core Experimental
az synapse kusto database show

Returns a database.

Core Experimental
az synapse kusto database update

Updates a database.

Core Experimental
az synapse kusto database wait

Place the CLI in a waiting state until a condition of the synapse kusto database is met.

Core Experimental
az synapse kusto pool

Manage kusto pool with synapse.

Core GA
az synapse kusto pool-principal-assignment

Manage kusto pool principal assignment with synapse.

Core Experimental
az synapse kusto pool-principal-assignment create

Create a Kusto pool principalAssignment.

Core Experimental
az synapse kusto pool-principal-assignment delete

Deletes a Kusto pool principalAssignment.

Core Experimental
az synapse kusto pool-principal-assignment list

Lists all Kusto pool principalAssignments.

Core Experimental
az synapse kusto pool-principal-assignment show

Gets a Kusto pool principalAssignment.

Core Experimental
az synapse kusto pool-principal-assignment update

Update a Kusto pool principalAssignment.

Core Experimental
az synapse kusto pool-principal-assignment wait

Place the CLI in a waiting state until a condition of the synapse kusto pool-principal-assignment is met.

Core Experimental
az synapse kusto pool add-language-extension

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

Core GA
az synapse kusto pool create

Create a Kusto pool.

Core GA
az synapse kusto pool delete

Deletes a Kusto pool.

Core GA
az synapse kusto pool detach-follower-database

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

Core GA
az synapse kusto pool list

List all Kusto pools.

Core GA
az synapse kusto pool list-follower-database

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

Core GA
az synapse kusto pool list-language-extension

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

Core GA
az synapse kusto pool list-sku

Returns the SKUs available for the provided resource.

Core GA
az synapse kusto pool remove-language-extension

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

Core GA
az synapse kusto pool show

Gets a Kusto pool.

Core GA
az synapse kusto pool start

Starts a Kusto pool.

Core GA
az synapse kusto pool stop

Stops a Kusto pool.

Core GA
az synapse kusto pool update

Update a Kusto Kusto Pool.

Core GA
az synapse kusto pool wait

Place the CLI in a waiting state until a condition of the synapse kusto pool is met.

Core GA
az synapse link-connection

Manage Synapse's link connection.

Core GA
az synapse link-connection create

Create a link connection.

Core GA
az synapse link-connection delete

Delete a link connection.

Core GA
az synapse link-connection edit-link-tables

Edit tables for a link connection.

Core GA
az synapse link-connection get-link-tables-status

Query the link table status of a link connection.

Core GA
az synapse link-connection get-status

Check a link connection status after start/stop a link connection.

Core GA
az synapse link-connection list

List link connections in a synapse workspace.

Core GA
az synapse link-connection list-link-tables

List the link tables of a link connection.

Core GA
az synapse link-connection show

Get a link connection.

Core GA
az synapse link-connection start

Start a link connnection.

Core GA
az synapse link-connection stop

Stop a link connection.

Core GA
az synapse link-connection update

Update a link connection.

Core GA
az synapse link-connection update-landing-zone-credential

Update landing zone credetial of a link connection.

Core GA
az synapse linked-service

Manage Synapse's linked services.

Core GA
az synapse linked-service create

Create a linked service.

Core GA
az synapse linked-service delete

Delete a linked service.

Core GA
az synapse linked-service list

List linked services.

Core GA
az synapse linked-service set

Update an exist linked service.

Core Deprecated
az synapse linked-service show

Get a linked service.

Core GA
az synapse linked-service update

Update an exist linked service.

Core GA
az synapse managed-private-endpoints

Manage synapse managed private endpoints.

Core GA
az synapse managed-private-endpoints create

Create a synapse managed private endpoints.

Core GA
az synapse managed-private-endpoints delete

Delete synapse managed private endpoints in a workspace.

Core GA
az synapse managed-private-endpoints list

List synapse managed private endpoints in a workspace.

Core GA
az synapse managed-private-endpoints show

Get a synapse managed private endpoints.

Core GA
az synapse notebook

Manage Synapse's notebooks.

Core GA
az synapse notebook create

Create a notebook.

Core GA
az synapse notebook delete

Delete a notebook.

Core GA
az synapse notebook export

Export notebooks.

Core GA
az synapse notebook import

Import a notebook.

Core GA
az synapse notebook list

List notebooks.

Core GA
az synapse notebook set

Set an exist notebook.

Core GA
az synapse notebook show

Get a notebook.

Core GA
az synapse pipeline

Manage Synapse's pipelines.

Core GA
az synapse pipeline-run

Manage Synapse's pipeline run.

Core GA
az synapse pipeline-run cancel

Cancel a pipeline run by its run ID.

Core GA
az synapse pipeline-run query-by-workspace

Query pipeline runs in the workspace based on input filter conditions.

Core GA
az synapse pipeline-run show

Get a pipeline run by its run ID.

Core GA
az synapse pipeline create

Create a pipeline.

Core GA
az synapse pipeline create-run

Creates a run of a pipeline.

Core GA
az synapse pipeline delete

Delete a pipeline.

Core GA
az synapse pipeline list

List pipelines.

Core GA
az synapse pipeline set

Update an exist pipeline.

Core Deprecated
az synapse pipeline show

Get a pipeline.

Core GA
az synapse pipeline update

Update an exist pipeline.

Core GA
az synapse role

Manage Synapse's role assignments and definitions.

Core GA
az synapse role assignment

Manage Synapse's role assignments.

Core GA
az synapse role assignment create

Create a role assignment.

Core GA
az synapse role assignment delete

Delete role assignments of workspace.

Core GA
az synapse role assignment list

List role assignments.

Core GA
az synapse role assignment show

Get a role assignment by id.

Core GA
az synapse role definition

Manage Synapse's role definitions.

Core GA
az synapse role definition list

List role definitions.

Core GA
az synapse role definition show

Get role definition by role id/name.

Core GA
az synapse role scope

Manage Synapse's role scopes.

Core GA
az synapse role scope list

List role scopes.

Core GA
az synapse spark

Manage Spark pools and Spark jobs.

Core GA
az synapse spark-job-definition

Manage spark job definitions in a synapse workspace.

Core GA
az synapse spark-job-definition create

Create a spark job definition.

Core GA
az synapse spark-job-definition delete

Delete a spark job definition.

Core GA
az synapse spark-job-definition list

List spark job definitions.

Core GA
az synapse spark-job-definition show

Get a spark job definition.

Core GA
az synapse spark-job-definition update

Update a spark job definition.

Core GA
az synapse spark-job-definition wait

Place the CLI in a waiting state until a condition of a spark job definition is met.

Core GA
az synapse spark job

Manage Synapse Spark batch jobs.

Core GA
az synapse spark job cancel

Cancel a Spark job.

Core GA
az synapse spark job list

List all Spark jobs.

Core GA
az synapse spark job show

Get a Spark job.

Core GA
az synapse spark job submit

Submit a Spark job.

Core GA
az synapse spark pool

Manage Spark pools.

Core GA
az synapse spark pool create

Create a Spark pool.

Core GA
az synapse spark pool delete

Delete a Spark pool.

Core GA
az synapse spark pool list

List all Spark pools.

Core GA
az synapse spark pool show

Get a Spark pool.

Core GA
az synapse spark pool update

Update the Spark pool.

Core GA
az synapse spark pool wait

Place the CLI in a waiting state until a condition of a Spark pool is met.

Core GA
az synapse spark session

Manage Synapse Spark sessions.

Core GA
az synapse spark session cancel

Cancel a Spark session.

Core GA
az synapse spark session create

Create a Spark session.

Core GA
az synapse spark session list

List all Spark sessions.

Core GA
az synapse spark session reset-timeout

Reset a Spark session timeout time.

Core GA
az synapse spark session show

Get a Spark session.

Core GA
az synapse spark statement

Manage Synapse Spark statements.

Core GA
az synapse spark statement cancel

Cancel a Spark statement.

Core GA
az synapse spark statement invoke

Invoke a Spark statement.

Core GA
az synapse spark statement list

List all Spark statements.

Core GA
az synapse spark statement show

Get a Spark statement.

Core GA
az synapse sql

Manage SQL pools.

Core GA
az synapse sql-script

Manage SQL scripts in a synapse workspace.

Core GA
az synapse sql-script create

Create or update a SQL script.

Core GA
az synapse sql-script delete

Delete a SQL script.

Core GA
az synapse sql-script export

Export a SQL script.

Core GA
az synapse sql-script import

Import a SQL script.

Core GA
az synapse sql-script list

List SQL scripts in a synapse workspace.

Core GA
az synapse sql-script show

Get a SQL script.

Core GA
az synapse sql-script wait

Place the CLI in a waiting state until a condition of a sql script is met.

Core GA
az synapse sql ad-admin

Manage SQL Active Directory administrator.

Core GA
az synapse sql ad-admin create

Create the SQL Azure Active Directory administrator.

Core GA
az synapse sql ad-admin delete

Delete the SQL Azure Active Directory administrator.

Core GA
az synapse sql ad-admin show

Get the SQL Azure Active Directory administrator.

Core GA
az synapse sql ad-admin update

Update the SQL Azure Active Directory administrator.

Core GA
az synapse sql ad-admin wait

Place the CLI in a waiting state until a condition is met.

Core GA
az synapse sql audit-policy

Manage SQL auditing policy.

Core GA
az synapse sql audit-policy show

Get a SQL's auditing policy.

Core GA
az synapse sql audit-policy update

Update a SQL's auditing policy.

Core GA
az synapse sql audit-policy wait

Place the CLI in a waiting state until a condition is met.

Core GA
az synapse sql pool

Manage SQL pools.

Core GA
az synapse sql pool audit-policy

Manage a SQL pool's auditing policy.

Core GA
az synapse sql pool audit-policy show

Get a SQL pool's auditing policy.

Core GA
az synapse sql pool audit-policy update

Update a SQL pool's auditing policy.

Core GA
az synapse sql pool classification

Manage sensitivity classifications.

Core GA
az synapse sql pool classification create

Create a column's sensitivity classification.

Core GA
az synapse sql pool classification delete

Delete the sensitivity classification of a given column.

Core GA
az synapse sql pool classification list

Get the sensitivity classifications of a given SQL pool.

Core GA
az synapse sql pool classification recommendation

Manage sensitivity classification recommendations.

Core GA
az synapse sql pool classification recommendation disable

Disable sensitivity recommendations for a given column(recommendations are enabled by default on all columns).

Core GA
az synapse sql pool classification recommendation enable

Enable sensitivity recommendations for a given column(recommendations are enabled by default on all columns).

Core GA
az synapse sql pool classification recommendation list

List the recommended sensitivity classifications of a given SQL pool.

Core GA
az synapse sql pool classification show

Get the sensitivity classification of a given column.

Core GA
az synapse sql pool classification update

Update a column's sensitivity classification.

Core GA
az synapse sql pool create

Create a SQL pool.

Core GA
az synapse sql pool delete

Delete a SQL pool.

Core GA
az synapse sql pool list

List all SQL pools.

Core GA
az synapse sql pool list-deleted

List all deleted SQL pools.

Core GA
az synapse sql pool pause

Pause a SQL pool.

Core GA
az synapse sql pool restore

Create a new SQL pool by restoring from a backup.

Core GA
az synapse sql pool resume

Resume a SQL pool.

Core GA
az synapse sql pool show

Get a SQL pool.

Core GA
az synapse sql pool show-connection-string

Generate a connection string to a SQL pool.

Core GA
az synapse sql pool tde

Manage a SQL pool's transparent data encryption.

Core GA
az synapse sql pool tde set

Set a SQL pool's transparent data encryption configuration.

Core GA
az synapse sql pool tde show

Get a SQL pool's transparent data encryption configuration.

Core GA
az synapse sql pool threat-policy

Manage a SQL pool's threat detection policies.

Core GA
az synapse sql pool threat-policy show

Get a SQL pool's threat detection policy.

Core GA
az synapse sql pool threat-policy update

Update a SQL pool's threat detection policy.

Core GA
az synapse sql pool update

Update a SQL pool.

Core GA
az synapse sql pool wait

Place the CLI in a waiting state until a condition of a SQL pool is met.

Core GA
az synapse trigger

Manage Synapse's triggers.

Core GA
az synapse trigger-run

Synapse trigger-run.

Core GA
az synapse trigger-run cancel

Cancel a single trigger instance by runId.

Core GA
az synapse trigger-run query-by-workspace

Query trigger runs in the workspace based on input filter conditions.

Core GA
az synapse trigger-run rerun

Rerun single trigger instance by runId.

Core GA
az synapse trigger create

Create a trigger.

Core GA
az synapse trigger delete

Delete a trigger.

Core GA
az synapse trigger get-event-subscription-status

Get a trigger's event subscription status.

Core GA
az synapse trigger list

List triggers.

Core GA
az synapse trigger set

Update an exist trigger.

Core Deprecated
az synapse trigger show

Get a trigger.

Core GA
az synapse trigger start

Starts a trigger.

Core GA
az synapse trigger stop

Stops a trigger.

Core GA
az synapse trigger subscribe-to-event

Subscribe event trigger to events.

Core GA
az synapse trigger unsubscribe-from-event

Unsubscribe event trigger from events.

Core GA
az synapse trigger update

Update an exist trigger.

Core GA
az synapse trigger wait

Place the CLI in a waiting state until a condition of a trigger is met.

Core GA
az synapse workspace

Manage Synapse workspaces.

Core GA
az synapse workspace-package

Manage Synapse's workspace packages.

Core GA
az synapse workspace-package delete

Delete a workspace package.

Core GA
az synapse workspace-package list

List workspace packages.

Core GA
az synapse workspace-package show

Get a workspace package.

Core GA
az synapse workspace-package upload

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

Core GA
az synapse workspace-package upload-batch

Upload workspace package files from a local directory to an Azure Synapse workspace.

Core GA
az synapse workspace activate

Activates a workspace and change it's state from pending to success state when the workspace is first being provisioned and double encryption is enabled.

Core GA
az synapse workspace check-name

Check if a Synapse workspace name is available or not.

Core GA
az synapse workspace create

Create a Synapse workspace.

Core GA
az synapse workspace delete

Delete a Synapse workspace.

Core GA
az synapse workspace firewall-rule

Manage a workspace's firewall rules.

Core GA
az synapse workspace firewall-rule create

Create a firewall rule.

Core GA
az synapse workspace firewall-rule delete

Delete a firewall rule.

Core GA
az synapse workspace firewall-rule list

List all firewall rules.

Core GA
az synapse workspace firewall-rule show

Get a firewall rule.

Core GA
az synapse workspace firewall-rule update

Update a firewall rule.

Core GA
az synapse workspace firewall-rule wait

Place the CLI in a waiting state until a condition of a firewall rule is met.

Core GA
az synapse workspace key

Manage workspace's keys.

Core GA
az synapse workspace key create

Create a workspace's key.

Core GA
az synapse workspace key delete

Delete a workspace's key. The key at active status can't be deleted.

Core GA
az synapse workspace key list

List keys under specified workspace.

Core GA
az synapse workspace key show

Show a workspace's key by name.

Core GA
az synapse workspace key wait

Place the CLI in a waiting state until a condition of a workspace key is met.

Core GA
az synapse workspace list

List all Synapse workspaces.

Core GA
az synapse workspace managed-identity

Manage workspace's managed-identity.

Core GA
az synapse workspace managed-identity grant-sql-access

Grant workspace's sql-access to managed-identity.

Core GA
az synapse workspace managed-identity revoke-sql-access

Revoke workspace's sql-access to managed-identity.

Core GA
az synapse workspace managed-identity show-sql-access

Show workspace's sql-access state to managed-identity.

Core GA
az synapse workspace managed-identity wait

Place the CLI in a waiting state until a condition of sql-access state to managed-identity is met.

Core GA
az synapse workspace show

Get a Synapse workspace.

Core GA
az synapse workspace update

Update a Synapse workspace.

Core GA
az synapse workspace wait

Place the CLI in a waiting state until a condition of the workspace is met.

Core GA