Share via

az datashare data-set

  • Experimental
  • Reference

Note

This reference is part of the datashare extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az datashare data-set command. Learn more about extensions.

Command group 'datashare' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage data set with datashare.

Commands

Name Description Type Status
az datashare data-set create

Create a DataSet.

 Extension Experimental
az datashare data-set delete

Delete a DataSet in a share.

 Extension Experimental
az datashare data-set list

List DataSets in a share.

 Extension Experimental
az datashare data-set show

Get a DataSet in a share.

 Extension Experimental
az datashare data-set wait

Place the CLI in a waiting state until a condition of the datashare data-set is met.

 Extension Experimental

az datashare data-set create

Experimental

Command group 'datashare' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a DataSet.

az datashare data-set create --account-name
                             --data-set
                             --data-set-name
                             --resource-group
                             --share-name

Examples

DataSets_Create

az datashare data-set create --account-name "Account1" --data-set "{\"kind\":\"Blob\",\"properties\":{\"containerName\":\"C1\",\"filePath\":\"file21\",\"resourceGroup\":\"SampleResourceGroup\",\"storageAccountName\":\"storage2\",\"subscriptionId\":\"433a8dfd-e5d5-4e77-ad86-90acdc75eb1a\"}}" --name "Dataset1" --resource-group "SampleResourceGroup" --share-name "Share1"

DataSets_KustoCluster_Create

az datashare data-set create --account-name "Account1" --data-set "{\"kind\":\"KustoCluster\",\"properties\":{\"kustoClusterResourceId\":\"/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Kusto/clusters/Cluster1\"}}" --name "Dataset1" --resource-group "SampleResourceGroup" --share-name "Share1"

DataSets_KustoDatabase_Create

az datashare data-set create --account-name "Account1" --data-set "{\"kind\":\"KustoDatabase\",\"properties\":{\"kustoDatabaseResourceId\":\"/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Kusto/clusters/Cluster1/databases/Database1\"}}" --name "Dataset1" --resource-group "SampleResourceGroup" --share-name "Share1"

DataSets_KustoTable_Create

az datashare data-set create --account-name "Account1" --data-set "{\"kind\":\"KustoTable\",\"properties\":{\"kustoDatabaseResourceId\":\"/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Kusto/clusters/Cluster1/databases/Database1\",\"tableLevelSharingProperties\":{\"externalTablesToExclude\":[\"test11\",\"test12\"],\"externalTablesToInclude\":[\"test9\",\"test10\"],\"materializedViewsToExclude\":[\"test7\",\"test8\"],\"materializedViewsToInclude\":[\"test5\",\"test6\"],\"tablesToExclude\":[\"test3\",\"test4\"],\"tablesToInclude\":[\"test1\",\"test2\"]}}}" --name "Dataset1" --resource-group "SampleResourceGroup" --share-name "Share1"

DataSets_SqlDBTable_Create

az datashare data-set create --account-name "Account1" --data-set "{\"kind\":\"SqlDBTable\",\"properties\":{\"databaseName\":\"SqlDB1\",\"schemaName\":\"dbo\",\"sqlServerResourceId\":\"/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1\",\"tableName\":\"Table1\"}}" --name "Dataset1" --resource-group "SampleResourceGroup" --share-name "Share1"

DataSets_SqlDWTable_Create

az datashare data-set create --account-name "Account1" --data-set "{\"kind\":\"SqlDWTable\",\"properties\":{\"dataWarehouseName\":\"DataWarehouse1\",\"schemaName\":\"dbo\",\"sqlServerResourceId\":\"/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1\",\"tableName\":\"Table1\"}}" --name "Dataset1" --resource-group "SampleResourceGroup" --share-name "Share1"

DataSets_SynapseWorkspaceSqlPoolTable_Create

az datashare data-set create --account-name "sourceAccount" --data-set "{\"kind\":\"SynapseWorkspaceSqlPoolTable\",\"properties\":{\"synapseWorkspaceSqlPoolTableResourceId\":\"/subscriptions/0f3dcfc3-18f8-4099-b381-8353e19d43a7/resourceGroups/SampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/sqlPools/ExampleSqlPool/schemas/dbo/tables/table1\"}}" --name "dataset1" --resource-group "SampleResourceGroup" --share-name "share1"

Required Parameters

--account-name

The name of the share account.

--data-set

The new data set information. Expected value: json-string/json-file/@json-file.

--data-set-name --name -n

The name of the dataSet.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--share-name

The name of the share to add the data set to.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datashare data-set delete

Experimental

Command group 'datashare' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a DataSet in a share.

az datashare data-set delete [--account-name]
                             [--data-set-name]
                             [--ids]
                             [--no-wait]
                             [--resource-group]
                             [--share-name]
                             [--subscription]
                             [--yes]

Examples

DataSets_Delete

az datashare data-set delete --account-name "Account1" --name "Dataset1" --resource-group "SampleResourceGroup" --share-name "Share1"

Optional Parameters

--account-name

The name of the share account.

--data-set-name --name -n

The name of the dataSet.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--share-name

The name of the share.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datashare data-set list

Experimental

Command group 'datashare' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List DataSets in a share.

az datashare data-set list --account-name
                           --resource-group
                           --share-name
                           [--filter]
                           [--orderby]
                           [--skip-token]

Examples

DataSets_ListByShare

az datashare data-set list --account-name "Account1" --resource-group "SampleResourceGroup" --share-name "Share1"

Required Parameters

--account-name

The name of the share account.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--share-name

The name of the share.

Optional Parameters

--filter

Filters the results using OData syntax.

--orderby

Sorts the results using OData syntax.

--skip-token

Continuation token.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datashare data-set show

Experimental

Command group 'datashare' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a DataSet in a share.

az datashare data-set show [--account-name]
                           [--data-set-name]
                           [--ids]
                           [--resource-group]
                           [--share-name]
                           [--subscription]

Examples

DataSets_Get

az datashare data-set show --account-name "Account1" --name "Dataset1" --resource-group "SampleResourceGroup" --share-name "Share1"

Optional Parameters

--account-name

The name of the share account.

--data-set-name --name -n

The name of the dataSet.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--share-name

The name of the share.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datashare data-set wait

Experimental

Command group 'datashare' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition of the datashare data-set is met.

az datashare data-set wait [--account-name]
                           [--created]
                           [--custom]
                           [--data-set-name]
                           [--deleted]
                           [--exists]
                           [--ids]
                           [--interval]
                           [--resource-group]
                           [--share-name]
                           [--subscription]
                           [--timeout]
                           [--updated]

Examples

Pause executing next line of CLI script until the datashare data-set is successfully deleted.

az datashare data-set wait --account-name "Account1" --name "Dataset1" --resource-group "SampleResourceGroup" --share-name "Share1" --deleted

Optional Parameters

--account-name

The name of the share account.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--data-set-name --name -n

The name of the dataSet.

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

default value: 30
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--share-name

The name of the share.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.