-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
render.json
1013 lines (1013 loc) · 51 KB
/
render.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"swagger": "2.0",
"info": {
"title": "Azure Maps Render Service",
"version": "2022-08-01",
"description": "Azure Maps Render REST APIs"
},
"host": "atlas.microsoft.com",
"schemes": [
"https"
],
"consumes": [],
"produces": [
"application/json"
],
"securityDefinitions": {
"AADToken": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "These are the [Microsoft Entra OAuth 2.0](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).",
"scopes": {
"https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default"
}
},
"AzureKey": {
"type": "apiKey",
"description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.",
"name": "subscription-key",
"in": "header"
},
"SasToken": {
"type": "apiKey",
"description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.",
"name": "SAS Token",
"in": "header"
}
},
"security": [
{
"AADToken": [
"https://atlas.microsoft.com/.default"
]
},
{
"AzureKey": []
},
{
"SasToken": []
}
],
"responses": {},
"parameters": {
"ApiVersion": {
"name": "api-version",
"description": "Version number of Azure Maps API. Current version is 2022-08-01",
"type": "string",
"in": "query",
"required": true,
"x-ms-parameter-location": "client"
},
"BoundingBoxNorthEast": {
"name": "maxcoordinates",
"x-ms-client-name": "northEast",
"in": "query",
"description": "Maximum coordinates (north-east point) of bounding box in latitude longitude coordinate system. E.g. 52.41064,4.84228",
"required": true,
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"collectionFormat": "csv",
"x-ms-parameter-location": "method",
"x-ms-parameter-grouping": {
"name": "BoundingBox"
}
},
"BoundingBoxSouthWest": {
"name": "mincoordinates",
"x-ms-client-name": "southWest",
"in": "query",
"description": "Minimum coordinates (south-west point) of bounding box in latitude longitude coordinate system. E.g. 52.41064,4.84228",
"required": true,
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"collectionFormat": "csv",
"x-ms-parameter-location": "method",
"x-ms-parameter-grouping": {
"name": "BoundingBox"
}
},
"MapTileSize": {
"name": "tileSize",
"in": "query",
"description": "The size of the returned map tile in pixels.",
"type": "string",
"enum": [
"256",
"512"
],
"x-ms-enum": {
"name": "MapTileSize",
"modelAsString": true,
"values": [
{
"value": "256",
"name": "size256",
"description": "Return a 256 by 256 pixel tile."
},
{
"value": "512",
"name": "size512",
"description": "Return a 512 by 512 pixel tile."
}
]
},
"x-ms-parameter-location": "method"
},
"RasterTileFormat": {
"name": "format",
"description": "Desired format of the response. Possible value: png.",
"type": "string",
"in": "path",
"required": true,
"x-ms-client-default": "png",
"enum": [
"png"
],
"x-ms-enum": {
"name": "RasterTileFormat",
"modelAsString": true,
"values": [
{
"value": "png",
"description": "An image in the png format. Supports zoom levels 0 through 18."
}
]
},
"x-ms-parameter-location": "method"
},
"TilesetId": {
"name": "tilesetId",
"description": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/en-us/rest/api/maps/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.",
"type": "string",
"in": "query",
"required": true,
"enum": [
"microsoft.base",
"microsoft.base.labels",
"microsoft.base.hybrid",
"microsoft.terra.main",
"microsoft.base.road",
"microsoft.base.darkgrey",
"microsoft.base.labels.road",
"microsoft.base.labels.darkgrey",
"microsoft.base.hybrid.road",
"microsoft.base.hybrid.darkgrey",
"microsoft.imagery",
"microsoft.weather.radar.main",
"microsoft.weather.infrared.main",
"microsoft.traffic.absolute",
"microsoft.traffic.absolute.main",
"microsoft.traffic.relative",
"microsoft.traffic.relative.main",
"microsoft.traffic.relative.dark",
"microsoft.traffic.delay",
"microsoft.traffic.delay.main",
"microsoft.traffic.reduced.main",
"microsoft.traffic.incident"
],
"x-ms-enum": {
"name": "TilesetID",
"modelAsString": true,
"values": [
{
"value": "microsoft.base",
"description": "A base map is a standard map that displays roads, natural and artificial features along with the labels for those features in a vector tile.<br>\n\nSupports zoom levels 0 through 22. Format: vector (pbf)."
},
{
"value": "microsoft.base.labels",
"description": "Displays labels for roads, natural and artificial features in a vector tile.<br>\n\nSupports zoom levels 0 through 22. Format: vector (pbf)."
},
{
"value": "microsoft.base.hybrid",
"description": "Displays road, boundary and label data in a vector tile.<br>\n\nSupports zoom levels 0 through 22. Format: vector (pbf)."
},
{
"value": "microsoft.terra.main",
"description": "Shaded relief and terra layers.<br>\n\nSupports zoom levels 0 through 6. Format: raster (png)."
},
{
"value": "microsoft.base.road",
"description": "All layers with our main style.<br>\n\nSupports zoom levels 0 through 22. Format: raster (png)."
},
{
"value": "microsoft.base.darkgrey",
"description": "All layers with our dark grey style.<br>\n\nSupports zoom levels 0 through 22. Format: raster (png)."
},
{
"value": "microsoft.base.labels.road",
"description": "Label data in our main style.<br>\n\nSupports zoom levels 0 through 22. Format: raster (png)."
},
{
"value": "microsoft.base.labels.darkgrey",
"description": "Label data in our dark grey style.<br>\n\nSupports zoom levels 0 through 22. Format: raster (png)."
},
{
"value": "microsoft.base.hybrid.road",
"description": "Road, boundary and label data in our main style.<br>\n\nSupports zoom levels 0 through 22. Format: raster (png)."
},
{
"value": "microsoft.base.hybrid.darkgrey",
"description": "Road, boundary and label data in our dark grey style.<br>\n\nSupports zoom levels 0 through 22. Format: raster (png)."
},
{
"value": "microsoft.imagery",
"description": "A combination of satellite and aerial imagery. Only available in S1 pricing SKU.<br>\n\nSupports zoom levels 1 through 19. Format: raster (jpeg)."
},
{
"value": "microsoft.weather.radar.main",
"description": "Weather radar tiles. Latest weather radar images including areas of rain, snow, ice and mixed conditions. Please see [coverage information](https://aka.ms/AzureMapsWeatherCoverage) for Azure Maps Weather service. To learn more about the Radar data, please see [Weather concepts](https://aka.ms/AzureMapsWeatherConcepts).<br>\n\nSupports zoom levels 0 through 15. Format: raster (png)."
},
{
"value": "microsoft.weather.infrared.main",
"description": "Weather infrared tiles. Latest Infrared Satellite images shows clouds by their temperature. Please see [coverage information](https://aka.ms/AzureMapsWeatherCoverage) for Azure Maps Weather service. To learn more about the returned Satellite data, please see [Weather concepts](https://aka.ms/AzureMapsWeatherConcepts).<br>\n\nSupports zoom levels 0 through 15. Format: raster (png)."
},
{
"value": "microsoft.traffic.absolute",
"description": "absolute traffic tiles in vector"
},
{
"value": "microsoft.traffic.absolute.main",
"description": "absolute traffic tiles in raster in our main style."
},
{
"value": "microsoft.traffic.relative",
"description": "relative traffic tiles in vector"
},
{
"value": "microsoft.traffic.relative.main",
"description": "relative traffic tiles in raster in our main style."
},
{
"value": "microsoft.traffic.relative.dark",
"description": "relative traffic tiles in raster in our dark style."
},
{
"value": "microsoft.traffic.delay",
"description": "traffic tiles in vector"
},
{
"value": "microsoft.traffic.delay.main",
"description": "traffic tiles in raster in our main style"
},
{
"value": "microsoft.traffic.reduced.main",
"description": "reduced traffic tiles in raster in our main style"
},
{
"value": "microsoft.traffic.incident",
"description": "incident tiles in vector"
}
]
},
"x-ms-parameter-location": "method"
}
},
"paths": {
"/map/tile": {
"get": {
"description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Get Map Tiles API allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default, Azure Maps uses vector tiles for its web map control (Web SDK) and Android SDK.",
"operationId": "Render_GetMapTile",
"x-ms-client-name": "GetMapTile",
"x-ms-examples": {
"Successful Tile Request": {
"$ref": "./examples/Render_GetMapTile.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/TilesetId"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/zTileIndex"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/xTileIndex"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/yTileIndex"
},
{
"name": "timeStamp",
"in": "query",
"format": "date-time",
"description": "The desired date and time of the requested tile. This parameter must be specified in the standard date-time format (e.g. 2019-11-14T16:03:00-08:00), as defined by [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). This parameter is only supported when tilesetId parameter is set to one of the values below.\n \n* microsoft.weather.infrared.main: We provide tiles up to 3 hours in the past. Tiles are available in 10-minute intervals. We round the timeStamp value to the nearest 10-minute time frame.\n* microsoft.weather.radar.main: We provide tiles up to 1.5 hours in the past and up to 2 hours in the future. Tiles are available in 5-minute intervals. We round the timeStamp value to the nearest 5-minute time frame.",
"type": "string"
},
{
"$ref": "#/parameters/MapTileSize"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/Language"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/View"
}
],
"produces": [
"application/json",
"image/jpeg",
"image/png",
"image/pbf",
"application/vnd.mapbox-vector-tile"
],
"responses": {
"200": {
"description": "The tile returned from a successful API call.",
"schema": {
"type": "object",
"format": "file",
"readOnly": true
},
"headers": {
"Content-Type": {
"type": "string",
"description": "The content-type for the response."
}
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/map/tileset": {
"get": {
"description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Get Map Tileset API allows users to request metadata for a tileset.",
"operationId": "Render_GetMapTileset",
"x-ms-examples": {
"Successful Tileset Request": {
"$ref": "./examples/Render_GetMapTileset.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/TilesetId"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MapTileset"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/map/attribution": {
"get": {
"description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Get Map Attribution API allows users to request map copyright attribution information for a section of a tileset.",
"operationId": "Render_GetMapAttribution",
"x-ms-examples": {
"Successful Attribution Request": {
"$ref": "./examples/Render_GetMapAttribution.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/TilesetId"
},
{
"name": "zoom",
"in": "query",
"description": "Zoom level for the desired map attribution.",
"required": true,
"type": "integer",
"format": "int32",
"x-ms-parameter-location": "method"
},
{
"name": "bounds",
"in": "query",
"description": "The string that represents the rectangular area of a bounding box. The bounds parameter is defined by the 4 bounding box coordinates, with WGS84 longitude and latitude of the southwest corner followed by WGS84 longitude and latitude of the northeast corner. The string is presented in the following format: `[SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]`.",
"required": true,
"type": "array",
"collectionFormat": "csv",
"items": {
"type": "number",
"format": "double"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MapAttribution"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/map/statetile": {
"get": {
"description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nFetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid))",
"operationId": "Render_GetMapStateTile",
"x-ms-examples": {
"Successful State Tile Request": {
"$ref": "./examples/Render_GetMapStateTile.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/zTileIndex"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/xTileIndex"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/yTileIndex"
},
{
"name": "statesetId",
"in": "query",
"description": "The stateset id.",
"required": true,
"type": "string"
}
],
"produces": [
"application/vnd.mapbox-vector-tile",
"application/json"
],
"responses": {
"200": {
"description": "This tile is returned from a successful Get Map State Tile call",
"schema": {
"type": "object",
"format": "file",
"readOnly": true
},
"headers": {
"Content-Type": {
"type": "string",
"description": "The content-type for the response."
}
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/map/copyright/caption/{format}": {
"get": {
"description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCopyrights API is designed to serve copyright information for Render Tile \nservice. In addition to basic copyright for the whole map, API is serving \nspecific groups of copyrights for some countries/regions.\n\nAs an alternative to copyrights for map request, one can receive captions\nfor displaying the map provider information on the map.",
"operationId": "Render_GetCopyrightCaption",
"x-ms-examples": {
"Successful Copyright Caption Request": {
"$ref": "./examples/Render_GetCopyrightCaption.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CopyrightCaption"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/map/static/{format}": {
"get": {
"description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. \n\nService also provides Image Composition functionality to get a static image back with additional data like; pushpins and geometry overlays with following capabilities. \n\n- Specify multiple pushpin styles\n- Render circle, polyline and polygon geometry types.\n\nPlease see [How-to-Guide](https://aka.ms/AzureMapsHowToGuideImageCompositor) for detailed examples.\n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the\nAPI.\n<br><br>\nThe supported Lat and Lon ranges when using the **bbox** parameter, are as follows:\n<br><br>\n\n |Zoom Level | Max Lon Range | Max Lat Range|\n |:----------|:----------------|:-------------|\n |0 | 360.0 | 170.0 | \n |1 | 360.0 | 170.0 |\n |2 | 360.0 | 170.0 |\n |3 | 360.0 | 170.0 |\n |4 | 360.0 | 170.0 |\n |5 | 180.0 | 85.0 |\n |6 | 90.0 | 42.5 |\n |7 | 45.0 | 21.25 |\n |8 | 22.5 | 10.625 |\n |9 | 11.25 | 5.3125 |\n |10 | 5.625 | 2.62625 |\n |11 | 2.8125 | 1.328125 |\n |12 | 1.40625 | 0.6640625 |\n |13 | 0.703125 | 0.33203125 |\n |14 | 0.3515625 | 0.166015625 |\n |15 | 0.17578125 | 0.0830078125 | \n |16 | 0.087890625 | 0.0415039063 | \n |17 | 0.0439453125 | 0.0207519531 |\n |18 | 0.0219726563 | 0.0103759766 |\n |19 | 0.0109863281 | 0.0051879883 |\n |20 | 0.0054931641 | 0.0025939941 |",
"operationId": "Render_GetMapStaticImage",
"x-ms-examples": {
"Successful Static Image Request": {
"$ref": "./examples/Render_GetMapStaticImage.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/RasterTileFormat"
},
{
"name": "layer",
"in": "query",
"description": "Map layer requested. If layer is set to labels or hybrid, the format should be png.",
"type": "string",
"enum": [
"basic",
"hybrid",
"labels"
],
"x-ms-enum": {
"name": "StaticMapLayer",
"modelAsString": true,
"values": [
{
"value": "basic",
"description": "Returns an image containing all map features including polygons, borders, roads and labels."
},
{
"value": "hybrid",
"description": "Returns an image containing borders, roads, and labels, and can be overlaid on other tiles (such as satellite imagery) to produce hybrid tiles."
},
{
"value": "labels",
"description": "Returns an image of just the map's label information."
}
]
}
},
{
"name": "style",
"in": "query",
"description": "Map style to be returned. Possible values are main and dark.",
"type": "string",
"enum": [
"main",
"dark"
],
"x-ms-enum": {
"name": "MapImageStyle",
"modelAsString": true,
"values": [
{
"value": "main",
"description": "Azure Maps main style"
},
{
"value": "dark",
"description": "Dark grey version of the Azure Maps main style"
}
]
}
},
{
"name": "zoom",
"in": "query",
"description": "Desired zoom level of the map. Zoom value must be in the range: 0-20 (inclusive). Default value is 12.<br><br>Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.",
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 20
},
{
"name": "center",
"in": "query",
"description": "Coordinates of the center point. Format: 'lon,lat'. Projection used\n- EPSG:3857. Longitude range: -180 to 180. Latitude range: -85 to 85. \n\nNote: Either center or bbox are required parameters. They are\nmutually exclusive.",
"type": "array",
"collectionFormat": "csv",
"items": {
"type": "number",
"format": "double"
}
},
{
"name": "bbox",
"x-ms-client-name": "boundingBoxPrivate",
"in": "query",
"description": "Bounding box. Projection used - EPSG:3857. Format : 'minLon, minLat,\nmaxLon, maxLat'. \n\nNote: Either bbox or center are required\nparameters. They are mutually exclusive. It shouldn’t be used with\nheight or width.\n\nThe maximum allowed ranges for Lat and Lon are defined for each zoom level\nin the table at the top of this page.",
"type": "array",
"collectionFormat": "csv",
"items": {
"type": "number",
"format": "double"
}
},
{
"name": "height",
"in": "query",
"description": "Height of the resulting image in pixels. Range is 1 to 8192. Default\nis 512. It shouldn’t be used with bbox.",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 8192
},
{
"name": "width",
"in": "query",
"description": "Width of the resulting image in pixels. Range is 1 to 8192. Default is 512. It shouldn’t be used with bbox.",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 8192
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/Language"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/View"
},
{
"name": "pins",
"description": "Pushpin style and instances. Use this parameter to optionally add pushpins to the image.\nThe pushpin style describes the appearance of the pushpins, and the instances specify\nthe coordinates of the pushpins and optional labels for each pin. (Be sure to properly URL-encode values of this\nparameter since it will contain reserved characters such as pipes and punctuation.)\n\nThe Azure Maps account S0 SKU only supports a single instance of the pins parameter. Other SKUs\nallow multiple instances of the pins parameter to specify multiple pin styles.\n\nTo render a pushpin at latitude 45°N and longitude 122°W using the default built-in pushpin style, add the\nquerystring parameter \n\n`pins=default||-122 45` \n\nNote that the longitude comes before the latitude.\nAfter URL encoding this will look like\n\n`pins=default%7C%7C-122+45`\n\nAll of the examples here show the pins\nparameter without URL encoding, for clarity.\n\nTo render a pin at multiple locations, separate each location with a pipe character. For example, use\n\n`pins=default||-122 45|-119.5 43.2|-121.67 47.12`\n\nThe S0 Azure Maps account SKU only allows five pushpins. Other account SKUs do not have this limitation.\n\n### Style Modifiers\n\nYou can modify the appearance of the pins by adding style modifiers. These are added after the style but before\nthe locations and labels. Style modifiers each have a two-letter name. These abbreviated names are used to help\nreduce the length of the URL.\n\nTo change the color of the pushpin, use the 'co' style modifier and specify the color using the HTML/CSS RGB color\nformat which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use\na deep pink color which you would specify as #FF1493 in CSS, use\n\n`pins=default|coFF1493||-122 45`\n\n### Pushpin Labels\n\nTo add a label to the pins, put the label in single quotes just before the coordinates. For example, to label\nthree pins with the values '1', '2', and '3', use\n\n`pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12`\n\nThere is a built in pushpin style called 'none' that does not display a pushpin image. You can use this if\nyou want to display labels without any pin image. For example,\n\n`pins=none||'A'-122 45|'B'-119.5 43.2`\n\nTo change the color of the pushpin labels, use the 'lc' label color style modifier. For example, to use pink\npushpins with black labels, use\n\n`pins=default|coFF1493|lc000000||-122 45`\n\nTo change the size of the labels, use the 'ls' label size style modifier. The label size represents the approximate\nheight of the label text in pixels. For example, to increase the label size to 12, use\n\n`pins=default|ls12||'A'-122 45|'B'-119 43`\n\nThe labels are centered at the pushpin 'label anchor.' The anchor location is predefined for built-in pushpins and\nis at the top center of custom pushpins (see below). To override the label anchor, using the 'la' style modifier\nand provide X and Y pixel coordinates for the anchor. These coordinates are relative to the top left corner of the\npushpin image. Positive X values move the anchor to the right, and positive Y values move the anchor down. For example,\nto position the label anchor 10 pixels right and 4 pixels above the top left corner of the pushpin image,\nuse\n\n`pins=default|la10 -4||'A'-122 45|'B'-119 43`\n\n### Custom Pushpins\n\nTo use a custom pushpin image, use the word 'custom' as the pin style name, and then specify a URL after the\nlocation and label information. Use two pipe characters to indicate that you're done specifying locations and are\nstarting the URL. For example,\n\n`pins=custom||-122 45||http://contoso.com/pushpins/red.png`\n\nAfter URL encoding, this would look like\n\n`pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png`\n\nBy default, custom pushpin images are drawn centered at the pin coordinates. This usually isn't ideal as it obscures\nthe location that you're trying to highlight. To override the anchor location of the pin image, use the 'an'\nstyle modifier. This uses the same format as the 'la' label anchor style modifier. For example, if your custom\npin image has the tip of the pin at the top left corner of the image, you can set the anchor to that spot by\nusing\n\n`pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png`\n\nNote: If you use the 'co' color modifier with a custom pushpin image, the specified color will replace the RGB \nchannels of the pixels in the image but will leave the alpha (opacity) channel unchanged. This would usually\nonly be done with a solid-color custom image.\n\n### Scale, Rotation, and Opacity\n\nYou can make pushpins and their labels larger or smaller by using the 'sc' scale style modifier. This is a\nvalue greater than zero. A value of 1 is the standard scale. Values larger than 1 will make the pins larger, and\nvalues smaller than 1 will make them smaller. For example, to draw the pushpins 50% larger than normal, use\n\n`pins=default|sc1.5||-122 45`\n\nYou can rotate pushpins and their labels by using the 'ro' rotation style modifier. This is a number of degrees\nof clockwise rotation. Use a negative number to rotate counter-clockwise. For example, to rotate the pushpins\n90 degrees clockwise and double their size, use\n\n`pins=default|ro90|sc2||-122 45`\n\nYou can make pushpins and their labels partially transparent by specifying the 'al' alpha style modifier.\nThis is a number between 0 and 1 indicating the opacity of the pushpins. Zero makes them completely transparent\n(and not visible) and 1 makes them completely opaque (which is the default). For example, to make pushpins\nand their labels only 67% opaque, use\n\n`pins=default|al.67||-122 45`\n\n### Style Modifier Summary\n\nModifier | Description | Range \n:--------:|-----------------|------------------\nal | Alpha (opacity) | 0 to 1 \nan | Pin anchor | * \nco | Pin color | 000000 to FFFFFF \nla | Label anchor | * \nlc | Label color | 000000 to FFFFFF \nls | Label size | Greater than 0 \nro | Rotation | -360 to 360 \nsc | Scale | Greater than 0 \n\n* X and Y coordinates can be anywhere within pin image or a margin around it.\nThe margin size is the minimum of the pin width and height.",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"items": {
"type": "string"
}
},
{
"name": "path",
"description": "Path style and locations. Use this parameter to optionally add lines, polygons or circles to the image.\nThe path style describes the appearance of the line and fill. (Be sure to properly URL-encode values of this\nparameter since it will contain reserved characters such as pipes and punctuation.)\n\nPath parameter is supported in Azure Maps account SKU starting with S1. Multiple instances of the path parameter \nallow to specify multiple geometries with their styles. Number of parameters per request is limited to 10 and\nnumber of locations is limited to 100 per path.\n\nTo render a circle with radius 100 meters and center point at latitude 45°N and longitude 122°W using the default style, add the\nquerystring parameter \n\n`path=ra100||-122 45` \n\nNote that the longitude comes before the latitude.\nAfter URL encoding this will look like\n\n`path=ra100%7C%7C-122+45`\n\nAll of the examples here show the path parameter without URL encoding, for clarity.\n\nTo render a line, separate each location with a pipe character. For example, use\n\n`path=||-122 45|-119.5 43.2|-121.67 47.12`\n\nTo render a polygon, last location must be equal to the start location. For example, use\n\n`path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45`\n\nLongitude and latitude values for locations of lines and polygons can be in the range from -360 to 360 to allow for rendering of geometries crossing the anti-meridian.\n\n### Style Modifiers\n\nYou can modify the appearance of the path by adding style modifiers. These are added before the locations. \nStyle modifiers each have a two-letter name. These abbreviated names are used to help reduce the length\nof the URL.\n\nTo change the color of the outline, use the 'lc' style modifier and specify the color using the HTML/CSS RGB color\nformat which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use\na deep pink color which you would specify as #FF1493 in CSS, use\n\n`path=lcFF1493||-122 45|-119.5 43.2`\n\nMultiple style modifiers may be combined together to create a more complex visual style.\n\n`lc0000FF|lw3|la0.60|fa0.50||-122.2 47.6|-122.2 47.7|-122.3 47.7|-122.3 47.6|-122.2 47.6`\n\n### Style Modifier Summary\n\nModifier | Description | Range \n:--------:|------------------------|------------------\nlc | Line color | 000000 to FFFFFF\nfc | Fill color | 000000 to FFFFFF\nla | Line alpha (opacity) | 0 to 1 \nfa | Fill alpha (opacity) | 0 to 1 \nlw | Line width | Greater than 0 \nra | Circle radius (meters) | Greater than 0",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"items": {
"type": "string"
}
}
],
"produces": [
"application/json",
"image/jpeg",
"image/png",
"image/pbf",
"application/vnd.mapbox-vector-tile"
],
"responses": {
"200": {
"description": "This image is returned from a successful Get Map Static Image call",
"schema": {
"type": "object",
"format": "file",
"readOnly": true
},
"headers": {
"Content-Type": {
"type": "string",
"description": "The content-type for the response."
}
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/map/copyright/bounding/{format}": {
"get": {
"description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nReturns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates",
"operationId": "Render_GetCopyrightFromBoundingBox",
"x-ms-examples": {
"Successful BoundingBox Copyright Request": {
"$ref": "./examples/Render_GetCopyrightFromBoundingBox.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/BoundingBoxSouthWest"
},
{
"$ref": "#/parameters/BoundingBoxNorthEast"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/IncludeText"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Copyright"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/map/copyright/tile/{format}": {
"get": {
"description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.\nReturns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid).",
"operationId": "Render_GetCopyrightForTile",
"x-ms-examples": {
"Successful Tile Copyright Request": {
"$ref": "./examples/Render_GetCopyrightForTile.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/zTileIndex"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/xTileIndex"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/yTileIndex"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/IncludeText"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Copyright"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/map/copyright/world/{format}": {
"get": {
"description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.\nReturns the copyright information for the world. To obtain the default copyright information for the whole world, do not specify a tile or bounding box.",
"operationId": "Render_GetCopyrightForWorld",
"x-ms-examples": {
"Successful World Copyright Request": {
"$ref": "./examples/Render_GetCopyrightForWorld.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat"
},
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/IncludeText"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Copyright"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
}
},
"definitions": {
"Copyright": {
"description": "This object is returned from a successful copyright request",
"type": "object",
"properties": {
"formatVersion": {
"description": "Format Version property",
"type": "string",
"readOnly": true
},
"generalCopyrights": {
"description": "General Copyrights array",
"type": "array",
"readOnly": true,
"items": {
"type": "string",
"readOnly": true
}
},
"regions": {
"description": "Regions array",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/RegionCopyrights"
}
}
}
},
"CopyrightCaption": {
"description": "This object is returned from a successful copyright call",
"type": "object",
"properties": {
"formatVersion": {
"description": "Format Version property",
"type": "string",
"readOnly": true
},
"copyrightsCaption": {
"description": "Copyrights Caption property",
"type": "string",
"readOnly": true
}
}
},
"MapAttribution": {
"description": "Copyright attribution for the requested section of a tileset.",
"type": "object",
"readOnly": true,
"properties": {
"copyrights": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of copyright strings."
}
}
},
"MapTileset": {
"description": "Metadata for a tileset in the TileJSON format.",
"type": "object",
"readOnly": true,
"properties": {
"tilejson": {
"type": "string",
"pattern": "\\d+\\.\\d+\\.\\d+\\w?[\\w\\d]*",
"description": "Describes the version of the TileJSON spec that is implemented by this JSON object."
},
"name": {
"type": "string",
"description": "A name describing the tileset. The name can contain any legal character. Implementations SHOULD NOT interpret the name as HTML."
},
"description": {
"type": "string",
"description": "Text description of the tileset. The description can contain any legal character. Implementations SHOULD NOT interpret the description as HTML."
},
"version": {
"type": "string",
"pattern": "\\d+\\.\\d+\\.\\d+\\w?[\\w\\d]*",
"description": "A semver.org style version number for the tiles contained within the tileset. When changes across tiles are introduced, the minor version MUST change."
},
"attribution": {
"type": "string",
"description": "Copyright attribution to be displayed on the map. Implementations MAY decide to treat this as HTML or literal text. For security reasons, make absolutely sure that this field can't be abused as a vector for XSS or beacon tracking."
},
"template": {
"type": "string",
"description": "A mustache template to be used to format data from grids for interaction."
},
"legend": {
"type": "string",
"description": "A legend to be displayed with the map. Implementations MAY decide to treat this as HTML or literal text. For security reasons, make absolutely sure that this field can't be abused as a vector for XSS or beacon tracking."
},
"scheme": {
"type": "string",
"description": "Default: \"xyz\". Either \"xyz\" or \"tms\". Influences the y direction of the tile coordinates. The global-mercator (aka Spherical Mercator) profile is assumed."
},
"tiles": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tile endpoints. If multiple endpoints are specified, clients may use any combination of endpoints. All endpoints MUST return the same content for the same URL. The array MUST contain at least one endpoint."
},
"grids": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of interactivity endpoints."
},
"data": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of data files in GeoJSON format."
},
"minzoom": {
"x-ms-client-name": "minZoom",
"minimum": 0,
"maximum": 30,
"type": "integer",
"description": "The minimum zoom level."
},
"maxzoom": {
"x-ms-client-name": "maxZoom",
"minimum": 0,
"maximum": 30,
"type": "integer",
"description": "The maximum zoom level."
},
"bounds": {
"type": "array",
"items": {
"type": "number"
},
"description": "The maximum extent of available map tiles. Bounds MUST define an area covered by all zoom levels. The bounds are represented in WGS:84 latitude and longitude values, in the order left, bottom, right, top. Values may be integers or floating point numbers."
},
"center": {
"type": "array",
"items": {
"type": "number"
},
"description": "The default location of the tileset in the form [longitude, latitude, zoom]. The zoom level MUST be between minzoom and maxzoom. Implementations can use this value to set the default location."
}
}
},
"RegionCopyrights": {
"type": "object",
"properties": {
"copyrights": {
"description": "Copyrights array",
"type": "array",
"readOnly": true,
"items": {
"type": "string",
"readOnly": true
}
},
"country": {
"description": "Country property",
"type": "object",
"readOnly": true,
"properties": {
"ISO3": {
"description": "ISO3 property",
"type": "string",