projects / platform / core / dotnet / build-tools.git / blob
? search:


0c7fbd762dd5f75dceb2b4619bda1667c85cfb8b
[platform/core/dotnet/build-tools.git] /
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext">\r
8             <summary>\r
9             Health check context. Provides health check registrations to <see cref="M:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck.CheckHealthAsync(Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext,System.Threading.CancellationToken)"/>.\r
10             </summary>\r
11         </member>\r
12         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext.Registration">\r
13             <summary>\r
14             Gets or sets the <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration"/> of the currently executing <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/>.\r
15             </summary>\r
16         </member>\r
17         <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration">\r
18             <summary>\r
19             Represent the registration information associated with an <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> implementation.\r
20             </summary>\r
21             <remarks>\r
22             <para>\r
23             The health check registration is provided as a separate object so that application developers can customize\r
24             how health check implementations are configured.\r
25             </para>\r
26             <para>\r
27             The registration is provided to an <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> implementation during execution through\r
28             <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext.Registration"/>. This allows a health check implementation to access named\r
29             options or perform other operations based on the registered name.\r
30             </para>\r
31             </remarks>\r
32         </member>\r
33         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.#ctor(System.String,Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String})">\r
34             <summary>\r
35             Creates a new <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration" /> for an existing <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck" /> instance.\r
36             </summary>\r
37             <param name="name">The health check name.</param>\r
38             <param name="instance">The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck" /> instance.</param>\r
39             <param name="failureStatus">\r
40             The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus" /> that should be reported upon failure of the health check. If the provided value\r
41             is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy" /> will be reported.\r
42             </param>\r
43             <param name="tags">A list of tags that can be used for filtering health checks.</param>\r
44         </member>\r
45         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.#ctor(System.String,Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.TimeSpan})">\r
46             <summary>\r
47             Creates a new <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration"/> for an existing <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.\r
48             </summary>\r
49             <param name="name">The health check name.</param>\r
50             <param name="instance">The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.</param>\r
51             <param name="failureStatus">\r
52             The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported upon failure of the health check. If the provided value\r
53             is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.\r
54             </param>\r
55             <param name="tags">A list of tags that can be used for filtering health checks.</param>\r
56             <param name="timeout">An optional <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>\r
57         </member>\r
58         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.#ctor(System.String,System.Func{System.IServiceProvider,Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck},System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String})">\r
59             <summary>\r
60             Creates a new <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration"/> for an existing <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.\r
61             </summary>\r
62             <param name="name">The health check name.</param>\r
63             <param name="factory">A delegate used to create the <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.</param>\r
64             <param name="failureStatus">\r
65             The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value\r
66             is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.\r
67             </param>\r
68             <param name="tags">A list of tags that can be used for filtering health checks.</param>\r
69         </member>\r
70         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.#ctor(System.String,System.Func{System.IServiceProvider,Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck},System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.TimeSpan})">\r
71             <summary>\r
72             Creates a new <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration"/> for an existing <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.\r
73             </summary>\r
74             <param name="name">The health check name.</param>\r
75             <param name="factory">A delegate used to create the <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.</param>\r
76             <param name="failureStatus">\r
77             The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value\r
78             is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.\r
79             </param>\r
80             <param name="tags">A list of tags that can be used for filtering health checks.</param>\r
81             <param name="timeout">An optional <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>\r
82         </member>\r
83         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.Factory">\r
84             <summary>\r
85             Gets or sets a delegate used to create the <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.\r
86             </summary>\r
87         </member>\r
88         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.FailureStatus">\r
89             <summary>\r
90             Gets or sets the <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported upon failure of the health check.\r
91             </summary>\r
92         </member>\r
93         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.Timeout">\r
94             <summary>\r
95             Gets or sets the timeout used for the test.\r
96             </summary>\r
97         </member>\r
98         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.Name">\r
99             <summary>\r
100             Gets or sets the health check name.\r
101             </summary>\r
102         </member>\r
103         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.Tags">\r
104             <summary>\r
105             Gets a list of tags that can be used for filtering health checks.\r
106             </summary>\r
107         </member>\r
108         <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult">\r
109             <summary>\r
110             Represents the result of a health check.\r
111             </summary>\r
112         </member>\r
113         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.#ctor(Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus,System.String,System.Exception,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object})">\r
114             <summary>\r
115             Creates a new <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult"/> with the specified values for <paramref name="status"/>,\r
116             <paramref name="exception"/>, <paramref name="description"/>, and <paramref name="data"/>.\r
117             </summary>\r
118             <param name="status">A value indicating the status of the component that was checked.</param>\r
119             <param name="description">A human-readable description of the status of the component that was checked.</param>\r
120             <param name="exception">An <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Exception"/> representing the exception that was thrown when checking for status (if any).</param>\r
121             <param name="data">Additional key-value pairs describing the health of the component.</param>\r
122         </member>\r
123         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Data">\r
124             <summary>\r
125             Gets additional key-value pairs describing the health of the component.\r
126             </summary>\r
127         </member>\r
128         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Description">\r
129             <summary>\r
130             Gets a human-readable description of the status of the component that was checked.\r
131             </summary>\r
132         </member>\r
133         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Exception">\r
134             <summary>\r
135             Gets an <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Exception"/> representing the exception that was thrown when checking for status (if any).\r
136             </summary>\r
137         </member>\r
138         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Status">\r
139             <summary>\r
140             Gets a value indicating the status of the component that was checked.\r
141             </summary>\r
142         </member>\r
143         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Healthy(System.String,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object})">\r
144             <summary>\r
145             Creates a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult"/> representing a healthy component.\r
146             </summary>\r
147             <param name="description">A human-readable description of the status of the component that was checked. Optional.</param>\r
148             <param name="data">Additional key-value pairs describing the health of the component. Optional.</param>\r
149             <returns>A <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult"/> representing a healthy component.</returns>\r
150         </member>\r
151         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Degraded(System.String,System.Exception,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object})">\r
152             <summary>\r
153             Creates a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult"/> representing a degraded component.\r
154             </summary>\r
155             <param name="description">A human-readable description of the status of the component that was checked. Optional.</param>\r
156             <param name="exception">An <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Exception"/> representing the exception that was thrown when checking for status. Optional.</param>\r
157             <param name="data">Additional key-value pairs describing the health of the component. Optional.</param>\r
158             <returns>A <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult"/> representing a degraged component.</returns>\r
159         </member>\r
160         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Unhealthy(System.String,System.Exception,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object})">\r
161             <summary>\r
162             Creates a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult"/> representing an unhealthy component.\r
163             </summary>\r
164             <param name="description">A human-readable description of the status of the component that was checked. Optional.</param>\r
165             <param name="exception">An <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Exception"/> representing the exception that was thrown when checking for status. Optional.</param>\r
166             <param name="data">Additional key-value pairs describing the health of the component. Optional.</param>\r
167             <returns>A <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult"/> representing an unhealthy component.</returns>\r
168         </member>\r
169         <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport">\r
170             <summary>\r
171             Represents the result of executing a group of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instances.\r
172             </summary>\r
173         </member>\r
174         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport.#ctor(System.Collections.Generic.IReadOnlyDictionary{System.String,Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry},System.TimeSpan)">\r
175             <summary>\r
176             Create a new <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport"/> from the specified results.\r
177             </summary>\r
178             <param name="entries">A <see cref="T:System.Collections.Generic.IReadOnlyDictionary`2"/> containing the results from each health check.</param>\r
179             <param name="totalDuration">A value indicating the time the health check service took to execute.</param>\r
180         </member>\r
181         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport.#ctor(System.Collections.Generic.IReadOnlyDictionary{System.String,Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry},Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus,System.TimeSpan)">\r
182             <summary>\r
183             Create a new <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport"/> from the specified results.\r
184             </summary>\r
185             <param name="entries">A <see cref="T:System.Collections.Generic.IReadOnlyDictionary`2"/> containing the results from each health check.</param>\r
186             <param name="status">A <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> representing the aggregate status of all the health checks.</param>\r
187             <param name="totalDuration">A value indicating the time the health check service took to execute.</param>\r
188         </member>\r
189         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport.Entries">\r
190             <summary>\r
191             A <see cref="T:System.Collections.Generic.IReadOnlyDictionary`2"/> containing the results from each health check.\r
192             </summary>\r
193             <remarks>\r
194             The keys in this dictionary map the name of each executed health check to a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry"/> for the\r
195             result data returned from the corresponding health check.\r
196             </remarks>\r
197         </member>\r
198         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport.Status">\r
199             <summary>\r
200             Gets a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> representing the aggregate status of all the health checks. The value of <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport.Status"/>\r
201             will be the most severe status reported by a health check. If no checks were executed, the value is always <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Healthy"/>.\r
202             </summary>\r
203         </member>\r
204         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport.TotalDuration">\r
205             <summary>\r
206             Gets the time the health check service took to execute.\r
207             </summary>\r
208         </member>\r
209         <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry">\r
210             <summary>\r
211             Represents an entry in a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport"/>. Corresponds to the result of a single <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/>.\r
212             </summary>\r
213         </member>\r
214         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.#ctor(Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus,System.String,System.TimeSpan,System.Exception,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object})">\r
215             <summary>\r
216             Creates a new <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry"/> with the specified values for <paramref name="status"/>, <paramref name="exception"/>,\r
217             <paramref name="description"/>, and <paramref name="data"/>.\r
218             </summary>\r
219             <param name="status">A value indicating the health status of the component that was checked.</param>\r
220             <param name="description">A human-readable description of the status of the component that was checked.</param>\r
221             <param name="duration">A value indicating the health execution duration.</param>\r
222             <param name="exception">An <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.Exception"/> representing the exception that was thrown when checking for status (if any).</param>\r
223             <param name="data">Additional key-value pairs describing the health of the component.</param>\r
224         </member>\r
225         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.#ctor(Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus,System.String,System.TimeSpan,System.Exception,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object},System.Collections.Generic.IEnumerable{System.String})">\r
226             <summary>\r
227             Creates a new <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry"/> with the specified values for <paramref name="status"/>, <paramref name="exception"/>,\r
228             <paramref name="description"/>, and <paramref name="data"/>.\r
229             </summary>\r
230             <param name="status">A value indicating the health status of the component that was checked.</param>\r
231             <param name="description">A human-readable description of the status of the component that was checked.</param>\r
232             <param name="duration">A value indicating the health execution duration.</param>\r
233             <param name="exception">An <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.Exception"/> representing the exception that was thrown when checking for status (if any).</param>\r
234             <param name="data">Additional key-value pairs describing the health of the component.</param>\r
235             <param name="tags">Tags associated with the health check that generated the report entry.</param>\r
236         </member>\r
237         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.Data">\r
238             <summary>\r
239             Gets additional key-value pairs describing the health of the component.\r
240             </summary>\r
241         </member>\r
242         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.Description">\r
243             <summary>\r
244             Gets a human-readable description of the status of the component that was checked.\r
245             </summary>\r
246         </member>\r
247         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.Duration">\r
248             <summary>\r
249             Gets the health check execution duration.\r
250             </summary>\r
251         </member>\r
252         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.Exception">\r
253             <summary>\r
254             Gets an <see cref="T:System.Exception"/> representing the exception that was thrown when checking for status (if any).\r
255             </summary>\r
256         </member>\r
257         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.Status">\r
258             <summary>\r
259             Gets the health status of the component that was checked.\r
260             </summary>\r
261         </member>\r
262         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.Tags">\r
263             <summary>\r
264             Gets the tags associated with the health check.\r
265             </summary>\r
266         </member>\r
267         <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus">\r
268             <summary>\r
269             Represents the reported status of a health check result.\r
270             </summary>\r
271             <remarks>\r
272             <para>\r
273             A status of <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> should be considered the default value for a failing health check. Application\r
274             developers may configure a health check to report a different status as desired.\r
275             </para>\r
276             <para>\r
277             The values of this enum or ordered from least healthy to most healthy. So <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Degraded"/> is\r
278             greater than <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> but less than <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Healthy"/>.\r
279             </para>\r
280             </remarks>\r
281         </member>\r
282         <member name="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy">\r
283             <summary>\r
284             Indicates that the health check determined that the component was unhealthy, or an unhandled\r
285             exception was thrown while executing the health check.\r
286             </summary>\r
287         </member>\r
288         <member name="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Degraded">\r
289             <summary>\r
290             Indicates that the health check determined that the component was in a degraded state.\r
291             </summary>\r
292         </member>\r
293         <member name="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Healthy">\r
294             <summary>\r
295             Indicates that the health check determined that the component was healthy.\r
296             </summary>\r
297         </member>\r
298         <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck">\r
299             <summary>\r
300             Represents a health check, which can be used to check the status of a component in the application, such as a backend service, database or some internal\r
301             state.\r
302             </summary>\r
303         </member>\r
304         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck.CheckHealthAsync(Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext,System.Threading.CancellationToken)">\r
305             <summary>\r
306             Runs the health check, returning the status of the component being checked.\r
307             </summary>\r
308             <param name="context">A context object associated with the current execution.</param>\r
309             <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that can be used to cancel the health check.</param>\r
310             <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that completes when the health check has finished, yielding the status of the component being checked.</returns>\r
311         </member>\r
312         <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher">\r
313             <summary>\r
314             Represents a publisher of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport"/> information.\r
315             </summary>\r
316             <remarks>\r
317             <para>\r
318             The default health checks implementation provided an <c>IHostedService</c> implementation that can\r
319             be used to execute health checks at regular intervals and provide the resulting <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport"/>\r
320             data to all registered <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/> instances.\r
321             </para>\r
322             <para>\r
323             To provide an <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/> implementation, register an instance or type as a singleton\r
324             service in the dependency injection container.\r
325             </para>\r
326             <para>\r
327             <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/> instances are provided with a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport"/> after executing\r
328             health checks in a background thread. The use of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/> depend on hosting in\r
329             an application using <c>IWebHost</c> or generic host (<c>IHost</c>). Execution of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/>\r
330             instance is not related to execution of health checks via a middleware.\r
331             </para>\r
332             </remarks>\r
333         </member>\r
334         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher.PublishAsync(Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport,System.Threading.CancellationToken)">\r
335             <summary>\r
336             Publishes the provided <paramref name="report"/>.\r
337             </summary>\r
338             <param name="report">The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport"/>. The result of executing a set of health checks.</param>\r
339             <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>\r
340             <returns>A <see cref="T:System.Threading.Tasks.Task"/> which will complete when publishing is complete.</returns>\r
341         </member>\r
342     </members>\r
343 </doc>\r
Domain: Dotnet / Common;