Data Set Mappings - Get

Referência

Service:: Data Share

API Version:: 2021-08-01

Obter DataSetMapping em um shareSubscription.
Obter um DataSetMapping em um shareSubscription

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
accountName	path	True	string	O nome da conta de compartilhamento.
dataSetMappingName	path	True	string	O nome do dataSetMapping.
resourceGroupName	path	True	string	O nome do grupo de recursos.
shareSubscriptionName	path	True	string	O nome da shareSubscription.
subscriptionId	path	True	string	O identificador de assinatura
api-version	query	True	string	A versão da API a ser usada.

Respostas

Nome	Tipo	Description
200 OK	DataSetMapping: ADLSGen2FileDataSetMapping ADLSGen2FileSystemDataSetMapping ADLSGen2FolderDataSetMapping BlobContainerDataSetMapping BlobDataSetMapping BlobFolderDataSetMapping KustoClusterDataSetMapping KustoDatabaseDataSetMapping KustoTableDataSetMapping SqlDBTableDataSetMapping SqlDWTableDataSetMapping SynapseWorkspaceSqlPoolTableDataSetMapping	Êxito
Other Status Codes	DataShareError	Uma resposta de erro recebida do provedor de recursos Microsoft.DataShare.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Definições

Nome	Description
ADLSGen2FileDataSetMapping	Um mapeamento de conjunto de dados de arquivo do ADLS Gen2.
ADLSGen2FileSystemDataSetMapping	Um mapeamento de conjunto de dados do sistema de arquivos do ADLS Gen2.
ADLSGen2FolderDataSetMapping	Um mapeamento de conjunto de dados de pasta do ADLS Gen2.
BlobContainerDataSetMapping	Um mapeamento de conjunto de dados de contêiner de Blob.
BlobDataSetMapping	Um mapeamento de conjunto de dados de blob.
BlobFolderDataSetMapping	Um mapeamento de conjunto de dados de pasta de Blob.
createdByType	O tipo de identidade que criou o recurso.
dataSetMappingStatus	Obtém o status do mapeamento do conjunto de dados.
DataShareError	O modelo de erro de compartilhamento de dados.
DataShareErrorInfo	O modelo do corpo do erro do compartilhamento de dados.
KustoClusterDataSetMapping	Um mapeamento de conjunto de dados do cluster Kusto
KustoDatabaseDataSetMapping	Um mapeamento de conjunto de dados do banco de dados Kusto
KustoTableDataSetMapping	Um mapeamento de conjunto de dados do banco de dados Kusto
lastModifiedByType	O tipo de identidade que modificou o recurso pela última vez.
outputType	Tipo de arquivo de saída
provisioningState	Estado de provisionamento da conta
SqlDBTableDataSetMapping	Um mapeamento de conjunto de dados da Tabela do BD SQL.
SqlDWTableDataSetMapping	Um mapeamento de conjunto de dados da Tabela do SQL DW.
SynapseWorkspaceSqlPoolTableDataSetMapping	Um mapeamento de conjunto de dados da Tabela do Pool de Sql do Workspace do Synapse
SystemData	Metadados relativos à criação e à última modificação do recurso.

ADLSGen2FileDataSetMapping

Um mapeamento de conjunto de dados de arquivo do ADLS Gen2.

Nome	Tipo	Description
id	string	A ID do recurso do azure
kind	string: AdlsGen2File	Tipo de mapeamento de conjunto de dados.
name	string	Nome do recurso do Azure
properties.dataSetId	string	A ID do conjunto de dados de origem.
properties.dataSetMappingStatus	dataSetMappingStatus	Obtém o status do mapeamento do conjunto de dados.
properties.filePath	string	Caminho do arquivo dentro do sistema de arquivos.
properties.fileSystem	string	Sistema de arquivos ao qual o arquivo pertence.
properties.outputType	outputType	Tipo de arquivo de saída
properties.provisioningState	provisioningState	Estado de provisionamento do mapeamento do conjunto de dados.
properties.resourceGroup	string	Grupo de recursos da conta de armazenamento.
properties.storageAccountName	string	Nome da conta de armazenamento do conjunto de dados de origem.
properties.subscriptionId	string	ID da assinatura da conta de armazenamento.
systemData	SystemData	Dados do sistema do recurso do Azure.
type	string	Tipo do recurso do Azure

ADLSGen2FileSystemDataSetMapping

Um mapeamento de conjunto de dados do sistema de arquivos do ADLS Gen2.

Nome	Tipo	Description
id	string	A ID do recurso do azure
kind	string: AdlsGen2FileSystem	Tipo de mapeamento de conjunto de dados.
name	string	Nome do recurso do Azure
properties.dataSetId	string	A ID do conjunto de dados de origem.
properties.dataSetMappingStatus	dataSetMappingStatus	Obtém o status do mapeamento do conjunto de dados.
properties.fileSystem	string	O nome do sistema de arquivos.
properties.provisioningState	provisioningState	Estado de provisionamento do mapeamento do conjunto de dados.
properties.resourceGroup	string	Grupo de recursos da conta de armazenamento.
properties.storageAccountName	string	Nome da conta de armazenamento do conjunto de dados de origem.
properties.subscriptionId	string	ID da assinatura da conta de armazenamento.
systemData	SystemData	Dados do sistema do recurso do Azure.
type	string	Tipo do recurso do Azure

ADLSGen2FolderDataSetMapping

Um mapeamento de conjunto de dados de pasta do ADLS Gen2.

Nome	Tipo	Description
id	string	A ID do recurso do azure
kind	string: AdlsGen2Folder	Tipo de mapeamento de conjunto de dados.
name	string	Nome do recurso do Azure
properties.dataSetId	string	A ID do conjunto de dados de origem.
properties.dataSetMappingStatus	dataSetMappingStatus	Obtém o status do mapeamento do conjunto de dados.
properties.fileSystem	string	Sistema de arquivos ao qual a pasta pertence.
properties.folderPath	string	Caminho da pasta dentro do sistema de arquivos.
properties.provisioningState	provisioningState	Estado de provisionamento do mapeamento do conjunto de dados.
properties.resourceGroup	string	Grupo de recursos da conta de armazenamento.
properties.storageAccountName	string	Nome da conta de armazenamento do conjunto de dados de origem.
properties.subscriptionId	string	ID da assinatura da conta de armazenamento.
systemData	SystemData	Dados do sistema do recurso do Azure.
type	string	Tipo do recurso do Azure

BlobContainerDataSetMapping

Um mapeamento de conjunto de dados de contêiner de Blob.

Nome	Tipo	Description
id	string	A ID do recurso do azure
kind	string: Container	Tipo de mapeamento de conjunto de dados.
name	string	Nome do recurso do Azure
properties.containerName	string	Nome do contêiner de BLOB.
properties.dataSetId	string	A ID do conjunto de dados de origem.
properties.dataSetMappingStatus	dataSetMappingStatus	Obtém o status do mapeamento do conjunto de dados.
properties.provisioningState	provisioningState	Estado de provisionamento do mapeamento do conjunto de dados.
properties.resourceGroup	string	Grupo de recursos da conta de armazenamento.
properties.storageAccountName	string	Nome da conta de armazenamento do conjunto de dados de origem.
properties.subscriptionId	string	ID da assinatura da conta de armazenamento.
systemData	SystemData	Dados do sistema do recurso do Azure.
type	string	Tipo do recurso do Azure

BlobDataSetMapping

Um mapeamento de conjunto de dados de blob.

Nome	Tipo	Description
id	string	A ID do recurso do azure
kind	string: Blob	Tipo de mapeamento de conjunto de dados.
name	string	Nome do recurso do Azure
properties.containerName	string	Contêiner que tem o caminho do arquivo.
properties.dataSetId	string	A ID do conjunto de dados de origem.
properties.dataSetMappingStatus	dataSetMappingStatus	Obtém o status do mapeamento do conjunto de dados.
properties.filePath	string	Caminho do arquivo dentro do conjunto de dados de origem
properties.outputType	outputType	Tipo de saída de arquivo
properties.provisioningState	provisioningState	Estado de provisionamento do mapeamento do conjunto de dados.
properties.resourceGroup	string	Grupo de recursos da conta de armazenamento.
properties.storageAccountName	string	Nome da conta de armazenamento do conjunto de dados de origem.
properties.subscriptionId	string	ID da assinatura da conta de armazenamento.
systemData	SystemData	Dados do sistema do recurso do Azure.
type	string	Tipo do recurso do Azure

BlobFolderDataSetMapping

Um mapeamento de conjunto de dados de pasta de Blob.

Nome	Tipo	Description
id	string	A ID do recurso do azure
kind	string: BlobFolder	Tipo de mapeamento de conjunto de dados.
name	string	Nome do recurso do Azure
properties.containerName	string	Contêiner que tem o caminho do arquivo.
properties.dataSetId	string	A ID do conjunto de dados de origem.
properties.dataSetMappingStatus	dataSetMappingStatus	Obtém o status do mapeamento do conjunto de dados.
properties.prefix	string	Prefixo para pasta de blob
properties.provisioningState	provisioningState	Estado de provisionamento do mapeamento do conjunto de dados.
properties.resourceGroup	string	Grupo de recursos da conta de armazenamento.
properties.storageAccountName	string	Nome da conta de armazenamento do conjunto de dados de origem.
properties.subscriptionId	string	ID da assinatura da conta de armazenamento.
systemData	SystemData	Dados do sistema do recurso do Azure.
type	string	Tipo do recurso do Azure

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

dataSetMappingStatus

Obtém o status do mapeamento do conjunto de dados.

Nome	Tipo	Description
Broken	string
Ok	string

DataShareError

O modelo de erro de compartilhamento de dados.

Nome	Tipo	Description
error	DataShareErrorInfo	O corpo do erro do compartilhamento de dados

DataShareErrorInfo

O modelo do corpo do erro do compartilhamento de dados.

Nome	Tipo	Description
code	string	Código do erro
details	DataShareErrorInfo[]	Detalhes aninhados do modelo de erro
message	string	Mensagem do erro
target	string	Destino do erro

KustoClusterDataSetMapping

Um mapeamento de conjunto de dados do cluster Kusto

Nome	Tipo	Description
id	string	A ID do recurso do azure
kind	string: KustoCluster	Tipo de mapeamento de conjunto de dados.
name	string	Nome do recurso do Azure
properties.dataSetId	string	A ID do conjunto de dados de origem.
properties.dataSetMappingStatus	dataSetMappingStatus	Obtém o status do mapeamento do conjunto de dados.
properties.kustoClusterResourceId	string	ID do recurso do cluster kusto do coletor.
properties.location	string	Local do cluster kusto do coletor.
properties.provisioningState	provisioningState	Estado de provisionamento do mapeamento do conjunto de dados.
systemData	SystemData	Dados do sistema do recurso do Azure.
type	string	Tipo do recurso do Azure

KustoDatabaseDataSetMapping

Um mapeamento de conjunto de dados do banco de dados Kusto

Nome	Tipo	Description
id	string	A ID do recurso do azure
kind	string: KustoDatabase	Tipo de mapeamento de conjunto de dados.
name	string	Nome do recurso do Azure
properties.dataSetId	string	A ID do conjunto de dados de origem.
properties.dataSetMappingStatus	dataSetMappingStatus	Obtém o status do mapeamento do conjunto de dados.
properties.kustoClusterResourceId	string	ID do recurso do cluster kusto do coletor.
properties.location	string	Local do cluster kusto do coletor.
properties.provisioningState	provisioningState	Estado de provisionamento do mapeamento do conjunto de dados.
systemData	SystemData	Dados do sistema do recurso do Azure.
type	string	Tipo do recurso do Azure

KustoTableDataSetMapping

Um mapeamento de conjunto de dados do banco de dados Kusto

Nome	Tipo	Description
id	string	A ID do recurso do azure
kind	string: KustoTable	Tipo de mapeamento de conjunto de dados.
name	string	Nome do recurso do Azure
properties.dataSetId	string	A ID do conjunto de dados de origem.
properties.dataSetMappingStatus	dataSetMappingStatus	Obtém o status do mapeamento do conjunto de dados.
properties.kustoClusterResourceId	string	ID do recurso do cluster kusto do coletor.
properties.location	string	Local do cluster kusto do coletor.
properties.provisioningState	provisioningState	Estado de provisionamento do mapeamento do conjunto de dados.
systemData	SystemData	Dados do sistema do recurso do Azure.
type	string	Tipo do recurso do Azure

lastModifiedByType

O tipo de identidade que modificou o recurso pela última vez.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

outputType

Tipo de arquivo de saída

Nome	Tipo	Description
Csv	string
Parquet	string

provisioningState

Estado de provisionamento da conta

Nome	Tipo	Description
Creating	string
Deleting	string
Failed	string
Moving	string
Succeeded	string

SqlDBTableDataSetMapping

Um mapeamento de conjunto de dados da Tabela do BD SQL.

Nome	Tipo	Description
id	string	A ID do recurso do azure
kind	string: SqlDBTable	Tipo de mapeamento de conjunto de dados.
name	string	Nome do recurso do Azure
properties.dataSetId	string	A ID do conjunto de dados de origem.
properties.dataSetMappingStatus	dataSetMappingStatus	Obtém o status do mapeamento do conjunto de dados.
properties.databaseName	string	Nome de DatabaseName do conjunto de dados do coletor
properties.provisioningState	provisioningState	Estado de provisionamento do mapeamento do conjunto de dados.
properties.schemaName	string	Esquema da tabela. O valor padrão é dbo.
properties.sqlServerResourceId	string	ID do recurso do SQL Server
properties.tableName	string	Nome da tabela do BD SQL.
systemData	SystemData	Dados do sistema do recurso do Azure.
type	string	Tipo do recurso do Azure

SqlDWTableDataSetMapping

Um mapeamento de conjunto de dados da Tabela do SQL DW.

Nome	Tipo	Description
id	string	A ID do recurso do azure
kind	string: SqlDWTable	Tipo de mapeamento de conjunto de dados.
name	string	Nome do recurso do Azure
properties.dataSetId	string	A ID do conjunto de dados de origem.
properties.dataSetMappingStatus	dataSetMappingStatus	Obtém o status do mapeamento do conjunto de dados.
properties.dataWarehouseName	string	Nome do DataWarehouse do conjunto de dados de origem
properties.provisioningState	provisioningState	Estado de provisionamento do mapeamento do conjunto de dados.
properties.schemaName	string	Esquema da tabela. O valor padrão é dbo.
properties.sqlServerResourceId	string	ID do recurso do SQL Server
properties.tableName	string	Nome da tabela do SQL DW.
systemData	SystemData	Dados do sistema do recurso do Azure.
type	string	Tipo do recurso do Azure

SynapseWorkspaceSqlPoolTableDataSetMapping

Um mapeamento de conjunto de dados da Tabela do Pool de Sql do Workspace do Synapse

Nome	Tipo	Description
id	string	A ID do recurso do azure
kind	string: SynapseWorkspaceSqlPoolTable	Tipo de mapeamento de conjunto de dados.
name	string	Nome do recurso do Azure
properties.dataSetId	string	A ID do conjunto de dados de origem.
properties.dataSetMappingStatus	dataSetMappingStatus	Obtém o status do mapeamento do conjunto de dados.
properties.provisioningState	provisioningState	Estado de provisionamento do mapeamento do conjunto de dados.
properties.synapseWorkspaceSqlPoolTableResourceId	string	ID do recurso da Tabela do Pool de SQL do Workspace do Synapse
systemData	SystemData	Dados do sistema do recurso do Azure.
type	string	Tipo do recurso do Azure

SystemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O tipo de identidade que modificou o recurso pela última vez.
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	lastModifiedByType	O tipo de identidade que modificou o recurso pela última vez.