review.tizen.org Git - platform/core/dotnet/build-tools.git/blob

   1 <?xml version="1.0"?>\r
   2 <doc>\r
   3     <assembly>\r
   4         <name>Microsoft.AspNetCore.Diagnostics.HealthChecks</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="T:Microsoft.AspNetCore.Builder.HealthCheckApplicationBuilderExtensions">\r
   8             <summary>\r
   9             <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/> extension methods for the <see cref="T:Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckMiddleware"/>.\r
  10             </summary>\r
  11         </member>\r
  12         <member name="M:Microsoft.AspNetCore.Builder.HealthCheckApplicationBuilderExtensions.UseHealthChecks(Microsoft.AspNetCore.Builder.IApplicationBuilder,Microsoft.AspNetCore.Http.PathString)">\r
  13             <summary>\r
  14             Adds a middleware that provides health check status.\r
  15             </summary>\r
  16             <param name="app">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</param>\r
  17             <param name="path">The path on which to provide health check status.</param>\r
  18             <returns>A reference to the <paramref name="app"/> after the operation has completed.</returns>\r
  19             <remarks>\r
  20             <para>\r
  21             If <paramref name="path"/> is set to <c>null</c> or the empty string then the health check middleware\r
  22             will ignore the URL path and process all requests. If <paramref name="path"/> is set to a non-empty\r
  23             value, the health check middleware will process requests with a URL that matches the provided value\r
  24             of <paramref name="path"/> case-insensitively, allowing for an extra trailing slash ('/') character.\r
  25             </para>\r
  26             <para>\r
  27             The health check middleware will use default settings from <see cref="T:Microsoft.Extensions.Options.IOptions`1"/>.\r
  28             </para>\r
  29             </remarks>\r
  30         </member>\r
  31         <member name="M:Microsoft.AspNetCore.Builder.HealthCheckApplicationBuilderExtensions.UseHealthChecks(Microsoft.AspNetCore.Builder.IApplicationBuilder,Microsoft.AspNetCore.Http.PathString,Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions)">\r
  32             <summary>\r
  33             Adds a middleware that provides health check status.\r
  34             </summary>\r
  35             <param name="app">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</param>\r
  36             <param name="path">The path on which to provide health check status.</param>\r
  37             <param name="options">A <see cref="T:Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions"/> used to configure the middleware.</param>\r
  38             <returns>A reference to the <paramref name="app"/> after the operation has completed.</returns>\r
  39             <remarks>\r
  40             <para>\r
  41             If <paramref name="path"/> is set to <c>null</c> or the empty string then the health check middleware\r
  42             will ignore the URL path and process all requests. If <paramref name="path"/> is set to a non-empty\r
  43             value, the health check middleware will process requests with a URL that matches the provided value\r
  44             of <paramref name="path"/> case-insensitively, allowing for an extra trailing slash ('/') character.\r
  45             </para>\r
  46             </remarks>\r
  47         </member>\r
  48         <member name="M:Microsoft.AspNetCore.Builder.HealthCheckApplicationBuilderExtensions.UseHealthChecks(Microsoft.AspNetCore.Builder.IApplicationBuilder,Microsoft.AspNetCore.Http.PathString,System.Int32)">\r
  49             <summary>\r
  50             Adds a middleware that provides health check status.\r
  51             </summary>\r
  52             <param name="app">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</param>\r
  53             <param name="path">The path on which to provide health check status.</param>\r
  54             <param name="port">The port to listen on. Must be a local port on which the server is listening.</param>\r
  55             <returns>A reference to the <paramref name="app"/> after the operation has completed.</returns>\r
  56             <remarks>\r
  57             <para>\r
  58             If <paramref name="path"/> is set to <c>null</c> or the empty string then the health check middleware\r
  59             will ignore the URL path and process all requests on the specified port. If <paramref name="path"/> is\r
  60             set to a non-empty value, the health check middleware will process requests with a URL that matches the \r
  61             provided value of <paramref name="path"/> case-insensitively, allowing for an extra trailing slash ('/') \r
  62             character.\r
  63             </para>\r
  64             <para>\r
  65             The health check middleware will use default settings from <see cref="T:Microsoft.Extensions.Options.IOptions`1"/>.\r
  66             </para>\r
  67             </remarks>\r
  68         </member>\r
  69         <member name="M:Microsoft.AspNetCore.Builder.HealthCheckApplicationBuilderExtensions.UseHealthChecks(Microsoft.AspNetCore.Builder.IApplicationBuilder,Microsoft.AspNetCore.Http.PathString,System.String)">\r
  70             <summary>\r
  71             Adds a middleware that provides health check status.\r
  72             </summary>\r
  73             <param name="app">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</param>\r
  74             <param name="path">The path on which to provide health check status.</param>\r
  75             <param name="port">The port to listen on. Must be a local port on which the server is listening.</param>\r
  76             <returns>A reference to the <paramref name="app"/> after the operation has completed.</returns>\r
  77             <remarks>\r
  78             <para>\r
  79             If <paramref name="path"/> is set to <c>null</c> or the empty string then the health check middleware\r
  80             will ignore the URL path and process all requests on the specified port. If <paramref name="path"/> is\r
  81             set to a non-empty value, the health check middleware will process requests with a URL that matches the \r
  82             provided value of <paramref name="path"/> case-insensitively, allowing for an extra trailing slash ('/') \r
  83             character.\r
  84             </para>\r
  85             <para>\r
  86             The health check middleware will use default settings from <see cref="T:Microsoft.Extensions.Options.IOptions`1"/>.\r
  87             </para>\r
  88             </remarks>\r
  89         </member>\r
  90         <member name="M:Microsoft.AspNetCore.Builder.HealthCheckApplicationBuilderExtensions.UseHealthChecks(Microsoft.AspNetCore.Builder.IApplicationBuilder,Microsoft.AspNetCore.Http.PathString,System.Int32,Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions)">\r
  91             <summary>\r
  92             Adds a middleware that provides health check status.\r
  93             </summary>\r
  94             <param name="app">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</param>\r
  95             <param name="path">The path on which to provide health check status.</param>\r
  96             <param name="port">The port to listen on. Must be a local port on which the server is listening.</param>\r
  97             <param name="options">A <see cref="T:Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions"/> used to configure the middleware.</param>\r
  98             <returns>A reference to the <paramref name="app"/> after the operation has completed.</returns>\r
  99             <remarks>\r
 100             <para>\r
 101             If <paramref name="path"/> is set to <c>null</c> or the empty string then the health check middleware\r
 102             will ignore the URL path and process all requests on the specified port. If <paramref name="path"/> is\r
 103             set to a non-empty value, the health check middleware will process requests with a URL that matches the \r
 104             provided value of <paramref name="path"/> case-insensitively, allowing for an extra trailing slash ('/') \r
 105             character.\r
 106             </para>\r
 107             </remarks>\r
 108         </member>\r
 109         <member name="M:Microsoft.AspNetCore.Builder.HealthCheckApplicationBuilderExtensions.UseHealthChecks(Microsoft.AspNetCore.Builder.IApplicationBuilder,Microsoft.AspNetCore.Http.PathString,System.String,Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions)">\r
 110             <summary>\r
 111             Adds a middleware that provides health check status.\r
 112             </summary>\r
 113             <param name="app">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</param>\r
 114             <param name="path">The path on which to provide health check status.</param>\r
 115             <param name="port">The port to listen on. Must be a local port on which the server is listening.</param>\r
 116             <param name="options">A <see cref="T:Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions"/> used to configure the middleware.</param>\r
 117             <returns>A reference to the <paramref name="app"/> after the operation has completed.</returns>\r
 118             <remarks>\r
 119             <para>\r
 120             If <paramref name="path"/> is set to <c>null</c> or the empty string then the health check middleware\r
 121             will ignore the URL path and process all requests on the specified port. If <paramref name="path"/> is\r
 122             set to a non-empty value, the health check middleware will process requests with a URL that matches the \r
 123             provided value of <paramref name="path"/> case-insensitively, allowing for an extra trailing slash ('/') \r
 124             character.\r
 125             </para>\r
 126             </remarks>\r
 127         </member>\r
 128         <member name="T:Microsoft.AspNetCore.Builder.HealthCheckEndpointRouteBuilderExtensions">\r
 129             <summary>\r
 130             Provides extension methods for <see cref="T:Microsoft.AspNetCore.Routing.IEndpointRouteBuilder"/> to add health checks.\r
 131             </summary>\r
 132         </member>\r
 133         <member name="M:Microsoft.AspNetCore.Builder.HealthCheckEndpointRouteBuilderExtensions.MapHealthChecks(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder,System.String)">\r
 134             <summary>\r
 135             Adds a health checks endpoint to the <see cref="T:Microsoft.AspNetCore.Routing.IEndpointRouteBuilder"/> with the specified template.\r
 136             </summary>\r
 137             <param name="endpoints">The <see cref="T:Microsoft.AspNetCore.Routing.IEndpointRouteBuilder"/> to add the health checks endpoint to.</param>\r
 138             <param name="pattern">The URL pattern of the health checks endpoint.</param>\r
 139             <returns>A convention routes for the health checks endpoint.</returns>\r
 140         </member>\r
 141         <member name="M:Microsoft.AspNetCore.Builder.HealthCheckEndpointRouteBuilderExtensions.MapHealthChecks(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder,System.String,Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions)">\r
 142             <summary>\r
 143             Adds a health checks endpoint to the <see cref="T:Microsoft.AspNetCore.Routing.IEndpointRouteBuilder"/> with the specified template and options.\r
 144             </summary>\r
 145             <param name="endpoints">The <see cref="T:Microsoft.AspNetCore.Routing.IEndpointRouteBuilder"/> to add the health checks endpoint to.</param>\r
 146             <param name="pattern">The URL pattern of the health checks endpoint.</param>\r
 147             <param name="options">A <see cref="T:Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions"/> used to configure the health checks.</param>\r
 148             <returns>A convention routes for the health checks endpoint.</returns>\r
 149         </member>\r
 150         <member name="M:Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckMiddleware.InvokeAsync(Microsoft.AspNetCore.Http.HttpContext)">\r
 151             <summary>\r
 152             Processes a request.\r
 153             </summary>\r
 154             <param name="httpContext"></param>\r
 155             <returns></returns>\r
 156         </member>\r
 157         <member name="T:Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions">\r
 158             <summary>\r
 159             Contains options for the <see cref="T:Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckMiddleware"/>.\r
 160             </summary>\r
 161         </member>\r
 162         <member name="P:Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions.Predicate">\r
 163             <summary>\r
 164             Gets or sets a predicate that is used to filter the set of health checks executed.\r
 165             </summary>\r
 166             <remarks>\r
 167             If <see cref="P:Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions.Predicate"/> is <c>null</c>, the <see cref="T:Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckMiddleware"/> will run all\r
 168             registered health checks - this is the default behavior. To run a subset of health checks,\r
 169             provide a function that filters the set of checks.\r
 170             </remarks>\r
 171         </member>\r
 172         <member name="P:Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions.ResultStatusCodes">\r
 173             <summary>\r
 174             Gets or sets a dictionary mapping the <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> to an HTTP status code applied\r
 175             to the response. This property can be used to configure the status codes returned for each status.\r
 176             </summary>\r
 177             <remarks>\r
 178             Setting this property to <c>null</c> resets the mapping to its default value which maps\r
 179             <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Healthy"/> to 200 (OK), <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Degraded"/> to 200 (OK) and\r
 180             <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> to 503 (Service Unavailable).\r
 181             </remarks>\r
 182             <exception cref="T:System.InvalidOperationException">Thrown if at least one <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> is missing when setting this property.</exception>\r
 183         </member>\r
 184         <member name="P:Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions.ResponseWriter">\r
 185             <summary>\r
 186             Gets or sets a delegate used to write the response.\r
 187             </summary>\r
 188             <remarks>\r
 189             The default value is a delegate that will write a minimal <c>text/plain</c> response with the value\r
 190             of <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport.Status"/> as a string.\r
 191             </remarks>\r
 192         </member>\r
 193         <member name="P:Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckOptions.AllowCachingResponses">\r
 194             <summary>\r
 195             Gets or sets a value that controls whether responses from the health check middleware can be cached.\r
 196             </summary>\r
 197             <remarks>\r
 198             <para>\r
 199             The health check middleware does not perform caching of any kind. This setting configures whether\r
 200             the middleware will apply headers to the HTTP response that instruct clients to avoid caching.\r
 201             </para>\r
 202             <para>\r
 203             If the value is <c>false</c> the health check middleware will set or override the \r
 204             <c>Cache-Control</c>, <c>Expires</c>, and <c>Pragma</c> headers to prevent response caching. If the value \r
 205             is <c>true</c> the health check middleware will not modify the cache headers of the response.\r
 206             </para>\r
 207             </remarks>\r
 208         </member>\r
 209         <member name="P:Microsoft.AspNetCore.Diagnostics.HealthChecks.Resources.UnableToFindServices">\r
 210             <summary>Unable to find the required services. Please add all the required services by calling '{0}.{1}' inside the call to '{2}' in the application startup code.</summary>\r
 211         </member>\r
 212         <member name="M:Microsoft.AspNetCore.Diagnostics.HealthChecks.Resources.FormatUnableToFindServices(System.Object,System.Object,System.Object)">\r
 213             <summary>Unable to find the required services. Please add all the required services by calling '{0}.{1}' inside the call to '{2}' in the application startup code.</summary>\r
 214         </member>\r
 215     </members>\r
 216 </doc>\r