-
Notifications
You must be signed in to change notification settings - Fork 255
/
DurableClientAttribute.xml
100 lines (100 loc) · 5.55 KB
/
DurableClientAttribute.xml
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
<Type Name="DurableClientAttribute" FullName="Microsoft.Azure.Functions.Worker.DurableClientAttribute">
<TypeSignature Language="C#" Value="public sealed class DurableClientAttribute : Microsoft.Azure.Functions.Worker.Extensions.Abstractions.InputBindingAttribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit DurableClientAttribute extends Microsoft.Azure.Functions.Worker.Extensions.Abstractions.InputBindingAttribute" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Functions.Worker.DurableClientAttribute" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class DurableClientAttribute
Inherits InputBindingAttribute" />
<TypeSignature Language="F#" Value="type DurableClientAttribute = class
 inherit InputBindingAttribute" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Functions.Worker.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.0.2.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Functions.Worker.Extensions.Abstractions.InputBindingAttribute</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Azure Functions attribute for binding a function parameter to a Durable Task client object.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DurableClientAttribute ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Functions.Worker.DurableClientAttribute.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Functions.Worker.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>1.0.2.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ConnectionName">
<MemberSignature Language="C#" Value="public string? ConnectionName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ConnectionName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Functions.Worker.DurableClientAttribute.ConnectionName" />
<MemberSignature Language="VB.NET" Value="Public Property ConnectionName As String" />
<MemberSignature Language="F#" Value="member this.ConnectionName : string with get, set" Usage="Microsoft.Azure.Functions.Worker.DurableClientAttribute.ConnectionName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Functions.Worker.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>1.0.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Optional. Gets or sets the name of the app setting or environment variable that contains the
configured storage provider's connection string credentials.
</summary>
<value>The name of an app setting or environment variable containing a connection string.</value>
<remarks>
The connection name used typically comes from the appropriate storage provider configuration value
in host.json. If using the default Azure Storage provider and if no connection name value is explicitly
configured, the <c>AzureWebJobsStorage</c> connection name is used.
</remarks>
</Docs>
</Member>
<Member MemberName="TaskHub">
<MemberSignature Language="C#" Value="public string? TaskHub { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TaskHub" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Functions.Worker.DurableClientAttribute.TaskHub" />
<MemberSignature Language="VB.NET" Value="Public Property TaskHub As String" />
<MemberSignature Language="F#" Value="member this.TaskHub : string with get, set" Usage="Microsoft.Azure.Functions.Worker.DurableClientAttribute.TaskHub" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Functions.Worker.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>1.0.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Optional. Gets or sets the name of the task hub in which the orchestration data lives.
</summary>
<value>The task hub used by this binding.</value>
<remarks>
<para>
If not specified, the task hub name used by this binding will be the value specified in host.json.
If a task hub name is not configured in host.json and if the function app is running in the
Azure Functions hosted service, then task hub name is derived from the function app's name.
Otherwise, a constant value is used for the task hub name.
</para>
<para>
In general, you should <i>not</i> set a value for the task hub name here unless you intend to
configure the client to interact with orchestrations in another app.
</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>