|
| 1 | +--- |
| 2 | +layout: "azapi" |
| 3 | +page_title: "Feature: Retry Configuration" |
| 4 | +description: |- |
| 5 | + This guide will describe how to configure the retry behavior in the AzAPI provider. The retry configuration allows you to control how the provider handles failed requests and if it should retry them. |
| 6 | +--- |
| 7 | + |
| 8 | +## Why retry? |
| 9 | + |
| 10 | +Sometimes, when managing cloud infrastructure, requests to the cloud provider may fail due to transient issues such as network problems, timeouts, eventual consistency, or rate limiting. In these cases, it can be beneficial to retry the request a few times before giving up. The AzAPI provider allows you to configure the retry behavior to suit your needs. |
| 11 | + |
| 12 | +## Retry configuration |
| 13 | + |
| 14 | +There are two types of retry configurations available in the AzAPI provider: |
| 15 | + |
| 16 | +1. Provider retry configuration |
| 17 | +2. Resource-specific retry configuration |
| 18 | + |
| 19 | +### Provider retry configuration |
| 20 | + |
| 21 | +The provider retry configuration is a global configuration that applies to all resources managed by the provider. You can configure the provider retry behavior by setting the following provider values: |
| 22 | + |
| 23 | +- `go_sdk_maximum_retry_attempts` |
| 24 | + |
| 25 | +This value controls the number of times the provider will retry a failed request. The default value is `3`. |
| 26 | +A retry will be triggered if the request fails with HTTP 408, 429, 500, 502, 503, or 504. |
| 27 | + |
| 28 | +In the case that the response header contains a `Retry-After` value, the provider will wait for the specified duration before retrying the request. |
| 29 | + |
| 30 | +### Resource-specific retry configuration |
| 31 | + |
| 32 | +In addition to the provider retry configuration, you can also configure the retry behavior for individual resources. This allows you to fine-tune the retry behavior for specific resources. |
| 33 | + |
| 34 | +The resource-specific retry comes after the provider retry, that is to say that the provider retry will be attempted first, and if it fails or exceeds the maximum attempts, the resource-specific retry will be attempted. |
| 35 | +Note that the resource-specific retry does not honour the `Retry-After` header and is exponential backoff based. |
| 36 | + |
| 37 | +Resource specific retry is configured using the `retry` attribute. |
| 38 | +With `azapi_resource` and `azapi_data_plane_resource` resources, the provider performs a read after the resource has been created/updated to collect the read-only attributes of the resource. In this case there is a second retry attribute called `retry_read_after_create`, which controls the retry behavior of this operation. |
| 39 | + |
| 40 | +If you configure a retry configuration, the maximum elapsed time for the retry will be set to the resource's timeout value for that operation (create, update, read, delete). |
| 41 | + |
| 42 | +The schema of these retry attributes is as follows: |
| 43 | + |
| 44 | +- `interval_seconds` - The initial number of seconds to wait before the 1st retry. The default value is `10`. |
| 45 | +- `max_interval_seconds` - The maximum number of times to retry the request. The default value is `180`. |
| 46 | +- `multiplier` - The multiplier to apply to the interval between retries. The default value is `1.5`. |
| 47 | +- `randomization_factor` - The randomization factor to apply to the interval between retries. The default value is `0.5`. The formula for the randomized interval is: `RetryInterval * (random value in range [1 - RandomizationFactor, 1 + RandomizationFactor])`. Set to zero `0.0` for no randomization. |
| 48 | +- `response_is_nil` - If the response is nil, should the request be retried. The default value is `true`. |
| 49 | +- `status_forbidden` - If the status code is 403, should the request be retried. The default value is `false`. |
| 50 | +- `status_not_found` - If the status code is 404, should the request be retried. The default value is `false`. |
0 commit comments