-
Notifications
You must be signed in to change notification settings - Fork 4.9k
/
imds.json
765 lines (765 loc) · 22.9 KB
/
imds.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
{
"swagger": "2.0",
"info": {
"title": "InstanceMetadataClient",
"description": "The Azure Instance Metadata Client",
"version": "2018-10-01"
},
"host": "169.254.169.254",
"basePath": "/metadata",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {
"/instance": {
"get": {
"operationId": "Instances_GetMetadata",
"description": "Get Instance Metadata for the Virtual Machine.",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/MetadataParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Instance"
}
},
"400": {
"description": "Invalid request",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"405": {
"description": "Method not allowed",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"429": {
"description": "Too many requests",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"503": {
"description": "Service unavailable",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Instance Metadata for the VM": {
"$ref": "./examples/getInstanceMetadata.json"
}
}
}
},
"/attested/document": {
"get": {
"operationId": "Attested_GetDocument",
"description": "Get Attested Data for the Virtual Machine.",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"name": "nonce",
"in": "query",
"required": false,
"type": "string",
"description": "This is a string of up to 32 random alphanumeric characters."
},
{
"$ref": "#/parameters/MetadataParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AttestedData"
}
},
"400": {
"description": "Invalid request",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"405": {
"description": "Method not allowed",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"429": {
"description": "Too many requests",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"503": {
"description": "Service unavailable",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get Attested Data for the VM": {
"$ref": "./examples/getAttestedData.json"
}
}
}
},
"/identity/oauth2/token": {
"get": {
"tags": [
"Get token"
],
"description": "Get a Token from Azure AD",
"operationId": "Identity_GetToken",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/MetadataParameter"
},
{
"name": "resource",
"in": "query",
"type": "string",
"description": "This is the urlencoded identifier URI of the sink resource for the requested Azure AD token. The resulting token contains the corresponding aud for this resource.",
"required": true
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"name": "client_id",
"in": "query",
"type": "string",
"description": "This identifies, by Azure AD client id, a specific explicit identity to use when authenticating to Azure AD. Mutually exclusive with object_id and msi_res_id.",
"required": false
},
{
"name": "object_id",
"in": "query",
"type": "string",
"description": "This identifies, by Azure AD object id, a specific explicit identity to use when authenticating to Azure AD. Mutually exclusive with client_id and msi_res_id.",
"required": false
},
{
"name": "msi_res_id",
"in": "query",
"type": "string",
"description": "This identifies, by urlencoded ARM resource id, a specific explicit identity to use when authenticating to Azure AD. Mutually exclusive with client_id and object_id.",
"required": false
},
{
"name": "authority",
"in": "query",
"type": "string",
"description": "This indicates the authority to request AAD tokens from. Defaults to the known authority of the identity to be used.",
"required": false
},
{
"name": "bypass_cache",
"in": "query",
"type": "string",
"enum": [
"true"
],
"description": "If provided, the value must be 'true'. This indicates to the server that the token must be retrieved from Azure AD and cannot be retrieved from an internal cache.",
"required": false,
"x-ms-enum": {
"name": "BypassCache",
"modelAsString": true
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"$ref": "#/definitions/IdentityTokenResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"$ref": "#/definitions/IdentityErrorResponse"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/IdentityErrorResponse"
}
},
"405": {
"description": "Method not allowed",
"schema": {
"$ref": "#/definitions/IdentityErrorResponse"
}
},
"429": {
"description": "Too many requests",
"schema": {
"$ref": "#/definitions/IdentityErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"$ref": "#/definitions/IdentityErrorResponse"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/IdentityErrorResponse"
}
}
},
"x-ms-examples": {
"Get Identity Token for the VM": {
"$ref": "./examples/getIdentityToken.json"
}
}
}
},
"/identity/info": {
"get": {
"tags": [
"Get metadata information"
],
"description": "Get information about AAD Metadata",
"operationId": "Identity_GetInfo",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/MetadataParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"$ref": "#/definitions/IdentityInfoResponse"
}
},
"400": {
"description": "Invalid request",
"schema": {
"$ref": "#/definitions/IdentityErrorResponse"
}
},
"404": {
"description": "Not found",
"schema": {
"$ref": "#/definitions/IdentityErrorResponse"
}
},
"405": {
"description": "Method not allowed",
"schema": {
"$ref": "#/definitions/IdentityErrorResponse"
}
},
"429": {
"description": "Too many requests",
"schema": {
"$ref": "#/definitions/IdentityErrorResponse"
}
},
"500": {
"description": "Server error",
"schema": {
"$ref": "#/definitions/IdentityErrorResponse"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/IdentityErrorResponse"
}
}
},
"x-ms-examples": {
"Get Identity Info for the VM": {
"$ref": "./examples/getIdentityInfo.json"
}
}
}
}
},
"definitions": {
"Compute": {
"type": "object",
"properties": {
"azEnvironment": {
"type": "string",
"description": "This is the name of the environment in which the VM is running."
},
"location": {
"type": "string",
"description": "This is the Azure Region in which the VM is running."
},
"name": {
"type": "string",
"description": "This is the name of the VM."
},
"offer": {
"type": "string",
"description": "This is the offer information for the VM image. This value is only present for images deployed from the Azure Image Gallery."
},
"osType": {
"type": "string",
"description": "This value indicates the type of OS the VM is running, either Linux or Windows."
},
"placementGroupId": {
"type": "string",
"description": "This is the placement group of your Virtual Machine Scale Set."
},
"plan": {
"type": "object",
"description": "This contains the data about the plan.",
"$ref": "#/definitions/PlanProperties"
},
"publicKeys": {
"type": "array",
"items": {
"$ref": "#/definitions/PublicKeysProperties"
},
"description": "This is information about the SSH certificate"
},
"platformFaultDomain": {
"type": "string",
"description": "This is the fault domain in which the VM."
},
"platformUpdateDomain": {
"type": "string",
"description": "This is the update domain in which the VM."
},
"provider": {
"type": "string",
"description": "This is the provider of the VM."
},
"publisher": {
"type": "string",
"description": "This is the publisher of the VM image."
},
"resourceGroupName": {
"type": "string",
"description": "This is the resource group for the VM."
},
"sku": {
"type": "string",
"description": "This is the specific SKU for the VM image."
},
"subscriptionId": {
"type": "string",
"description": "This is the Azure subscription for the VM."
},
"tags": {
"type": "string",
"description": "This is the list of tags for your VM."
},
"version": {
"type": "string",
"description": "This is the version of the VM image."
},
"vmId": {
"type": "string",
"description": "This is the unique identifier for the VM."
},
"vmScaleSetName": {
"type": "string",
"description": "This is the resource name of the VMSS."
},
"vmSize": {
"type": "string",
"description": "This is the size of the VM."
},
"zone": {
"type": "string",
"description": "This is the availability zone of the VM."
}
},
"description": "Compute Metadata"
},
"Network": {
"type": "object",
"properties": {
"interface": {
"type": "array",
"description": "This contains data about the network interface.",
"items": {
"type": "object",
"$ref": "#/definitions/NetworkInterface"
}
}
},
"description": "Network Metadata"
},
"NetworkInterface": {
"type": "object",
"description": "This contains data about the network interface.",
"properties": {
"ipv4": {
"type": "object",
"description": "This contains the IPv4 address.",
"properties": {
"ipAddress": {
"type": "array",
"description": "This is the IP address",
"items": {
"type": "object",
"description": "This contains the IPv4 properties.",
"$ref": "#/definitions/Ipv4Properties"
}
},
"subnet": {
"type": "array",
"description": "This is the subnet",
"items": {
"type": "object",
"description": "This contains the subnet properties.",
"$ref": "#/definitions/SubnetProperties"
}
}
}
},
"ipv6": {
"type": "object",
"description": "This contains the IPv6 address.",
"properties": {
"ipAddress": {
"type": "array",
"description": "This is the IP address",
"items": {
"type": "object",
"description": "This contains the IPv6 properties.",
"$ref": "#/definitions/Ipv6Properties"
}
}
}
},
"macAddress": {
"type": "string",
"description": "This is the MAC address of the interface."
}
}
},
"PlanProperties": {
"type": "object",
"description": "This contains the data about the plan.",
"properties": {
"name": {
"type": "string",
"description": "This is the Plan ID."
},
"publisher": {
"type": "string",
"description": "This is the publisher ID."
},
"product": {
"type": "string",
"description": "This is the product of the image from the Marketplace."
}
}
},
"PublicKeysProperties": {
"type": "object",
"description": "This contains the data about the public key.",
"properties": {
"path": {
"type": "string",
"description": "This specifies the full path on the VM where the SSH public key is stored."
},
"keyData": {
"type": "string",
"description": "This is the SSH public key certificate used to authenticate with the VM."
}
}
},
"Ipv4Properties": {
"type": "object",
"description": "This contains the IPv4 properties.",
"properties": {
"privateIpAddress": {
"type": "string",
"description": "This is the private IP address assigned to the interface."
},
"publicIpAddress": {
"type": "string",
"description": "This is the public IP address assigned to the interface."
}
}
},
"Ipv6Properties": {
"type": "object",
"description": "This contains the IPv6 properties.",
"properties": {
"privateIpAddress": {
"type": "string",
"description": "This is the private IPv6 address assigned to the interface."
}
}
},
"SubnetProperties": {
"type": "object",
"description": "This contains the properties of the subnet.",
"properties": {
"address": {
"type": "string",
"description": "This is the address range of the subnet."
},
"prefix": {
"type": "string",
"description": "This is the prefix of the subnet."
}
}
},
"Instance": {
"type": "object",
"description": "This is the response from the Instance_GetMetadata operation.",
"properties": {
"compute": {
"$ref": "#/definitions/Compute",
"description": "Compute Metadata"
},
"network": {
"$ref": "#/definitions/Network",
"description": "Network Metadata"
}
}
},
"AttestedData": {
"type": "object",
"description": "This is the response from the Attested_GetDocument operation.",
"properties": {
"signature": {
"type": "string",
"description": "This is the encoded string containing the VM ID, plan information, public key, timestamp, and nonce value."
},
"encoding": {
"type": "string",
"description": "This is the encoding scheme of the signature."
}
}
},
"ErrorResponse": {
"description": "This is the response from an operation in the case an error occurs.",
"type": "object",
"properties": {
"error": {
"description": "Error message indicating why the operation failed.",
"type": "string"
}
}
},
"IdentityErrorResponse": {
"type": "object",
"description": "This is the response from an Identity operation in the case an error occurs.",
"properties": {
"error": {
"type": "string",
"description": "Error code",
"enum": [
"invalid_request",
"unauthorized_client",
"access_denied",
"unsupported_response_type",
"invalid_scope",
"server_error",
"service_unavailable",
"bad_request",
"forbidden",
"not_found",
"method_not_allowed",
"too_many_requests"
],
"x-ms-enum": {
"name": "Error",
"modelAsString": true
}
},
"error_description": {
"type": "string",
"description": "Error message indicating why the operation failed."
}
}
},
"IdentityTokenResponse": {
"type": "object",
"description": "This is the response from the Identity_GetToken operation.",
"properties": {
"access_token": {
"type": "string",
"description": "This is the requested access token. The app can use this token to authenticate to the sink resource."
},
"expires_in": {
"type": "string",
"description": "This is how long the access token is valid (in seconds)."
},
"expires_on": {
"type": "string",
"description": "This is the time when the access token expires. The date is represented as the number of seconds from 1970-01-01T0:0:0Z UTC until the expiration time. This value is used to determine the lifetime of cached tokens."
},
"ext_expires_in": {
"type": "string",
"description": "This indicates the extended lifetime of the token."
},
"not_before": {
"type": "string",
"description": "This is the time when the access token becomes effective. The date is represented as the number of seconds from 1970-01-01T0:0:0Z UTC until the expiration time."
},
"resource": {
"type": "string",
"description": "This is the app ID URI of the sink resource."
},
"token_type": {
"type": "string",
"description": "This indicates the token type value."
},
"client_id": {
"type": "string",
"description": "This is the client_id specified in the request, if any."
},
"object_id": {
"type": "string",
"description": "This is the object_id specified in the request, if any."
},
"msi_res_id": {
"type": "string",
"description": "This is the msi_res_id specified in the request, if any."
}
}
},
"IdentityInfoResponse": {
"type": "object",
"description": "This is the response from the Identity_GetInfo operation.",
"properties": {
"tenantId": {
"type": "string",
"description": "This is the AAD tenantId of the identity of the caller."
}
}
}
},
"parameters": {
"ApiVersionParameter": {
"name": "api-version",
"in": "query",
"type": "string",
"enum": [
"2018-10-01"
],
"description": "This is the API version to use.",
"required": true,
"x-ms-enum": {
"name": "ApiVersion",
"modelAsString": true
}
},
"MetadataParameter": {
"name": "Metadata",
"in": "header",
"type": "string",
"enum": [
"true"
],
"description": "This must be set to 'true'.",
"required": true,
"x-ms-parameter-location": "method"
}
}
}