Data Set Mappings - Get

Reference

Service:: Data Share

API Version:: 2021-08-01

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=2021-08-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: ADLSGen2FileDataSetMapping ADLSGen2FileSystemDataSetMapping ADLSGen2FolderDataSetMapping BlobContainerDataSetMapping BlobDataSetMapping BlobFolderDataSetMapping KustoClusterDataSetMapping KustoDatabaseDataSetMapping KustoTableDataSetMapping SqlDBTableDataSetMapping SqlDWTableDataSetMapping SynapseWorkspaceSqlPoolTableDataSetMapping	Success
Other Status Codes	DataShareError	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

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataShare;
using Azure.ResourceManager.DataShare.Models;

// Generated from example definition: specification/datashare/resource-manager/Microsoft.DataShare/stable/2021-08-01/examples/DataSetMappings_Get.json
// this example is just showing the usage of "DataSetMappings_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ShareSubscriptionResource created on azure
// for more information of creating ShareSubscriptionResource, please refer to the document of ShareSubscriptionResource
string subscriptionId = "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a";
string resourceGroupName = "SampleResourceGroup";
string accountName = "Account1";
string shareSubscriptionName = "ShareSubscription1";
ResourceIdentifier shareSubscriptionResourceId = ShareSubscriptionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, shareSubscriptionName);
ShareSubscriptionResource shareSubscription = client.GetShareSubscriptionResource(shareSubscriptionResourceId);

// get the collection of this ShareDataSetMappingResource
ShareDataSetMappingCollection collection = shareSubscription.GetShareDataSetMappings();

// invoke the operation
string dataSetMappingName = "DatasetMapping1";
NullableResponse<ShareDataSetMappingResource> response = await collection.GetIfExistsAsync(dataSetMappingName);
ShareDataSetMappingResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ShareDataSetMappingData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

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

Response Body

{
  "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

Name	Description
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.
createdByType	The type of identity that created the resource.
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
KustoTableDataSetMapping	A Kusto database data set mapping
lastModifiedByType	The type of identity that last modified the resource.
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.
SynapseWorkspaceSqlPoolTableDataSetMapping	A Synapse Workspace Sql Pool Table data set mapping
SystemData	Metadata pertaining to creation and last modification of the resource.

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	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	outputType	Type of output file
properties.provisioningState	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.
systemData	SystemData	System Data of the Azure resource.
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	dataSetMappingStatus	Gets the status of the data set mapping.
properties.fileSystem	string	The file system name.
properties.provisioningState	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.
systemData	SystemData	System Data of the Azure resource.
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	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	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.
systemData	SystemData	System Data of the Azure resource.
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	dataSetMappingStatus	Gets the status of the data set mapping.
properties.provisioningState	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.
systemData	SystemData	System Data of the Azure resource.
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	dataSetMappingStatus	Gets the status of the data set mapping.
properties.filePath	string	File path within the source data set
properties.outputType	outputType	File output type
properties.provisioningState	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.
systemData	SystemData	System Data of the Azure resource.
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	dataSetMappingStatus	Gets the status of the data set mapping.
properties.prefix	string	Prefix for blob folder
properties.provisioningState	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.
systemData	SystemData	System Data of the Azure resource.
type	string	Type of the azure resource

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

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	DataShareErrorInfo	The data share error body

DataShareErrorInfo

The data share error body model.

Name	Type	Description
code	string	Code of the error
details	DataShareErrorInfo[]	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	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	provisioningState	Provisioning state of the data set mapping.
systemData	SystemData	System Data of the Azure resource.
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	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	provisioningState	Provisioning state of the data set mapping.
systemData	SystemData	System Data of the Azure resource.
type	string	Type of the azure resource

KustoTableDataSetMapping

A Kusto database data set mapping

Name	Type	Description
id	string	The resource id of the azure resource
kind	string: KustoTable	Kind of data set mapping.
name	string	Name of the azure resource
properties.dataSetId	string	The id of the source data set.
properties.dataSetMappingStatus	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	provisioningState	Provisioning state of the data set mapping.
systemData	SystemData	System Data of the Azure resource.
type	string	Type of the azure resource

lastModifiedByType

The type of identity that last modified the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

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	dataSetMappingStatus	Gets the status of the data set mapping.
properties.databaseName	string	DatabaseName name of the sink data set
properties.provisioningState	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.
systemData	SystemData	System Data of the Azure resource.
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	dataSetMappingStatus	Gets the status of the data set mapping.
properties.dataWarehouseName	string	DataWarehouse name of the source data set
properties.provisioningState	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.
systemData	SystemData	System Data of the Azure resource.
type	string	Type of the azure resource

SynapseWorkspaceSqlPoolTableDataSetMapping

A Synapse Workspace Sql Pool Table data set mapping

Name	Type	Description
id	string	The resource id of the azure resource
kind	string: SynapseWorkspaceSqlPoolTable	Kind of data set mapping.
name	string	Name of the azure resource
properties.dataSetId	string	The id of the source data set.
properties.dataSetMappingStatus	dataSetMappingStatus	Gets the status of the data set mapping.
properties.provisioningState	provisioningState	Provisioning state of the data set mapping.
properties.synapseWorkspaceSqlPoolTableResourceId	string	Resource id of the Synapse Workspace SQL Pool Table
systemData	SystemData	System Data of the Azure resource.
type	string	Type of the azure resource

SystemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The type of identity that last modified the resource.
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	lastModifiedByType	The type of identity that last modified the resource.