Share via

az datashare data-set-mapping

  • 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-mapping 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 mapping with datashare.

Commands

Name Description Type Status
az datashare data-set-mapping create

Create a DataSetMapping.

 Extension Experimental
az datashare data-set-mapping delete

Delete a DataSetMapping in a shareSubscription.

 Extension Experimental
az datashare data-set-mapping list

List DataSetMappings in a share subscription.

 Extension Experimental
az datashare data-set-mapping show

Get a DataSetMapping in a shareSubscription.

 Extension Experimental

az datashare data-set-mapping create

Experimental

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

Create a DataSetMapping.

az datashare data-set-mapping create --account-name
                                     --data-set-mapping-name
                                     --resource-group
                                     --share-subscription-name
                                     [--adls-gen2-file-data-set-mapping]
                                     [--adls-gen2-file-system-data-set-mapping]
                                     [--adls-gen2-folder-data-set-mapping]
                                     [--blob-container-data-set-mapping]
                                     [--blob-data-set-mapping]
                                     [--blob-folder-data-set-mapping]
                                     [--kusto-cluster-data-set-mapping]
                                     [--kusto-database-data-set-mapping]
                                     [--kusto-table-data-set-mapping]
                                     [--sqldb-table-data-set-mapping]
                                     [--sqldw-table-data-set-mapping]
                                     [--synapse-workspace-sql-pool-table-data-set-mapping]

Examples

DataSetMappings_SqlDWDataSetToAdlsGen2File_Create

az datashare data-set-mapping create --account-name "Account1" --adls-gen2-file-data-set-mapping data-set-id="a08f184b-0567-4b11-ba22-a1199336d226" file-path="file21" file-system="fileSystem" output-type="Csv" resource-group="SampleResourceGroup" storage-account-name="storage2" subscription-id="433a8dfd-e5d5-4e77-ad86-90acdc75eb1a" --name "DatasetMapping1" --resource-group "SampleResourceGroup" --share-subscription-name "ShareSubscription1"

Required Parameters

--account-name

The name of the share account.

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

The name of the data set mapping to be created.

--resource-group -g

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

--share-subscription-name

The name of the share subscription which will hold the data set sink.

Optional Parameters

--adls-gen2-file-data-set-mapping

An ADLS Gen2 file data set mapping.

Usage: --adls-gen2-file-data-set-mapping data-set-id=XX file-path=XX file-system=XX output-type=XX resource-group=XX storage-account-name=XX subscription-id=XX kind=XX

data-set-id: Required. The id of the source data set. file-path: Required. File path within the file system. file-system: Required. File system to which the file belongs. output-type: Type of output file resource-group: Required. Resource group of storage account. storage-account-name: Required. Storage account name of the source data set. subscription-id: Required. Subscription id of storage account. kind: Required. Kind of data set mapping.

--adls-gen2-file-system-data-set-mapping

An ADLS Gen2 file system data set mapping.

Usage: --adls-gen2-file-system-data-set-mapping data-set-id=XX file-system=XX resource-group=XX storage-account-name=XX subscription-id=XX kind=XX

data-set-id: Required. The id of the source data set. file-system: Required. The file system name. resource-group: Required. Resource group of storage account. storage-account-name: Required. Storage account name of the source data set. subscription-id: Required. Subscription id of storage account. kind: Required. Kind of data set mapping.

--adls-gen2-folder-data-set-mapping

An ADLS Gen2 folder data set mapping.

Usage: --adls-gen2-folder-data-set-mapping data-set-id=XX file-system=XX folder-path=XX resource-group=XX storage-account-name=XX subscription-id=XX kind=XX

data-set-id: Required. The id of the source data set. file-system: Required. File system to which the folder belongs. folder-path: Required. Folder path within the file system. resource-group: Required. Resource group of storage account. storage-account-name: Required. Storage account name of the source data set. subscription-id: Required. Subscription id of storage account. kind: Required. Kind of data set mapping.

--blob-container-data-set-mapping

A Blob container data set mapping.

Usage: --blob-container-data-set-mapping container-name=XX data-set-id=XX resource-group=XX storage-account-name=XX subscription-id=XX kind=XX

container-name: Required. BLOB Container name. data-set-id: Required. The id of the source data set. resource-group: Required. Resource group of storage account. storage-account-name: Required. Storage account name of the source data set. subscription-id: Required. Subscription id of storage account. kind: Required. Kind of data set mapping.

--blob-data-set-mapping

A Blob data set mapping.

Usage: --blob-data-set-mapping container-name=XX data-set-id=XX file-path=XX output-type=XX resource-group=XX storage-account-name=XX subscription-id=XX kind=XX

container-name: Required. Container that has the file path. data-set-id: Required. The id of the source data set. file-path: Required. File path within the source data set output-type: File output type resource-group: Required. Resource group of storage account. storage-account-name: Required. Storage account name of the source data set. subscription-id: Required. Subscription id of storage account. kind: Required. Kind of data set mapping.

--blob-folder-data-set-mapping

A Blob folder data set mapping.

Usage: --blob-folder-data-set-mapping container-name=XX data-set-id=XX prefix=XX resource-group=XX storage-account-name=XX subscription-id=XX kind=XX

container-name: Required. Container that has the file path. data-set-id: Required. The id of the source data set. prefix: Required. Prefix for blob folder resource-group: Required. Resource group of storage account. storage-account-name: Required. Storage account name of the source data set. subscription-id: Required. Subscription id of storage account. kind: Required. Kind of data set mapping.

--kusto-cluster-data-set-mapping

A Kusto cluster data set mapping.

Usage: --kusto-cluster-data-set-mapping data-set-id=XX kusto-cluster-resource-id=XX kind=XX

data-set-id: Required. The id of the source data set. kusto-cluster-resource-id: Required. Resource id of the sink kusto cluster. kind: Required. Kind of data set mapping.

--kusto-database-data-set-mapping

A Kusto database data set mapping.

Usage: --kusto-database-data-set-mapping data-set-id=XX kusto-cluster-resource-id=XX kind=XX

data-set-id: Required. The id of the source data set. kusto-cluster-resource-id: Required. Resource id of the sink kusto cluster. kind: Required. Kind of data set mapping.

--kusto-table-data-set-mapping

A Kusto database data set mapping.

Usage: --kusto-table-data-set-mapping data-set-id=XX kusto-cluster-resource-id=XX kind=XX

data-set-id: Required. The id of the source data set. kusto-cluster-resource-id: Required. Resource id of the sink kusto cluster. kind: Required. Kind of data set mapping.

--sqldb-table-data-set-mapping

A SQL DB Table data set mapping.

Usage: --sqldb-table-data-set-mapping database-name=XX data-set-id=XX schema-name=XX sql-server-resource-id=XX table-name=XX kind=XX

database-name: Required. DatabaseName name of the sink data set data-set-id: Required. The id of the source data set. schema-name: Required. Schema of the table. Default value is dbo. sql-server-resource-id: Required. Resource id of SQL server table-name: Required. SQL DB table name. kind: Required. Kind of data set mapping.

--sqldw-table-data-set-mapping

A SQL DW Table data set mapping.

Usage: --sqldw-table-data-set-mapping data-set-id=XX data-warehouse-name=XX schema-name=XX sql-server-resource-id=XX table-name=XX kind=XX

data-set-id: Required. The id of the source data set. data-warehouse-name: Required. DataWarehouse name of the source data set schema-name: Required. Schema of the table. Default value is dbo. sql-server-resource-id: Required. Resource id of SQL server table-name: Required. SQL DW table name. kind: Required. Kind of data set mapping.

--synapse-workspace-sql-pool-table-data-set-mapping

A Synapse Workspace Sql Pool Table data set mapping.

Usage: --synapse-workspace-sql-pool-table-data-set-mapping data-set-id=XX synapse-workspace-sql-pool-table-resource-id=XX kind=XX

data-set-id: Required. The id of the source data set. synapse-workspace-sql-pool-table-resource-id: Required. Resource id of the Synapse Workspace SQL Pool Table kind: Required. Kind of data set mapping.

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-mapping delete

Experimental

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

Delete a DataSetMapping in a shareSubscription.

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

Examples

DataSetMappings_Delete

az datashare data-set-mapping delete --account-name "Account1" --name "DatasetMapping1" --resource-group "SampleResourceGroup" --share-subscription-name "ShareSubscription1"

Optional Parameters

--account-name

The name of the share account.

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

The name of the dataSetMapping.

--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-subscription-name

The name of the shareSubscription.

--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-mapping list

Experimental

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

List DataSetMappings in a share subscription.

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

Examples

DataSetMappings_ListByShareSubscription

az datashare data-set-mapping list --account-name "Account1" --resource-group "SampleResourceGroup" --share-subscription-name "ShareSubscription1"

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-subscription-name

The name of the share subscription.

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-mapping show

Experimental

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

Get a DataSetMapping in a shareSubscription.

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

Examples

DataSetMappings_Get

az datashare data-set-mapping show --account-name "Account1" --name "DatasetMapping1" --resource-group "SampleResourceGroup" --share-subscription-name "ShareSubscription1"

Optional Parameters

--account-name

The name of the share account.

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

The name of the dataSetMapping.

--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-subscription-name

The name of the shareSubscription.

--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.