-
Notifications
You must be signed in to change notification settings - Fork 4.9k
/
LinkedService.json
8384 lines (8384 loc) · 335 KB
/
LinkedService.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": "DataFactoryManagementClient",
"version": "2018-06-01"
},
"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": {},
"definitions": {
"LinkedService": {
"description": "The nested object which contains the information and credential which can be used to connect with related store or compute resource.",
"type": "object",
"discriminator": "type",
"properties": {
"type": {
"type": "string",
"description": "Type of linked service."
},
"connectVia": {
"description": "The integration runtime reference.",
"$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference"
},
"description": {
"description": "Linked service description.",
"type": "string"
},
"parameters": {
"$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification",
"description": "Parameters for linked service."
},
"annotations": {
"description": "List of tags that can be used for describing the linked service.",
"type": "array",
"items": {
"type": "object"
},
"x-ms-identifiers": []
}
},
"additionalProperties": {
"type": "object"
},
"required": [
"type"
]
},
"AzureStorageLinkedService": {
"x-ms-discriminator-value": "AzureStorage",
"description": "The storage account linked service.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/LinkedService"
}
],
"properties": {
"typeProperties": {
"description": "Azure Storage linked service properties.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/AzureStorageLinkedServiceTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"AzureBlobStorageLinkedService": {
"x-ms-discriminator-value": "AzureBlobStorage",
"description": "The azure blob storage linked service.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/LinkedService"
}
],
"properties": {
"typeProperties": {
"description": "Azure Blob Storage linked service properties.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/AzureBlobStorageLinkedServiceTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"AzureTableStorageLinkedService": {
"x-ms-discriminator-value": "AzureTableStorage",
"description": "The azure table storage linked service.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/LinkedService"
}
],
"properties": {
"typeProperties": {
"description": "Azure Table Storage linked service properties.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/AzureStorageLinkedServiceTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"AzureStorageLinkedServiceTypeProperties": {
"description": "Azure Storage linked service properties.",
"type": "object",
"properties": {
"connectionString": {
"description": "The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.",
"x-ms-format": "dfe-string",
"type": "object"
},
"accountKey": {
"$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of accountKey in connection string."
},
"sasUri": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference."
},
"sasToken": {
"$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of sasToken in sas uri."
},
"encryptedCredential": {
"type": "string",
"description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string."
}
}
},
"AzureBlobStorageLinkedServiceTypeProperties": {
"description": "Azure Blob Storage linked service properties.",
"type": "object",
"properties": {
"connectionString": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference."
},
"accountKey": {
"$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of accountKey in connection string."
},
"sasUri": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference."
},
"sasToken": {
"$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of sasToken in sas uri."
},
"serviceEndpoint": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property."
},
"servicePrincipalId": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string)."
},
"servicePrincipalKey": {
"$ref": "../datafactory.json#/definitions/SecretBase",
"description": "The key of the service principal used to authenticate against Azure SQL Data Warehouse."
},
"tenant": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)."
},
"azureCloudType": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)."
},
"accountKind": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "Specify the kind of your storage account. Allowed values are: Storage (general purpose v1), StorageV2 (general purpose v2), BlobStorage, or BlockBlobStorage. Type: string (or Expression with resultType string)."
},
"encryptedCredential": {
"type": "string",
"description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string."
},
"credential": {
"$ref": "../datafactory.json#/definitions/CredentialReference",
"description": "The credential reference containing authentication information."
},
"authenticationType": {
"x-ms-enum": {
"name": "AzureStorageAuthenticationType",
"modelAsString": true
},
"enum": [
"Anonymous",
"AccountKey",
"SasUri",
"ServicePrincipal",
"Msi"
],
"type": "string",
"description": "The type used for authentication. Type: string."
},
"containerUri": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "Container uri of the Azure Blob Storage resource only support for anonymous access. Type: string (or Expression with resultType string)."
}
}
},
"SqlServerBaseLinkedServiceTypeProperties": {
"description": "Sql Server family connector common linked service properties.",
"type": "object",
"properties": {
"server": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The name or network address of the instance of SQL Server to which to connect, used by recommended version. Type: string (or Expression with resultType string)."
},
"database": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The name of the database, used by recommended version. Type: string (or Expression with resultType string)."
},
"encrypt": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. Possible values are true/yes/mandatory, false/no/optional and strict. Type: string (or Expression with resultType string)."
},
"trustServerCertificate": {
"type": "object",
"x-ms-format": "dfe-bool",
"description": "Indicate whether the channel will be encrypted while bypassing walking the certificate chain to validate trust, used by recommended version. Type: Boolean (or Expression with resultType boolean)."
},
"hostNameInCertificate": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The host name to use when validating the server certificate for the connection. When not specified, the server name from the Data Source is used for certificate validation, used by recommended version. Type: string (or Expression with resultType string)."
},
"applicationIntent": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The application workload type when connecting to a server, used by recommended version. Possible values are ReadOnly and ReadWrite. Type: string (or Expression with resultType string)."
},
"connectTimeout": {
"type": "object",
"x-ms-format": "dfe-int",
"description": "The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error, used by recommended version. Type: integer (or Expression with resultType integer)."
},
"connectRetryCount": {
"type": "object",
"x-ms-format": "dfe-int",
"description": "The number of re-connections attempted after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 0 and 255. Type: integer (or Expression with resultType integer)."
},
"connectRetryInterval": {
"type": "object",
"x-ms-format": "dfe-int",
"description": "The amount of time (in seconds) between each re-connection attempt after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 1 and 60. Type: integer (or Expression with resultType integer)."
},
"loadBalanceTimeout": {
"type": "object",
"x-ms-format": "dfe-int",
"description": "The minimum time, in seconds, for the connection to live in the connection pool before being destroyed, used by recommended version. Type: integer (or Expression with resultType integer)."
},
"commandTimeout": {
"type": "object",
"x-ms-format": "dfe-int",
"description": "The default wait time (in seconds) before terminating the attempt to execute a command and generating an error, used by recommended version. Type: integer (or Expression with resultType integer)."
},
"integratedSecurity": {
"type": "object",
"x-ms-format": "dfe-bool",
"description": "Indicate whether User ID and Password are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true), used by recommended version. Type: Boolean (or Expression with resultType boolean)."
},
"failoverPartner": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The name or address of the partner server to connect to if the primary server is down, used by recommended version. Type: string (or Expression with resultType string)."
},
"maxPoolSize": {
"type": "object",
"x-ms-format": "dfe-int",
"description": "The maximum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer)."
},
"minPoolSize": {
"type": "object",
"x-ms-format": "dfe-int",
"description": "The minimum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer)."
},
"multipleActiveResultSets": {
"type": "object",
"x-ms-format": "dfe-bool",
"description": "When true, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection, used by recommended version. Type: Boolean (or Expression with resultType boolean)."
},
"multiSubnetFailover": {
"type": "object",
"x-ms-format": "dfe-bool",
"description": "If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server, used by recommended version. Type: Boolean (or Expression with resultType boolean)."
},
"packetSize": {
"type": "object",
"x-ms-format": "dfe-int",
"description": "The size in bytes of the network packets used to communicate with an instance of server, used by recommended version. Type: integer (or Expression with resultType integer)."
},
"pooling": {
"type": "object",
"x-ms-format": "dfe-bool",
"description": "Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. Type: Boolean (or Expression with resultType boolean)."
}
}
},
"AzureSqlDWLinkedService": {
"x-ms-discriminator-value": "AzureSqlDW",
"description": "Azure SQL Data Warehouse linked service.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/LinkedService"
}
],
"properties": {
"typeProperties": {
"description": "Azure SQL Data Warehouse linked service properties.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/AzureSqlDWLinkedServiceTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"AzureSqlDWLinkedServiceTypeProperties": {
"description": "Azure SQL Data Warehouse linked service properties.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/SqlServerBaseLinkedServiceTypeProperties"
}
],
"properties": {
"connectionString": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference."
},
"authenticationType": {
"x-ms-enum": {
"name": "AzureSqlDWAuthenticationType",
"modelAsString": true
},
"enum": [
"SQL",
"ServicePrincipal",
"SystemAssignedManagedIdentity",
"UserAssignedManagedIdentity"
],
"type": "string",
"description": "The type used for authentication. Type: string."
},
"userName": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The user name to be used when connecting to server. Type: string (or Expression with resultType string)."
},
"password": {
"$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"servicePrincipalId": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string)."
},
"servicePrincipalKey": {
"$ref": "../datafactory.json#/definitions/SecretBase",
"description": "The key of the service principal used to authenticate against Azure SQL Data Warehouse."
},
"servicePrincipalCredentialType": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)."
},
"servicePrincipalCredential": {
"description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.",
"$ref": "../datafactory.json#/definitions/SecretBase"
},
"tenant": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)."
},
"azureCloudType": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)."
},
"encryptedCredential": {
"type": "string",
"description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string."
},
"credential": {
"$ref": "../datafactory.json#/definitions/CredentialReference",
"description": "The credential reference containing authentication information."
}
}
},
"SqlServerLinkedService": {
"x-ms-discriminator-value": "SqlServer",
"description": "SQL Server linked service.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/LinkedService"
}
],
"properties": {
"typeProperties": {
"description": "SQL Server linked service properties.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/SqlServerLinkedServiceTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"SqlServerLinkedServiceTypeProperties": {
"description": "SQL Server linked service properties.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/SqlServerBaseLinkedServiceTypeProperties"
}
],
"properties": {
"connectionString": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference."
},
"authenticationType": {
"x-ms-enum": {
"name": "SqlServerAuthenticationType",
"modelAsString": true
},
"enum": [
"SQL",
"Windows"
],
"type": "string",
"description": "The type used for authentication. Type: string."
},
"userName": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The on-premises Windows authentication user name. Type: string (or Expression with resultType string)."
},
"password": {
"description": "The on-premises Windows authentication password.",
"$ref": "../datafactory.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "string",
"description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string."
},
"alwaysEncryptedSettings": {
"$ref": "#/definitions/SqlAlwaysEncryptedProperties",
"description": "Sql always encrypted properties."
}
}
},
"AmazonRdsForSqlServerLinkedService": {
"x-ms-discriminator-value": "AmazonRdsForSqlServer",
"description": "Amazon RDS for SQL Server linked service.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/LinkedService"
}
],
"properties": {
"typeProperties": {
"description": "Amazon RDS for SQL Server linked service properties.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/AmazonRdsForSqlServerLinkedServiceTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"AmazonRdsForSqlServerLinkedServiceTypeProperties": {
"description": "Amazon Rds for SQL Server linked service properties.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/SqlServerBaseLinkedServiceTypeProperties"
}
],
"properties": {
"connectionString": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference."
},
"authenticationType": {
"x-ms-enum": {
"name": "AmazonRdsForSqlAuthenticationType",
"modelAsString": true
},
"enum": [
"SQL",
"Windows"
],
"type": "string",
"description": "The type used for authentication. Type: string."
},
"userName": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The on-premises Windows authentication user name. Type: string (or Expression with resultType string)."
},
"password": {
"description": "The on-premises Windows authentication password.",
"$ref": "../datafactory.json#/definitions/SecretBase"
},
"encryptedCredential": {
"type": "string",
"description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string."
},
"alwaysEncryptedSettings": {
"$ref": "#/definitions/SqlAlwaysEncryptedProperties",
"description": "Sql always encrypted properties."
}
}
},
"AzureSqlDatabaseLinkedService": {
"x-ms-discriminator-value": "AzureSqlDatabase",
"description": "Microsoft Azure SQL Database linked service.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/LinkedService"
}
],
"properties": {
"typeProperties": {
"description": "Azure SQL Database linked service properties.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/AzureSqlDatabaseLinkedServiceTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"AzureSqlDatabaseLinkedServiceTypeProperties": {
"description": "Azure SQL Database linked service properties.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/SqlServerBaseLinkedServiceTypeProperties"
}
],
"properties": {
"connectionString": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference."
},
"authenticationType": {
"x-ms-enum": {
"name": "AzureSqlDatabaseAuthenticationType",
"modelAsString": true
},
"enum": [
"SQL",
"ServicePrincipal",
"SystemAssignedManagedIdentity",
"UserAssignedManagedIdentity"
],
"type": "string",
"description": "The type used for authentication. Type: string."
},
"userName": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The user name to be used when connecting to server. Type: string (or Expression with resultType string)."
},
"password": {
"$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"servicePrincipalId": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string)."
},
"servicePrincipalKey": {
"$ref": "../datafactory.json#/definitions/SecretBase",
"description": "The key of the service principal used to authenticate against Azure SQL Database."
},
"servicePrincipalCredentialType": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)."
},
"servicePrincipalCredential": {
"description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.",
"$ref": "../datafactory.json#/definitions/SecretBase"
},
"tenant": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)."
},
"azureCloudType": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)."
},
"encryptedCredential": {
"type": "string",
"description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string."
},
"alwaysEncryptedSettings": {
"$ref": "#/definitions/SqlAlwaysEncryptedProperties",
"description": "Sql always encrypted properties."
},
"credential": {
"$ref": "../datafactory.json#/definitions/CredentialReference",
"description": "The credential reference containing authentication information."
}
}
},
"AzureSqlMILinkedService": {
"x-ms-discriminator-value": "AzureSqlMI",
"description": "Azure SQL Managed Instance linked service.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/LinkedService"
}
],
"properties": {
"typeProperties": {
"description": "Azure SQL Managed Instance linked service properties.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/AzureSqlMILinkedServiceTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"AzureSqlMILinkedServiceTypeProperties": {
"description": "Azure SQL Managed Instance linked service properties.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/SqlServerBaseLinkedServiceTypeProperties"
}
],
"properties": {
"connectionString": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference."
},
"authenticationType": {
"x-ms-enum": {
"name": "AzureSqlMIAuthenticationType",
"modelAsString": true
},
"enum": [
"SQL",
"ServicePrincipal",
"SystemAssignedManagedIdentity",
"UserAssignedManagedIdentity"
],
"type": "string",
"description": "The type used for authentication. Type: string."
},
"userName": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The user name to be used when connecting to server. Type: string (or Expression with resultType string)."
},
"password": {
"$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"servicePrincipalId": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string)."
},
"servicePrincipalKey": {
"$ref": "../datafactory.json#/definitions/SecretBase",
"description": "The key of the service principal used to authenticate against Azure SQL Managed Instance."
},
"servicePrincipalCredentialType": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)."
},
"servicePrincipalCredential": {
"description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.",
"$ref": "../datafactory.json#/definitions/SecretBase"
},
"tenant": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)."
},
"azureCloudType": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)."
},
"encryptedCredential": {
"type": "string",
"description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string."
},
"alwaysEncryptedSettings": {
"$ref": "#/definitions/SqlAlwaysEncryptedProperties",
"description": "Sql always encrypted properties."
},
"credential": {
"$ref": "../datafactory.json#/definitions/CredentialReference",
"description": "The credential reference containing authentication information."
}
}
},
"SqlAlwaysEncryptedProperties": {
"description": "Sql always encrypted properties.",
"type": "object",
"properties": {
"alwaysEncryptedAkvAuthType": {
"x-ms-enum": {
"name": "SqlAlwaysEncryptedAkvAuthType",
"modelAsString": true
},
"enum": [
"ServicePrincipal",
"ManagedIdentity",
"UserAssignedManagedIdentity"
],
"type": "string",
"description": "Sql always encrypted AKV authentication type. Type: string."
},
"servicePrincipalId": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The client ID of the application in Azure Active Directory used for Azure Key Vault authentication. Type: string (or Expression with resultType string)."
},
"servicePrincipalKey": {
"$ref": "../datafactory.json#/definitions/SecretBase",
"description": "The key of the service principal used to authenticate against Azure Key Vault."
},
"credential": {
"$ref": "../datafactory.json#/definitions/CredentialReference",
"description": "The credential reference containing authentication information."
}
},
"required": [
"alwaysEncryptedAkvAuthType"
]
},
"AzureBatchLinkedService": {
"x-ms-discriminator-value": "AzureBatch",
"description": "Azure Batch linked service.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/LinkedService"
}
],
"properties": {
"typeProperties": {
"description": "Azure Batch linked service properties.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/AzureBatchLinkedServiceTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"AzureBatchLinkedServiceTypeProperties": {
"description": "Azure Batch linked service properties.",
"type": "object",
"properties": {
"accountName": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The Azure Batch account name. Type: string (or Expression with resultType string)."
},
"accessKey": {
"description": "The Azure Batch account access key.",
"$ref": "../datafactory.json#/definitions/SecretBase"
},
"batchUri": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The Azure Batch URI. Type: string (or Expression with resultType string)."
},
"poolName": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The Azure Batch pool name. Type: string (or Expression with resultType string)."
},
"linkedServiceName": {
"description": "The Azure Storage linked service reference.",
"$ref": "../datafactory.json#/definitions/LinkedServiceReference"
},
"encryptedCredential": {
"type": "string",
"description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string."
},
"credential": {
"$ref": "../datafactory.json#/definitions/CredentialReference",
"description": "The credential reference containing authentication information."
}
},
"required": [
"accountName",
"batchUri",
"poolName",
"linkedServiceName"
]
},
"AzureKeyVaultLinkedService": {
"x-ms-discriminator-value": "AzureKeyVault",
"description": "Azure Key Vault linked service.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/LinkedService"
}
],
"properties": {
"typeProperties": {
"description": "Azure Key Vault linked service properties.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/AzureKeyVaultLinkedServiceTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"AzureKeyVaultLinkedServiceTypeProperties": {
"description": "Azure Key Vault linked service properties.",
"type": "object",
"properties": {
"baseUrl": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The base URL of the Azure Key Vault. e.g. https://myakv.vault.azure.net Type: string (or Expression with resultType string)."
},
"credential": {
"$ref": "../datafactory.json#/definitions/CredentialReference",
"description": "The credential reference containing authentication information."
}
},
"required": [
"baseUrl"
]
},
"CosmosDbLinkedService": {
"x-ms-discriminator-value": "CosmosDb",
"description": "Microsoft Azure Cosmos Database (CosmosDB) linked service.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/LinkedService"
}
],
"properties": {
"typeProperties": {
"description": "CosmosDB linked service properties.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/CosmosDbLinkedServiceTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"CosmosDbLinkedServiceTypeProperties": {
"description": "CosmosDB linked service properties.",
"type": "object",
"properties": {
"connectionString": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference."
},
"accountEndpoint": {
"x-ms-format": "dfe-string",
"description": "The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string)",
"type": "object"
},
"database": {
"x-ms-format": "dfe-string",
"description": "The name of the database. Type: string (or Expression with resultType string)",
"type": "object"
},
"accountKey": {
"$ref": "../datafactory.json#/definitions/SecretBase",
"description": "The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference."
},
"servicePrincipalId": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string)."
},
"servicePrincipalCredentialType": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string."
},
"servicePrincipalCredential": {
"$ref": "../datafactory.json#/definitions/SecretBase",
"description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference."
},
"tenant": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)."
},
"azureCloudType": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)."
},
"connectionMode": {
"description": "The connection mode used to access CosmosDB account. Type: string.",
"type": "string",
"enum": [
"Gateway",
"Direct"
],
"x-ms-enum": {
"name": "CosmosDbConnectionMode",
"modelAsString": true
}
},
"encryptedCredential": {
"type": "string",
"description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string."
},
"credential": {
"$ref": "../datafactory.json#/definitions/CredentialReference",
"description": "The credential reference containing authentication information."
}
}
},
"DynamicsLinkedService": {
"x-ms-discriminator-value": "Dynamics",
"description": "Dynamics linked service.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/LinkedService"
}
],
"properties": {
"typeProperties": {
"description": "Dynamics linked service properties.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/DynamicsLinkedServiceTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"DynamicsLinkedServiceTypeProperties": {
"description": "Dynamics linked service properties.",
"type": "object",
"properties": {
"deploymentType": {
"type": "object",