Data Set Mappings - Get

Get DataSetMapping in a shareSubscription.
Get a DataSetMapping in a shareSubscription

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/dataSetMappings/{dataSetMappingName}?api-version=2019-11-01

URI Parameters

Name In Required Type Description
accountName
path True
  • string

The name of the share account.

dataSetMappingName
path True
  • string

The name of the dataSetMapping.

resourceGroupName
path True
  • string

The resource group name.

shareSubscriptionName
path True
  • string

The name of the shareSubscription.

subscriptionId
path True
  • string

The subscription identifier

api-version
query True
  • string

The api version to use.

Responses

Name Type Description
200 OK DataSetMapping:

Success

Other Status Codes

An error response received from the Microsoft.DataShare resource provider.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

DataSetMappings_Get

Sample Request

GET https://management.azure.com/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1?api-version=2019-11-01

Sample Response

Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-tenant-reads: 14999
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd
{
  "kind": "Blob",
  "properties": {
    "dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
    "storageAccountName": "storage2",
    "filePath": "file21",
    "containerName": "C1",
    "subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a",
    "resourceGroup": "SampleResourceGroup"
  },
  "id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1",
  "name": "DatasetMapping1",
  "type": "Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings"
}

Definitions

ADLSGen2FileDataSetMapping

An ADLS Gen2 file data set mapping.

ADLSGen2FileSystemDataSetMapping

An ADLS Gen2 file system data set mapping.

ADLSGen2FolderDataSetMapping

An ADLS Gen2 folder data set mapping.

BlobContainerDataSetMapping

A Blob container data set mapping.

BlobDataSetMapping

A Blob data set mapping.

BlobFolderDataSetMapping

A Blob folder data set mapping.

dataSetMappingStatus

Gets the status of the data set mapping.

DataShareError

The data share error model.

DataShareErrorInfo

The data share error body model.

KustoClusterDataSetMapping

A Kusto cluster data set mapping

KustoDatabaseDataSetMapping

A Kusto database data set mapping

outputType

Type of output file

provisioningState

Provisioning state of the Account

SqlDBTableDataSetMapping

A SQL DB Table data set mapping.

SqlDWTableDataSetMapping

A SQL DW Table data set mapping.

ADLSGen2FileDataSetMapping

An ADLS Gen2 file data set mapping.

Name Type Description
id
  • string

The resource id of the azure resource

kind string:
  • AdlsGen2File

Kind of data set mapping.

name
  • string

Name of the azure resource

properties.dataSetId
  • string

The id of the source data set.

properties.dataSetMappingStatus

Gets the status of the data set mapping.

properties.filePath
  • string

File path within the file system.

properties.fileSystem
  • string

File system to which the file belongs.

properties.outputType

Type of output file

properties.provisioningState

Provisioning state of the data set mapping.

properties.resourceGroup
  • string

Resource group of storage account.

properties.storageAccountName
  • string

Storage account name of the source data set.

properties.subscriptionId
  • string

Subscription id of storage account.

type
  • string

Type of the azure resource

ADLSGen2FileSystemDataSetMapping

An ADLS Gen2 file system data set mapping.

Name Type Description
id
  • string

The resource id of the azure resource

kind string:
  • AdlsGen2FileSystem

Kind of data set mapping.

name
  • string

Name of the azure resource

properties.dataSetId
  • string

The id of the source data set.

properties.dataSetMappingStatus

Gets the status of the data set mapping.

properties.fileSystem
  • string

The file system name.

properties.provisioningState

Provisioning state of the data set mapping.

properties.resourceGroup
  • string

Resource group of storage account.

properties.storageAccountName
  • string

Storage account name of the source data set.

properties.subscriptionId
  • string

Subscription id of storage account.

type
  • string

Type of the azure resource

ADLSGen2FolderDataSetMapping

An ADLS Gen2 folder data set mapping.

Name Type Description
id
  • string

The resource id of the azure resource

kind string:
  • AdlsGen2Folder

Kind of data set mapping.

name
  • string

Name of the azure resource

properties.dataSetId
  • string

The id of the source data set.

properties.dataSetMappingStatus

Gets the status of the data set mapping.

properties.fileSystem
  • string

File system to which the folder belongs.

properties.folderPath
  • string

Folder path within the file system.

properties.provisioningState

Provisioning state of the data set mapping.

properties.resourceGroup
  • string

Resource group of storage account.

properties.storageAccountName
  • string

Storage account name of the source data set.

properties.subscriptionId
  • string

Subscription id of storage account.

type
  • string

Type of the azure resource

BlobContainerDataSetMapping

A Blob container data set mapping.

Name Type Description
id
  • string

The resource id of the azure resource

kind string:
  • Container

Kind of data set mapping.

name
  • string

Name of the azure resource

properties.containerName
  • string

BLOB Container name.

properties.dataSetId
  • string

The id of the source data set.

properties.dataSetMappingStatus

Gets the status of the data set mapping.

properties.provisioningState

Provisioning state of the data set mapping.

properties.resourceGroup
  • string

Resource group of storage account.

properties.storageAccountName
  • string

Storage account name of the source data set.

properties.subscriptionId
  • string

Subscription id of storage account.

type
  • string

Type of the azure resource

BlobDataSetMapping

A Blob data set mapping.

Name Type Description
id
  • string

The resource id of the azure resource

kind string:
  • Blob

Kind of data set mapping.

name
  • string

Name of the azure resource

properties.containerName
  • string

Container that has the file path.

properties.dataSetId
  • string

The id of the source data set.

properties.dataSetMappingStatus

Gets the status of the data set mapping.

properties.filePath
  • string

File path within the source data set

properties.outputType

File output type

properties.provisioningState

Provisioning state of the data set mapping.

properties.resourceGroup
  • string

Resource group of storage account.

properties.storageAccountName
  • string

Storage account name of the source data set.

properties.subscriptionId
  • string

Subscription id of storage account.

type
  • string

Type of the azure resource

BlobFolderDataSetMapping

A Blob folder data set mapping.

Name Type Description
id
  • string

The resource id of the azure resource

kind string:
  • BlobFolder

Kind of data set mapping.

name
  • string

Name of the azure resource

properties.containerName
  • string

Container that has the file path.

properties.dataSetId
  • string

The id of the source data set.

properties.dataSetMappingStatus

Gets the status of the data set mapping.

properties.prefix
  • string

Prefix for blob folder

properties.provisioningState

Provisioning state of the data set mapping.

properties.resourceGroup
  • string

Resource group of storage account.

properties.storageAccountName
  • string

Storage account name of the source data set.

properties.subscriptionId
  • string

Subscription id of storage account.

type
  • string

Type of the azure resource

dataSetMappingStatus

Gets the status of the data set mapping.

Name Type Description
Broken
  • string
Ok
  • string

DataShareError

The data share error model.

Name Type Description
error

The data share error body

DataShareErrorInfo

The data share error body model.

Name Type Description
code
  • string

Code of the error

details

Nested details of the error model

message
  • string

Message of the error

target
  • string

Target of the error

KustoClusterDataSetMapping

A Kusto cluster data set mapping

Name Type Description
id
  • string

The resource id of the azure resource

kind string:
  • KustoCluster

Kind of data set mapping.

name
  • string

Name of the azure resource

properties.dataSetId
  • string

The id of the source data set.

properties.dataSetMappingStatus

Gets the status of the data set mapping.

properties.kustoClusterResourceId
  • string

Resource id of the sink kusto cluster.

properties.location
  • string

Location of the sink kusto cluster.

properties.provisioningState

Provisioning state of the data set mapping.

type
  • string

Type of the azure resource

KustoDatabaseDataSetMapping

A Kusto database data set mapping

Name Type Description
id
  • string

The resource id of the azure resource

kind string:
  • KustoDatabase

Kind of data set mapping.

name
  • string

Name of the azure resource

properties.dataSetId
  • string

The id of the source data set.

properties.dataSetMappingStatus

Gets the status of the data set mapping.

properties.kustoClusterResourceId
  • string

Resource id of the sink kusto cluster.

properties.location
  • string

Location of the sink kusto cluster.

properties.provisioningState

Provisioning state of the data set mapping.

type
  • string

Type of the azure resource

outputType

Type of output file

Name Type Description
Csv
  • string
Parquet
  • string

provisioningState

Provisioning state of the Account

Name Type Description
Creating
  • string
Deleting
  • string
Failed
  • string
Moving
  • string
Succeeded
  • string

SqlDBTableDataSetMapping

A SQL DB Table data set mapping.

Name Type Description
id
  • string

The resource id of the azure resource

kind string:
  • SqlDBTable

Kind of data set mapping.

name
  • string

Name of the azure resource

properties.dataSetId
  • string

The id of the source data set.

properties.dataSetMappingStatus

Gets the status of the data set mapping.

properties.databaseName
  • string

DatabaseName name of the sink data set

properties.provisioningState

Provisioning state of the data set mapping.

properties.schemaName
  • string

Schema of the table. Default value is dbo.

properties.sqlServerResourceId
  • string

Resource id of SQL server

properties.tableName
  • string

SQL DB table name.

type
  • string

Type of the azure resource

SqlDWTableDataSetMapping

A SQL DW Table data set mapping.

Name Type Description
id
  • string

The resource id of the azure resource

kind string:
  • SqlDWTable

Kind of data set mapping.

name
  • string

Name of the azure resource

properties.dataSetId
  • string

The id of the source data set.

properties.dataSetMappingStatus

Gets the status of the data set mapping.

properties.dataWarehouseName
  • string

DataWarehouse name of the source data set

properties.provisioningState

Provisioning state of the data set mapping.

properties.schemaName
  • string

Schema of the table. Default value is dbo.

properties.sqlServerResourceId
  • string

Resource id of SQL server

properties.tableName
  • string

SQL DW table name.

type
  • string

Type of the azure resource