Data Registry - Register Or Replace

Referência

Serviço:: Maps

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

Use para registrar dados armazenados em uma Conta de Armazenamento do Azure com uma conta do Azure Mapas.

A Register API é uma solicitação HTTP PUT usada para registrar os dados em uma Conta de Armazenamento do Azure com uma conta do Azure Mapas. O tamanho máximo do arquivo que pode ser registrado é de um gigabyte.

Isso é útil em cenários como registrar uma coleção de Cercas Geográficas em GeoJSON formato para uso no Serviço de Geofencing do Azure Mapas ou registrar um conjunto de arquivos de design DWG como um Pacote de Desenho compactado para uso no Serviço de Conversão do Criador do Azure Mapas.

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

Enviar Solicitação de Registro ou Substituição

As Register solicitações e Replace são operações de execução longa que contêm um objeto JSON do AzureBlob no corpo da solicitação que define os detalhes do registro de dados.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description

Nome	Em	Obrigatório	Tipo	Description
geography	path	True	string	Esse parâmetro especifica onde a Conta do 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).
udid	path	True	string	A ID de dados do usuário do registro de dados. Padrão Regex: `^[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 de versão da API do Azure Mapas.

geography

path

True

string

Esse parâmetro especifica onde a Conta do 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).

udid

path

True

string

A ID de dados do usuário do registro de dados.

Padrão Regex: ^[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 de versão da API do Azure Mapas.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description

x-ms-client-id

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 da ID do Microsoft Entra. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar a segurança do Microsoft Entra ID no Azure Mapas, confira os artigos a seguir para obter diretrizes .
Operation-Id		string	A ID da operação, no formato GUID. Padrão Regex: `^[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}$`

string

Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança da ID do Microsoft Entra. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar a segurança do Microsoft Entra ID no Azure Mapas, confira os artigos a seguir para obter diretrizes .

Operation-Id

string

A ID da operação, no formato GUID.

Padrão Regex: ^[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}$

Corpo da solicitação

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.
kind	DataRegistryKind	Tipo de registro de dados.

Respostas

Nome	Tipo	Description
200 OK	DataRegistry	Substituição de recursos: a solicitação foi aceita para processamento. Cabeçalhos Operation-Id: string Operation-Location: string
201 Created	DataRegistry	Criação de recursos: a solicitação foi aceita para processamento. Cabeçalhos Operation-Id: string Operation-Location: string
Other Status Codes	MapsErrorResponse	Erro inesperado. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

DataRegistry

Substituição de recursos: a solicitação foi aceita para processamento.

Cabeçalhos

Operation-Id: string
Operation-Location: string

201 Created

DataRegistry

Criação de recursos: a solicitação foi aceita para processamento.

Cabeçalhos

Operation-Id: string
Operation-Location: string

Other Status Codes

MapsErrorResponse

Erro inesperado.

Cabeçalhos

x-ms-error-code: string

Segurança

AADToken

Estes são os Fluxos do 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 do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. 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 APIs REST do Azure Mapas.

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 recurso do Azure Mapas 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 ID do Microsoft Entra. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das 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 a plataforma de identidade da Microsoft, consulte Visão geral da plataforma de identidade da Microsoft.

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

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada ao criar um recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como chaves mestras para a conta para a qual são emitidas.

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

Tipo: apiKey
Em: header

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das 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.

Tipo: apiKey
Em: header

Exemplos

Register or replace a udid

Solicitação de exemplo

HTTP

PUT https://us.atlas.microsoft.com/dataRegistries/29a92cab-74af-49e7-a326-66898220aa9d?api-version=2023-06-01

{
  "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"
  }
}

Resposta de exemplo

Código de status:: 201

Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2

{
  "udid": "29a92cab-74af-49e7-a326-66898220aa9d",
  "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
  },
  "status": "Running"
}

Código de status:: 200

Operation-Id: 0522b4fe-0539-4c6c-ba70-e35ec865d8e2
Operation-Location: https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2

{
  "udid": "29a92cab-74af-49e7-a326-66898220aa9d",
  "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
  },
  "status": "Running"
}

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

LongRunningOperationStatus

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

Nome	Tipo	Description
Completed	string	A solicitação foi concluída com êxito.
Failed	string	A solicitação tem uma ou mais falhas.
Running	string	No momento, a solicitação está sendo processada.

MapsErrorDetail

O detalhe do erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	MapsErrorDetail[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
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 pelo homem do erro.
target	string	O destino do erro.

MapsErrorResponse

Resposta de erro comum para APIs do Azure Mapas retornarem detalhes de erro para operações com falha.

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

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

Compartilhar via

Data Registry - Register Or Replace

Enviar Solicitação de Registro ou Substituição

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

AADToken

Observações

Escopos

subscription-key

SAS Token

Exemplos

Register or replace a udid

Solicitação de exemplo

Resposta de exemplo

Definições

AzureBlob

DataFormat

DataRegistry

DataRegistryKind

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Recursos adicionais