Data Registry - Get Data Registry

Ссылка

Service:: Maps

API Version:: 2023-06-01

Используйте для получения указанных сведений реестра данных.

API Get Data Registry — это HTTP-запрос GET , который возвращает сведения о реестре данных в виде объекта AzureBlob в формате JSON в тексте ответа вместе с кодом состояния HTTP 200 при успешном выполнении. Если Azure Maps не удается получить доступ к базовому содержимому или проверка целостности не удается, status устанавливается значение Failed и возвращается ошибка.

Конечная точка службы реестра данных ограничена область регионом учетной записи Azure Maps и недоступна для глобальных учетных записей Azure Maps.

Отправка запроса на получение реестра данных

Запрос реестра GET данных возвращает сведения о запрошенном реестре данных, определяемый указанным udid. Сведения возвращаются в тексте ответа в формате JSON.

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

Параметры URI

Имя В Обязательно Тип Описание

Имя	В	Обязательно	Тип	Описание
geography	path	True	string	Этот параметр указывает, где находится учетная запись Azure Maps. Допустимые значения: us (восточная часть США, центрально-западная часть США, западная часть США 2) и eu (Северная Европа, Западная Европа).
udid	path	True	string	Идентификатор пользовательских данных реестра данных. 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	Номер версии API Azure Maps.

geography

path

True

string

Этот параметр указывает, где находится учетная запись Azure Maps. Допустимые значения: us (восточная часть США, центрально-западная часть США, западная часть США 2) и eu (Северная Европа, Западная Европа).

udid

path

True

string

Идентификатор пользовательских данных реестра данных.

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

Номер версии API Azure Maps.

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях.

Ответы

Имя Тип Описание

200 OK

Имя	Тип	Описание
200 OK	DataRegistry	Запрос `Get Data Registry` успешно выполнен. Текст ответа содержит реестр данных указанного `udid`объекта .
Other Status Codes	MapsErrorResponse	Произошла непредвиденная ошибка. Headers x-ms-error-code: string

DataRegistry

Запрос Get Data Registry успешно выполнен. Текст ответа содержит реестр данных указанного udidобъекта .

Other Status Codes

MapsErrorResponse

Произошла непредвиденная ошибка.

Headers

x-ms-error-code: string

Безопасность

AADToken

Это Microsoft Entra потоков OAuth 2.0. При связывании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе можно предоставить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений на Azure Maps REST API.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных управлять доступом к определенным API и областям.

Примечания

Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами.

Объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API. * Использование веб-пакета SDK для Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

Дополнительные сведения о платформа удостоверений Майкрософт см. в платформа удостоверений Майкрософт обзоре.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя	Описание
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, который подготавливается при создании ресурса Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого ключа любое приложение авторизовано для доступа ко всем REST API. Другими словами, в настоящее время они могут рассматриваться как master ключи к учетной записи, для которых они выдаются.

Для общедоступных приложений мы рекомендуем использовать доступ между серверами Azure Maps REST API, где этот ключ можно безопасно хранить.

Type: apiKey
In: header

SAS Token

Это маркер подписанного URL-адреса, созданный с помощью операции List SAS для ресурса Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов, используемых для конкретного маркера. Другими словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи map , чтобы ограничить использование маркера SAS и регулярно обновлять маркер SAS.

Type: apiKey
In: header

Примеры

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

Определения

Имя	Описание
AzureBlob	Сведения о реестре данных BLOB-объектов Azure.
DataFormat	Формат данных отправленного содержимого, используемого для проверки.
DataRegistry	Реестр данных в Azure Maps.
DataRegistryKind	Тип реестра данных.
LongRunningOperationStatus	Состояние длительной операции.
MapsErrorDetail	Сведения об ошибке.
MapsErrorResponse	Распространенные ответы об ошибках Azure Maps API для возврата сведений об ошибке для неудачных операций.
MapsInnerError	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.

AzureBlob

Сведения о реестре данных BLOB-объектов Azure.

Имя	Тип	Описание
blobUrl	string	URL-адрес большого двоичного объекта содержит путь к регистрируемого файлу.
contentMD5	string	Содержимое MD5 содержимого, используемое для проверки данных.
dataFormat	DataFormat	Формат данных отправленного содержимого, используемого для проверки.
linkedResource	string	Идентификатор хранилища данных в учетной записи Azure Maps.
msiClientId	string	Идентификатор клиента управляемого удостоверения, назначаемого пользователем. Используйте управляемое удостоверение, назначаемое системой, если оно не указано.
sizeInBytes	integer	Размер содержимого в байтах.

DataFormat

Формат данных отправленного содержимого, используемого для проверки.

Имя	Тип	Описание
geojson	string	GeoJSON — это формат обмена геопространственных данных на основе JSON.
zip	string	Сжатый формат данных.

DataRegistry

Реестр данных в Azure Maps.

Имя	Тип	Описание
azureBlob	AzureBlob	Сведения о реестре данных BLOB-объектов Azure.
description	string	Описание, данное реестру данных. Максимальная длина составляет 1024 символа.
error	MapsErrorDetail	Сведения об ошибке.
kind	DataRegistryKind	Тип реестра данных.
status	LongRunningOperationStatus	Состояние длительной операции.
udid	string	Идентификатор данных пользователя для реестра данных.

DataRegistryKind

Тип реестра данных.

Имя	Тип	Описание
AzureBlob	string	Большой двоичный объект Azure

LongRunningOperationStatus

Состояние длительной операции.

Имя	Тип	Описание
Completed	string	Запрос успешно выполнен.
Failed	string	Запрос имеет один или несколько сбоев.
Running	string	Запрос в настоящее время обрабатывается.

MapsErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
code	string	Один из серверных наборов кодов ошибок.
details	MapsErrorDetail[]	Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
innererror	MapsInnerError	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Понятное представление ошибки.
target	string	Целевой объект ошибки.

MapsErrorResponse

Распространенные ответы об ошибках Azure Maps API для возврата сведений об ошибке для неудачных операций.

Имя	Тип	Описание
error	MapsErrorDetail	Сведения об ошибке.

MapsInnerError

Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.

Имя	Тип	Описание
code	string	Код ошибки.
innererror	MapsInnerError	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.

Data Registry - Get Data Registry

Отправка запроса на получение реестра данных

Параметры URI

Заголовок запроса

Ответы

Безопасность

AADToken

Примечания

Scopes

subscription-key

SAS Token

Примеры

Get the data registry of a completed udid

Sample Request

Sample Response

Get the data registry of a failed udid

Sample Request

Sample Response

Определения

AzureBlob

DataFormat

DataRegistry

DataRegistryKind

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

Дополнительные ресурсы