Data - List Preview

Referência

Service:: Maps

API Version:: 1.0

O pedido Lista permite que o autor da chamada obtenha uma lista de todos os conteúdos carregados anteriormente com o Carregamento de Dados.
Aplica-se a: Escalão de preço S1.

Esta API permite ao autor da chamada obter uma lista de todos os conteúdos carregados anteriormente com a API de Carregamento de Dados.

Nota

Azure Maps Descontinuação do Serviço de dados

O serviço Azure Maps Dados (v1 e v2) foi preterido e será descontinuado a 16/09/24. Para evitar interrupções do serviço, todas as chamadas para o serviço de Dados terão de ser atualizadas para utilizar o serviço de Registo de Dados do Azure Maps até 16/09/24. Para obter mais informações, veja Como criar um registo de dados.

Submeter Pedido de Lista

Para listar todos os conteúdos de dados do mapa, emitirá um GET pedido sem parâmetros adicionais.

Resposta de Dados de Lista

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

udid - O ID de dados exclusivo para o recurso de dados.

location - A localização do recurso de dados. Execute um HTTP GET nesta localização para transferir os dados.

Segue-se uma resposta de exemplo que devolve e udidlocation de 3 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 do URI

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

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps veja os seguintes artigos para obter orientações.

Respostas

Name	Tipo	Description
200 OK	MapDataListResponse	Pedido de dados de lista concluído com êxito. O corpo da resposta contém uma lista de todos os dados carregados anteriormente. Headers Content-Type: string
400 Bad Request	ODataErrorResponse	Pedido incorreto: um ou mais parâmetros foram especificados incorretamente ou são mutuamente exclusivos.
401 Unauthorized	ODataErrorResponse	Acesso negado devido a chave de subscrição inválida ou token de portador Microsoft Entra ID inválido. Certifique-se de que fornece uma chave válida para uma subscrição ativa do Azure e o recurso do Maps. Caso contrário, verifique o cabeçalho WWW-Authenticate para obter o código de erro e a descrição do token de portador de 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: não foi possível localizar o recurso pedido, mas poderá estar novamente disponível no futuro.
500 Internal Server Error	ODataErrorResponse	Ocorreu um erro ao processar o pedido. Tente novamente mais tarde.

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

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

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

Esta é uma chave partilhada que é aprovisionada quando Cria uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.

Type: apiKey
In: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de 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

Name	Description
MapDataDetailInfo	Informações detalhadas sobre os dados.
MapDataListResponse	O modelo de resposta da API de Lista de Dados. Devolve uma lista de todos os dados carregados anteriormente.
ODataError	Este objeto é devolvido quando ocorre um erro na API de Azure Maps.
ODataErrorResponse	Este objeto de resposta é devolvido quando ocorre um erro na API de Azure Maps.

MapDataDetailInfo

Informações detalhadas sobre os dados.

Name	Tipo	Description
location	string	A localização dos dados. Execute um HTTP `GET` nesta localização para transferir os dados.
sizeInBytes	integer	O tamanho do conteúdo em bytes.
udid	string	O ID de dados exclusivo para os dados.
uploadStatus	string	O estado de carregamento atual do conteúdo.

MapDataListResponse

O modelo de resposta da API de Lista de Dados. Devolve uma lista de todos os dados carregados anteriormente.

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

ODataError

Este objeto é devolvido quando ocorre um erro na API de Azure Maps.

Name	Tipo	Description
code	string	O código ODataError.
details	ODataError[]	Este objeto é devolvido quando ocorre um erro na API de Azure Maps.
message	string	Se disponível, uma descrição legível por humanos do erro.
target	string	Se disponível, o destino está a causar o erro.

ODataErrorResponse

Este objeto de resposta é devolvido quando ocorre um erro na API de Azure Maps.

Name	Tipo	Description
error	ODataError	Este objeto é devolvido quando ocorre um erro na API de Azure Maps.

Share via