CmdID / az / az managedcleanroom / az managedcleanroom frontend / az managedcleanroom frontend analytics / az managedcleanroom frontend analytics query

az managedcleanroom frontend analytics query run

Run a query in the collaboration Azure CLI extensions reference

Execute a published query with optional configuration parameters. A run ID is automatically generated if not provided.

5 examples 10 options Its page in the Azure CLI extensions reference

Examples

from the Azure CLI, each command read by CmdID

Run a query with default settings

az managedcleanroom frontend analytics query run               --collaboration-id my-collab-123               --document-id my-query

Identify

--collaboration-idCollaboration identifier

--document-idQuery document identifier

Run a query with dry run and date range

az managedcleanroom frontend analytics query run               --collaboration-id my-collab-123               --document-id my-query               --dry-run               --start-date "2024-01-01"               --end-date "2024-12-31"

Identify

--collaboration-idCollaboration identifier

--document-idQuery document identifier

--dry-runPerform a dry run without executing the query

--start-dateStart date for query execution

--end-dateEnd date for query execution

Run a query with optimizer enabled

az managedcleanroom frontend analytics query run               --collaboration-id my-collab-123               --document-id my-query               --use-optimizer

Identify

--collaboration-idCollaboration identifier

--document-idQuery document identifier

--use-optimizerUse query optimizer

Run a query on a larger compute size

az managedcleanroom frontend analytics query run               --collaboration-id my-collab-123               --document-id my-query               --scale-sku medium

Identify

--collaboration-idCollaboration identifier

--document-idQuery document identifier

--scale-skuCompute size for the run (small, medium, or large)

Run a query using a JSON body file (legacy mode)

az managedcleanroom frontend analytics query run               --collaboration-id my-collab-123               --document-id my-query               --body @run-config.json

Identify

--collaboration-idCollaboration identifier

--document-idQuery document identifier

--bodyJSON configuration file path (@file.json) or JSON string (legacy mode)

Options

10 in the Azure CLI extensions reference

--api-versionAPI version to use for this request

--bodyJSON configuration file path (@file.json) or JSON string (legacy mode)

--cmdCLI command context

--collaboration-id, -cCollaboration identifier

--document-id, -dQuery document identifier

--dry-runPerform a dry run without executing the query

--end-dateEnd date for query execution

--scale-skuCompute size for the run (small, medium, or large)

--start-dateStart date for query execution

--use-optimizerUse query optimizer