Features - Replace
Use para sobrescribir todos los atributos existentes de una característica.
La Replace
API se ajusta a laespecificación Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete .
Esta es una parte de Creator, lo que permite desarrollar aplicaciones basadas en los datos privados del mapa interior mediante Azure Maps API y SDK. Características GET API siguen open Geospatial Consortium API - Features - Part 1: Core corrigendum standard to query Datasets. Los conjuntos de datos constan de varias colecciones de características, que son una agrupación de características definidas por un esquema común.
Enviar solicitud de reemplazo
La Replace
API es una solicitud HTTP PUT
que reemplaza la característica identificada por el proporcionado featureId
en la colección especificada, lo que significa que los datos proporcionados en el cuerpo de la solicitud sobrescriben todos los atributos de la característica.
PUT https://{geography}.atlas.microsoft.com/features/datasets/{datasetId}/collections/{collectionId}/items/{featureId}?api-version=2023-03-01-preview
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
collection
|
path | True |
string |
Identificador (nombre) de una colección específica. |
dataset
|
path | True |
string |
Identificador del conjunto de datos desde el que se va a consultar. |
feature
|
path | True |
string |
Identificador que distingue mayúsculas de minúsculas de una característica específica. |
geography
|
path | True |
string |
Este parámetro especifica dónde se encuentra el recurso Azure Maps Creator. Los valores válidos son nosotros y eu. |
api-version
|
query | True |
string |
Número de versión de la API de Azure Maps. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
204 No Content |
Característica actualizada. |
|
Other Status Codes |
Se ha producido un error inesperado. |
Seguridad
AADToken
Estos son los flujos de OAuth2 de Azure Active Directory . Cuando se empareja con el control de acceso basado en rol de Azure, se puede usar para controlar el acceso a Azure Maps API REST. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias Azure Maps cuenta de recursos o subrecursos. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o un rol personalizado compuesto por uno o varios permisos para Azure Maps API REST.
Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.
Notas
- Esta definición de seguridad requiere el uso del
x-ms-client-id
encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps.
Authorization URL
es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Azure Active Directory.
* El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.
* El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
- Actualmente, Azure Active Directory v1.0 o v2.0 admite Work, School e Invitados, pero no admite cuentas personales.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Se trata de una clave compartida que se aprovisiona al crear un recurso de Azure Maps a través del plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.
Con esta clave, cualquier aplicación está autorizada para acceder a todas las API REST. En otras palabras, estos se pueden tratar actualmente como claves maestras para la cuenta para la que se emiten.
En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de Azure Maps API REST en las que esta clave se puede almacenar de forma segura.
Type:
apiKey
In:
query
SAS Token
Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.
Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. En otras palabras, el token de SAS se puede usar para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.
En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta de asignación para limitar la representación del abuso y renovar periódicamente el token de SAS.
Type:
apiKey
In:
header
Ejemplos
PutFeature
Sample Request
PUT https://us.atlas.microsoft.com/features/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items/UNIT39?api-version=2023-03-01-preview
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.12658487074886,
47.640834702079935
],
[
-122.12658773103239,
47.640771775842055
],
[
-122.12654387335145,
47.64077940326483
],
[
-122.12654768706284,
47.64082707465716
],
[
-122.12658487074886,
47.640834702079935
]
]
]
},
"properties": {
"categoryId": "CTG6",
"levelId": "LVL22",
"isOpenArea": false
}
}
Sample Response
Definiciones
Nombre | Description |
---|---|
Error |
Información adicional sobre el error de administración de recursos. |
Error |
Detalle del error. |
Error |
Respuesta de error |
Geo |
Objeto geometry válido |
Geo |
Tipo de objeto válido |
Geo |
Un tipo de geometría válido |
Geo |
Un tipo de geometría válido |
Geo |
Un tipo de geometría válido |
Geo |
Tipo de objeto válido |
Geo |
Especifica el |
Geo |
Un tipo de geometría válido |
Geo |
Un tipo de geometría válido |
ErrorAdditionalInfo
Información adicional sobre el error de administración de recursos.
Nombre | Tipo | Description |
---|---|---|
info |
object |
Información adicional. |
type |
string |
Tipo de información adicional. |
ErrorDetail
Detalle del error.
Nombre | Tipo | Description |
---|---|---|
additionalInfo |
Información adicional del error. |
|
code |
string |
Código de error. |
details |
Los detalles del error. |
|
message |
string |
El mensaje de error. |
target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
GeoJsonGeometry
Objeto geometry válido GeoJSON
. El tipo debe ser uno de los siete tipos de geometría GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon y GeometryCollection. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
type |
Especifica el tipo |
GeoJsonGeometryCollection
Tipo de objeto válido GeoJSON GeometryCollection
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
geometries | GeoJsonGeometry[]: |
Contiene una lista de objetos geometry válidos |
type |
string:
Geometry |
Especifica el tipo |
GeoJsonLineString
Un tipo de geometría válido GeoJSON LineString
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
Coordenadas de la |
type |
string:
Line |
Especifica el tipo |
GeoJsonMultiLineString
Un tipo de geometría válido GeoJSON MultiLineString
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
Coordenadas de la |
type |
string:
Multi |
Especifica el tipo |
GeoJsonMultiPoint
Un tipo de geometría válido GeoJSON MultiPoint
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
Coordenadas de la |
type |
string:
Multi |
Especifica el tipo |
GeoJsonMultiPolygon
Tipo de objeto válido GeoJSON MultiPolygon
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
Contiene una lista de objetos válidos |
type |
string:
Multi |
Especifica el tipo |
GeoJsonObjectType
Especifica el GeoJSON
tipo: FeatureCollection.
Nombre | Tipo | Description |
---|---|---|
FeatureCollection |
string |
Objeto |
GeoJsonPoint
Un tipo de geometría válido GeoJSON Point
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
Un |
type |
string:
Point |
Especifica el tipo |
GeoJsonPolygon
Un tipo de geometría válido GeoJSON Polygon
. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] |
Coordenadas para el |
type |
string:
Polygon |
Especifica el tipo |