You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/connectors/apis-list.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -137,17 +137,17 @@ To make sure that your workflow runs at your specified start time and doesn't mi
137
137
138
138
## Custom connectors and APIs
139
139
140
-
In Consumption logic apps, you can call APIs that run custom code or aren't available as connectors in the following ways:
140
+
In Consumption logic apps that run in multi-tenant Azure Logic Apps, you can call Swagger-based or SOAP-based APIs that aren't available as connectors or run custom code in the following ways:
141
141
142
-
*[Create custom API Apps](../logic-apps/logic-apps-create-api-app.md)
143
-
144
-
*[Create custom connectors](../logic-apps/custom-connector-overview.md) for REST or SOAP-based APIs [up to specific limits](../logic-apps/logic-apps-limits-and-config.md#custom-connector-limits).
142
+
*[About custom connectors for Consumption logic apps](../logic-apps/custom-connector-overview.md#custom-connector-consumption)
145
143
146
144
Custom connectors make these APIs available to any Consumption logic app in your Azure subscription. To make custom API Apps or connectors public for anyone to use in Azure, you can [submit connectors for Microsoft certification](/connectors/custom-connectors/submit-certification).
147
145
148
-
In Standard logic apps, you can create natively running custom [built-in connectors](../connectors/built-in.md) that are available to any Standard logic app. For more information, review the following documentation:
146
+
*[Create custom API Apps](../logic-apps/logic-apps-create-api-app.md)
147
+
148
+
In Standard logic apps, you can create natively running [service provider-based custom built-in connectors](../connectors/built-in.md) that are available to any Standard logic app. For more information, review the following documentation:
149
149
150
-
*[Custom connectors for Standard logic apps](../logic-apps/custom-connector-overview.md#custom-connector-standard)
150
+
*[About custom built-in connectors for Standard logic apps](../logic-apps/custom-connector-overview.md#custom-connector-standard)
151
151
152
152
*[Create custom built-in connectors for Standard logic apps](../logic-apps/create-custom-built-in-connector-standard.md)
Copy file name to clipboardExpand all lines: articles/logic-apps/create-custom-built-in-connector-standard.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ The following outline describes the high-level steps to build the example connec
51
51
52
52
1. In your project, add the **Microsoft.Azure.Workflows.WebJobs.Extension** NuGet package as a NuGet reference.
53
53
54
-
1. Provide the operations and operation descriptions for your built-in connector by using the NuGet package to implement methods for the interfaces named [**IServiceOperationsProvider**](custom-connector-overview.md#iserviceoperationsprovider) and [**IServiceOperationsTriggerProvider**](custom-connector-overview.md#iserviceoperationstriggerprovider).
54
+
1. Provide the operations for your built-in connector by using the NuGet package to implement the methods for the interfaces named [**IServiceOperationsProvider**](custom-connector-overview.md#iserviceoperationsprovider) and [**IServiceOperationsTriggerProvider**](custom-connector-overview.md#iserviceoperationstriggerprovider).
55
55
56
56
1. Register your custom built-in connector with the Azure Functions runtime extension.
57
57
@@ -65,21 +65,21 @@ The following outline describes the high-level steps to build the example connec
65
65
66
66
## Implement the service provider interface
67
67
68
-
To provide the operations and their descriptions for the sample built-in connector, in the **Microsoft.Azure.Workflows.WebJobs.Extension** NuGet package, implement the methods for the following interfaces. The following diagram shows the interfaces with the method implementations that the Azure Logic Apps designer and runtime expect for a custom built-in connector that has an Azure Functions-based trigger:
68
+
To provide the operations for the sample built-in connector, in the **Microsoft.Azure.Workflows.WebJobs.Extension** NuGet package, implement the methods for the following interfaces. The following diagram shows the interfaces with the method implementations that the Azure Logic Apps designer and runtime expect for a custom built-in connector that has an Azure Functions-based trigger:
69
69
70
70

71
71
72
72
### IServiceOperationsProvider
73
73
74
-
This interface includes the following methods that provide the operation descriptions and operation invocations required from your custom built-in connector. For more information, review [IServiceOperationsProvider](custom-connector-overview.md#iserviceoperationsprovider).
74
+
This interface includes the following methods that provide the operation manifest and performs your service provider's specific tasks or actual business logic in your custom built-in connector. For more information, review [IServiceOperationsProvider](custom-connector-overview.md#iserviceoperationsprovider).
75
75
76
76
*[**GetService()**](#getservice)
77
77
78
78
The designer in Azure Logic Apps requires the [**GetService()**](#getservice) method to retrieve the high-level description for your custom service, including the service description, connection input parameters required on the designer, capabilities, brand color, icon URL, and so on.
79
79
80
80
*[**GetOperations()**](#getoperations)
81
81
82
-
The designer in Azure Logic Apps requires the [**GetOperations()**](#getoperations) method to retrieve the operations implemented by your custom service. The operations list is based on Swagger schema. The designer also uses operation descriptions to understand the input parameters for specific operations and generate the outputs as property tokens, based on the schema of the output for an operation.
82
+
The designer in Azure Logic Apps requires the [**GetOperations()**](#getoperations) method to retrieve the operations implemented by your custom service. The operations list is based on Swagger schema. The designer also uses the operation metadata to understand the input parameters for specific operations and generate the outputs as property tokens, based on the schema of the output for an operation.
@@ -99,7 +99,7 @@ You can add or expose an [Azure Functions trigger or action](../azure-functions/
99
99
100
100
* The [**GetFunctionTriggerType()**](#getfunctiontriggertype) method is required to return the string that's the same as the **type** parameter in the Azure Functions trigger binding.
101
101
102
-
* The [**GetFunctionTriggerDefinition()**](#getfunctiontriggerdefinition) has a default implementation, so you don't need to explicitly implement this method.
102
+
* The [**GetFunctionTriggerDefinition()**](#getfunctiontriggerdefinition) has a default implementation, so you don't need to explicitly implement this method. However, if you want to update the trigger's default behavior, such as provide extra parameters that the designer doesn't expose, you can implement this method and override the default behavior.
103
103
104
104
### Methods to implement
105
105
@@ -170,7 +170,7 @@ public string GetFunctionTriggerType()
170
170
171
171
#### GetFunctionTriggerDefinition()
172
172
173
-
This method has a default implementation, so you don't need to explicitly implement this method.
173
+
This method has a default implementation, so you don't need to explicitly implement this method. However, if you want to update the trigger's default behavior, such as provide extra parameters that the designer doesn't expose, you can implement this method and override the default behavior.
174
174
175
175
<aname="register-connector"></a>
176
176
@@ -216,7 +216,7 @@ The following sections show how to register your custom built-in connector as an
216
216
217
217
### Register the service provider
218
218
219
-
Now, register the service provider implementation as an Azure Functions extension. This example uses the built-in [Azure Cosmos DB trigger for Azure Functions](../azure-functions/functions-bindings-cosmosdb-v2-trigger.md?tabs=in-process%2Cfunctionsv2&pivots=programming-language-csharp) as a new trigger. This example also registers the new Cosmos DB service provider for an existing list of service providers, which is already part of the Azure Logic Apps extension. For more information, review [Register Azure Functions binding extensions](../azure-functions/functions-bindings-register.md).
219
+
Now, register the service provider implementation as an Azure Functions extension with the Azure Logic Apps engine. This example uses the built-in [Azure Cosmos DB trigger for Azure Functions](../azure-functions/functions-bindings-cosmosdb-v2-trigger.md?tabs=in-process%2Cfunctionsv2&pivots=programming-language-csharp) as a new trigger. This example also registers the new Cosmos DB service provider for an existing list of service providers, which is already part of the Azure Logic Apps extension. For more information, review [Register Azure Functions binding extensions](../azure-functions/functions-bindings-register.md).
Copy file name to clipboardExpand all lines: articles/logic-apps/custom-connector-overview.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ This article provides an overview about custom connectors for [Consumption logic
31
31
32
32
## Consumption logic apps
33
33
34
-
In [multi-tenant Azure Logic Apps](logic-apps-overview.md), you can create [Swagger-based or SOAP-based custom connectors](/connectors/custom-connectors/)from REST APIs to use in Consumption logic app workflows. The [Connectors documentation](/connectors/connectors) provides more overview information about how to create custom connectors for Consumption logic apps, including complete basic and advanced tutorials. The following list also provides direct links to information about custom connectors for Consumption logic apps:
34
+
In [multi-tenant Azure Logic Apps](logic-apps-overview.md), you can create [custom connectors from Swagger-based or SOAP-based APIs](/connectors/custom-connectors/)up to [specific limits](../logic-apps/logic-apps-limits-and-config.md#custom-connector-limits) for use in Consumption logic app workflows. The [Connectors documentation](/connectors/connectors) provides more overview information about how to create custom connectors for Consumption logic apps, including complete basic and advanced tutorials. The following list also provides direct links to information about custom connectors for Consumption logic apps:
35
35
36
36
*[Create an Azure Logic Apps connector](/connectors/custom-connectors/create-logic-apps-connector)
37
37
*[Create a custom connector from an OpenAPI definition](/connectors/custom-connectors/define-openapi-definition)
@@ -87,19 +87,19 @@ The following sections provide more information about the interfaces that your c
87
87
88
88
#### IServiceOperationsProvider
89
89
90
-
This interface includes the methods that provide the operation descriptions and invocations for your custom built-in connector.
90
+
This interface includes the methods that provide the operations manifest for your custom built-in connector.
91
91
92
-
*Operation descriptions
92
+
*Operations manifest
93
93
94
-
Operation descriptions are metadata about the implemented operations in your custom built-in connector. The Azure Logic Apps designer primarily uses these descriptions to drive the authoring and monitoring experiences for your connector's operations. For example, the designer uses operation descriptions to understand the input parameters required by a specific operation and to facilitate generating the outputs' property tokens, based on the schema for the operation's outputs.
94
+
The operations manifest includes metadata about the implemented operations in your custom built-in connector. The Azure Logic Apps designer primarily uses this metadata to drive the authoring and monitoring experiences for your connector's operations. For example, the designer uses operation metadata to understand the input parameters required by a specific operation and to facilitate generating the outputs' property tokens, based on the schema for the operation's outputs.
95
95
96
96
The designer requires and uses the [**GetService()**](#getservice) and [**GetOperations()**](#getoperations) methods to query the operations that your connector provides and shows on the designer surface. The **GetService()** method also specifies the connection's input parameters that are required by the designer.
97
97
98
98
For more information about these methods and their implementation, review the [Methods to implement](#method-implementation) section later in this article.
99
99
100
100
* Operation invocations
101
101
102
-
Operation invocations are the implementations used during workflow execution by the Azure Logic Apps runtime to call the specified operation in the workflow definition.
102
+
Operation invocations are the method implementations used during workflow execution by the Azure Logic Apps runtime to call the specified operations in the workflow definition.
103
103
104
104
* If your trigger is an Azure Functions-based trigger type, the [**GetBindingConnectionInformation()**](#getbindingconnectioninformation) method is used by the runtime in Azure Logic Apps to provide the required connection parameters information to the Azure Functions trigger binding.
105
105
@@ -113,7 +113,7 @@ Custom built-in trigger capabilities support adding or exposing an [Azure Functi
113
113
114
114
* The [**GetFunctionTriggerType()**](#getfunctiontriggertype) method is required to return the string that's the same as the **type** parameter in the Azure Functions trigger binding.
115
115
116
-
* The [**GetFunctionTriggerDefinition()**](#getfunctiontriggerdefinition) has a default implementation, so you don't need to explicitly implement this method.
116
+
* The [**GetFunctionTriggerDefinition()**](#getfunctiontriggerdefinition) has a default implementation, so you don't need to explicitly implement this method. However, if you want to update the trigger's default behavior, such as provide extra parameters that the designer doesn't expose, you can implement this method and override the default behavior.
117
117
118
118
<aname="method-implementation"></a>
119
119
@@ -136,7 +136,7 @@ For more information, review [Sample CosmosDbServiceOperationProvider.cs](https:
136
136
137
137
#### GetOperations()
138
138
139
-
The designer requires this method to get the operations implemented by your service. The operations list is based on Swagger schema. The designer also uses operation descriptions to understand the input parameters for specific operations and generate the outputs as property tokens, based on the schema of the output for an operation.
139
+
The designer requires this method to get the operations implemented by your service. The operations list is based on Swagger schema. The designer also uses the operation metadata to understand the input parameters for specific operations and generate the outputs as property tokens, based on the schema of the output for an operation.
@@ -200,7 +200,7 @@ For more information, review [Sample CosmosDbServiceOperationProvider.cs](https:
200
200
201
201
#### GetFunctionTriggerDefinition()
202
202
203
-
This method has a default implementation, so you don't need to explicitly implement this method.
203
+
This method has a default implementation, so you don't need to explicitly implement this method. However, if you want to update the trigger's default behavior, such as provide extra parameters that the designer doesn't expose, you can implement this method and override the default behavior.
0 commit comments