Data Registry - Get Data Registry

Referência

Service:: Maps

API Version:: 2023-06-01

Utilize para obter as informações de registo de dados especificadas.

A Get Data Registry API é um pedido HTTP GET que devolve informações do registo de dados, como um objeto AzureBlob no formato JSON, no corpo da resposta, juntamente com o código de estado HTTP 200, quando bem-sucedida. Se Azure Maps não conseguir aceder ao conteúdo subjacente ou a verificação de integridade falhar, o status está definido como Failed e é devolvido um erro.

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

Submeter Pedido de Obtenção de Registo de Dados

Um pedido de registo de GET dados devolve detalhes do registo de dados pedido, conforme determinado pelo especificado udid. Os detalhes são devolvidos no corpo da resposta no formato JSON.

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

Parâmetros do URI

Name Em Necessário Tipo Description

Name	Em	Necessário	Tipo	Description
geography	path	True	string	Este parâmetro especifica onde está localizada a Conta de 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).
udid	path	True	string	O ID de dados do utilizador do registo de dados. Regex pattern: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
api-version	query	True	string	O número da versão da API Azure Maps.

geography

path

True

string

Este parâmetro especifica onde está localizada a Conta de 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).

udid

path

True

string

O ID de dados do utilizador do registo de dados.

Regex pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

api-version

query

True

string

O número da versão da API 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 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 consulte os seguintes artigos para obter orientações.

Respostas

Name Tipo Description

200 OK

Name	Tipo	Description
200 OK	DataRegistry	O `Get Data Registry` pedido foi concluído com êxito. O corpo da resposta contém o registo de dados do especificado `udid`.
Other Status Codes	MapsErrorResponse	Ocorreu um erro inesperado. Headers x-ms-error-code: string

DataRegistry

O Get Data Registry pedido foi concluído com êxito. O corpo da resposta contém o registo de dados do especificado udid.

Other Status Codes

MapsErrorResponse

Ocorreu um erro inesperado.

Headers

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 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 recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps.

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 ao criar um recurso 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 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 Azure Maps onde esta chave pode ser armazenada de forma segura.

Type: apiKey
In: header

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso 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

Get the data registry of a completed udid

Get the data registry of a failed udid

Get the data registry of a completed udid

Sample Request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Sample Response

Status code:: 200

{
  "udid": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "description": "Contoso Geofence GeoJSON",
  "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/path.json",
    "sizeInBytes": 1339,
    "contentMD5": "sOJMJvFParkSxBsvvrPOMQ=="
  },
  "status": "Completed"
}

Get the data registry of a failed udid

Sample Request

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Sample Response

Status code:: 200

{
  "udid": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "description": "Contoso Geofence GeoJSON",
  "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/path.json"
  },
  "status": "Failed",
  "error": {
    "code": "AuthorizationPermissionMismatch",
    "message": "Not authorized to perform this operation on resource: https://mystorageaccount.blob.core.windows.net/my-container/my/blob/path.json."
  }
}

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.
LongRunningOperationStatus	O estado de uma operação de execução prolongada.
MapsErrorDetail	O detalhe do erro.
MapsErrorResponse	Resposta de erro comum para Azure Maps APIs para devolver detalhes do 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 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 comprimidos.

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

LongRunningOperationStatus

O estado de uma operação de execução prolongada.

Name	Tipo	Description
Completed	string	O pedido foi concluído com êxito.
Failed	string	O pedido tem uma ou mais falhas.
Running	string	O pedido está atualmente a ser processado.

MapsErrorDetail

O detalhe do erro.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	MapsErrorDetail[]	Uma série de detalhes sobre erros específicos que levaram a este erro comunicado.
innererror	MapsInnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O destino do erro.

MapsErrorResponse

Resposta de erro comum para Azure Maps APIs para devolver detalhes do erro para operações falhadas.

Name	Tipo	Description
error	MapsErrorDetail	O detalhe do erro.

MapsInnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

Name	Tipo	Description
code	string	O código de erro.
innererror	MapsInnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

Data Registry - Get Data Registry

Submeter Pedido de Obtenção de Registo de Dados

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

AADToken

Notas

Scopes

subscription-key

SAS Token

Exemplos

Get the data registry of a completed udid

Sample Request

Sample Response

Get the data registry of a failed udid

Sample Request

Sample Response

Definições

AzureBlob

DataFormat

DataRegistry

DataRegistryKind

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Recursos adicionais