az datashare dataset
Commands for providers to manage datashare datasets.
Commands
az datashare dataset create |
Create a dataset. |
az datashare dataset delete |
Delete a dataset in a share. |
az datashare dataset list |
List datasets in a share. |
az datashare dataset show |
Show a dataset. |
az datashare dataset wait |
Place the CLI in a waiting state until a condition of the datashare dataset is met. |
az datashare dataset create
Create a dataset.
az datashare dataset create --account-name
--dataset
--name
--resource-group
--share-name
Examples
Create a Blob dataset
az datashare dataset create --account-name MyAccount --name MyDataset --resource-group MyResourceGroup --share-name MyShare --dataset "{\"kind\":\"Blob\",\"properties\":{\"containerName\":\"C1\",\"filePath\":\"file21\",\"resourceGroup\": \"SampleResourceGroup\",\"storageAccountName\":\"storage2\",\"subscriptionId\":\"00000000-0000-0000-0000-000000000000\"}}"
Create a BlobFolder dataset
az datashare dataset create --account-name MyAccount --name MyDataset --resource-group MyResourceGroup --share-name MyShare --dataset "{\"kind\":\"BlobFolder\",\"properties\":{\"containerName\":\"C1\",\"prefix\":\"folder21\",\"resourceGroup\": \"SampleResourceGroup\",\"storageAccountName\":\"storage2\",\"subscriptionId\":\"00000000-0000-0000-0000-000000000000\"}}"
Create a KustoCluster dataset
az datashare dataset create --account-name MyAccount --name MyDataset --resource-group MyResourceGroup --share-name MyShare --dataset "{\"kind\":\"KustoCluster\",\"properties\":{\"kustoClusterResourceId\": \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleResourceGroup/providers/Microsoft.Kusto/clusters/Cluster1\"}}"
Create a KustoDatabase dataset
az datashare dataset create --account-name MyAccount --name MyDataset --resource-group MyResourceGroup --share-name MyShare --dataset "{\"kind\":\"KustoDatabase\",\"properties\":{\"kustoDatabaseResourceId\": \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleResourceGroup/providers/Microsoft.Kusto/clusters/Cluster1/databases/Database1\"}}"
Create a SqlDBTable dataset
az datashare dataset create --account-name MyAccount --name MyDataset --resource-group MyResourceGroup --share-name MyShare --dataset "{\"kind\":\"SqlDBTable\",\"properties\":{\"databaseName\":\"MySqlDB\",\"schemaName\":\"dbo\", \"sqlServerResourceId\":\"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1\", \"tableName\":\"Table1\"}}"
Create a SqlDWTable dataset
az datashare dataset create --account-name MyAccount --name MyDataset --resource-group MyResourceGroup --share-name MyShare --dataset "{\"kind\":\"SqlDWTable\",\"properties\":{\"dataWarehouseName\":\"MyDataWarehouse\",\"schemaName\":\"dbo\", \"sqlServerResourceId\":\"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Sql/servers/MyServer\",\"tableName\":\"MyTable\"}}"
Required Parameters
The name of the share account.
Dataset parameters in JSON string or path to JSON file.
The name of the dataset.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the share.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az datashare dataset delete
Delete a dataset in a share.
az datashare dataset delete --account-name
--name
--resource-group
--share-name
[--no-wait]
[--yes]
Examples
Delete a dataset
az datashare dataset delete --account-name MyAccount --name MyDataset --resource-group MyResourceGroup --share-name MyShare
Required Parameters
The name of the share account.
The name of the dataset.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the share.
Optional Parameters
Do not wait for the long-running operation to finish.
Do not prompt for confirmation.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az datashare dataset list
List datasets in a share.
az datashare dataset list --account-name
--resource-group
--share-name
Examples
List datasets
az datashare dataset list --account-name MyAccount --resource-group MyResourceGroup --share-name MyShare
Required Parameters
The name of the share account.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the share.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az datashare dataset show
Show a dataset.
az datashare dataset show --account-name
--name
--resource-group
--share-name
Examples
Show a dataset
az datashare dataset show --account-name MyAccount --name MyDataset --resource-group MyResourceGroup --share-name MyShare
Required Parameters
The name of the share account.
The name of the dataset.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the share.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az datashare dataset wait
Place the CLI in a waiting state until a condition of the datashare dataset is met.
az datashare dataset wait --account-name
--name
--resource-group
--share-name
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Examples
Pause executing next line of CLI script until the datashare dataset is successfully provisioned.
az datashare dataset wait --account-name MyAccount --share-name MyShare --name MyDataset --resource-group MyResourceGroup --created
Required Parameters
The name of the share account.
The name of the dataset.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the share.
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Polling interval in seconds.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.