PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{appName}/resiliencyPolicies/{name}/?api-version=2023-08-01-preview
Create or update container app resiliency policy.
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
Name of the resiliency policy. |
subscriptionId |
String | Yes |
The ID of the target subscription. The value must be an UUID. |
appName |
String | Yes |
Name of the Container App. |
resourceGroupName |
String | Yes |
The name of the resource group. The name is case insensitive. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
properties |
Object | No |
App Resiliency resource specific properties |
properties.tcpRetryPolicy |
Object | No |
Policy that defines tcp request retry conditions |
properties.tcpRetryPolicy.maxConnectAttempts |
Integer | No |
Maximum number of attempts to connect to the tcp service |
properties.httpRetryPolicy |
Object | No |
Policy that defines http request retry conditions |
properties.httpRetryPolicy.matches |
Object | No |
Conditions that must be met for a request to be retried |
properties.httpRetryPolicy.matches.errors[] |
Array | No |
Errors that can trigger a retry |
properties.httpRetryPolicy.matches.httpStatusCodes[] |
Array | No |
Additional http status codes that can trigger a retry |
properties.httpRetryPolicy.matches.headers[] |
Array | No |
Headers that must be present for a request to be retried |
properties.httpRetryPolicy.matches.headers[].header |
String | No |
Name of the header |
properties.httpRetryPolicy.matches.headers[].match |
Object | No |
Type of match to perform |
properties.httpRetryPolicy.matches.headers[].match.regexMatch |
String | No |
Regex value of the header |
properties.httpRetryPolicy.matches.headers[].match.prefixMatch |
String | No |
Prefix value of the header |
properties.httpRetryPolicy.matches.headers[].match.exactMatch |
String | No |
Exact value of the header |
properties.httpRetryPolicy.matches.headers[].match.suffixMatch |
String | No |
Suffix value of the header |
properties.httpRetryPolicy.maxRetries |
Integer | No |
Maximum number of times a request will retry |
properties.httpRetryPolicy.retryBackOff |
Object | No |
Settings for retry backoff characteristics |
properties.httpRetryPolicy.retryBackOff.maxIntervalInMilliseconds |
Integer | No |
Maximum interval, in milliseconds, between retries |
properties.httpRetryPolicy.retryBackOff.initialDelayInMilliseconds |
Integer | No |
Initial delay, in milliseconds, before retrying a request |
properties.timeoutPolicy |
Object | No |
Policy to set request timeouts |
properties.timeoutPolicy.responseTimeoutInSeconds |
Integer | No |
Timeout, in seconds, for a request to respond |
properties.timeoutPolicy.connectionTimeoutInSeconds |
Integer | No |
Timeout, in seconds, for a request to initiate a connection |
properties.circuitBreakerPolicy |
Object | No |
Policy that defines circuit breaker conditions |
properties.circuitBreakerPolicy.intervalInSeconds |
Integer | No |
The time interval, in seconds, between endpoint checks. This can result in opening the circuit breaker if the check fails as well as closing the circuit breaker if the check succeeds. Defaults to 10s. |
properties.circuitBreakerPolicy.maxEjectionPercent |
Integer | No |
Maximum percentage of hosts that will be ejected after failure threshold has been met |
properties.circuitBreakerPolicy.consecutiveErrors |
Integer | No |
Number of consecutive errors before the circuit breaker opens |
properties.httpConnectionPool |
Object | No |
Defines parameters for http connection pooling |
properties.httpConnectionPool.http1MaxPendingRequests |
Integer | No |
Maximum number of pending http1 requests allowed |
properties.httpConnectionPool.http2MaxRequests |
Integer | No |
Maximum number of http2 requests allowed |
properties.tcpConnectionPool |
Object | No |
Defines parameters for tcp connection pooling |
properties.tcpConnectionPool.maxConnections |
Integer | No |
Maximum number of tcp connections allowed |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.