Data Registry - List

Referência

Service:: Maps

API Version:: 2023-06-01

Use para obter uma lista de todos os registros de dados na conta Azure Mapas.

A List API é uma solicitação HTTP GET que retorna uma matriz que contém todos os registros de dados registrados anteriormente usando a API Registrar ou Substituir.

O ponto de extremidade de serviço do Registro de Dados é limitado no escopo para a região da sua conta de Azure Mapas e não está disponível para contas de Azure Mapas globais.

Enviar Solicitação de Lista

Para listar todos os registros de dados, emita uma solicitação GET sem parâmetros adicionais.

Listar Resposta

A List solicitação retorna uma matriz de registros de dados no JSON formato no corpo da resposta.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
geography	path	True	string	Esse parâmetro especifica onde a conta de Azure Mapas está localizada. Os valores válidos são nós (Leste dos EUA, Centro-Oeste dos EUA, Oeste dos EUA 2) e EU (Norte da Europa, Europa Ocidental).
api-version	query	True	string	O número de versão da API de Azure Mapas.

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 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

Nome	Tipo	Description
200 OK	DataRegistryList	A `List` solicitação foi concluída com êxito. O corpo da resposta contém uma matriz de registros de dados.
Other Status Codes	MapsErrorResponse	Erro inesperado. Headers x-ms-error-code: string

DataRegistryList

A List solicitação foi concluída com êxito. O corpo da resposta contém uma matriz de registros de dados.

Other Status Codes

MapsErrorResponse

Erro inesperado.

Headers

x-ms-error-code: string

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 à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 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 ao qual 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 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 ao criar um 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 essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como master chaves para a conta para a qual são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor a servidor de Azure Mapas APIs REST em que essa chave pode ser armazenada com segurança.

Type: apiKey
In: header

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da 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 à expiração, taxa e 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 do Mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.

Type: apiKey
In: header

Exemplos

List all previously registered data registries

Sample Request

HTTP

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

Sample Response

Status code:: 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

Nome	Description
AzureBlob	Detalhes do registro de dados de blob do Azure.
DataFormat	O formato de dados do conteúdo carregado usado para fins de validação.
DataRegistry	O registro de dados no Azure Mapas.
DataRegistryKind	Tipo de registro de dados.
DataRegistryList	O modelo de resposta para a API de Lista do Registro de Dados. Retorna uma lista de todos os dados registrados anteriormente.
LongRunningOperationStatus	O status de uma operação de longa execução.
MapsErrorDetail	O detalhe do erro.
MapsErrorResponse	Resposta de erro comum para Azure Mapas APIs retornarem detalhes de erro para operações com falha.
MapsInnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

AzureBlob

Detalhes do registro de dados de blob do Azure.

Nome	Tipo	Description
blobUrl	string	A URL do blob contém o caminho para o arquivo que está sendo registrado.
contentMD5	string	O conteúdo MD5 do conteúdo, usado para validação de dados.
dataFormat	DataFormat	O formato de dados do conteúdo carregado usado para fins de validação.
linkedResource	string	A ID do armazenamento de dados na conta Azure Mapas.
msiClientId	string	ID do cliente da identidade gerenciada atribuída pelo usuário. Use a identidade gerenciada atribuída pelo sistema, se não for fornecida.
sizeInBytes	integer	O tamanho do conteúdo em bytes.

DataFormat

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

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

DataRegistry

O registro de dados no Azure Mapas.

Nome	Tipo	Description
azureBlob	AzureBlob	Detalhes do registro de dados de blob do Azure.
description	string	A descrição fornecida ao registro de dados. O comprimento máximo é de 1024 caracteres.
error	MapsErrorDetail	O detalhe do erro.
kind	DataRegistryKind	Tipo de registro de dados.
status	LongRunningOperationStatus	O status de uma operação de longa execução.
udid	string	A ID de dados do usuário para o registro de dados.

DataRegistryKind

Tipo de registro de dados.

Nome	Tipo	Description
AzureBlob	string	Blob do Azure