-
Notifications
You must be signed in to change notification settings - Fork 255
/
EventGridNotificationOptions.xml
183 lines (183 loc) · 9.87 KB
/
EventGridNotificationOptions.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
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
<Type Name="EventGridNotificationOptions" FullName="Microsoft.Azure.WebJobs.Extensions.DurableTask.EventGridNotificationOptions">
<TypeSignature Language="C#" Value="public class EventGridNotificationOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EventGridNotificationOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.WebJobs.Extensions.DurableTask.EventGridNotificationOptions" />
<TypeSignature Language="VB.NET" Value="Public Class EventGridNotificationOptions" />
<TypeSignature Language="F#" Value="type EventGridNotificationOptions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Configuration of the Event Grid notification options
for the Durable Task Extension.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EventGridNotificationOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.Extensions.DurableTask.EventGridNotificationOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="KeySettingName">
<MemberSignature Language="C#" Value="public string KeySettingName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string KeySettingName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.Extensions.DurableTask.EventGridNotificationOptions.KeySettingName" />
<MemberSignature Language="VB.NET" Value="Public Property KeySettingName As String" />
<MemberSignature Language="F#" Value="member this.KeySettingName : string with get, set" Usage="Microsoft.Azure.WebJobs.Extensions.DurableTask.EventGridNotificationOptions.KeySettingName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of the app setting containing the key used for authenticating with the Azure Event Grid custom topic at <see cref="P:Microsoft.Azure.WebJobs.Extensions.DurableTask.EventGridNotificationOptions.TopicEndpoint" />.
</summary>
<value>
The name of the app setting that stores the Azure Event Grid key.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PublishEventTypes">
<MemberSignature Language="C#" Value="public string[] PublishEventTypes { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string[] PublishEventTypes" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.Extensions.DurableTask.EventGridNotificationOptions.PublishEventTypes" />
<MemberSignature Language="VB.NET" Value="Public Property PublishEventTypes As String()" />
<MemberSignature Language="F#" Value="member this.PublishEventTypes : string[] with get, set" Usage="Microsoft.Azure.WebJobs.Extensions.DurableTask.EventGridNotificationOptions.PublishEventTypes" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the event types that will be published to Event Grid.
</summary>
<value>
A list of strings. Possible values 'Started', 'Completed', 'Failed', 'Terminated'.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PublishRetryCount">
<MemberSignature Language="C#" Value="public int PublishRetryCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 PublishRetryCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.Extensions.DurableTask.EventGridNotificationOptions.PublishRetryCount" />
<MemberSignature Language="VB.NET" Value="Public Property PublishRetryCount As Integer" />
<MemberSignature Language="F#" Value="member this.PublishRetryCount : int with get, set" Usage="Microsoft.Azure.WebJobs.Extensions.DurableTask.EventGridNotificationOptions.PublishRetryCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the Event Grid publish request retry count.
</summary>
<value>The number of retry attempts.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PublishRetryHttpStatus">
<MemberSignature Language="C#" Value="public int[] PublishRetryHttpStatus { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32[] PublishRetryHttpStatus" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.Extensions.DurableTask.EventGridNotificationOptions.PublishRetryHttpStatus" />
<MemberSignature Language="VB.NET" Value="Public Property PublishRetryHttpStatus As Integer()" />
<MemberSignature Language="F#" Value="member this.PublishRetryHttpStatus : int[] with get, set" Usage="Microsoft.Azure.WebJobs.Extensions.DurableTask.EventGridNotificationOptions.PublishRetryHttpStatus" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32[]</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the Event Grid publish request http status.
</summary>
<value>A list of HTTP status codes, e.g. 400, 403.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PublishRetryInterval">
<MemberSignature Language="C#" Value="public TimeSpan PublishRetryInterval { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan PublishRetryInterval" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.Extensions.DurableTask.EventGridNotificationOptions.PublishRetryInterval" />
<MemberSignature Language="VB.NET" Value="Public Property PublishRetryInterval As TimeSpan" />
<MemberSignature Language="F#" Value="member this.PublishRetryInterval : TimeSpan with get, set" Usage="Microsoft.Azure.WebJobs.Extensions.DurableTask.EventGridNotificationOptions.PublishRetryInterval" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets orsets the Event Grid publish request retry interval.
</summary>
<value>A <see cref="T:System.TimeSpan" /> representing the retry interval. The default value is 5 minutes.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TopicEndpoint">
<MemberSignature Language="C#" Value="public string TopicEndpoint { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TopicEndpoint" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.Extensions.DurableTask.EventGridNotificationOptions.TopicEndpoint" />
<MemberSignature Language="VB.NET" Value="Public Property TopicEndpoint As String" />
<MemberSignature Language="F#" Value="member this.TopicEndpoint : string with get, set" Usage="Microsoft.Azure.WebJobs.Extensions.DurableTask.EventGridNotificationOptions.TopicEndpoint" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the URL of an Azure Event Grid custom topic endpoint.
When set, orchestration life cycle notification events will be automatically
published to this endpoint.
</summary>
<value>
The Azure Event Grid custom topic URL.
</value>
<remarks>
Azure Event Grid topic URLs are generally expected to be in the form
https://{topic_name}.{region}.eventgrid.azure.net/api/events.
</remarks>
</Docs>
</Member>
</Members>
</Type>