Dataset - Get

Aplica-se a: consulte os tipos de preços.

O criador possibilita desenvolver aplicativos com base em seus dados de mapa privados internos usando Azure Mapas API e SDK. Este artigo apresenta conceitos e ferramentas que se aplicam a Azure Mapas Criador.

Essa API permite que o chamador busque um conjunto de dados criado com êxito.

Enviar Solicitação Obter Detalhes

Para obter os detalhes de um conjunto de dados criado anteriormente, você emitirá uma solicitação GET com o datasetId caminho.

Obter resposta de detalhes

A API Obter Detalhes retorna os detalhes de um conjunto de dados no json formato. A resposta contém os campos a seguir (se eles não forem nulos ou vazios):

criado - O carimbo de data/hora em que o conjunto de dados foi criado. datasetId – A ID do conjunto de dados. descrição – A descrição do conjunto de dados. datasetSources - Os dados de origem usados quando a solicitação de criação foi emitida. ontologia – a ontologia de origem usada no serviço de conversão para os dados de entrada.

Descreve datasetSources os dados de origem usados quando a solicitação de criação foi emitida e contém os seguintes elementos (se eles não forem nulos ou vazios):

conversionIds - A lista de conversionId (nulo se nenhum tiver sido fornecido). appendDatasetId - O datasetId que foi usado para uma operação de acréscimo (nulo se nenhum foi usado). featureCounts - As contagens para cada tipo de recurso no conjunto de dados.

Aqui está uma resposta de exemplo que retorna o timestamprecurso , datasetIde datasetSourcesdescriptionontology de um conjunto de dados:

{
   "timestamp": "2020-01-01T22:50:48.123Z",
   "datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
   "description": "Some description or comment for the dataset.",
   "datasetSources": {
     "conversionIds": [
       "15d21452-c9bb-27b6-5e79-743ca5c3205d"
     ],
   },
   "ontology": "facility-2.0",
   "featureCounts": {
     "directoryInfo": 2,
     "category": 10,
     "facility": 1,
     "level": 3,
     "unit": 183,
     "zone": 3,
     "verticalPenetration": 6,
     "opening": 48,
     "areaElement": 108
   }
 }
GET https://{geography}.atlas.microsoft.com/datasets/{datasetId}?api-version=2.0

Parâmetros de URI

Name In Required Type Description
datasetId
path True
  • string

O identificador do conjunto de dados do qual consultar.

geography
path True
  • string

Esse parâmetro especifica onde o recurso Azure Mapas Criador está localizado. Valores válidos são nós e eu.

api-version
query True
  • string

Número de versão da API de Mapas Azure.

Cabeçalho da solicitação

Name Required Type Description
x-ms-client-id
  • string

Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Azure AD. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperada da API de Conta do plano de gerenciamento Azure Mapas. Para usar Azure AD segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Respostas

Name Type Description
200 OK

A solicitação obter conjunto de dados foi concluída com êxito.

Other Status Codes

Erro inesperado.

Segurança

AADToken

Estes são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode ter acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.

Observações

  • Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual recurso Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações do Azure Active Directory. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

  • Atualmente, o Azure Active Directory v1.0 ou v2.0 dá suporte a Trabalho, Escola e Convidados, mas não dá suporte a contas pessoais.

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

Scopes

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Essa é uma chave compartilhada que é provisionada quando você cria uma conta Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta na qual elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar Azure Mapas APIs REST para que sua chave possa ser armazenada com segurança.

Type: apiKey
In: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação sas de lista no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado à expiração, taxa e região(s) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta de mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.

Type: apiKey
In: header

Exemplos

Get details for a previously created dataset

Sample Request

GET https://us.atlas.microsoft.com/datasets/[datasetId]?api-version=2.0

Sample Response

Location: https://us.atlas.microsoft.com/dataset/{datasetId}?api-version=1.0
Access-Control-Expose-Headers: Resource-Location
{
  "created": "2021-05-21T01:02:03.456Z",
  "datasetId": "[datasetId]",
  "description": "Some description or comment about the dataset",
  "datasetSources": {
    "conversionIds": [
      "15d21452-c9bb-27b6-5e79-743ca5c3205d",
      "c39de51c-b4f5-4733-aeeb-d8cb6f8b2f1d"
    ],
    "appendDatasetId": "6a49a490-1d9c-4f05-bf1e-51998fbc4733"
  },
  "featureCounts": {
    "directoryInfo": 2,
    "category": 10,
    "facility": 1,
    "level": 3,
    "unit": 183,
    "zone": 3,
    "verticalPenetration": 6,
    "opening": 48,
    "areaElement": 108
  },
  "ontology": "facility-2.0"
}

Definições

Dataset

Informações detalhadas do conjunto de dados.

DatasetSources

Informações sobre os detalhes da solicitação create para o conjunto de dados.

ErrorAdditionalInfo

As informações adicionais de erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

Dataset

Informações detalhadas do conjunto de dados.

Name Type Description
created
  • string

O carimbo de data/hora criado para o conjunto de dados.

datasetId
  • string

A ID do conjunto de dados.

datasetSources

Informações sobre os detalhes da solicitação create para o conjunto de dados.

description
  • string

A descrição do conjunto de dados.

featureCounts
  • object

O recurso conta para o conjunto de dados.

ontology
  • string

A versão de ontologia desse conjunto de dados.

DatasetSources

Informações sobre os detalhes da solicitação create para o conjunto de dados.

Name Type Description
appendDatasetId
  • string

O conjunto de dados que foi acrescentado para criar o conjunto de dados atual.

conversionIds
  • string[]

A lista que foi usada para criar o conjunto de conversionId dados.

ErrorAdditionalInfo

As informações adicionais de erro de gerenciamento de recursos.

Name Type Description
info
  • object

As informações adicionais.

type
  • string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Type Description
additionalInfo

As informações adicionais do erro.

code
  • string

O código de erro.

details

Os detalhes do erro.

message
  • string

A mensagem de erro.

target
  • string

O destino do erro.

ErrorResponse

Resposta de erro

Name Type Description
error

O objeto de erro.