Skip to content

Commit a8c6386

Browse files
xiangyan99xiangyan99
authored
add policy description (Azure#16238)
* add policy description * high light default value
1 parent 2a8d7c9 commit a8c6386

File tree

1 file changed

+54
-44
lines changed

1 file changed

+54
-44
lines changed

‎sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md‎

Lines changed: 54 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -395,50 +395,60 @@ from azure.core.pipeline.policies import (
395395

396396
#### Available Policies
397397

398-
| Name | Policy Flavor | Parameters accepted in Init | Parameters accepted in Request |
399-
| --- | --- | --- | --- |
400-
| HeadersPolicy | SansIOHTTPPolicy | base_headers | headers |
401-
| | | headers | |
402-
| RequestIdPolicy | SansIOHTTPPolicy | request_id | request_id |
403-
| | | auto_request_id | |
404-
| UserAgentPolicy | SansIOHTTPPolicy | base_user_agent | user_agent |
405-
| | | user_agent_overwrite | |
406-
| | | user_agent_use_env | |
407-
| | | user_agent | |
408-
| | | sdk_moniker | |
409-
| NetworkTraceLoggingPolicy | SansIOHTTPPolicy | logging_enable | logging_enable |
410-
| HttpLoggingPolicy | SansIOHTTPPolicy | logger | logger |
411-
| ContentDecodePolicy | SansIOHTTPPolicy | response_encoding | response_encoding |
412-
| ProxyPolicy | SansIOHTTPPolicy | proxies | proxies |
413-
| CustomHookPolicy | SansIOHTTPPolicy | raw_request_hook | raw_request_hook |
414-
| | | raw_response_hook | raw_response_hook |
415-
| DistributedTracingPolicy | SansIOHTTPPolicy | network_span_namer | network_span_namer |
416-
| | | tracing_attributes | |
417-
| --- | --- | --- | --- |
418-
| RedirectPolicy | HTTPPolicy | permit_redirects | permit_redirects |
419-
| | | redirect_max | redirect_max |
420-
| | | redirect_remove_headers | |
421-
| | | redirect_on_status_codes | |
422-
| AsyncRedirectPolicy | AsyncHTTPPolicy | permit_redirects | permit_redirects |
423-
| | | redirect_max | redirect_max |
424-
| | | redirect_remove_headers | |
425-
| | | redirect_on_status_codes | |
426-
| RetryPolicy | HTTPPolicy | retry_total | retry_total |
427-
| | | retry_connect | retry_connect |
428-
| | | retry_read | retry_read |
429-
| | | retry_status | retry_status |
430-
| | | retry_backoff_factor | retry_backoff_factor |
431-
| | | retry_backoff_max | retry_backoff_max |
432-
| | | retry_mode | retry_mode |
433-
| | | retry_on_status_codes | retry_on_status_codes |
434-
| AsyncRetryPolicy | AsyncHTTPPolicy | retry_total | retry_total |
435-
| | | retry_connect | retry_connect |
436-
| | | retry_read | retry_read |
437-
| | | retry_status | retry_status |
438-
| | | retry_backoff_factor | retry_backoff_factor |
439-
| | | retry_backoff_max | retry_backoff_max |
440-
| | | retry_mode | retry_mode |
441-
| | | retry_on_status_codes | retry_on_status_codes |
398+
| Name | Policy Flavor | Parameters | Accepted in Init? | Accepted in Request? | Description |
399+
| --- | --- | --- | --- | --- | --- |
400+
| HeadersPolicy | SansIOHTTPPolicy | | | | |
401+
| | | base_headers | x | | Headers to send with the request. |
402+
| | | headers | x | x | The HTTP Request headers. |
403+
| RequestIdPolicy | SansIOHTTPPolicy | | | | |
404+
| | | request_id | x | x | The request id to be added into header. |
405+
| | | auto_request_id | x | | Auto generates a unique request ID per call if `True` which is by default. |
406+
| UserAgentPolicy | SansIOHTTPPolicy | | | | |
407+
| | | base_user_agent | x | | Sets the base user agent value. |
408+
| | | user_agent_overwrite | x | | Overwrites User-Agent when True. Defaults to `False`. |
409+
| | | user_agent_use_env | x | | Gets user-agent from environment. Defaults to `True`. |
410+
| | | user_agent | x | x | If specified, this will be added in front of the user agent string. |
411+
| | | sdk_moniker | x | | If specified, the user agent string will be `azsdk-python-[sdk_moniker] Python/[python_version] ([platform_version])` |
412+
| NetworkTraceLoggingPolicy | SansIOHTTPPolicy | | | | |
413+
| | | logging_enable | x | x | Use to enable per operation. Defaults to `False`. |
414+
| HttpLoggingPolicy | SansIOHTTPPolicy | | | | |
415+
| | | logger | x | x | If specified, it will be used to log information |
416+
| ContentDecodePolicy | SansIOHTTPPolicy | | | | |
417+
| | | response_encoding | x | x | The encoding to use if known for this service (will disable auto-detection). |
418+
| ProxyPolicy | SansIOHTTPPolicy | | | | |
419+
| | | proxies | x | x | Maps protocol or protocol and hostname to the URL of the proxy. |
420+
| CustomHookPolicy | SansIOHTTPPolicy | | | | |
421+
| | | raw_request_hook | x | x | Callback function. Will be invoked on request. |
422+
| | | raw_response_hook | x | x | Callback function. Will be invoked on response. |
423+
| DistributedTracingPolicy | SansIOHTTPPolicy | | | | |
424+
| | | network_span_namer | x | x | A callable to customize the span name. |
425+
| | | tracing_attributes | x | x | Attributes to set on all created spans. |
426+
| --- | --- | --- | --- | --- | --- |
427+
| RedirectPolicy | HTTPPolicy | | | | |
428+
| | | permit_redirects | x | x | Whether the client allows redirects. Defaults to `True`. |
429+
| | | redirect_max | x | x | The maximum allowed redirects. Defaults to `30`. |
430+
| AsyncRedirectPolicy | AsyncHTTPPolicy | | | | |
431+
| | | permit_redirects | x | x | Whether the client allows redirects. Defaults to `True`. |
432+
| | | redirect_max | x | x | The maximum allowed redirects. Defaults to `30`. |
433+
| RetryPolicy | HTTPPolicy | | | | |
434+
| | | retry_total | x | x | Total number of retries to allow. Takes precedence over other counts. Default value is `10`. |
435+
| | | retry_connect | x | x | How many connection-related errors to retry on. These are errors raised before the request is sent to the remote server, which we assume has not triggered the server to process the request. Default value is `3`. |
436+
| | | retry_read | x | x | How many times to retry on read errors. These errors are raised after the request was sent to the server, so the request may have side-effects. Default value is `3`. |
437+
| | | retry_status | x | x | How many times to retry on bad status codes. Default value is `3`. |
438+
| | | retry_backoff_factor | x | x | A backoff factor to apply between attempts after the second try (most errors are resolved immediately by a second try without a delay). Retry policy will sleep for: `{backoff factor} * (2 ** ({number of total retries} - 1))` seconds. If the backoff_factor is 0.1, then the retry will sleep for [0.0s, 0.2s, 0.4s, ...] between retries. The default value is `0.8`. |
439+
| | | retry_backoff_max | x | x | The maximum back off time. Default value is `120` seconds (2 minutes). |
440+
| | | retry_mode | x | x | Fixed or exponential delay between attemps, default is `exponential`. |
441+
| | | timeout | x | x | Timeout setting for the operation in seconds, default is `604800s` (7 days). |
442+
| AsyncRetryPolicy | AsyncHTTPPolicy | | | | |
443+
| | | retry_total | x | x | Total number of retries to allow. Takes precedence over other counts. Default value is `10`. |
444+
| | | retry_connect | x | x | How many connection-related errors to retry on. These are errors raised before the request is sent to the remote server, which we assume has not triggered the server to process the request. Default value is `3`. |
445+
| | | retry_read | x | x | How many times to retry on read errors. These errors are raised after the request was sent to the server, so the request may have side-effects. Default value is `3`. |
446+
| | | retry_status | x | x | How many times to retry on bad status codes. Default value is `3`. |
447+
| | | retry_backoff_factor | x | x | A backoff factor to apply between attempts after the second try (most errors are resolved immediately by a second try without a delay). Retry policy will sleep for: `{backoff factor} * (2 ** ({number of total retries} - 1))` seconds. If the backoff_factor is 0.1, then the retry will sleep for [0.0s, 0.2s, 0.4s, ...] between retries. The default value is `0.8`. |
448+
| | | retry_backoff_max | x | x | The maximum back off time. Default value is `120` seconds (2 minutes). |
449+
| | | retry_mode | x | x | Fixed or exponential delay between attemps, default is exponential. |
450+
| | | timeout | x | x | Timeout setting for the operation in seconds, default is `604800s` (7 days). |
451+
442452

443453
### The Pipeline
444454

0 commit comments

Comments
 (0)