Data Registry - List

Ссылка

Служба:: Maps

Версия API:: 2023-06-01

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

API List — это HTTP-запрос GET , который возвращает массив, содержащий все реестры данных, ранее зарегистрированные с помощью API Register или Replace.

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

Запрос на отправку списка

Чтобы получить список всех реестров данных, отправьте GET запрос без дополнительных параметров.

Ответ списка

Запрос List возвращает массив реестров данных в JSON формате в тексте ответа.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
geography	path	True	string	Этот параметр указывает, где находится учетная запись Azure Maps. Допустимые значения: us (восточная часть США, центрально-западная часть США, западная часть США 2) и eu (Северная Европа, Западная Европа).
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	DataRegistryList	Запрос `List` успешно выполнен. Текст ответа содержит массив реестров данных.
Other Status Codes	MapsErrorResponse	Произошла непредвиденная ошибка. Заголовки x-ms-error-code: string

DataRegistryList

Запрос List успешно выполнен. Текст ответа содержит массив реестров данных.

Other Status Codes

MapsErrorResponse

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

Заголовки

x-ms-error-code: string

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

AADToken

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

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

Примечания

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

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

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

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

subscription-key

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

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

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

Тип: apiKey
В: header

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

List all previously registered data registries

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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==."
      }
    }
  ]
}

Определения

Имя	Описание
AzureBlob	Сведения о реестре данных BLOB-объектов Azure.
DataFormat	Формат данных отправленного содержимого, используемого для проверки.
DataRegistry	Реестр данных в Azure Maps.
DataRegistryKind	Тип реестра данных.
DataRegistryList	Модель ответа для API списка реестра данных. Возвращает список всех ранее зарегистрированных данных.
LongRunningOperationStatus	Состояние длительной операции.
MapsErrorDetail	Сведения об ошибке.
MapsErrorResponse	Распространенные ответы об ошибках, которые API-интерфейсы Azure Maps возвращают сведения об ошибках для неудачных операций.
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