az synapse

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

Commands

az synapse activity-run

Synapse activity-run.

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

Query activity runs based on input filter conditions.

az synapse data-flow

Manage Synapse's data flows.

az synapse data-flow create

Create a data flow.

az synapse data-flow delete

Delete a data flow.

az synapse data-flow list

List data flows.

az synapse data-flow set

Set an exist data flow.

az synapse data-flow show

Get a data flow.

az synapse dataset

Manage Synapse's datasets.

az synapse dataset create

Create a dataset.

az synapse dataset delete

Delete a dataset.

az synapse dataset list

List datasets.

az synapse dataset set

Update an exist dataset.

az synapse dataset show

Get a dataset.

az synapse dataset update

Update an exist dataset.

az synapse integration-runtime

Manage Synapse's integration runtimes.

az synapse integration-runtime create

Create an integration runtime.

az synapse integration-runtime delete

Delete an integration runtime.

az synapse integration-runtime get-connection-info

Get the integration runtime connection infomation.

az synapse integration-runtime get-monitoring-data

Get metric data for a self-hosted integration runtime.

az synapse integration-runtime get-status

Gets detailed status information for an integration runtime.

az synapse integration-runtime list

List integration runtimes.

az synapse integration-runtime list-auth-key

Get keys for a self-hosted integration runtime.

az synapse integration-runtime managed

Manage integration runtime with synapse sub group managed.

az synapse integration-runtime managed create

Create an managed integration runtime.

az synapse integration-runtime regenerate-auth-key

Regenerate self-hosted integration runtime key.

az synapse integration-runtime self-hosted

Manage integration runtime with synapse sub group self-hosted.

az synapse integration-runtime self-hosted create

Create an self-hosted integration runtime.

az synapse integration-runtime show

Get an integration runtime.

az synapse integration-runtime start

Start an SSIS integration runtime.

az synapse integration-runtime stop

Stop an SSIS integration runtime.

az synapse integration-runtime sync-credentials

Synchronize credentials among integration runtime nodes.

az synapse integration-runtime update

Update an integration runtime.

az synapse integration-runtime upgrade

Upgrade self-hosted integration runtime.

az synapse integration-runtime wait

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

az synapse integration-runtime-node

Manage Synapse's self-hosted integration runtime nodes.

az synapse integration-runtime-node delete

Remove a self-hosted integration runtime node.

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

Get self-hosted integration runtime node ip.

az synapse integration-runtime-node show

Get self-hosted integration runtime node information.

az synapse integration-runtime-node update

Update self-hosted integration runtime node.

az synapse kql-script

Manage script with kusto.

az synapse kql-script create

Creates a KQL script.

az synapse kql-script delete

Deletes a KQL script.

az synapse kql-script export

Export KQL scripts.

az synapse kql-script import

Creates a KQL script.

az synapse kql-script list

List KQL scripts.

az synapse kql-script show

Gets a KQL script.

az synapse kql-script wait

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

az synapse kusto

Manage synapse kusto.

az synapse kusto attached-database-configuration

Manage kusto pool attached database configuration with synapse.

az synapse kusto attached-database-configuration create

Create an attached database configuration.

az synapse kusto attached-database-configuration delete

Deletes the attached database configuration with the given name.

az synapse kusto attached-database-configuration list

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

az synapse kusto attached-database-configuration show

Returns an attached database configuration.

az synapse kusto attached-database-configuration update

Update an attached database configuration.

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.

az synapse kusto database

Manage kusto pool database with synapse.

az synapse kusto database create

Create a database.

az synapse kusto database delete

Deletes the database with the given name.

az synapse kusto database list

Returns the list of databases of the given Kusto pool.

az synapse kusto database show

Returns a database.

az synapse kusto database update

Updates a database.

az synapse kusto database wait

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

az synapse kusto database-principal-assignment

Manage kusto pool database principal assignment with synapse.

az synapse kusto database-principal-assignment create

Creates a Kusto pool database principalAssignment.

az synapse kusto database-principal-assignment delete

Deletes a Kusto pool principalAssignment.

az synapse kusto database-principal-assignment list

Lists all Kusto pool database principalAssignments.

az synapse kusto database-principal-assignment show

Gets a Kusto pool database principalAssignment.

az synapse kusto database-principal-assignment update

Update a Kusto pool database principalAssignment.

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.

az synapse kusto data-connection

Manage kusto pool data connection with synapse.

az synapse kusto data-connection delete

Deletes the data connection with the given name.

az synapse kusto data-connection event-grid

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

az synapse kusto data-connection event-grid create

Create a data connection.

az synapse kusto data-connection event-grid update

Updates a data connection.

az synapse kusto data-connection event-hub

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

az synapse kusto data-connection event-hub create

Create a data connection.

az synapse kusto data-connection event-hub update

Updates a data connection.

az synapse kusto data-connection iot-hub

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

az synapse kusto data-connection iot-hub create

Create a data connection.

az synapse kusto data-connection iot-hub update

Updates a data connection.

az synapse kusto data-connection list

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

az synapse kusto data-connection show

Returns a data connection.

az synapse kusto data-connection wait

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

az synapse kusto pool

Manage kusto pool with synapse.

az synapse kusto pool add-language-extension

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

az synapse kusto pool create

Create a Kusto pool.

az synapse kusto pool delete

Deletes a Kusto pool.

az synapse kusto pool detach-follower-database

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

az synapse kusto pool list

List all Kusto pools.

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.

az synapse kusto pool list-language-extension

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

az synapse kusto pool list-sku

Returns the SKUs available for the provided resource.

az synapse kusto pool remove-language-extension

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

az synapse kusto pool show

Gets a Kusto pool.

az synapse kusto pool start

Starts a Kusto pool.

az synapse kusto pool stop

Stops a Kusto pool.

az synapse kusto pool update

Update a Kusto Kusto Pool.

az synapse kusto pool wait

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

az synapse kusto pool-principal-assignment

Manage kusto pool principal assignment with synapse.

az synapse kusto pool-principal-assignment create

Create a Kusto pool principalAssignment.

az synapse kusto pool-principal-assignment delete

Deletes a Kusto pool principalAssignment.

az synapse kusto pool-principal-assignment list

Lists all Kusto pool principalAssignments.

az synapse kusto pool-principal-assignment show

Gets a Kusto pool principalAssignment.

az synapse kusto pool-principal-assignment update

Update a Kusto pool principalAssignment.

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.

az synapse kusto-operation

Manage kusto operation with synapse.

az synapse kusto-operation list

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

az synapse linked-service

Manage Synapse's linked services.

az synapse linked-service create

Create a linked service.

az synapse linked-service delete

Delete a linked service.

az synapse linked-service list

List linked services.

az synapse linked-service set

Update an exist linked service.

az synapse linked-service show

Get a linked service.

az synapse linked-service update

Update an exist linked service.

az synapse managed-private-endpoints

Manage synapse managed private endpoints.

az synapse managed-private-endpoints create

Create a synapse managed private endpoints.

az synapse managed-private-endpoints delete

Delete synapse managed private endpoints in a workspace.

az synapse managed-private-endpoints list

List synapse managed private endpoints in a workspace.

az synapse managed-private-endpoints show

Get a synapse managed private endpoints.

az synapse notebook

Manage Synapse's notebooks.

az synapse notebook create

Create a notebook.

az synapse notebook delete

Delete a notebook.

az synapse notebook export

Export notebooks.

az synapse notebook import

Import a notebook.

az synapse notebook list

List notebooks.

az synapse notebook set

Set an exist notebook.

az synapse notebook show

Get a notebook.

az synapse pipeline

Manage Synapse's pipelines.

az synapse pipeline create

Create a pipeline.

az synapse pipeline create-run

Creates a run of a pipeline.

az synapse pipeline delete

Delete a pipeline.

az synapse pipeline list

List pipelines.

az synapse pipeline set

Update an exist pipeline.

az synapse pipeline show

Get a pipeline.

az synapse pipeline update

Update an exist pipeline.

az synapse pipeline-run

Manage Synapse's pipeline run.

az synapse pipeline-run cancel

Cancel a pipeline run by its run ID.

az synapse pipeline-run query-by-workspace

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

az synapse pipeline-run show

Get a pipeline run by its run ID.

az synapse role

Manage Synapse's role assignments and definitions.

az synapse role assignment

Manage Synapse's role assignments.

az synapse role assignment create

Create a role assignment.

az synapse role assignment delete

Delete role assignments of workspace.

az synapse role assignment list

List role assignments.

az synapse role assignment show

Get a role assignment by id.

az synapse role definition

Manage Synapse's role definitions.

az synapse role definition list

List role definitions.

az synapse role definition show

Get role definition by role id/name.

az synapse role scope

Manage Synapse's role scopes.

az synapse role scope list

List role scopes.

az synapse spark

Manage Spark pools and Spark jobs.

az synapse spark job

Manage Synapse Spark batch jobs.

az synapse spark job cancel

Cancel a Spark job.

az synapse spark job list

List all Spark jobs.

az synapse spark job show

Get a Spark job.

az synapse spark job submit

Submit a Spark job.

az synapse spark pool

Manage Spark pools.

az synapse spark pool create

Create a Spark pool.

az synapse spark pool delete

Delete a Spark pool.

az synapse spark pool list

List all Spark pools.

az synapse spark pool show

Get a Spark pool.

az synapse spark pool update

Update the Spark pool.

az synapse spark pool wait

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

az synapse spark session

Manage Synapse Spark sessions.

az synapse spark session cancel

Cancel a Spark session.

az synapse spark session create

Create a Spark session.

az synapse spark session list

List all Spark sessions.

az synapse spark session reset-timeout

Reset a Spark session timeout time.

az synapse spark session show

Get a Spark session.

az synapse spark statement

Manage Synapse Spark statements.

az synapse spark statement cancel

Cancel a Spark statement.

az synapse spark statement invoke

Invoke a Spark statement.

az synapse spark statement list

List all Spark statements.

az synapse spark statement show

Get a Spark statement.

az synapse spark-job-definition

Manage spark job definitions in a synapse workspace.

az synapse spark-job-definition create

Create a spark job definition.

az synapse spark-job-definition delete

Delete a spark job definition.

az synapse spark-job-definition list

List spark job definitions.

az synapse spark-job-definition show

Get a spark job definition.

az synapse spark-job-definition update

Update a spark job definition.

az synapse spark-job-definition wait

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

az synapse sql

Manage SQL pools.

az synapse sql ad-admin

Manage SQL Active Directory administrator.

az synapse sql ad-admin create

Create the SQL Azure Active Directory administrator.

az synapse sql ad-admin delete

Delete the SQL Azure Active Directory administrator.

az synapse sql ad-admin show

Get the SQL Azure Active Directory administrator.

az synapse sql ad-admin update

Update the SQL Azure Active Directory administrator.

az synapse sql ad-admin wait

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

az synapse sql audit-policy

Manage SQL auditing policy.

az synapse sql audit-policy show

Get a SQL's auditing policy.

az synapse sql audit-policy update

Update a SQL's auditing policy.

az synapse sql audit-policy wait

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

az synapse sql pool

Manage SQL pools.

az synapse sql pool audit-policy

Manage a SQL pool's auditing policy.

az synapse sql pool audit-policy show

Get a SQL pool's auditing policy.

az synapse sql pool audit-policy update

Update a SQL pool's auditing policy.

az synapse sql pool classification

Manage sensitivity classifications.

az synapse sql pool classification create

Create a column's sensitivity classification.

az synapse sql pool classification delete

Delete the sensitivity classification of a given column.

az synapse sql pool classification list

Get the sensitivity classifications of a given SQL pool.

az synapse sql pool classification recommendation

Manage sensitivity classification recommendations.

az synapse sql pool classification recommendation disable

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

az synapse sql pool classification recommendation enable

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

az synapse sql pool classification recommendation list

List the recommended sensitivity classifications of a given SQL pool.

az synapse sql pool classification show

Get the sensitivity classification of a given column.

az synapse sql pool classification update

Update a column's sensitivity classification.

az synapse sql pool create

Create a SQL pool.

az synapse sql pool delete

Delete a SQL pool.

az synapse sql pool list

List all SQL pools.

az synapse sql pool list-deleted

List all deleted SQL pools.

az synapse sql pool pause

Pause a SQL pool.

az synapse sql pool restore

Create a new SQL pool by restoring from a backup.

az synapse sql pool resume

Resume a SQL pool.

az synapse sql pool show

Get a SQL pool.

az synapse sql pool show-connection-string

Generate a connection string to a SQL pool.

az synapse sql pool tde

Manage a SQL pool's transparent data encryption.

az synapse sql pool tde set

Set a SQL pool's transparent data encryption configuration.

az synapse sql pool tde show

Get a SQL pool's transparent data encryption configuration.

az synapse sql pool threat-policy

Manage a SQL pool's threat detection policies.

az synapse sql pool threat-policy show

Get a SQL pool's threat detection policy.

az synapse sql pool threat-policy update

Update a SQL pool's threat detection policy.

az synapse sql pool update

Update a SQL pool.

az synapse sql pool wait

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

az synapse sql-script

Manage SQL scripts in a synapse workspace.

az synapse sql-script create

Create or update a SQL script.

az synapse sql-script delete

Delete a SQL script.

az synapse sql-script export

Export a SQL script.

az synapse sql-script import

Import a SQL script.

az synapse sql-script list

List SQL scripts in a synapse workspace.

az synapse sql-script show

Get a SQL script.

az synapse sql-script wait

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

az synapse trigger

Manage Synapse's triggers.

az synapse trigger create

Create a trigger.

az synapse trigger delete

Delete a trigger.

az synapse trigger get-event-subscription-status

Get a trigger's event subscription status.

az synapse trigger list

List triggers.

az synapse trigger set

Update an exist trigger.

az synapse trigger show

Get a trigger.

az synapse trigger start

Starts a trigger.

az synapse trigger stop

Stops a trigger.

az synapse trigger subscribe-to-event

Subscribe event trigger to events.

az synapse trigger unsubscribe-from-event

Unsubscribe event trigger from events.

az synapse trigger update

Update an exist trigger.

az synapse trigger wait

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

az synapse trigger-run

Synapse trigger-run.

az synapse trigger-run cancel

Cancel a single trigger instance by runId.

az synapse trigger-run query-by-workspace

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

az synapse trigger-run rerun

Rerun single trigger instance by runId.

az synapse workspace

Manage Synapse workspaces.

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.

az synapse workspace check-name

Check if a Synapse workspace name is available or not.

az synapse workspace create

Create a Synapse workspace.

az synapse workspace delete

Delete a Synapse workspace.

az synapse workspace firewall-rule

Manage a workspace's firewall rules.

az synapse workspace firewall-rule create

Create a firewall rule.

az synapse workspace firewall-rule delete

Delete a firewall rule.

az synapse workspace firewall-rule list

List all firewall rules.

az synapse workspace firewall-rule show

Get a firewall rule.

az synapse workspace firewall-rule update

Update a firewall rule.

az synapse workspace firewall-rule wait

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

az synapse workspace key

Manage workspace's keys.

az synapse workspace key create

Create a workspace's key.

az synapse workspace key delete

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

az synapse workspace key list

List keys under specified workspace.

az synapse workspace key show

Show a workspace's key by name.

az synapse workspace key wait

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

az synapse workspace list

List all Synapse workspaces.

az synapse workspace managed-identity

Manage workspace's managed-identity.

az synapse workspace managed-identity grant-sql-access

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

az synapse workspace managed-identity revoke-sql-access

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

az synapse workspace managed-identity show-sql-access

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

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.

az synapse workspace show

Get a Synapse workspace.

az synapse workspace update

Update a Synapse workspace.

az synapse workspace wait

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

az synapse workspace-package

Manage Synapse's workspace packages.

az synapse workspace-package delete

Delete a workspace package.

az synapse workspace-package list

List workspace packages.

az synapse workspace-package show

Get a workspace package.

az synapse workspace-package upload

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

az synapse workspace-package upload-batch

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