Skip to content

Commit a7ae206

Browse files
sougatacAzureRestAPISpecReview
sougatac
and
AzureRestAPISpecReview
authored
[Hub Generated] Publish private branch 'datafactory/sochat/AddCredReg_Swagger' (#21460)
* [AutoSync] d54a7e8518 Swagger update for Credential - Register Credential API-s * [AutoSync] 03b2cb0141 Add referenced payload and response example files * [AutoSync] 1ab6348327 Add credential definition * [AutoSync] 0d9b0cea02 Fix duplicate key issue * [AutoSync] 6565da4d52 Fix missing quote * [AutoSync] f6049ee8ef Add ref for Credential Name * [AutoSync] 2f9d1ef4d6 Add type and update references * [AutoSync] 1095d23613 Fix prettier check Co-authored-by: swagger-automation <[email protected]>
1 parent 51db80e commit a7ae206

File tree

5 files changed

+376
-0
lines changed

5 files changed

+376
-0
lines changed

‎specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json‎

Lines changed: 251 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3962,6 +3962,208 @@
39623962
}
39633963
}
39643964
},
3965+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials": {
3966+
"get": {
3967+
"tags": [
3968+
"credentials"
3969+
],
3970+
"operationId": "CredentialOperations_ListByFactory",
3971+
"x-ms-examples": {
3972+
"Credentials_ListByFactory": {
3973+
"$ref": "./examples/Credentials_ListByFactory.json"
3974+
}
3975+
},
3976+
"description": "List credentials.",
3977+
"parameters": [
3978+
{
3979+
"$ref": "#/parameters/subscriptionId"
3980+
},
3981+
{
3982+
"$ref": "#/parameters/resourceGroupName"
3983+
},
3984+
{
3985+
"$ref": "#/parameters/factoryName"
3986+
},
3987+
{
3988+
"$ref": "#/parameters/api-version"
3989+
}
3990+
],
3991+
"responses": {
3992+
"200": {
3993+
"description": "OK.",
3994+
"schema": {
3995+
"$ref": "#/definitions/CredentialListResponse"
3996+
}
3997+
},
3998+
"default": {
3999+
"description": "An error response received from the Azure Data Factory service.",
4000+
"schema": {
4001+
"$ref": "#/definitions/CloudError"
4002+
}
4003+
}
4004+
},
4005+
"x-ms-pageable": {
4006+
"nextLinkName": "nextLink"
4007+
}
4008+
}
4009+
},
4010+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/credentials/{credentialName}": {
4011+
"put": {
4012+
"tags": [
4013+
"credentials"
4014+
],
4015+
"operationId": "CredentialOperations_CreateOrUpdate",
4016+
"x-ms-examples": {
4017+
"Credentials_Create": {
4018+
"$ref": "./examples/Credentials_Create.json"
4019+
}
4020+
},
4021+
"description": "Creates or updates a credential.",
4022+
"parameters": [
4023+
{
4024+
"$ref": "#/parameters/subscriptionId"
4025+
},
4026+
{
4027+
"$ref": "#/parameters/resourceGroupName"
4028+
},
4029+
{
4030+
"$ref": "#/parameters/factoryName"
4031+
},
4032+
{
4033+
"$ref": "#/parameters/credentialName"
4034+
},
4035+
{
4036+
"$ref": "#/parameters/api-version"
4037+
},
4038+
{
4039+
"name": "If-Match",
4040+
"in": "header",
4041+
"required": false,
4042+
"type": "string",
4043+
"description": "ETag of the credential entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update."
4044+
},
4045+
{
4046+
"name": "credential",
4047+
"description": "Credential resource definition.",
4048+
"in": "body",
4049+
"required": true,
4050+
"schema": {
4051+
"$ref": "#/definitions/ManagedIdentityCredentialResource"
4052+
}
4053+
}
4054+
],
4055+
"responses": {
4056+
"200": {
4057+
"description": "OK.",
4058+
"schema": {
4059+
"$ref": "#/definitions/ManagedIdentityCredentialResource"
4060+
}
4061+
},
4062+
"default": {
4063+
"description": "An error response received from PUT credential operation.",
4064+
"schema": {
4065+
"$ref": "#/definitions/CloudError"
4066+
}
4067+
}
4068+
}
4069+
},
4070+
"get": {
4071+
"tags": [
4072+
"credentials"
4073+
],
4074+
"operationId": "CredentialOperations_Get",
4075+
"x-ms-examples": {
4076+
"Credentials_Get": {
4077+
"$ref": "./examples/Credentials_Get.json"
4078+
}
4079+
},
4080+
"description": "Gets a credential.",
4081+
"parameters": [
4082+
{
4083+
"$ref": "#/parameters/subscriptionId"
4084+
},
4085+
{
4086+
"$ref": "#/parameters/resourceGroupName"
4087+
},
4088+
{
4089+
"$ref": "#/parameters/factoryName"
4090+
},
4091+
{
4092+
"$ref": "#/parameters/credentialName"
4093+
},
4094+
{
4095+
"$ref": "#/parameters/api-version"
4096+
},
4097+
{
4098+
"name": "If-None-Match",
4099+
"in": "header",
4100+
"required": false,
4101+
"type": "string",
4102+
"description": "ETag of the credential entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned."
4103+
}
4104+
],
4105+
"responses": {
4106+
"200": {
4107+
"description": "OK.",
4108+
"schema": {
4109+
"$ref": "#/definitions/ManagedIdentityCredentialResource"
4110+
}
4111+
},
4112+
"304": {
4113+
"description": "Not modified."
4114+
},
4115+
"default": {
4116+
"description": "An error response received from GET credential operation.",
4117+
"schema": {
4118+
"$ref": "#/definitions/CloudError"
4119+
}
4120+
}
4121+
}
4122+
},
4123+
"delete": {
4124+
"tags": [
4125+
"credentials"
4126+
],
4127+
"operationId": "CredentialOperations_Delete",
4128+
"x-ms-examples": {
4129+
"Credentials_Delete": {
4130+
"$ref": "./examples/Credentials_Delete.json"
4131+
}
4132+
},
4133+
"description": "Deletes a credential.",
4134+
"parameters": [
4135+
{
4136+
"$ref": "#/parameters/subscriptionId"
4137+
},
4138+
{
4139+
"$ref": "#/parameters/resourceGroupName"
4140+
},
4141+
{
4142+
"$ref": "#/parameters/factoryName"
4143+
},
4144+
{
4145+
"$ref": "#/parameters/credentialName"
4146+
},
4147+
{
4148+
"$ref": "#/parameters/api-version"
4149+
}
4150+
],
4151+
"responses": {
4152+
"200": {
4153+
"description": "OK."
4154+
},
4155+
"204": {
4156+
"description": "No Content."
4157+
},
4158+
"default": {
4159+
"description": "An error response received from DELETE credential operation.",
4160+
"schema": {
4161+
"$ref": "#/definitions/CloudError"
4162+
}
4163+
}
4164+
}
4165+
}
4166+
},
39654167
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}": {
39664168
"put": {
39674169
"tags": [
@@ -7052,6 +7254,26 @@
70527254
}
70537255
}
70547256
},
7257+
"CredentialListResponse": {
7258+
"description": "A list of credential resources.",
7259+
"type": "object",
7260+
"required": [
7261+
"value"
7262+
],
7263+
"properties": {
7264+
"value": {
7265+
"type": "array",
7266+
"description": "List of credentials.",
7267+
"items": {
7268+
"$ref": "#/definitions/ManagedIdentityCredentialResource"
7269+
}
7270+
},
7271+
"nextLink": {
7272+
"description": "The link to the next page of results, if any remaining results exist.",
7273+
"type": "string"
7274+
}
7275+
}
7276+
},
70557277
"ManagedPrivateEndpointResource": {
70567278
"description": "Managed private endpoint resource type.",
70577279
"allOf": [
@@ -7069,6 +7291,24 @@
70697291
"properties"
70707292
]
70717293
},
7294+
"ManagedIdentityCredentialResource": {
7295+
"description": "Credential resource type.",
7296+
"type": "object",
7297+
"allOf": [
7298+
{
7299+
"$ref": "#/definitions/SubResource"
7300+
}
7301+
],
7302+
"properties": {
7303+
"properties": {
7304+
"$ref": "./entityTypes/Credential.json#/definitions/ManagedIdentityCredential",
7305+
"description": "Managed Identity Credential properties."
7306+
}
7307+
},
7308+
"required": [
7309+
"properties"
7310+
]
7311+
},
70727312
"ManagedVirtualNetworkListResponse": {
70737313
"description": "A list of managed Virtual Network resources.",
70747314
"type": "object",
@@ -7486,6 +7726,17 @@
74867726
"maxLength": 127,
74877727
"x-ms-parameter-location": "method"
74887728
},
7729+
"credentialName": {
7730+
"name": "credentialName",
7731+
"description": "Credential name",
7732+
"in": "path",
7733+
"required": true,
7734+
"type": "string",
7735+
"pattern": "^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$",
7736+
"minLength": 1,
7737+
"maxLength": 127,
7738+
"x-ms-parameter-location": "method"
7739+
},
74897740
"managedPrivateEndpointName": {
74907741
"name": "managedPrivateEndpointName",
74917742
"description": "Managed private endpoint name",

‎specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Credentials_Create.json‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
{
2+
"parameters": {
3+
"subscriptionId": "12345678-1234-1234-1234-12345678abc",
4+
"resourceGroupName": "exampleResourceGroup",
5+
"factoryName": "exampleFactoryName",
6+
"credentialName": "exampleCredential",
7+
"ifMatch": null,
8+
"credential": {
9+
"properties": {
10+
"type": "ManagedIdentity",
11+
"typeProperties": {
12+
"resourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami"
13+
}
14+
}
15+
},
16+
"api-version": "2018-06-01"
17+
},
18+
"responses": {
19+
"200": {
20+
"headers": {
21+
"Date": "Sat, 16 Jun 2018 00:37:34 GMT",
22+
"X-Content-Type-Options": "nosniff",
23+
"x-ms-ratelimit-remaining-subscription-writes": "1196",
24+
"x-ms-request-id": "b3b336b3-b203-4654-9cb6-a3a8d3a4b5de",
25+
"x-ms-correlation-request-id": "b3b336b3-b203-4654-9cb6-a3a8d3a4b5de"
26+
},
27+
"body": {
28+
"id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/credentials/exampleCredential",
29+
"name": "exampleCredential",
30+
"type": "Microsoft.DataFactory/factories/credentials",
31+
"properties": {
32+
"type": "ManagedIdentity",
33+
"typeProperties": {
34+
"resourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami"
35+
}
36+
},
37+
"etag": "0a0062d4-0000-0000-0000-5b245bcf0000"
38+
}
39+
}
40+
}
41+
}

‎specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Credentials_Delete.json‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"parameters": {
3+
"subscriptionId": "12345678-1234-1234-1234-12345678abc",
4+
"resourceGroupName": "exampleResourceGroup",
5+
"factoryName": "exampleFactoryName",
6+
"credentialName": "exampleCredential",
7+
"api-version": "2018-06-01"
8+
},
9+
"responses": {
10+
"200": {},
11+
"204": {}
12+
}
13+
}

‎specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Credentials_Get.json‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"parameters": {
3+
"subscriptionId": "12345678-1234-1234-1234-12345678abc",
4+
"resourceGroupName": "exampleResourceGroup",
5+
"factoryName": "exampleFactoryName",
6+
"credentialName": "exampleCredential",
7+
"ifNoneMatch": "1500474f-0000-0200-0000-5cbe090d0000",
8+
"api-version": "2018-06-01"
9+
},
10+
"responses": {
11+
"304": {},
12+
"200": {
13+
"headers": {
14+
"Date": "Mon, 22 Apr 2019 18:33:48 GMT",
15+
"X-Content-Type-Options": "nosniff",
16+
"x-ms-ratelimit-remaining-subscription-reads": "11995",
17+
"x-ms-request-id": "99e5d0d9-55e6-45a0-8bd2-cf39210f317c",
18+
"x-ms-correlation-request-id": "99e5d0d9-55e6-45a0-8bd2-cf39210f317c"
19+
},
20+
"body": {
21+
"id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/credentials/exampleCredential",
22+
"name": "exampleLinkedService",
23+
"type": "Microsoft.DataFactory/factories/credentials",
24+
"properties": {
25+
"type": "ManagedIdentity",
26+
"typeProperties": {
27+
"resourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourcegroups/exampleResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleUami"
28+
},
29+
"description": "Example description"
30+
},
31+
"etag": "1500474f-0000-0200-0000-5cbe090d0000"
32+
}
33+
}
34+
}
35+
}

0 commit comments

Comments
 (0)