Data - List Preview

Referência

Service:: Maps

API Version:: 1.0

A solicitação Lista permite que o chamador busque uma lista de todo o conteúdo carregado anteriormente usando o Carregamento de Dados.
Aplica-se a: Tipo de preço S1.

Essa API permite que o chamador busque uma lista de todo o conteúdo carregado anteriormente usando a API de Upload de Dados.

Observação

Desativação do serviço Dados do Azure Mapas

O serviço Dados do Azure Mapas (v1 e v2) foi preterido e será desativado em 16/09/24. Para evitar interrupções de serviço, todas as chamadas ao Serviço de Dados precisarão ser atualizadas para usar o serviço de Registro de Dados do Azure Mapas até 16/09/24. Para obter mais informações, confira Como criar um registro de dados.

Enviar Solicitação de Lista

Para listar todo o conteúdo de dados do mapa, você emitirá uma solicitação GET sem parâmetros adicionais.

Listar resposta de dados

A API de Lista de Dados retorna a lista completa de todos os dados em json formato. A resposta contém os seguintes detalhes para cada recurso de dados:

udid - A ID de dados exclusiva para o recurso de dados.

location – o local do recurso de dados. Execute um HTTP GET neste local para baixar os dados.

Aqui está um exemplo de resposta que retorna o udid e location de três recursos de dados:

{
    "mapDataList": 
    [
        {
            "udid": "9a1288fa-1858-4a3b-b68d-13a8j5af7d7c",
            "location": "https://atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0",
            "sizeInBytes": 29920,
            "uploadStatus": "Completed"
        },
        {
            "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
            "location": "https://atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
            "sizeInBytes": 1339,
            "uploadStatus": "Completed"
        },
        {
            "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
            "location": "https://atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
            "sizeInBytes": 1650,
            "uploadStatus": "Pending"
        }]
}

GET https://{geography}.atlas.microsoft.com/mapData?api-version=1.0

With optional parameters:

GET https://{geography}.atlas.microsoft.com/mapData?subscription-key={subscription-key}&api-version=1.0

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
geography	path	True	string	Esse parâmetro especifica onde o recurso Azure Mapas Creator está localizado. Os valores válidos são nós e eu.
api-version	query	True	string	Número de versão da API de Mapas Azure. A versão atual é 1.0
subscription-key	query		string	Uma das chaves de Mapas do Azure fornecidas de uma Conta do Azure Mapas. Consulte este artigo para obter detalhes sobre como gerenciar a autenticação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-id		string	Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Microsoft Entra ID. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Respostas

Nome	Tipo	Description
200 OK	MapDataListResponse	Liste a solicitação de dados concluída com êxito. O corpo da resposta contém uma lista de todos os dados carregados anteriormente. Headers Content-Type: string
400 Bad Request	ODataErrorResponse	Solicitação incorreta: um ou mais parâmetros foram especificados incorretamente ou são mutuamente exclusivos.
401 Unauthorized	ODataErrorResponse	Acesso negado devido a uma chave de assinatura inválida ou token de portador de Microsoft Entra ID inválido. Certifique-se de fornecer uma chave válida para uma assinatura ativa do Azure e um recurso do Mapas. Caso contrário, verifique o cabeçalho WWW-Authenticate quanto ao código de erro e a descrição do token de portador Microsoft Entra ID fornecido. Headers WWW-Authenticate: string
403 Forbidden	ODataErrorResponse	Problemas de permissão, capacidade ou autenticação.
404 Not Found	ODataErrorResponse	Não encontrado: o recurso solicitado não pôde ser encontrado, mas pode estar disponível novamente no futuro.
500 Internal Server Error	ODataErrorResponse	Ocorreu um erro ao processar a solicitação. Tente novamente mais tarde.

Segurança

AADToken

Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso a Azure Mapas APIs REST. 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 receber 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 Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de 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 de Microsoft Entra ID. * 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 do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Para obter mais informações sobre plataforma de identidade da Microsoft, consulte visão geral plataforma de identidade da Microsoft.

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

Scopes

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

subscription-key

Essa é uma chave compartilhada 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 master na conta em que 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 com base na operação Listar SAS 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 para a expiração, a taxa e as regiões 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 maneira 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

List all the previously uploaded data

Sample Request

HTTP

GET https://us.atlas.microsoft.com/mapData?subscription-key=[subscription-key]&api-version=1.0

Sample Response

Status code:: 200

{
  "mapDataList": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "location": "https://atlas.microsoft.com/mapData/f6495f62-94f8-0ec2-c252-45626f82fcb2?api-version=1.0",
      "sizeInBytes": 29920,
      "uploadStatus": "Completed"
    },
    {
      "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
      "location": "https://atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
      "sizeInBytes": 1339,
      "uploadStatus": "Completed"
    },
    {
      "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
      "location": "https://atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
      "sizeInBytes": 1650,
      "uploadStatus": "Pending"
    }
  ]
}

Status code:: 400

{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}

Status code:: 401

{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}

Status code:: 403

{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}

Status code:: 404

{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}

Status code:: 500

{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

Definições

Nome	Description
MapDataDetailInfo	Informações detalhadas dos dados.
MapDataListResponse	O modelo de resposta para a API de Lista de Dados. Retorna uma lista de todos os dados carregados anteriormente.
ODataError	Esse objeto é retornado quando ocorre um erro na API Azure Mapas.
ODataErrorResponse	Esse objeto de resposta é retornado quando ocorre um erro na API Azure Mapas.

MapDataDetailInfo

Informações detalhadas dos dados.

Nome	Tipo	Description
location	string	O local dos dados. Execute um HTTP `GET` neste local para baixar os dados.
sizeInBytes	integer	O tamanho do conteúdo em bytes.
udid	string	A ID de dados exclusiva para os dados.
uploadStatus	string	O status de upload atual do conteúdo.

MapDataListResponse

O modelo de resposta para a API de Lista de Dados. Retorna uma lista de todos os dados carregados anteriormente.

Nome	Tipo	Description
mapDataList	MapDataDetailInfo[]	Uma lista de todos os dados carregados anteriormente.

ODataError

Esse objeto é retornado quando ocorre um erro na API Azure Mapas.

Nome	Tipo	Description
code	string	O código ODataError.
details	ODataError[]	Esse objeto é retornado quando ocorre um erro na API Azure Mapas.
message	string	Se disponível, uma descrição legível do erro.
target	string	Se disponível, o destino causará o erro.

ODataErrorResponse

Esse objeto de resposta é retornado quando ocorre um erro na API Azure Mapas.

Nome	Tipo	Description
error	ODataError	Esse objeto é retornado quando ocorre um erro na API Azure Mapas.

Share via