-
Notifications
You must be signed in to change notification settings - Fork 12
/
CosmosDbServiceOperationProvider.cs
306 lines (289 loc) · 13.3 KB
/
CosmosDbServiceOperationProvider.cs
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
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
namespace Microsoft.Azure.Workflows.ServiceProvider.Extensions.CosmosDB
{
using System;
using System.Collections.Generic;
using System.Drawing;
using System.Threading.Tasks;
using Microsoft.Azure.Workflows.ServiceProvider.Extensions.Common;
using Microsoft.Azure.Workflows.ServiceProviders.Abstractions;
using Microsoft.Azure.Workflows.ServiceProviders.WebJobs.Abstractions.Providers;
using Microsoft.WindowsAzure.ResourceStack.Common.Collections;
using Microsoft.WindowsAzure.ResourceStack.Common.Extensions;
using Microsoft.WindowsAzure.ResourceStack.Common.Swagger.Entities;
using Newtonsoft.Json.Linq;
/// <summary>
/// This is the service operation provider class where you define all the operations and apis.
/// </summary>
[ServiceOperationsProvider(Id = CosmosDBServiceOperationProvider.ServiceId, Name = CosmosDBServiceOperationProvider.ServiceName)]
public class CosmosDBServiceOperationProvider : IServiceOperationsTriggerProvider
{
/// <summary>
/// The service name.
/// </summary>
public const string ServiceName = "cosmosdb";
/// <summary>
/// The service id.
/// </summary>
public const string ServiceId = "/serviceProviders/cosmosdb";
/// <summary>
/// Gets or sets service Operations.
/// </summary>
private readonly List<ServiceOperation> serviceOperationsList;
/// <summary>
/// The set of all API Operations.
/// </summary>
private readonly InsensitiveDictionary<ServiceOperation> apiOperationsList;
/// <summary>
/// Initializes a new instance of the <see cref="CosmosDBServiceOperationProvider"/> class.
/// </summary>
public CosmosDBServiceOperationProvider()
{
this.serviceOperationsList = new List<ServiceOperation>();
this.apiOperationsList = new InsensitiveDictionary<ServiceOperation>();
this.apiOperationsList.AddRange(new InsensitiveDictionary<ServiceOperation>
{
{ "receiveDocument", this.GetReceiveDocumentServiceOperation() },
});
this.serviceOperationsList.AddRange(new List<ServiceOperation>
{
{ this.GetReceiveDocumentServiceOperation().CloneWithManifest(this.GetServiceOperationManifest()) },
});
}
/// <summary>
/// Get binding connection information, needed for Azure function triggers.
/// </summary>
/// <param name="operationId">Operation id.</param>
/// <param name="connectionParameters">Connection parameters.</param>
/// <returns>string.</returns>
public string GetBindingConnectionInformation(string operationId, InsensitiveDictionary<JToken> connectionParameters)
{
return ServiceOperationsProviderUtilities
.GetRequiredParameterValue(
serviceId: ServiceId,
operationId: operationId,
parameterName: "connectionString",
parameters: connectionParameters)?
.ToValue<string>();
}
/// <summary>
/// If the registration of service provider is successful then this should resturn the trigger type.
/// </summary>
/// <returns>string.</returns>
public string GetFunctionTriggerType()
{
return "cosmosDBTrigger";
}
/// <summary>
/// Get operations.
/// </summary>
/// <param name="expandManifest">Expand manifest generation.</param>
/// <returns>Service operation list.</returns>
public IEnumerable<ServiceOperation> GetOperations(bool expandManifest)
{
return expandManifest ? this.serviceOperationsList : this.GetApiOperations();
}
/// <summary>
/// Get service operation.
/// </summary>
/// <returns>Service operation api.</returns>
public ServiceOperationApi GetService()
{
return this.GetServiceOperationApi();
}
/// <summary>
/// The CosmosDB service provider is only trigger based connector hence skipped the implementation.
/// </summary>
/// <param name="operationId">Operation Id.</param>
/// <param name="connectionParameters">Connection parameters.</param>
/// <param name="serviceOperationRequest">Service operation request.</param>
/// <returns>Service operation response.</returns>
public Task<ServiceOperationResponse> InvokeOperation(string operationId, InsensitiveDictionary<JToken> connectionParameters, ServiceOperationRequest serviceOperationRequest)
{
throw new NotImplementedException();
}
/// <summary>
/// Implements the Swagger schema defining the input , output and scope.
/// </summary>
private ServiceOperationManifest GetServiceOperationManifest()
{
return new ServiceOperationManifest
{
ConnectionReference = new ConnectionReferenceFormat
{
ReferenceKeyFormat = ConnectionReferenceKeyFormat.ServiceProvider,
},
Settings = new OperationManifestSettings
{
SecureData = new OperationManifestSettingWithOptions<SecureDataOptions>(),
TrackedProperties = new OperationManifestSetting
{
Scopes = new OperationScope[] { OperationScope.Trigger },
},
},
InputsLocation = new InputsLocation[]
{
InputsLocation.Inputs,
InputsLocation.Parameters,
},
Outputs = new SwaggerSchema
{
Type = SwaggerSchemaType.Object,
Properties = new OrdinalDictionary<SwaggerSchema>
{
{
"body", new SwaggerSchema
{
Type = SwaggerSchemaType.Array,
Title = "Receive document",
Description = "Receive document from Azure Cosmos DB",
Items = new SwaggerSchema
{
Type = SwaggerSchemaType.Object,
Properties = new OrdinalDictionary<SwaggerSchema>
{
{
"contentData", new SwaggerSchema
{
Type = SwaggerSchemaType.String,
Title = "Content",
Format = "byte",
Description = "content",
}
},
{
"Properties", new SwaggerSchema
{
Type = SwaggerSchemaType.Object,
Title = "documentProperties",
AdditionalProperties = new JObject
{
{ "type", "object" },
{ "properties", new JObject { } },
{ "required", new JObject { } },
},
Description = "Document DB data properties",
}
},
},
},
}
},
},
},
Inputs = new SwaggerSchema
{
Type = SwaggerSchemaType.Object,
Properties = new OrdinalDictionary<SwaggerSchema>
{
{
"databaseName", new SwaggerSchema
{
Type = SwaggerSchemaType.String,
Title = "Database name",
Description = "Database name",
}
},
{
"collectionName", new SwaggerSchema
{
Type = SwaggerSchemaType.String,
Title = "Collection name",
Description = "Collection name",
}
},
{
"connectionStringSetting", new SwaggerSchema
{
Type = SwaggerSchemaType.String,
Title = "Connection String",
Default = "CosmosDB-connectionString",
Description = "Connection-string",
}
},
},
Required = new string[]
{
"databaseName",
"collectionName",
},
},
Connector = this.GetServiceOperationApi(),
Trigger = TriggerType.Batch,
Recurrence = new RecurrenceSetting
{
Type = RecurrenceType.None,
},
};
}
/// <summary>
/// Gets the api operations.
/// </summary>
private IEnumerable<ServiceOperation> GetApiOperations()
{
return this.apiOperationsList.Values;
}
/// <summary>
/// The receive documents operation which define the connection and top level design.
/// </summary>
private ServiceOperation GetReceiveDocumentServiceOperation()
{
return new ServiceOperation
{
Name = "receiveDocument",
Id = "receiveDocument",
Type = "receiveDocument",
Properties = new ServiceOperationProperties
{
Api = this.GetServiceOperationApi().GetFlattenedApi(),
Summary = "Receive document",
Description = "Receive document from Azure Cosmos DB",
Visibility = Visibility.Important,
OperationType = OperationType.ServiceProvider,
BrandColor = Color.LightSkyBlue.ToHexColor(),
IconUri = new Uri("https://raw.githubusercontent.com/Azure/logicapps-connector-extensions/CosmosDB/src/CosmosDB/icon.png"),
Trigger = TriggerType.Batch,
},
};
}
/// <summary>
/// The Azure cosmos db API which defines the connection.
/// </summary>
private ServiceOperationApi GetServiceOperationApi()
{
return new ServiceOperationApi
{
Name = "cosmosdb",
Id = ServiceId,
Type = DesignerApiType.ServiceProvider,
Properties = new ServiceOperationApiProperties
{
BrandColor = Color.LightSkyBlue.ToHexColor(),
Description = "Connect to Azure Cosmos db to receive document.",
DisplayName = "Cosmos Db",
IconUri = new Uri("https://raw.githubusercontent.com/Azure//logicapps-connector-extensions/CosmosDB/src/CosmosDB/icon.png"),
Capabilities = new ApiCapability[] { ApiCapability.Triggers },
ConnectionParameters = new ConnectionParameters
{
ConnectionString = new ConnectionStringParameters
{
Type = ConnectionStringType.SecureString,
ParameterSource = ConnectionParameterSource.AppConfiguration,
UIDefinition = new UIDefinition
{
DisplayName = "Connection String",
Description = "Azure Cosmos db Connection String",
Tooltip = "Provide Azure Cosmos db Connection String",
Constraints = new Constraints
{
Required = "true",
},
},
},
},
},
};
}
}
}