Data Registry - Register Or Replace

Ссылка

Служба:: Maps

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

Используйте для регистрации данных, хранящихся в учетной записи хранения Azure, с помощью учетной записи Azure Maps.

API Register — это HTTP-запрос PUT , используемый для регистрации данных в учетной записи хранения Azure с помощью учетной записи Azure Maps. Максимальный размер файла, который можно зарегистрировать, составляет один гигабайт.

Это полезно в таких сценариях, как регистрация коллекции геозон в GeoJSON формате для использования в службе геозон Azure Maps или регистрация набора файлов проектирования DWG в качестве zip-пакета рисования для использования в Службе преобразования создателя Azure Maps.

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

Отправка запроса на регистрацию или замену

Register Запросы и Replace являются длительными операциями, содержащими объект JSON AzureBlob в тексте запроса, который определяет сведения о реестре данных.

PUT 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	Идентификатор пользовательских данных реестра данных. Шаблон регулярного выражения: `^[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

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

Шаблон регулярного выражения: ^[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

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Идентификатора Microsoft Entra. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи плоскости управления Azure Maps. Инструкции по использованию безопасности Microsoft Entra ID в Azure Maps см. в следующих статьях .
Operation-Id		string	Идентификатор операции в формате GUID. Шаблон регулярного выражения: `^[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

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

Operation-Id

string

Идентификатор операции в формате GUID.

Шаблон регулярного выражения: ^[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}$

Текст запроса

Имя	Тип	Описание
azureBlob	AzureBlob	Сведения о реестре данных BLOB-объектов Azure.
description	string	Описание, данное реестру данных. Максимальная длина — 1024 символа.
kind	DataRegistryKind	Тип реестра данных.

Ответы

Имя	Тип	Описание
200 OK	DataRegistry	Замена ресурса. Запрос принят для обработки. Заголовки Operation-Id: string Operation-Location: string
201 Created	DataRegistry	Создание ресурса. Запрос принят для обработки. Заголовки Operation-Id: string Operation-Location: string
Other Status Codes	MapsErrorResponse	Произошла непредвиденная ошибка. Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

DataRegistry

Замена ресурса. Запрос принят для обработки.

Заголовки

Operation-Id: string
Operation-Location: string

201 Created

DataRegistry

Создание ресурса. Запрос принят для обработки.

Заголовки

Operation-Id: string
Operation-Location: string

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, пакетов AZURE SDK или REST API.

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

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

Тип: apiKey
В: header

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

Register or replace a udid

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

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

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

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

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

Определения

Имя	Описание
AzureBlob	Сведения о реестре данных BLOB-объектов Azure.
DataFormat	Формат данных отправленного содержимого, используемого для проверки.
DataRegistry	Реестр данных в Azure Maps.
DataRegistryKind	Тип реестра данных.
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

LongRunningOperationStatus

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

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

MapsErrorDetail

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

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

MapsErrorResponse

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

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

MapsInnerError

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

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

Поделиться через

Data Registry - Register Or Replace

Отправка запроса на регистрацию или замену

Параметры URI

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

Текст запроса

Ответы

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

AADToken

Примечания

Области

subscription-key

SAS Token

Примеры

Register or replace a udid

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

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

Определения

AzureBlob

DataFormat

DataRegistry

DataRegistryKind

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

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