-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
dedicatedhsm.json
775 lines (775 loc) · 25.7 KB
/
dedicatedhsm.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
{
"swagger": "2.0",
"info": {
"title": "Azure Dedicated HSM Resource Provider",
"description": "The Azure management API provides a RESTful set of web services that interact with Azure Dedicated HSM RP.",
"version": "2024-06-30-preview"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"produces": [
"application/json"
],
"consumes": [
"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": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/{name}": {
"put": {
"tags": [
"DedicatedHsms"
],
"operationId": "DedicatedHsm_CreateOrUpdate",
"x-ms-long-running-operation": true,
"description": "Create or Update a dedicated HSM in the specified subscription.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/DedicatedHsmName"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/DedicatedHsm"
},
"description": "Parameters to create or update the dedicated hsm"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"201": {
"description": "Created dedicated HSM",
"schema": {
"$ref": "#/definitions/DedicatedHsm"
}
},
"200": {
"description": "Created dedicated HSM",
"schema": {
"$ref": "#/definitions/DedicatedHsm"
}
},
"default": {
"description": "The error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/DedicatedHsmError"
}
}
},
"x-ms-examples": {
"Create a new or update an existing dedicated HSM": {
"$ref": "./examples/DedicatedHsm_CreateOrUpdate.json"
},
"Create a new or update an existing payment HSM": {
"$ref": "./examples/PaymentHsm_CreateOrUpdate.json"
},
"Create a new or update an existing payment HSM with management profile": {
"$ref": "./examples/PaymentHsm_CreateOrUpdate_WithManagementProfile.json"
}
}
},
"patch": {
"tags": [
"DedicatedHsms"
],
"operationId": "DedicatedHsm_Update",
"x-ms-long-running-operation": true,
"description": "Update a dedicated HSM in the specified subscription.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/DedicatedHsmName"
},
{
"name": "parameters",
"in": "body",
"required": true,
"x-ms-client-flatten": true,
"schema": {
"$ref": "#/definitions/DedicatedHsmPatchParameters"
},
"description": "Parameters to patch the dedicated HSM"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Patched dedicated HSM",
"schema": {
"$ref": "#/definitions/DedicatedHsm"
}
},
"202": {
"description": "Patched dedicated HSM",
"headers": {
"Location": {
"description": "The URI to poll for completion status.",
"type": "string"
}
}
},
"default": {
"description": "The error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/DedicatedHsmError"
}
}
},
"x-ms-examples": {
"Update an existing dedicated HSM": {
"$ref": "./examples/DedicatedHsm_Update.json"
},
"Update an existing payment HSM": {
"$ref": "./examples/PaymentHsm_Update.json"
}
}
},
"delete": {
"tags": [
"DedicatedHsms"
],
"operationId": "DedicatedHsm_Delete",
"x-ms-long-running-operation": true,
"description": "Deletes the specified Azure Dedicated HSM.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/DedicatedHsmName"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"202": {
"description": "Accepted",
"headers": {
"Location": {
"description": "The URI to poll for completion status.",
"type": "string"
}
}
},
"204": {
"description": "No Content"
},
"default": {
"description": "The error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/DedicatedHsmError"
}
}
},
"x-ms-examples": {
"Delete a dedicated HSM": {
"$ref": "./examples/DedicatedHsm_Delete.json"
}
}
},
"get": {
"tags": [
"DedicatedHsms"
],
"operationId": "DedicatedHsm_Get",
"description": "Gets the specified Azure dedicated HSM.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/DedicatedHsmName"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Retrieved dedicated HSM",
"schema": {
"$ref": "#/definitions/DedicatedHsm"
}
},
"default": {
"description": "The error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/DedicatedHsmError"
}
}
},
"x-ms-examples": {
"Get a dedicated HSM": {
"$ref": "./examples/DedicatedHsm_Get.json"
},
"Get a payment HSM": {
"$ref": "./examples/PaymentHsm_Get.json"
},
"Get a payment HSM with 2018-10-31Preview api version": {
"$ref": "./examples/PaymentHsm_Get_With_2018-10-31Preview_Version.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs": {
"get": {
"tags": [
"DedicatedHsms"
],
"operationId": "DedicatedHsm_ListByResourceGroup",
"description": "The List operation gets information about the dedicated hsms associated with the subscription and within the specified resource group.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "$top",
"in": "query",
"type": "integer",
"format": "int32",
"description": "Maximum number of results to return."
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Get information about all dedicated HSMs in the specified resource group.",
"schema": {
"$ref": "#/definitions/DedicatedHsmListResult"
}
},
"default": {
"description": "The error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/DedicatedHsmError"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"List dedicated HSM devices in a resource group": {
"$ref": "./examples/DedicatedHsm_ListByResourceGroup.json"
},
"List dedicated HSM devices in a resource group including payment HSM": {
"$ref": "./examples/PaymentHsm_ListByResourceGroup.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs": {
"get": {
"tags": [
"DedicatedHsms"
],
"operationId": "DedicatedHsm_ListBySubscription",
"description": "The List operation gets information about the dedicated HSMs associated with the subscription.",
"parameters": [
{
"name": "$top",
"in": "query",
"type": "integer",
"format": "int32",
"description": "Maximum number of results to return."
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Get information about all dedicated HSMs in the specified subscription.",
"schema": {
"$ref": "#/definitions/DedicatedHsmListResult"
}
},
"default": {
"description": "The error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/DedicatedHsmError"
}
}
},
"x-ms-examples": {
"List dedicated HSM devices in a subscription": {
"$ref": "./examples/DedicatedHsm_ListBySubscription.json"
},
"List dedicated HSM devices in a subscription including payment HSM": {
"$ref": "./examples/PaymentHsm_ListBySubscription.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/{name}/outboundNetworkDependenciesEndpoints": {
"get": {
"tags": [
"DedicatedHsms"
],
"operationId": "DedicatedHsm_ListOutboundNetworkDependenciesEndpoints",
"summary": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource.",
"description": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource. The operation returns properties of each egress endpoint.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/DedicatedHsmName"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OutboundEnvironmentEndpointCollection"
}
},
"default": {
"description": "The error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/DedicatedHsmError"
}
}
},
"x-ms-examples": {
"List OutboundNetworkDependenciesEndpoints by Managed Cluster": {
"$ref": "./examples/GetOutboundNetworkDependenciesEndpointsList.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
}
},
"definitions": {
"ApiEntityReference": {
"properties": {
"resourceId": {
"type": "string",
"description": "The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...",
"format": "arm-id"
}
},
"description": "The API entity reference.",
"type": "object"
},
"NetworkInterface": {
"properties": {
"resourceId": {
"readOnly": true,
"type": "string",
"description": "The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..."
},
"privateIpAddress": {
"type": "string",
"description": "Private Ip address of the interface"
}
},
"description": "The network interface definition.",
"type": "object"
},
"NetworkProfile": {
"properties": {
"subnet": {
"$ref": "#/definitions/ApiEntityReference",
"description": "Specifies the identifier of the subnet."
},
"networkInterfaces": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkInterface"
},
"description": "Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM."
}
},
"description": "The network profile definition.",
"type": "object"
},
"Sku": {
"type": "object",
"description": "SKU of the dedicated HSM",
"properties": {
"name": {
"type": "string",
"description": "SKU of the dedicated HSM",
"enum": [
"SafeNet Luna Network HSM A790",
"payShield10K_LMK1_CPS60",
"payShield10K_LMK1_CPS250",
"payShield10K_LMK1_CPS2500",
"payShield10K_LMK2_CPS60",
"payShield10K_LMK2_CPS250",
"payShield10K_LMK2_CPS2500"
],
"x-ms-enum": {
"name": "SkuName",
"modelAsString": true,
"values": [
{
"value": "SafeNet Luna Network HSM A790",
"description": "The dedicated HSM is a Safenet Luna Network HSM A790 device."
},
{
"value": "payShield10K_LMK1_CPS60",
"description": "The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 1 local master key which supports up to 60 calls per second."
},
{
"value": "payShield10K_LMK1_CPS250",
"description": "The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 1 local master key which supports up to 250 calls per second."
},
{
"value": "payShield10K_LMK1_CPS2500",
"description": "The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 1 local master key which supports up to 2500 calls per second."
},
{
"value": "payShield10K_LMK2_CPS60",
"description": "The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 2 local master keys which supports up to 60 calls per second."
},
{
"value": "payShield10K_LMK2_CPS250",
"description": "The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 2 local master keys which supports up to 250 calls per second."
},
{
"value": "payShield10K_LMK2_CPS2500",
"description": "The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 2 local master keys which supports up to 2500 calls per second."
}
]
}
}
}
},
"DedicatedHsmProperties": {
"properties": {
"networkProfile": {
"$ref": "#/definitions/NetworkProfile",
"description": "Specifies the network interfaces of the dedicated hsm."
},
"managementNetworkProfile": {
"$ref": "#/definitions/NetworkProfile",
"description": "Specifies the management network interfaces of the dedicated hsm."
},
"stampId": {
"type": "string",
"description": "This field will be used when RP does not support Availability zones."
},
"statusMessage": {
"readOnly": true,
"type": "string",
"description": "Resource Status Message."
},
"provisioningState": {
"readOnly": true,
"type": "string",
"description": "Provisioning state.",
"enum": [
"Succeeded",
"Provisioning",
"Allocating",
"Connecting",
"Failed",
"CheckingQuota",
"Deleting"
],
"x-ms-enum": {
"name": "JsonWebKeyType",
"modelAsString": true,
"values": [
{
"value": "Succeeded",
"description": "The dedicated HSM has been fully provisioned."
},
{
"value": "Provisioning",
"description": "The dedicated HSM is currently being provisioned."
},
{
"value": "Allocating",
"description": "A device is currently being allocated for the dedicated HSM resource."
},
{
"value": "Connecting",
"description": "The dedicated HSM is being connected to the virtual network."
},
{
"value": "Failed",
"description": "Provisioning of the dedicated HSM has failed."
},
{
"value": "CheckingQuota",
"description": "Validating the subscription has sufficient quota to allocate a dedicated HSM device."
},
{
"value": "Deleting",
"description": "The dedicated HSM is currently being deleted."
}
]
}
}
},
"description": "Properties of the dedicated hsm",
"type": "object"
},
"DedicatedHsm": {
"properties": {
"sku": {
"$ref": "#/definitions/Sku",
"description": "SKU details"
},
"zones": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Dedicated Hsm zones."
},
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/DedicatedHsmProperties",
"description": "Properties of the dedicated HSM"
}
},
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
],
"required": [
"location",
"sku",
"properties"
],
"description": "Resource information with extended details.",
"type": "object"
},
"DedicatedHsmPatchParameters": {
"properties": {
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Resource tags"
}
},
"description": "Patchable properties of the dedicated HSM",
"type": "object"
},
"DedicatedHsmListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/DedicatedHsm"
},
"description": "The list of dedicated HSMs."
},
"nextLink": {
"type": "string",
"description": "The URL to get the next set of dedicated hsms."
}
},
"description": "List of dedicated HSMs",
"type": "object"
},
"DedicatedHsmError": {
"properties": {
"error": {
"description": "The error detail of the operation if any.",
"readOnly": true,
"$ref": "#/definitions/Error"
}
},
"description": "The error exception.",
"type": "object"
},
"Error": {
"properties": {
"code": {
"type": "string",
"readOnly": true,
"description": "The error code."
},
"message": {
"type": "string",
"readOnly": true,
"description": "The error message."
},
"innererror": {
"description": "Contains more specific error that narrows down the cause. May be null.",
"x-ms-client-name": "innerError",
"readOnly": true,
"$ref": "#/definitions/Error"
}
},
"description": "The key vault server error.",
"type": "object"
},
"IdentityType": {
"type": "string",
"description": "The type of identity.",
"enum": [
"User",
"Application",
"ManagedIdentity",
"Key"
],
"x-ms-enum": {
"name": "identityType",
"modelAsString": true
}
},
"OutboundEnvironmentEndpointCollection": {
"description": "Collection of OutboundEnvironmentEndpoint",
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"description": "Collection of resources.",
"type": "array",
"items": {
"$ref": "#/definitions/OutboundEnvironmentEndpoint"
},
"x-ms-identifiers": []
},
"nextLink": {
"description": "Link to next page of resources.",
"type": "string",
"readOnly": true
}
}
},
"OutboundEnvironmentEndpoint": {
"description": "Egress endpoints which dedicated hsm service connects to for common purpose.",
"type": "object",
"properties": {
"category": {
"description": "The category of endpoints accessed by the dedicated hsm service, e.g. azure-resource-management, apiserver, etc.",
"type": "string"
},
"endpoints": {
"description": "The endpoints that dedicated hsm service connects to",
"type": "array",
"items": {
"$ref": "#/definitions/EndpointDependency"
},
"x-ms-identifiers": []
}
}
},
"EndpointDependency": {
"description": "A domain name that dedicated hsm services are reaching at.",
"type": "object",
"properties": {
"domainName": {
"description": "The domain name of the dependency.",
"type": "string"
},
"endpointDetails": {
"description": "The Ports and Protocols used when connecting to domainName.",
"type": "array",
"items": {
"$ref": "#/definitions/EndpointDetail"
},
"x-ms-identifiers": []
}
}
},
"EndpointDetail": {
"description": "Connect information from the dedicated hsm service to a single endpoint.",
"type": "object",
"properties": {
"ipAddress": {
"description": "An IP Address that Domain Name currently resolves to.",
"type": "string"
},
"port": {
"format": "int32",
"description": "The port an endpoint is connected to.",
"type": "integer"
},
"protocol": {
"description": "The protocol used for connection",
"type": "string"
},
"description": {
"description": "Description of the detail",
"type": "string"
}
}
}
},
"parameters": {
"DedicatedHsmName": {
"name": "name",
"in": "path",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9-]{3,24}$",
"description": "Name of the dedicated Hsm",
"x-ms-parameter-location": "method"
}
}
}