-
Notifications
You must be signed in to change notification settings - Fork 5.2k
/
Copy pathfeaturestate.json
702 lines (702 loc) · 29.4 KB
/
featurestate.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
{
"swagger": "2.0",
"info": {
"title": "Azure Maps Feature State Service",
"version": "2.0",
"description": "APIs for managing the dynamic feature states in Azure Maps."
},
"x-ms-parameterized-host": {
"hostTemplate": "{geography}.atlas.microsoft.com",
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation"
}
]
},
"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](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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 Microsoft Entra ID 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"
}
},
"SharedKey": {
"type": "apiKey",
"description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.",
"name": "subscription-key",
"in": "query"
},
"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"
]
},
{
"SharedKey": []
},
{
"SasToken": []
}
],
"responses": {},
"parameters": {
"ApiVersion": {
"name": "api-version",
"description": "Version number of Azure Maps API.",
"type": "string",
"in": "query",
"required": true,
"default": "2.0",
"x-ms-parameter-location": "client"
},
"FeatureStateSetDescription": {
"name": "description",
"description": "Description for the stateset. Max length allowed is 1000.",
"type": "string",
"in": "query",
"required": false,
"x-ms-parameter-location": "method"
},
"DatasetIdForCreate": {
"name": "datasetId",
"description": "The datasetId must have been obtained from a successful [Dataset Create API](/rest/api/maps-creator/dataset/create) call.",
"type": "string",
"in": "query",
"required": true,
"x-ms-parameter-location": "method"
},
"StatesetIdInPath": {
"name": "statesetId",
"description": "The stateset id that was created.",
"type": "string",
"in": "path",
"required": true,
"x-ms-parameter-location": "method"
},
"FeatureIdSet": {
"name": "featureId",
"description": "The id of a feature in the given dataset. If the featureId is not present in the dataset, Bad Request response will be returned.",
"type": "string",
"in": "path",
"required": true,
"x-ms-parameter-location": "method"
},
"FeatureIdGet": {
"name": "featureId",
"description": "The id of a feature in the given stateset. If no state was set for the featureId in the stateset earlier, Bad Request response will be returned.",
"type": "string",
"in": "path",
"required": true,
"x-ms-parameter-location": "method"
},
"FeatureIdDelete": {
"name": "featureId",
"description": "The id of a feature in the given stateset. If no state was set for the featureId in the stateset earlier, Bad Request response will be returned.",
"type": "string",
"in": "path",
"required": true,
"x-ms-parameter-location": "method"
},
"StateKeyName": {
"name": "stateKeyName",
"x-ms-client-name": "keyName",
"description": "The Name of the state to be deleted.",
"type": "string",
"in": "query",
"required": true,
"x-ms-parameter-location": "method"
}
},
"paths": {
"/featureStateSets": {
"post": {
"summary": "Use to create a new stateset.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Create Stateset` API is an HTTP `POST` request used to create a new stateset, defining the values and corresponding styles for its properties in the body of the request. For more information, see [Create a feature stateset](/azure/azure-maps/how-to-creator-feature-stateset).\n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the stateset. Like tileset, stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that `statesetId` to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. For more information, see the Render services [Get Map State Tile](/rest/api/maps/render/get-map-state-tile).",
"operationId": "FeatureState_CreateStateset",
"x-ms-examples": {
"Create a new stateset with a datasetId": {
"$ref": "./examples/featurestate/Featurestate_CreateStateset.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/DatasetIdForCreate"
},
{
"$ref": "#/parameters/FeatureStateSetDescription"
},
{
"name": "styleRules",
"in": "body",
"description": "The stateset style JSON data.",
"required": true,
"schema": {
"$ref": "#/definitions/StyleRules"
}
}
],
"responses": {
"200": {
"description": "Stateset created.",
"schema": {
"$ref": "#/definitions/StatesetCreatedResult"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
},
"get": {
"summary": "Use to get a list of statesets.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit List Statesets Request \n\nThe `List Statesets` API is an HTTP `GET` request used to return a list of existing statesets.",
"operationId": "FeatureState_ListStatesets",
"x-ms-examples": {
"List all the previously created statesets": {
"$ref": "./examples/featurestate/Featurestate_List.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
}
],
"x-ms-pageable": {
"itemName": "statesets",
"nextLinkName": "nextLink"
},
"responses": {
"200": {
"description": "The list stateset request completed successfully. The response body contains a list of all the previously created statesets.",
"schema": {
"$ref": "#/definitions/StatesetListResult"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/featureStateSets/{statesetId}": {
"put": {
"summary": "Use to update the stateset style rules.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Update Stateset Request \n\nThe `Update Stateset` API is an HTTP `PUT` request used to update the stateset style rules of the specified stateset.",
"operationId": "FeatureState_UpdateStateset",
"x-ms-examples": {
"Update stateset style rules with a statesetId": {
"$ref": "./examples/featurestate/Featurestate_UpdateStateset.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/StatesetIdInPath"
},
{
"name": "styleRules",
"in": "body",
"description": "The stateset style JSON data. Only style rules are allowed to be updated, update on keyname and type is not allowed.",
"required": true,
"schema": {
"$ref": "#/definitions/StyleRules"
}
}
],
"responses": {
"200": {
"description": "Stateset styles are updated successfully."
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
},
"delete": {
"summary": "Use to delete a stateset and its associated data.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Delete Stateset Request \n\nThe `Delete Stateset` API is an HTTP `DELETE` request used to delete the specified stateset and its associated data.",
"operationId": "FeatureState_DeleteStateset",
"x-ms-examples": {
"Delete an existing stateset": {
"$ref": "./examples/featurestate/Featurestate_DeleteStateset.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/StatesetIdInPath"
}
],
"responses": {
"204": {
"description": "Stateset Deleted."
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
},
"get": {
"summary": "Use to retrieve stateset information.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get Stateset` API is an HTTP `GET` request used to retrieve the specified stateset information, including the `datasetId` associated to the stateset, and its styles.",
"operationId": "FeatureState_GetStateset",
"x-ms-examples": {
"Get stateset information with a statesetId": {
"$ref": "./examples/featurestate/Featurestate_GetStateset.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/StatesetIdInPath"
}
],
"responses": {
"200": {
"description": "Get request completed successfully.",
"schema": {
"$ref": "#/definitions/Stateset"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
},
"/featureStateSets/{statesetId}/featureStates/{featureId}": {
"put": {
"operationId": "FeatureState_UpdateStates",
"summary": "Use to update the state of a feature.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Update States Request \n\n The `Update States` API is a `PUT` request that allows the user to update the state of the specified feature in a given stateset.",
"x-ms-examples": {
"Update the states of a feature": {
"$ref": "./examples/featurestate/Featurestate_UpdateStates.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/StatesetIdInPath"
},
{
"$ref": "#/parameters/FeatureIdSet"
},
{
"name": "featureStates",
"in": "body",
"description": "The feature state JSON data. A feature can have only one state at a given point in time. The specified state keyname must have been defined during the stateset creation.",
"required": true,
"schema": {
"$ref": "#/definitions/FeatureStatesStructure"
}
}
],
"responses": {
"200": {
"description": "Feature states are updated successfully."
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
},
"delete": {
"operationId": "FeatureState_DeleteState",
"summary": "Use to delete state information.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Delete State` API is an HTTP `DELETE` request is used to delete state information defined by the `stateKeyName` parameter for the specified feature as specified by the `featureId` parameter in the the stateset.",
"x-ms-examples": {
"Delete the given feature state": {
"$ref": "./examples/featurestate/Featurestate_DeleteFeatureState.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/StatesetIdInPath"
},
{
"$ref": "#/parameters/FeatureIdDelete"
},
{
"$ref": "#/parameters/StateKeyName"
}
],
"responses": {
"204": {
"description": "Feature states deleted successfully."
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
},
"get": {
"operationId": "FeatureState_ListStates",
"summary": "Use to get the state information of a feature.",
"description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit List States Request \n\n The `List States` API is an HTTP `GET` request used to return the current state information associated with the specified feature in a given stateset.",
"x-ms-examples": {
"Get the current states of a feature": {
"$ref": "./examples/featurestate/Featurestate_ListStates.json"
}
},
"parameters": [
{
"$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/StatesetIdInPath"
},
{
"$ref": "#/parameters/FeatureIdGet"
}
],
"responses": {
"200": {
"description": "Get request completed successfully.",
"schema": {
"$ref": "#/definitions/FeatureStatesStructure"
}
},
"default": {
"$ref": "../../../Common/preview/1.0/common.json#/responses/default"
}
}
}
}
},
"definitions": {
"Stateset": {
"description": "The response model for the successful Stateset Get API.",
"type": "object",
"properties": {
"description": {
"description": "Description associated with the stateset.",
"type": "string",
"readOnly": true
},
"datasetIds": {
"description": "Dataset ID associated with the stateset.",
"type": "array",
"items": {
"type": "string"
}
},
"statesetStyle": {
"x-ms-client-name": "styleRules",
"$ref": "#/definitions/StyleRules"
}
}
},
"StatesetListResult": {
"description": "The response model for the successful Stateset List API.",
"type": "object",
"properties": {
"statesets": {
"description": "A list of statesets information.",
"type": "array",
"items": {
"$ref": "#/definitions/StatesetInfo"
}
},
"nextLink": {
"description": "If present, the location of the next page of data.",
"type": "string",
"readOnly": true
}
}
},
"StatesetInfo": {
"description": "The stateset information detail.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Stateset"
}
],
"properties": {
"statesetId": {
"description": "The stateset ID of this stateset.",
"type": "string",
"readOnly": true
}
}
},
"StatesetCreatedResult": {
"description": "The response model for the successful Stateset Create API.",
"type": "object",
"properties": {
"statesetId": {
"description": "The ID for the new stateset created.",
"type": "string",
"readOnly": true
}
}
},
"FeatureStatesStructure": {
"description": "The feature states model for a feature.",
"type": "object",
"properties": {
"states": {
"description": "The feature states array.",
"type": "array",
"items": {
"$ref": "#/definitions/FeatureState"
}
}
}
},
"FeatureState": {
"description": "Single feature state model.",
"type": "object",
"properties": {
"keyName": {
"description": "Feature state Keyname. Maximum length allowed is 1000.",
"type": "string"
},
"value": {
"description": "Value for the feature state. Type should comply with the style definition attached to the featurestate. Maximum length allowed for string type is 1024.",
"type": "string"
},
"eventTimestamp": {
"description": "Valid Timestamp when the feature state was captured.",
"type": "string"
}
}
},
"StyleRules": {
"description": "The styles model.",
"type": "object",
"properties": {
"styles": {
"x-ms-client-name": "styleRules",
"description": "An array of stateset style rules. The style rule could be a numeric or string or a boolean type style rule. Refer to NumberRule, StringRule and BooleanRule definitions [here](https://aka.ms/AzureMapsStatesetStyles). ",
"type": "array",
"items": {
"$ref": "#/definitions/StyleRule"
}
}
}
},
"NumberRule": {
"description": "The numeric rule. The color is selected from the first range it falls into.",
"type": "object",
"properties": {
"range": {
"$ref": "#/definitions/Range"
},
"color": {
"description": "The color when value is within the range. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.",
"type": "string"
}
}
},
"Range": {
"description": "The numeric value range for this style rule. If the value is in the range, all the conditions must hold true.",
"type": "object",
"properties": {
"minimum": {
"description": "All the number x that x ≥ minimum.",
"type": "string"
},
"maximum": {
"description": "All the number x that x ≤ maximum.",
"type": "string"
},
"exclusiveMinimum": {
"description": "All the number x that x > exclusiveMinimum.",
"type": "string"
},
"exclusiveMaximum": {
"description": "All the number x that x < exclusiveMaximum.",
"type": "string"
}
}
},
"BooleanRule": {
"description": "The boolean rule. The color is selected based on the logic value of the key.",
"type": "object",
"properties": {
"true": {
"description": "The color when value is true. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.",
"type": "string"
},
"false": {
"description": "The color when value is false. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.",
"type": "string"
}
}
},
"StringRuleObject": {
"description": "The string rule. The string value matching is case sensitive. If a feature's state doesn't match any of the values defined here, that feature will not have any dynamic style. If duplicate string values are given, the first one takes precedence.",
"type": "object",
"additionalProperties": {
"description": "The color when the keyName value string is equal to this property name. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.",
"type": "string"
}
},
"StyleRule": {
"description": "The stateset style model. The style rule could be a numeric type style rule or a boolean type style rule. Refer to NumberRule, StringRuleObject and BooleanRule definitions [here](https://aka.ms/AzureMapsStatesetStyles). ",
"discriminator": "type",
"type": "object",
"required": [
"keyName",
"type"
],
"properties": {
"keyName": {
"description": "Stateset style key name. Key names are random strings but they should be unique inside style array.",
"type": "string"
},
"type": {
"description": "The type of stateset style.",
"type": "string",
"enum": [
"boolean",
"number",
"string"
],
"x-ms-enum": {
"name": "StyleRuleType",
"modelAsString": true,
"values": [
{
"value": "boolean",
"description": "Boolean type of stateset style."
},
{
"value": "number",
"description": "Number type of stateset style."
},
{
"value": "string",
"description": "String type of stateset style."
}
]
}
}
}
},
"BooleanStyleRule": {
"description": "The boolean type style rule object.",
"x-ms-discriminator-value": "boolean",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/StyleRule"
}
],
"properties": {
"rules": {
"description": "Boolean style rules.",
"type": "array",
"items": {
"$ref": "#/definitions/BooleanRule"
}
}
},
"required": [
"rules"
]
},
"NumberStyleRule": {
"description": "The numeric type style rule object.",
"x-ms-discriminator-value": "number",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/StyleRule"
}
],
"properties": {
"rules": {
"description": "Numeric style rules.",
"type": "array",
"items": {
"$ref": "#/definitions/NumberRule"
}
}
},
"required": [
"rules"
]
},
"StringStyleRule": {
"description": "The string type style rule object.",
"x-ms-discriminator-value": "string",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/StyleRule"
}
],
"properties": {
"rules": {
"description": "String style rules.",
"type": "array",
"items": {
"$ref": "#/definitions/StringRuleObject"
}
}
},
"required": [
"rules"
]
}
}
}