Microsoft.App managedEnvironments/daprComponents/resiliencyPolicies 2023-11-02-preview

• Latest
• 2024-10-02-preview
• 2024-08-02-preview
• 2024-02-02-preview
• 2023-11-02-preview
• 2023-08-01-preview

Bicep resource definition

The managedEnvironments/daprComponents/resiliencyPolicies resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies@2023-11-02-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    inboundPolicy: {
      circuitBreakerPolicy: {
        consecutiveErrors: int
        intervalInSeconds: int
        timeoutInSeconds: int
      }
      httpRetryPolicy: {
        maxRetries: int
        retryBackOff: {
          initialDelayInMilliseconds: int
          maxIntervalInMilliseconds: int
        }
      }
      timeoutPolicy: {
        responseTimeoutInSeconds: int
      }
    }
    outboundPolicy: {
      circuitBreakerPolicy: {
        consecutiveErrors: int
        intervalInSeconds: int
        timeoutInSeconds: int
      }
      httpRetryPolicy: {
        maxRetries: int
        retryBackOff: {
          initialDelayInMilliseconds: int
          maxIntervalInMilliseconds: int
        }
      }
      timeoutPolicy: {
        responseTimeoutInSeconds: int
      }
    }
  }
}

Property values

DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration

Name	Description	Value
consecutiveErrors	The number of consecutive errors before the circuit is opened.	int
intervalInSeconds	The optional interval in seconds after which the error count resets to 0. An interval of 0 will never reset. If not specified, the timeoutInSeconds value will be used.	int
timeoutInSeconds	The interval in seconds until a retry attempt is made after the circuit is opened.	int

DaprComponentResiliencyPolicyConfiguration

Name	Description	Value
circuitBreakerPolicy	The optional circuit breaker policy configuration	DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration
httpRetryPolicy	The optional HTTP retry policy configuration	DaprComponentResiliencyPolicyHttpRetryPolicyConfiguration
timeoutPolicy	The optional timeout policy configuration	DaprComponentResiliencyPolicyTimeoutPolicyConfiguration

DaprComponentResiliencyPolicyHttpRetryBackOffConfiguration

Name	Description	Value
initialDelayInMilliseconds	The optional initial delay in milliseconds before an operation is retried	int
maxIntervalInMilliseconds	The optional maximum time interval in milliseconds between retry attempts	int

DaprComponentResiliencyPolicyHttpRetryPolicyConfiguration

Name	Description	Value
maxRetries	The optional maximum number of retries	int
retryBackOff	The optional retry backoff configuration	DaprComponentResiliencyPolicyHttpRetryBackOffConfiguration

DaprComponentResiliencyPolicyProperties

Name	Description	Value
inboundPolicy	The optional inbound component resiliency policy configuration	DaprComponentResiliencyPolicyConfiguration
outboundPolicy	The optional outbound component resiliency policy configuration	DaprComponentResiliencyPolicyConfiguration

DaprComponentResiliencyPolicyTimeoutPolicyConfiguration

Name	Description	Value
responseTimeoutInSeconds	The optional response timeout in seconds	int

Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies

Name	Description	Value
name	The resource name	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: managedEnvironments/daprComponents
properties	Dapr Component Resiliency Policy resource specific properties	DaprComponentResiliencyPolicyProperties

ARM template resource definition

The managedEnvironments/daprComponents/resiliencyPolicies resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies resource, add the following JSON to your template.

{
  "type": "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies",
  "apiVersion": "2023-11-02-preview",
  "name": "string",
  "properties": {
    "inboundPolicy": {
      "circuitBreakerPolicy": {
        "consecutiveErrors": "int",
        "intervalInSeconds": "int",
        "timeoutInSeconds": "int"
      },
      "httpRetryPolicy": {
        "maxRetries": "int",
        "retryBackOff": {
          "initialDelayInMilliseconds": "int",
          "maxIntervalInMilliseconds": "int"
        }
      },
      "timeoutPolicy": {
        "responseTimeoutInSeconds": "int"
      }
    },
    "outboundPolicy": {
      "circuitBreakerPolicy": {
        "consecutiveErrors": "int",
        "intervalInSeconds": "int",
        "timeoutInSeconds": "int"
      },
      "httpRetryPolicy": {
        "maxRetries": "int",
        "retryBackOff": {
          "initialDelayInMilliseconds": "int",
          "maxIntervalInMilliseconds": "int"
        }
      },
      "timeoutPolicy": {
        "responseTimeoutInSeconds": "int"
      }
    }
  }
}

Property values

DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration

Name	Description	Value
consecutiveErrors	The number of consecutive errors before the circuit is opened.	int
intervalInSeconds	The optional interval in seconds after which the error count resets to 0. An interval of 0 will never reset. If not specified, the timeoutInSeconds value will be used.	int
timeoutInSeconds	The interval in seconds until a retry attempt is made after the circuit is opened.	int

DaprComponentResiliencyPolicyConfiguration

Name	Description	Value
circuitBreakerPolicy	The optional circuit breaker policy configuration	DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration
httpRetryPolicy	The optional HTTP retry policy configuration	DaprComponentResiliencyPolicyHttpRetryPolicyConfiguration
timeoutPolicy	The optional timeout policy configuration	DaprComponentResiliencyPolicyTimeoutPolicyConfiguration

DaprComponentResiliencyPolicyHttpRetryBackOffConfiguration

Name	Description	Value
initialDelayInMilliseconds	The optional initial delay in milliseconds before an operation is retried	int
maxIntervalInMilliseconds	The optional maximum time interval in milliseconds between retry attempts	int

DaprComponentResiliencyPolicyHttpRetryPolicyConfiguration

Name	Description	Value
maxRetries	The optional maximum number of retries	int
retryBackOff	The optional retry backoff configuration	DaprComponentResiliencyPolicyHttpRetryBackOffConfiguration

DaprComponentResiliencyPolicyProperties

Name	Description	Value
inboundPolicy	The optional inbound component resiliency policy configuration	DaprComponentResiliencyPolicyConfiguration
outboundPolicy	The optional outbound component resiliency policy configuration	DaprComponentResiliencyPolicyConfiguration

DaprComponentResiliencyPolicyTimeoutPolicyConfiguration

Name	Description	Value
responseTimeoutInSeconds	The optional response timeout in seconds	int

Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies

Name	Description	Value
apiVersion	The api version	'2023-11-02-preview'
name	The resource name	string (required)
properties	Dapr Component Resiliency Policy resource specific properties	DaprComponentResiliencyPolicyProperties
type	The resource type	'Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies'

Terraform (AzAPI provider) resource definition

The managedEnvironments/daprComponents/resiliencyPolicies resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies@2023-11-02-preview"
  name = "string"
  body = jsonencode({
    properties = {
      inboundPolicy = {
        circuitBreakerPolicy = {
          consecutiveErrors = int
          intervalInSeconds = int
          timeoutInSeconds = int
        }
        httpRetryPolicy = {
          maxRetries = int
          retryBackOff = {
            initialDelayInMilliseconds = int
            maxIntervalInMilliseconds = int
          }
        }
        timeoutPolicy = {
          responseTimeoutInSeconds = int
        }
      }
      outboundPolicy = {
        circuitBreakerPolicy = {
          consecutiveErrors = int
          intervalInSeconds = int
          timeoutInSeconds = int
        }
        httpRetryPolicy = {
          maxRetries = int
          retryBackOff = {
            initialDelayInMilliseconds = int
            maxIntervalInMilliseconds = int
          }
        }
        timeoutPolicy = {
          responseTimeoutInSeconds = int
        }
      }
    }
  })
}

Property values

DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration

Name	Description	Value
consecutiveErrors	The number of consecutive errors before the circuit is opened.	int
intervalInSeconds	The optional interval in seconds after which the error count resets to 0. An interval of 0 will never reset. If not specified, the timeoutInSeconds value will be used.	int
timeoutInSeconds	The interval in seconds until a retry attempt is made after the circuit is opened.	int

DaprComponentResiliencyPolicyConfiguration

Name	Description	Value
circuitBreakerPolicy	The optional circuit breaker policy configuration	DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration
httpRetryPolicy	The optional HTTP retry policy configuration	DaprComponentResiliencyPolicyHttpRetryPolicyConfiguration
timeoutPolicy	The optional timeout policy configuration	DaprComponentResiliencyPolicyTimeoutPolicyConfiguration

DaprComponentResiliencyPolicyHttpRetryBackOffConfiguration

Name	Description	Value
initialDelayInMilliseconds	The optional initial delay in milliseconds before an operation is retried	int
maxIntervalInMilliseconds	The optional maximum time interval in milliseconds between retry attempts	int

DaprComponentResiliencyPolicyHttpRetryPolicyConfiguration

Name	Description	Value
maxRetries	The optional maximum number of retries	int
retryBackOff	The optional retry backoff configuration	DaprComponentResiliencyPolicyHttpRetryBackOffConfiguration

DaprComponentResiliencyPolicyProperties

Name	Description	Value
inboundPolicy	The optional inbound component resiliency policy configuration	DaprComponentResiliencyPolicyConfiguration
outboundPolicy	The optional outbound component resiliency policy configuration	DaprComponentResiliencyPolicyConfiguration

DaprComponentResiliencyPolicyTimeoutPolicyConfiguration

Name	Description	Value
responseTimeoutInSeconds	The optional response timeout in seconds	int

Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies

Name	Description	Value
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: managedEnvironments/daprComponents
properties	Dapr Component Resiliency Policy resource specific properties	DaprComponentResiliencyPolicyProperties
type	The resource type	"Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies@2023-11-02-preview"