Skip to content

Commit 0b1c7f0

Browse files
Merge pull request #245877 from mattchenderson/sdktypes2
updating blob and event grid versions
2 parents 2b20ab2 + 40aa209 commit 0b1c7f0

11 files changed

+43
-32
lines changed

articles/azure-functions/dotnet-isolated-in-process-differences.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Use the following table to compare feature and functional differences between th
2727
| Core packages | [Microsoft.NET.Sdk.Functions](https://www.nuget.org/packages/Microsoft.NET.Sdk.Functions/) | [Microsoft.Azure.Functions.Worker](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker/)<br/>[Microsoft.Azure.Functions.Worker.Sdk](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Sdk) |
2828
| Binding extension packages | [Microsoft.Azure.WebJobs.Extensions.*](https://www.nuget.org/packages?q=Microsoft.Azure.WebJobs.Extensions) | [Microsoft.Azure.Functions.Worker.Extensions.*](https://www.nuget.org/packages?q=Microsoft.Azure.Functions.Worker.Extensions) |
2929
| Durable Functions | [Supported](durable/durable-functions-overview.md) | [Supported](durable/durable-functions-isolated-create-first-csharp.md?pivots=code-editor-visualstudio) |
30-
| Model types exposed by bindings | Simple types<br/>[JSON serializable](/dotnet/api/system.text.json.jsonserializeroptions) types<br/>Arrays/enumerations<br/>Service SDK types such as [BlobClient](/dotnet/api/azure.storage.blobs.blobclient)<br/>`IAsyncCollector` (for output bindings) | Simple types<br/>JSON serializable types<br/>Arrays/enumerations<br/>[Some service-specific SDK types](dotnet-isolated-process-guide.md#sdk-types-preview) |
30+
| Model types exposed by bindings | Simple types<br/>[JSON serializable](/dotnet/api/system.text.json.jsonserializeroptions) types<br/>Arrays/enumerations<br/>Service SDK types<sup>4</sup> | Simple types<br/>JSON serializable types<br/>Arrays/enumerations<br/>[Service SDK types](dotnet-isolated-process-guide.md#sdk-types)<sup>4</sup> |
3131
| HTTP trigger model types| [HttpRequest] / [IActionResult] | [HttpRequestData] / [HttpResponseData]<br/>[HttpRequest] / [IActionResult] (as a [public preview extension][aspnetcore-integration])|
3232
| Output binding interactions | Return values (single output only)<br/>`out` parameters<br/>`IAsyncCollector` | Return values (expanded model with single or [multiple outputs](dotnet-isolated-process-guide.md#multiple-output-bindings)) |
3333
| Imperative bindings<sup>1</sup> | [Supported](functions-dotnet-class-library.md#binding-at-runtime) | Not supported |
@@ -45,6 +45,8 @@ Use the following table to compare feature and functional differences between th
4545

4646
<sup>3</sup> C# Script functions also run in-process and use the same libraries as in-process class library functions. For more information, see the [Azure Functions C# script (.csx) developer reference](functions-reference-csharp.md).
4747

48+
<sup>4</sup> Service SDK types include types from the [Azure SDK for .NET](/dotnet/azure/sdk/azure-sdk-for-dotnet) such as [BlobClient](/dotnet/api/azure.storage.blobs.blobclient). For the isolated process model, support from some extensions is currently in preview.
49+
4850
[HttpRequest]: /dotnet/api/microsoft.aspnetcore.http.httprequest
4951
[IActionResult]: /dotnet/api/microsoft.aspnetcore.mvc.iactionresult
5052
[HttpRequestData]: /dotnet/api/microsoft.azure.functions.worker.http.httprequestdata?view=azure-dotnet&preserve-view=true

articles/azure-functions/dotnet-isolated-process-guide.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ A .NET Functions isolated worker process project uses a unique set of packages,
6262

6363
The following packages are required to run your .NET functions in an isolated worker process:
6464

65-
+ [Microsoft.Azure.Functions.Worker](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker/)
66-
+ [Microsoft.Azure.Functions.Worker.Sdk](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Sdk/)
65+
+ [Microsoft.Azure.Functions.Worker]
66+
+ [Microsoft.Azure.Functions.Worker.Sdk]
6767

6868
### Extension packages
6969

@@ -189,7 +189,7 @@ The trigger attribute specifies the trigger type and binds input data to a metho
189189

190190
The `Function` attribute marks the method as a function entry point. The name must be unique within a project, start with a letter and only contain letters, numbers, `_`, and `-`, up to 127 characters in length. Project templates often create a method named `Run`, but the method name can be any valid C# method name.
191191

192-
Bindings can provide data as strings, arrays, and serializable types, such as plain old class objects (POCOs). You can also bind to [types from some service SDKs](#sdk-types-preview).
192+
Bindings can provide data as strings, arrays, and serializable types, such as plain old class objects (POCOs). You can also bind to [types from some service SDKs](#sdk-types).
193193

194194
For HTTP triggers, you must use [HttpRequestData] and [HttpResponseData] to access the request and response data. This is because you don't have access to the original HTTP request and response objects when using .NET Functions isolated worker process.
195195

@@ -213,23 +213,28 @@ The data written to an output binding is always the return value of the function
213213

214214
The response from an HTTP trigger is always considered an output, so a return value attribute isn't required.
215215

216-
### SDK types (preview)
216+
### SDK types
217217

218-
For some service-specific binding types, binding data can be provided using types from service SDKs and frameworks. These provide additional capability beyond what a serialized string or plain-old CLR object (POCO) may offer. Support for SDK types is currently in preview with limited scenario coverage.
218+
For some service-specific binding types, binding data can be provided using types from service SDKs and frameworks. These provide additional capability beyond what a serialized string or plain-old CLR object (POCO) may offer. To use the newer types, your project needs to be updated to use newer versions of core dependencies.
219219

220-
To use SDK type bindings, your project must reference [Microsoft.Azure.Functions.Worker 1.15.0-preview1 or later](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker/1.15.0-preview1) and [Microsoft.Azure.Functions.Worker.Sdk 1.11.0-preview1 or later](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Sdk/1.11.0-preview1). Specific package versions will be needed for each of the service extensions as well. When testing SDK types locally on your machine, you will also need to use [Azure Functions Core Tools version 4.0.5000 or later](./functions-run-local.md). You can check your current version using the command `func version`.
220+
| Dependency | Version requirement |
221+
|-|-|
222+
|[Microsoft.Azure.Functions.Worker]| For **Generally Available** extensions in the table below: 1.18.0 or later<br/>For extensions that have **preview support**: 1.15.0-preview1 |
223+
|[Microsoft.Azure.Functions.Worker.Sdk]|For **Generally Available** extensions in the table below: 1.12.0 or later<br/>For extensions that have **preview support**: 1.11.0-preview1 |
221224

222-
The following service-specific bindings are currently included in the preview:
225+
When testing SDK types locally on your machine, you will also need to use [Azure Functions Core Tools version 4.0.5000 or later](./functions-run-local.md). You can check your current version using the command `func version`.
226+
227+
Each trigger and binding extension also has its own minimum version requirement, which is described in the extension reference articles. The following service-specific bindings offer additional SDK types:
223228

224229
| Service | Trigger | Input binding | Output binding |
225230
|-|-|-|-|
226-
| [Azure Blobs][blob-sdk-types] | **Preview support** | **Preview support** | _SDK types not recommended.<sup>1</sup>_ |
231+
| [Azure Blobs][blob-sdk-types] | **Generally Available** | **Generally Available** | _SDK types not recommended.<sup>1</sup>_ |
227232
| [Azure Queues][queue-sdk-types] | **Preview support** | _Input binding does not exist_ | _SDK types not recommended.<sup>1</sup>_ |
228233
| [Azure Service Bus][servicebus-sdk-types] | **Preview support<sup>2</sup>** | _Input binding does not exist_ | _SDK types not recommended.<sup>1</sup>_ |
229234
| [Azure Event Hubs][eventhub-sdk-types] | **Preview support** | _Input binding does not exist_ | _SDK types not recommended.<sup>1</sup>_ |
230-
| [Azure Cosmos DB][cosmos-sdk-types] | _SDK types not used<sup>3</sup>_ | **Preview support** | _SDK types not recommended<.sup>1</sup>_ |
235+
| [Azure Cosmos DB][cosmos-sdk-types] | _SDK types not used<sup>3</sup>_ | **Preview support** | _SDK types not recommended.<sup>1</sup>_ |
231236
| [Azure Tables][tables-sdk-types] | _Trigger does not exist_ | **Preview support** | _SDK types not recommended.<sup>1</sup>_ |
232-
| [Azure Event Grid][eventgrid-sdk-types] | **Preview support** | _Input binding does not exist_ | _SDK types not recommended.<sup>1</sup>_ |
237+
| [Azure Event Grid][eventgrid-sdk-types] | **Generally Available** | _Input binding does not exist_ | _SDK types not recommended.<sup>1</sup>_ |
233238

234239
[blob-sdk-types]: ./functions-bindings-storage-blob.md?tabs=isolated-process%2Cextensionv5&pivots=programming-language-csharp#binding-types
235240
[cosmos-sdk-types]: ./functions-bindings-cosmosdb-v2.md?tabs=isolated-process%2Cextensionv4&pivots=programming-language-csharp#binding-types
@@ -438,6 +443,10 @@ Because your isolated worker process app runs outside the Functions runtime, you
438443

439444

440445
[supported-versions]: #supported-versions
446+
447+
[Microsoft.Azure.Functions.Worker]: https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker/
448+
[Microsoft.Azure.Functions.Worker.Sdk]: https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Sdk/
449+
441450
[HostBuilder]: /dotnet/api/microsoft.extensions.hosting.hostbuilder
442451
[IHost]: /dotnet/api/microsoft.extensions.hosting.ihost
443452
[ConfigureFunctionsWorkerDefaults]: /dotnet/api/microsoft.extensions.hosting.workerhostbuilderextensions.configurefunctionsworkerdefaults?view=azure-dotnet&preserve-view=true#Microsoft_Extensions_Hosting_WorkerHostBuilderExtensions_ConfigureFunctionsWorkerDefaults_Microsoft_Extensions_Hosting_IHostBuilder_

articles/azure-functions/functions-bindings-storage-blob.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ Functions 1.x exposed types from the deprecated [Microsoft.WindowsAzure.Storage]
180180

181181
# [Extension 5.x and higher](#tab/extensionv5/isolated-process)
182182

183-
The isolated worker process supports parameter types according to the tables below. Support for binding to `Stream`, and to types from [Azure.Storage.Blobs] is in preview.
183+
The isolated worker process supports parameter types according to the tables below.
184184

185185
**Blob trigger**
186186

includes/functions-bindings-cosmosdb-v2-input-dotnet-isolated-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ When you want the function to process multiple documents from a query, the Cosmo
2121
| [Database] | _(Preview<sup>1</sup>)_<br/>A client connected to the Cosmos DB database. |
2222
| [Container] | _(Preview<sup>1</sup>)_<br/>A client connected to the Cosmos DB container. |
2323

24-
<sup>1</sup> To use these types, you need to reference [Microsoft.Azure.Functions.Worker.Extensions.CosmosDB 4.3.1-preview1 or later](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Extensions.CosmosDB/4.3.1-preview1) and the [common dependencies for SDK type bindings](../articles/azure-functions/dotnet-isolated-process-guide.md#sdk-types-preview).
24+
<sup>1</sup> To use these types, you need to reference [Microsoft.Azure.Functions.Worker.Extensions.CosmosDB 4.3.1-preview1 or later](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Extensions.CosmosDB/4.3.1-preview1) and the [common dependencies for SDK type bindings](../articles/azure-functions/dotnet-isolated-process-guide.md#sdk-types).
2525

2626
[CosmosClient]: /dotnet/api/microsoft.azure.cosmos.cosmosclient
2727
[Database]: /dotnet/api/microsoft.azure.cosmos.database

includes/functions-bindings-event-grid-trigger-dotnet-isolated-types.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ When you want the function to process a single event, the Event Grid trigger can
1212
| --- | --- |
1313
| JSON serializable types | Functions tries to deserialize the JSON data of the event into a plain-old CLR object (POCO) type. |
1414
| `string` | The event as a string. |
15-
| [BinaryData] | _(Preview<sup>1</sup>)_<br/>The bytes of the event message. |
16-
| [CloudEvent] | _(Preview<sup>1</sup>)_<br/>The event object. Use when Event Grid is configured to deliver using the CloudEvents schema. |
17-
| [EventGridEvent] | _(Preview<sup>1</sup>)_<br/>The event object. Use when Event Grid is configured to deliver using the Event Grid schema. |
15+
| [BinaryData]<sup>1</sup> | The bytes of the event message. |
16+
| [CloudEvent]<sup>1</sup> | The event object. Use when Event Grid is configured to deliver using the CloudEvents schema. |
17+
| [EventGridEvent]<sup>1</sup> | The event object. Use when Event Grid is configured to deliver using the Event Grid schema. |
1818

1919
When you want the function to process a batch of events, the Event Grid trigger can bind to the following types:
2020

2121
| Type | Description |
2222
| --- | --- |
23-
| `CloudEvent[]`,<br/>`EventGridEvent[]`,<br/>`string[]`,<br/>`BinaryData[]` | An array of events from the batch. Each entry represents one event. |
23+
| `CloudEvent[]`<sup>1</sup>,<br/>`EventGridEvent[]`<sup>1</sup>,<br/>`string[]`,<br/>`BinaryData[]`<sup>1</sup> | An array of events from the batch. Each entry represents one event. |
2424

25-
<sup>1</sup> To use these types, you need to reference [Microsoft.Azure.Functions.Worker.Extensions.EventGrid 3.3.0-preview1 or later](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Extensions.EventGrid/3.3.0-preview1) and the [common dependencies for SDK type bindings](../articles/azure-functions/dotnet-isolated-process-guide.md#sdk-types-preview).
25+
<sup>1</sup> To use these types, you need to reference [Microsoft.Azure.Functions.Worker.Extensions.EventGrid 3.3.0 or later](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Extensions.EventGrid/3.3.0) and the [common dependencies for SDK type bindings](../articles/azure-functions/dotnet-isolated-process-guide.md#sdk-types).
2626

2727
[CloudEvent]: /dotnet/api/azure.messaging.cloudevent
2828
[EventGridEvent]: /dotnet/api/azure.messaging.eventgrid.eventgridevent

includes/functions-bindings-event-hubs-trigger-dotnet-isolated-types.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ When you want the function to process a single event, the Event Hubs trigger can
1212
| --- | --- |
1313
| `string` | The event as a string. Use when the event is simple text. |
1414
| `byte[]` | The bytes of the event. |
15-
| JSON serializable types | When a event contains JSON data, Functions tries to deserialize the JSON data into a plain-old CLR object (POCO) type. |
15+
| JSON serializable types | When an event contains JSON data, Functions tries to deserialize the JSON data into a plain-old CLR object (POCO) type. |
1616
| [Azure.Messaging.EventHubs.EventData] | _(Preview<sup>1</sup>)_<br/>The event object.<br/>If you are migrating from any older versions of the Event Hubs SDKs, note that this version drops support for the legacy `Body` type in favor of [EventBody](/dotnet/api/azure.messaging.eventhubs.eventdata.eventbody).|
1717

1818
When you want the function to process a batch of events, the Event Hubs trigger can bind to the following types:
@@ -23,6 +23,6 @@ When you want the function to process a batch of events, the Event Hubs trigger
2323
| `EventData[]` | _(Preview<sup>1</sup>)_<br/>An array of events from the batch, as instances of [Azure.Messaging.EventHubs.EventData]. Each entry represents one event. |
2424
| `T[]` where `T` is a JSON serializable type | _(Preview<sup>1</sup>)_<br/>An array of events from the batch, as instances of a custom POCO type. Each entry represents one event. |
2525

26-
<sup>1</sup> To use these types, you need to reference [Microsoft.Azure.Functions.Worker.Extensions.EventHubs 5.4.1-preview1 or later](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Extensions.EventHubs/5.4.1-preview1) and the [common dependencies for SDK type bindings](../articles/azure-functions/dotnet-isolated-process-guide.md#sdk-types-preview).
26+
<sup>1</sup> To use these types, you need to reference [Microsoft.Azure.Functions.Worker.Extensions.EventHubs 5.4.1-preview1 or later](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Extensions.EventHubs/5.4.1-preview1) and the [common dependencies for SDK type bindings](../articles/azure-functions/dotnet-isolated-process-guide.md#sdk-types).
2727

28-
[Azure.Messaging.EventHubs.EventData]: /dotnet/api/azure.messaging.eventhubs.eventdata
28+
[Azure.Messaging.EventHubs.EventData]: /dotnet/api/azure.messaging.eventhubs.eventdata

includes/functions-bindings-service-bus-trigger-dotnet-isolated-types.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ When you want the function to process a single message, the Service Bus trigger
1212
| --- | --- |
1313
| `string` | The message as a string. Use when the message is simple text. |
1414
| `byte[]` | The bytes of the message. |
15-
| JSON serializable types | When a event contains JSON data, Functions tries to deserialize the JSON data into a plain-old CLR object (POCO) type. |
15+
| JSON serializable types | When an event contains JSON data, Functions tries to deserialize the JSON data into a plain-old CLR object (POCO) type. |
1616
| [ServiceBusReceivedMessage] | _(Preview<sup>1</sup>)_<br/>The message object. |
1717

1818
When you want the function to process a batch of messages, the Service Bus trigger can bind to the following types:
@@ -23,7 +23,7 @@ When you want the function to process a batch of messages, the Service Bus trigg
2323

2424
The isolated process model does not yet support message settlement scenarios for Service Bus triggers.
2525

26-
<sup>1</sup> To use these types, you need to reference [Microsoft.Azure.Functions.Worker.Extensions.ServiceBus 5.10.0-preview2 or later](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Extensions.ServiceBus/5.10.0-preview2) and the [common dependencies for SDK type bindings](../articles/azure-functions/dotnet-isolated-process-guide.md#sdk-types-preview).
26+
<sup>1</sup> To use these types, you need to reference [Microsoft.Azure.Functions.Worker.Extensions.ServiceBus 5.10.0-preview2 or later](https://www.nuget.org/packages/Microsoft.Azure.Functions.Worker.Extensions.ServiceBus/5.10.0-preview2) and the [common dependencies for SDK type bindings](../articles/azure-functions/dotnet-isolated-process-guide.md#sdk-types).
2727

2828
[Azure.Messaging.ServiceBus]: /dotnet/api/azure.messaging.servicebus
2929
[ServiceBusReceivedMessage]: /dotnet/api/azure.messaging.servicebus.servicebusreceivedmessage

0 commit comments

Comments
 (0)