LogPolicyOptions interface
Options to pass to the logPolicy. By default only a set list of headers are logged, though this can be configured. Request and response bodies are never logged.
Properties
| allowed |
Header names whose values will be logged when logging is enabled. Defaults to: x-ms-client-request-id, x-ms-return-client-request-id, x-ms-useragent, x-ms-correlation-request-id, x-ms-request-id, client-request-id, ms-cv, return-client-request-id, traceparent, Access-Control-Allow-Credentials, Access-Control-Allow-Headers, Access-Control-Allow-Methods, Access-Control-Allow-Origin, Access-Control-Expose-Headers, Access-Control-Max-Age, Access-Control-Request-Headers, Access-Control-Request-Method, Origin, Accept, Accept-Encoding, Cache-Control, Connection, Content-Length, Content-Type, Date, ETag, Expires, If-Match, If-Modified-Since, If-None-Match, If-Unmodified-Since, Last-Modified, Pragma, Request-Id, Retry-After, Server, Transfer-Encoding, and User-Agent. Any headers specified in this field will be added to that list. Any other values will be written to logs as "REDACTED". |
| allowed |
Query string names whose values will be logged when logging is enabled. By default no query string values are logged. |
| logger | The Debugger (logger) instance to use for writing pipeline logs. |
Property Details
allowedHeaderNames
Header names whose values will be logged when logging is enabled. Defaults to: x-ms-client-request-id, x-ms-return-client-request-id, x-ms-useragent, x-ms-correlation-request-id, x-ms-request-id, client-request-id, ms-cv, return-client-request-id, traceparent, Access-Control-Allow-Credentials, Access-Control-Allow-Headers, Access-Control-Allow-Methods, Access-Control-Allow-Origin, Access-Control-Expose-Headers, Access-Control-Max-Age, Access-Control-Request-Headers, Access-Control-Request-Method, Origin, Accept, Accept-Encoding, Cache-Control, Connection, Content-Length, Content-Type, Date, ETag, Expires, If-Match, If-Modified-Since, If-None-Match, If-Unmodified-Since, Last-Modified, Pragma, Request-Id, Retry-After, Server, Transfer-Encoding, and User-Agent.
Any headers specified in this field will be added to that list. Any other values will be written to logs as "REDACTED".
allowedHeaderNames?: string[]Property Value
string[]
allowedQueryParameters
Query string names whose values will be logged when logging is enabled. By default no query string values are logged.
allowedQueryParameters?: string[]Property Value
string[]
logger
The Debugger (logger) instance to use for writing pipeline logs.
logger?: Debugger