Data Registry - List

Referência

Serviço:: Maps

Versão da API:: 2023-06-01

Utilize para obter uma lista de todos os registos de dados na conta do Azure Maps.

A List API é um pedido HTTP GET que devolve uma matriz que contém todos os registos de dados registados anteriormente com a API Registar ou Substituir.

O ponto final do serviço de registo de dados está limitado no âmbito da região da sua conta do Azure Maps e não está disponível para contas globais do Azure Maps.

Submeter Pedido de Lista

Para listar todos os registos de dados, emita um GET pedido sem parâmetros adicionais.

Resposta da Lista

O List pedido devolve uma matriz de registos de dados em JSON formato no corpo da resposta.

GET https://{geography}.atlas.microsoft.com/dataRegistries?api-version=2023-06-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
geography	path	True	string	Este parâmetro especifica onde está localizada a Conta do Azure Maps. Os valores válidos são nós (E.U.A. Leste, E.U.A. Centro-Oeste, E.U.A. Oeste 2) e eu (Europa do Norte, Europa Ocidental).
api-version	query	True	string	O número da versão da API do Azure Maps.

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 do Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão do Azure Maps. Para utilizar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientações.

Respostas

Name Tipo Description

200 OK

Name	Tipo	Description
200 OK	DataRegistryList	O `List` pedido foi concluído com êxito. O corpo da resposta contém uma matriz de registos de dados.
Other Status Codes	MapsErrorResponse	Ocorreu um erro inesperado. Cabeçalhos x-ms-error-code: string

DataRegistryList

O List pedido foi concluído com êxito. O corpo da resposta contém uma matriz de registos de dados.

Other Status Codes

MapsErrorResponse

Ocorreu um erro inesperado.

Cabeçalhos

x-ms-error-code: string

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 do Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais contas de recursos ou sub-recursos do Azure Maps. 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 as APIs REST do Azure Maps.

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 recurso do Azure Maps 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 do 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 do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * A utilização do SDK Web do 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 a plataforma de identidades da Microsoft, consulte Descrição geral da plataforma de identidades da Microsoft.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

Esta é uma chave partilhada que é aprovisionada ao criar um recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com esta chave, qualquer aplicação está autorizada a aceder a todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras da conta para a qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar o acesso servidor a servidor das APIs REST do Azure Maps, onde esta chave pode ser armazenada de forma segura.

Tipo: apiKey
Em: header

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das 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.

Tipo: apiKey
Em: header

Exemplos

List all previously registered data registries

Pedido de amostra

HTTP

GET https://us.atlas.microsoft.com/dataRegistries?api-version=2023-06-01

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "description": "Contoso Indoor Design",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "zip",
        "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path1.zip",
        "sizeInBytes": 29920,
        "contentMD5": "CsFxZ2YSfxw3cRPlqokV0w=="
      },
      "status": "Completed"
    },
    {
      "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "geojson",
        "msiClientId": "3263cad5-ed8b-4829-b72b-3d1ba556e373",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path2.geojson",
        "sizeInBytes": 1339
      },
      "status": "Running"
    },
    {
      "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
      "description": "Contoso Geofence GeoJSON",
      "kind": "AzureBlob",
      "azureBlob": {
        "dataFormat": "geojson",
        "linkedResource": "my-storage-account",
        "blobUrl": "https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path3.geojson",
        "sizeInBytes": 1650,
        "contentMD5": "rYpEfIeLbWZPyaICGEGy3A=="
      },
      "status": "Failed",
      "error": {
        "code": "ContentMD5Mismatch",
        "message": "Actual content MD5: sOJMJvFParkSxBsvvrPOMQ== doesn't match expected content MD5: CsFxZ2YSfxw3cRPlqokV0w==."
      }
    }
  ]
}

Definições

Name	Description
AzureBlob	Detalhes do registo de dados de blobs do Azure.
DataFormat	O formato de dados do conteúdo carregado utilizado para fins de validação.
DataRegistry	O registo de dados no Azure Maps.
DataRegistryKind	Tipo de registo de dados.
DataRegistryList	O modelo de resposta da API de Lista de Registos de Dados. Devolve uma lista de todos os dados registados anteriormente.
LongRunningOperationStatus	O estado de uma operação de execução prolongada.
MapsErrorDetail	O detalhe do erro.
MapsErrorResponse	Resposta de erro comum às APIs do Azure Maps para devolver detalhes de erro para operações falhadas.
MapsInnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

AzureBlob

Detalhes do registo de dados de blobs do Azure.

Name	Tipo	Description
blobUrl	string	O URL do blob contém o caminho para o ficheiro que está a ser registado.
contentMD5	string	O conteúdo MD5 do conteúdo, utilizado para validação de dados.
dataFormat	DataFormat	O formato de dados do conteúdo carregado utilizado para fins de validação.
linkedResource	string	O ID do arquivo de dados na conta do Azure Maps.
msiClientId	string	ID de cliente da identidade gerida atribuída pelo utilizador. Se não for fornecido, utilize a identidade gerida atribuída pelo sistema.
sizeInBytes	integer	O tamanho do conteúdo em bytes.

DataFormat

O formato de dados do conteúdo carregado utilizado para fins de validação.

Name	Tipo	Description
geojson	string	GeoJSON é um formato de intercâmbio de dados geoespacial baseado em JSON.
zip	string	Formato de dados comprimido.

DataRegistry

O registo de dados no Azure Maps.

Name	Tipo	Description
azureBlob	AzureBlob	Detalhes do registo de dados de blobs do Azure.
description	string	A descrição dada ao registo de dados. O comprimento máximo é de 1024 carateres.
error	MapsErrorDetail	O detalhe do erro.
kind	DataRegistryKind	Tipo de registo de dados.
status	LongRunningOperationStatus	O estado de uma operação de execução prolongada.
udid	string	O ID de dados do utilizador do registo de dados.

DataRegistryKind

Tipo de registo de dados.

Name	Tipo	Description
AzureBlob	string	Blob do Azure