Data Registry - Unregister

Serviço:

Maps

Versão da API:

2023-06-01

Use para cancelar o registro de dados armazenados em uma Conta de Armazenamento do Azure registrada com uma conta do Azure Mapas.

A Unregister API é uma solicitação HTTP DELETE que remove um registro de dados sem excluir o conteúdo subjacente da conta de armazenamento do Azure.

Útil em cenários como cancelar o registro de arquivos de cerca geográfica registrados anteriormente usando a API Registrar ou Substituir para uso no Serviço de Cerca Geográfica do Azure Mapas ou cancelar o registro de um arquivo compactado (ZIP) que contém arquivos de design DWG usados pelo Serviço de Conversão do Criador dos Azure Mapas.

O ponto de extremidade de serviço do registro de dados é 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 cancelamento de registro

Use uma solicitação HTTP DELETE com o udid do registro de dados para cancelar o registro.

Cancelar o registro de resposta

A Unregister solicitação retornará uma resposta HTTP '204 Sem Conteúdo' com um corpo vazio, se o registro de dados tiver sido excluído com êxito.

DELETE https://{geography}.atlas.microsoft.com/dataRegistries/{udid}?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 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 UE (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		string	Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança de 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 de ID do Microsoft Entra no Azure Mapas, consulte os artigos a seguir para obter diretrizes .

Respostas

Nome	Tipo	Description
204 No Content		A Unregister solicitação foi concluída com êxito. O registro de dados é excluído, mas os dados não foram removidos da conta de armazenamento.
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 contas de recursos ou sub-recursos 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 para 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 para a expiração, a taxa e as 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 de mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Unregister a data registry without deleting the underlying contents

Solicitação de exemplo

HTTP

DELETE https://us.atlas.microsoft.com/dataRegistries/25084fb7-307a-4720-8f91-7952a0b91012?api-version=2023-06-01

Resposta de exemplo

Código de status:

204

Definições

Nome	Description
MapsErrorDetail	Os detalhes 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.

MapsErrorDetail

Os detalhes 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 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	Os detalhes 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.