Data Set Mappings - Get

Referenz

Service:: Data Share

API Version:: 2020-09-01

Rufen Sie DataSetMapping in einer shareSubscription ab.
Abrufen eines DataSetMapping in einer shareSubscription

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string	Der Name des Freigabekontos.
dataSetMappingName	path	True	string	Der Name des dataSetMapping.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
shareSubscriptionName	path	True	string	Der Name der shareSubscription.
subscriptionId	path	True	string	Der Abonnementbezeichner
api-version	query	True	string	Die zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	DataSetMapping: ADLSGen2FileDataSetMapping ADLSGen2FileSystemDataSetMapping ADLSGen2FolderDataSetMapping BlobContainerDataSetMapping BlobDataSetMapping BlobFolderDataSetMapping KustoClusterDataSetMapping KustoDatabaseDataSetMapping SqlDBTableDataSetMapping SqlDWTableDataSetMapping SynapseWorkspaceSqlPoolTableDataSetMapping	Erfolg
Other Status Codes	DataShareError	Eine Vom Microsoft.DataShare-Ressourcenanbieter empfangene Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Annehmen der Identität Ihres Benutzerkontos

Beispiele

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=2020-09-01

from azure.identity import DefaultAzureCredential
from azure.mgmt.datashare import DataShareManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datashare
# USAGE
    python data_set_mappings_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataShareManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="433a8dfd-e5d5-4e77-ad86-90acdc75eb1a",
    )

    response = client.data_set_mappings.get(
        resource_group_name="SampleResourceGroup",
        account_name="Account1",
        share_subscription_name="ShareSubscription1",
        data_set_mapping_name="DatasetMapping1",
    )
    print(response)


# x-ms-original-file: specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSetMappings_Get.json
if __name__ == "__main__":
    main()

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

package armdatashare_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datashare/armdatashare"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/datashare/resource-manager/Microsoft.DataShare/stable/2020-09-01/examples/DataSetMappings_Get.json
func ExampleDataSetMappingsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatashare.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataSetMappingsClient().Get(ctx, "SampleResourceGroup", "Account1", "ShareSubscription1", "DatasetMapping1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatashare.DataSetMappingsClientGetResponse{
	// 	                            DataSetMappingClassification: &armdatashare.BlobDataSetMapping{
	// 		Name: to.Ptr("DatasetMapping1"),
	// 		Type: to.Ptr("Microsoft.DataShare/accounts/shareSubscriptions/dataSetMappings"),
	// 		ID: to.Ptr("/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1"),
	// 		Kind: to.Ptr(armdatashare.DataSetMappingKindBlob),
	// 		Properties: &armdatashare.BlobMappingProperties{
	// 			ContainerName: to.Ptr("C1"),
	// 			DataSetID: to.Ptr("a08f184b-0567-4b11-ba22-a1199336d226"),
	// 			FilePath: to.Ptr("file21"),
	// 			ResourceGroup: to.Ptr("SampleResourceGroup"),
	// 			StorageAccountName: to.Ptr("storage2"),
	// 			SubscriptionID: to.Ptr("433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"),
	// 		},
	// 	},
	// 	                        }
}

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

Definitionen

Name	Beschreibung
ADLSGen2FileDataSetMapping	Eine ADLS Gen2-Dateidatensatzzuordnung.
ADLSGen2FileSystemDataSetMapping	Eine ADLS Gen2-Dateisystemdatensatzzuordnung.
ADLSGen2FolderDataSetMapping	Eine ADLS Gen2-Ordner-Datasetzuordnung.
BlobContainerDataSetMapping	Zuordnung eines Blobcontainer-Datasets.
BlobDataSetMapping	Eine Blob-Datasetzuordnung.
BlobFolderDataSetMapping	Eine Datasetzuordnung für Blobordner.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
dataSetMappingStatus	Ruft die status der Datasetzuordnung ab.
DataShareError	Das Datenfreigabefehlermodell.
DataShareErrorInfo	Das Datenfreigabefehlermodell.
KustoClusterDataSetMapping	Zuordnung eines Kusto-Clusterdatensatzes
KustoDatabaseDataSetMapping	Eine Kusto-Datenbank-Datasetzuordnung
lastModifiedByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.
outputType	Typ der Ausgabedatei
provisioningState	Bereitstellungsstatus des Kontos
SqlDBTableDataSetMapping	Eine SQL DB-Tabellendatensatzzuordnung.
SqlDWTableDataSetMapping	Eine SQL DW-Tabellendatensatzzuordnung.
SynapseWorkspaceSqlPoolTableDataSetMapping	Sql-Pooltabellen-Datasetzuordnung für den Synapse-Arbeitsbereich
SystemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

ADLSGen2FileDataSetMapping

Eine ADLS Gen2-Dateidatensatzzuordnung.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID der Azure-Ressource
kind	string: AdlsGen2File	Art der Datasetzuordnung.
name	string	Name der Azure-Ressource
properties.dataSetId	string	Die ID des Quelldatasets.
properties.dataSetMappingStatus	dataSetMappingStatus	Ruft die status der Datasetzuordnung ab.
properties.filePath	string	Dateipfad innerhalb des Dateisystems.
properties.fileSystem	string	Dateisystem, zu dem die Datei gehört.
properties.outputType	outputType	Typ der Ausgabedatei
properties.provisioningState	provisioningState	Bereitstellungsstatus der Datasetzuordnung.
properties.resourceGroup	string	Ressourcengruppe des Speicherkontos.
properties.storageAccountName	string	Speicherkontoname des Quelldatasets.
properties.subscriptionId	string	Abonnement-ID des Speicherkontos.
systemData	SystemData	Systemdaten der Azure-Ressource.
type	string	Typ der Azure-Ressource

ADLSGen2FileSystemDataSetMapping

Eine ADLS Gen2-Dateisystemdatensatzzuordnung.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID der Azure-Ressource
kind	string: AdlsGen2FileSystem	Art der Datasetzuordnung.
name	string	Name der Azure-Ressource
properties.dataSetId	string	Die ID des Quelldatasets.
properties.dataSetMappingStatus	dataSetMappingStatus	Ruft die status der Datasetzuordnung ab.
properties.fileSystem	string	Der Name des Dateisystems.
properties.provisioningState	provisioningState	Bereitstellungsstatus der Datasetzuordnung.
properties.resourceGroup	string	Ressourcengruppe des Speicherkontos.
properties.storageAccountName	string	Speicherkontoname des Quelldatasets.
properties.subscriptionId	string	Abonnement-ID des Speicherkontos.
systemData	SystemData	Systemdaten der Azure-Ressource.
type	string	Typ der Azure-Ressource

ADLSGen2FolderDataSetMapping

Eine ADLS Gen2-Ordner-Datasetzuordnung.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID der Azure-Ressource
kind	string: AdlsGen2Folder	Art der Datasetzuordnung.
name	string	Name der Azure-Ressource
properties.dataSetId	string	Die ID des Quelldatasets.
properties.dataSetMappingStatus	dataSetMappingStatus	Ruft die status der Datasetzuordnung ab.
properties.fileSystem	string	Dateisystem, zu dem der Ordner gehört.
properties.folderPath	string	Ordnerpfad innerhalb des Dateisystems.
properties.provisioningState	provisioningState	Bereitstellungsstatus der Datasetzuordnung.
properties.resourceGroup	string	Ressourcengruppe des Speicherkontos.
properties.storageAccountName	string	Speicherkontoname des Quelldatasets.
properties.subscriptionId	string	Abonnement-ID des Speicherkontos.
systemData	SystemData	Systemdaten der Azure-Ressource.
type	string	Typ der Azure-Ressource

BlobContainerDataSetMapping

Zuordnung eines Blobcontainer-Datasets.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID der Azure-Ressource
kind	string: Container	Art der Datasetzuordnung.
name	string	Name der Azure-Ressource
properties.containerName	string	BLOB-Containername.
properties.dataSetId	string	Die ID des Quelldatasets.
properties.dataSetMappingStatus	dataSetMappingStatus	Ruft die status der Datasetzuordnung ab.
properties.provisioningState	provisioningState	Bereitstellungsstatus der Datasetzuordnung.
properties.resourceGroup	string	Ressourcengruppe des Speicherkontos.
properties.storageAccountName	string	Speicherkontoname des Quelldatasets.
properties.subscriptionId	string	Abonnement-ID des Speicherkontos.
systemData	SystemData	Systemdaten der Azure-Ressource.
type	string	Typ der Azure-Ressource

BlobDataSetMapping

Eine Blob-Datasetzuordnung.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID der Azure-Ressource
kind	string: Blob	Art der Datasetzuordnung.
name	string	Name der Azure-Ressource
properties.containerName	string	Container mit dem Dateipfad.
properties.dataSetId	string	Die ID des Quelldatasets.
properties.dataSetMappingStatus	dataSetMappingStatus	Ruft die status der Datasetzuordnung ab.
properties.filePath	string	Dateipfad innerhalb des Quelldatasets
properties.outputType	outputType	Dateiausgabetyp
properties.provisioningState	provisioningState	Bereitstellungsstatus der Datasetzuordnung.
properties.resourceGroup	string	Ressourcengruppe des Speicherkontos.
properties.storageAccountName	string	Speicherkontoname des Quelldatasets.
properties.subscriptionId	string	Abonnement-ID des Speicherkontos.
systemData	SystemData	Systemdaten der Azure-Ressource.
type	string	Typ der Azure-Ressource

BlobFolderDataSetMapping

Eine Datasetzuordnung für Blobordner.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID der Azure-Ressource
kind	string: BlobFolder	Art der Datasetzuordnung.
name	string	Name der Azure-Ressource
properties.containerName	string	Container mit dem Dateipfad.
properties.dataSetId	string	Die ID des Quelldatasets.
properties.dataSetMappingStatus	dataSetMappingStatus	Ruft die status der Datasetzuordnung ab.
properties.prefix	string	Präfix für Blobordner
properties.provisioningState	provisioningState	Bereitstellungsstatus der Datasetzuordnung.
properties.resourceGroup	string	Ressourcengruppe des Speicherkontos.
properties.storageAccountName	string	Speicherkontoname des Quelldatasets.
properties.subscriptionId	string	Abonnement-ID des Speicherkontos.
systemData	SystemData	Systemdaten der Azure-Ressource.
type	string	Typ der Azure-Ressource

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

dataSetMappingStatus

Ruft die status der Datasetzuordnung ab.

Name	Typ	Beschreibung
Broken	string
Ok	string

DataShareError

Das Datenfreigabefehlermodell.

Name	Typ	Beschreibung
error	DataShareErrorInfo	Fehlertext der Datenfreigabe

DataShareErrorInfo

Das Datenfreigabefehlermodell.

Name	Typ	Beschreibung
code	string	Code des Fehlers
details	DataShareErrorInfo[]	Geschachtelte Details des Fehlermodells
message	string	Meldung des Fehlers
target	string	Ziel des Fehlers

KustoClusterDataSetMapping

Zuordnung eines Kusto-Clusterdatensatzes

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID der Azure-Ressource
kind	string: KustoCluster	Art der Datasetzuordnung.
name	string	Name der Azure-Ressource
properties.dataSetId	string	Die ID des Quelldatasets.
properties.dataSetMappingStatus	dataSetMappingStatus	Ruft die status der Datasetzuordnung ab.
properties.kustoClusterResourceId	string	Ressourcen-ID des Kusto-Senkenclusters.
properties.location	string	Speicherort des Kusto-Senkenclusters.
properties.provisioningState	provisioningState	Bereitstellungsstatus der Datasetzuordnung.
systemData	SystemData	Systemdaten der Azure-Ressource.
type	string	Typ der Azure-Ressource

KustoDatabaseDataSetMapping

Eine Kusto-Datenbank-Datasetzuordnung

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID der Azure-Ressource
kind	string: KustoDatabase	Art der Datasetzuordnung.
name	string	Name der Azure-Ressource
properties.dataSetId	string	Die ID des Quelldatasets.
properties.dataSetMappingStatus	dataSetMappingStatus	Ruft die status der Datasetzuordnung ab.
properties.kustoClusterResourceId	string	Ressourcen-ID des Kusto-Senkenclusters.
properties.location	string	Speicherort des Kusto-Senkenclusters.
properties.provisioningState	provisioningState	Bereitstellungsstatus der Datasetzuordnung.
systemData	SystemData	Systemdaten der Azure-Ressource.
type	string	Typ der Azure-Ressource

lastModifiedByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

outputType

Typ der Ausgabedatei

Name	Typ	Beschreibung
Csv	string
Parquet	string

provisioningState

Bereitstellungsstatus des Kontos

Name	Typ	Beschreibung
Creating	string
Deleting	string
Failed	string
Moving	string
Succeeded	string

SqlDBTableDataSetMapping

Eine SQL DB-Tabellendatensatzzuordnung.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID der Azure-Ressource
kind	string: SqlDBTable	Art der Datasetzuordnung.
name	string	Name der Azure-Ressource
properties.dataSetId	string	Die ID des Quelldatasets.
properties.dataSetMappingStatus	dataSetMappingStatus	Ruft die status der Datasetzuordnung ab.
properties.databaseName	string	DatabaseName name des Senkendatensatzes
properties.provisioningState	provisioningState	Bereitstellungsstatus der Datasetzuordnung.
properties.schemaName	string	Das Schema der Tabelle. Der Standardwert ist dbo.
properties.sqlServerResourceId	string	Ressourcen-ID von SQL Server
properties.tableName	string	SQL DB-Tabellenname.
systemData	SystemData	Systemdaten der Azure-Ressource.
type	string	Typ der Azure-Ressource

SqlDWTableDataSetMapping

Eine SQL DW-Tabellendatensatzzuordnung.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID der Azure-Ressource
kind	string: SqlDWTable	Art der Datasetzuordnung.
name	string	Name der Azure-Ressource
properties.dataSetId	string	Die ID des Quelldatasets.
properties.dataSetMappingStatus	dataSetMappingStatus	Ruft die status der Datasetzuordnung ab.
properties.dataWarehouseName	string	DataWarehouse-Name des Quelldatasets
properties.provisioningState	provisioningState	Bereitstellungsstatus der Datasetzuordnung.
properties.schemaName	string	Das Schema der Tabelle. Der Standardwert ist dbo.
properties.sqlServerResourceId	string	Ressourcen-ID von SQL Server
properties.tableName	string	SQL DW-Tabellenname.
systemData	SystemData	Systemdaten der Azure-Ressource.
type	string	Typ der Azure-Ressource

SynapseWorkspaceSqlPoolTableDataSetMapping

Sql-Pooltabellen-Datasetzuordnung für den Synapse-Arbeitsbereich

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID der Azure-Ressource
kind	string: SynapseWorkspaceSqlPoolTable	Art der Datasetzuordnung.
name	string	Name der Azure-Ressource
properties.dataSetId	string	Die ID des Quelldatasets.
properties.dataSetMappingStatus	dataSetMappingStatus	Ruft die status der Datasetzuordnung ab.
properties.provisioningState	provisioningState	Bereitstellungsstatus der Datasetzuordnung.
properties.synapseWorkspaceSqlPoolTableResourceId	string	Ressourcen-ID der SQL-Pooltabelle des Synapse-Arbeitsbereichs
systemData	SystemData	Systemdaten der Azure-Ressource.
type	string	Typ der Azure-Ressource

SystemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Identitätstyp, der die Ressource zuletzt geändert hat.
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	lastModifiedByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.