apimanagement.azure.com/v20250301preview

APIVersion

Value Description
“2025-03-01-preview”

Backend

Generator information:

  • Generated from: /apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2025-03-01-preview/openapi.json
  • ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ApiManagement/​service/​{serviceName}/​backends/​{backendId}

Used by: BackendList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec Backend_Spec
Optional
status Backend_STATUS
Optional

Backend_Spec

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
azureRegion Azure region in which the backend is deployed. Can be optionally specified to use features such as carbon-optimized load balancer. string
Optional
circuitBreaker Backend Circuit Breaker Configuration BackendCircuitBreaker
Optional
credentials Backend Credentials Contract Properties BackendCredentialsContract
Optional
description Backend Description. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure BackendOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a apimanagement.azure.com/Service resource genruntime.KnownResourceReference
Required
pool Backend Pool Properties BackendPool
Optional
properties Backend Properties contract BackendProperties
Optional
protocol Backend communication protocol. Required when backend type is Single. BackendProtocol
Optional
proxy Backend gateway Contract Properties BackendProxyContract
Optional
resourceReference Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps. genruntime.ResourceReference
Optional
title Backend Title. string
Optional
tls Backend TLS Properties BackendTlsProperties
Optional
type Type of the backend. A backend can be either Single or Pool. BackendType
Optional
url Runtime Url of the Backend. Required when backend type is Single. string
Optional

Backend_STATUS

Property Description Type
azureRegion Azure region in which the backend is deployed. Can be optionally specified to use features such as carbon-optimized load balancer. string
Optional
circuitBreaker Backend Circuit Breaker Configuration BackendCircuitBreaker_STATUS
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
credentials Backend Credentials Contract Properties BackendCredentialsContract_STATUS
Optional
description Backend Description. string
Optional
id Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName} string
Optional
name The name of the resource string
Optional
pool Backend Pool Properties BackendPool_STATUS
Optional
properties Backend Properties contract BackendProperties_STATUS
Optional
properties_type Type of the backend. A backend can be either Single or Pool. BackendType_STATUS
Optional
protocol Backend communication protocol. Required when backend type is Single. BackendProtocol_STATUS
Optional
proxy Backend gateway Contract Properties BackendProxyContract_STATUS
Optional
resourceId Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps. string
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
title Backend Title. string
Optional
tls Backend TLS Properties BackendTlsProperties_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional
url Runtime Url of the Backend. Required when backend type is Single. string
Optional

BackendList

Generator information:

  • Generated from: /apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/preview/2025-03-01-preview/openapi.json
  • ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ApiManagement/​service/​{serviceName}/​backends/​{backendId}
Property Description Type
metav1.TypeMeta
metav1.ListMeta
items Backend[]
Optional

Backend_Spec

Used by: Backend.

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
azureRegion Azure region in which the backend is deployed. Can be optionally specified to use features such as carbon-optimized load balancer. string
Optional
circuitBreaker Backend Circuit Breaker Configuration BackendCircuitBreaker
Optional
credentials Backend Credentials Contract Properties BackendCredentialsContract
Optional
description Backend Description. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure BackendOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a apimanagement.azure.com/Service resource genruntime.KnownResourceReference
Required
pool Backend Pool Properties BackendPool
Optional
properties Backend Properties contract BackendProperties
Optional
protocol Backend communication protocol. Required when backend type is Single. BackendProtocol
Optional
proxy Backend gateway Contract Properties BackendProxyContract
Optional
resourceReference Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps. genruntime.ResourceReference
Optional
title Backend Title. string
Optional
tls Backend TLS Properties BackendTlsProperties
Optional
type Type of the backend. A backend can be either Single or Pool. BackendType
Optional
url Runtime Url of the Backend. Required when backend type is Single. string
Optional

Backend_STATUS

Used by: Backend.

Property Description Type
azureRegion Azure region in which the backend is deployed. Can be optionally specified to use features such as carbon-optimized load balancer. string
Optional
circuitBreaker Backend Circuit Breaker Configuration BackendCircuitBreaker_STATUS
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
credentials Backend Credentials Contract Properties BackendCredentialsContract_STATUS
Optional
description Backend Description. string
Optional
id Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName} string
Optional
name The name of the resource string
Optional
pool Backend Pool Properties BackendPool_STATUS
Optional
properties Backend Properties contract BackendProperties_STATUS
Optional
properties_type Type of the backend. A backend can be either Single or Pool. BackendType_STATUS
Optional
protocol Backend communication protocol. Required when backend type is Single. BackendProtocol_STATUS
Optional
proxy Backend gateway Contract Properties BackendProxyContract_STATUS
Optional
resourceId Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps. string
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
title Backend Title. string
Optional
tls Backend TLS Properties BackendTlsProperties_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional
url Runtime Url of the Backend. Required when backend type is Single. string
Optional

BackendCircuitBreaker

The configuration of the backend circuit breaker

Used by: Backend_Spec.

Property Description Type
rules The rules for tripping the backend. CircuitBreakerRule[]
Optional

BackendCircuitBreaker_STATUS

The configuration of the backend circuit breaker

Used by: Backend_STATUS.

Property Description Type
rules The rules for tripping the backend. CircuitBreakerRule_STATUS[]
Optional

BackendCredentialsContract

Details of the Credentials used to connect to Backend.

Used by: Backend_Spec.

Property Description Type
authorization Authorization header authentication BackendAuthorizationHeaderCredentials
Optional
certificate List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided. string[]
Optional
certificateIds List of Client Certificate Ids. string[]
Optional
header Header Parameter description. map[string]string[]
Optional
query Query Parameter description. map[string]string[]
Optional

BackendCredentialsContract_STATUS

Details of the Credentials used to connect to Backend.

Used by: Backend_STATUS.

Property Description Type
authorization Authorization header authentication BackendAuthorizationHeaderCredentials_STATUS
Optional
certificate List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided. string[]
Optional
certificateIds List of Client Certificate Ids. string[]
Optional
header Header Parameter description. map[string]string[]
Optional
query Query Parameter description. map[string]string[]
Optional

BackendOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: Backend_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

BackendPool

Backend pool information

Used by: Backend_Spec.

Property Description Type
failureResponse The response to be returned when all the backends in the pool are inactive. BackendFailureResponse
Optional
services The list of backend entities belonging to a pool. BackendPoolItem[]
Optional
sessionAffinity The session stickiness properties of the backend pool. BackendSessionAffinity
Optional

BackendPool_STATUS

Backend pool information

Used by: Backend_STATUS.

Property Description Type
failureResponse The response to be returned when all the backends in the pool are inactive. BackendFailureResponse_STATUS
Optional
services The list of backend entities belonging to a pool. BackendPoolItem_STATUS[]
Optional
sessionAffinity The session stickiness properties of the backend pool. BackendSessionAffinity_STATUS
Optional

BackendProperties

Properties specific to the Backend Type.

Used by: Backend_Spec.

Property Description Type
serviceFabricCluster Backend Service Fabric Cluster Properties BackendServiceFabricClusterProperties
Optional

BackendProperties_STATUS

Properties specific to the Backend Type.

Used by: Backend_STATUS.

Property Description Type
serviceFabricCluster Backend Service Fabric Cluster Properties BackendServiceFabricClusterProperties_STATUS
Optional

BackendProtocol

Backend communication protocol. Required when backend type is Single.

Used by: Backend_Spec.

Value Description
“http”
“soap”

BackendProtocol_STATUS

Backend communication protocol. Required when backend type is Single.

Used by: Backend_STATUS.

Value Description
“http”
“soap”

BackendProxyContract

Details of the Backend WebProxy Server to use in the Request to Backend.

Used by: Backend_Spec.

Property Description Type
password Password to connect to the WebProxy Server genruntime.SecretReference
Optional
url WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. string
Required
username Username to connect to the WebProxy server string
Optional

BackendProxyContract_STATUS

Details of the Backend WebProxy Server to use in the Request to Backend.

Used by: Backend_STATUS.

Property Description Type
url WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. string
Optional
username Username to connect to the WebProxy server string
Optional

BackendTlsProperties

Properties controlling TLS Certificate Validation.

Used by: Backend_Spec.

Property Description Type
serverCertificateThumbprints Thumbprints of certificates used by the backend host for TLS communication. string[]
Optional
serverX509Names Server X509 Certificate Names of the Backend Host. X509CertificateName[]
Optional
validateCertificateChain Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. bool
Optional
validateCertificateName Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. bool
Optional

BackendTlsProperties_STATUS

Properties controlling TLS Certificate Validation.

Used by: Backend_STATUS.

Property Description Type
serverCertificateThumbprints Thumbprints of certificates used by the backend host for TLS communication. string[]
Optional
serverX509Names Server X509 Certificate Names of the Backend Host. X509CertificateName_STATUS[]
Optional
validateCertificateChain Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. bool
Optional
validateCertificateName Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. bool
Optional

BackendType

Type of the backend. A backend can be either Single or Pool.

Used by: Backend_Spec.

Value Description
“Pool”
“Single”

BackendType_STATUS

Type of the backend. A backend can be either Single or Pool.

Used by: Backend_STATUS.

Value Description
“Pool”
“Single”

SystemData_STATUS

Metadata pertaining to creation and last modification of the resource.

Used by: Backend_STATUS.

Property Description Type
createdAt The timestamp of resource creation (UTC). string
Optional
createdBy The identity that created the resource. string
Optional
createdByType The type of identity that created the resource. SystemData_CreatedByType_STATUS
Optional
lastModifiedAt The timestamp of resource last modification (UTC) string
Optional
lastModifiedBy The identity that last modified the resource. string
Optional
lastModifiedByType The type of identity that last modified the resource. SystemData_LastModifiedByType_STATUS
Optional

BackendAuthorizationHeaderCredentials

Authorization header information.

Used by: BackendCredentialsContract.

Property Description Type
parameter Authentication Parameter value. string
Required
scheme Authentication Scheme name. string
Required

BackendAuthorizationHeaderCredentials_STATUS

Authorization header information.

Used by: BackendCredentialsContract_STATUS.

Property Description Type
parameter Authentication Parameter value. string
Optional
scheme Authentication Scheme name. string
Optional

BackendFailureResponse

The response to be returned when a backend fails to respond

Used by: BackendPool, and CircuitBreakerRule.

Property Description Type
statusCode The status code of the response. int
Optional

BackendFailureResponse_STATUS

The response to be returned when a backend fails to respond

Used by: BackendPool_STATUS, and CircuitBreakerRule_STATUS.

Property Description Type
statusCode The status code of the response. int
Optional

BackendPoolItem

Backend pool service information

Used by: BackendPool.

Property Description Type
preferredCarbonEmission Scope 2 carbon emission preference for the backend. When specified, the load balancer will optimize traffic flow by routing to regions that have carbon emission less than or equal to the specified category. However, when all other backends are not available it will route traffic to these regions anyway. This requires the backend to be attributed with azureRegion information. CarbonEmissionCategory
Optional
priority The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified. int
Optional
reference The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity. genruntime.ResourceReference
Required
weight The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified. int
Optional

BackendPoolItem_STATUS

Backend pool service information

Used by: BackendPool_STATUS.

Property Description Type
id The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity. string
Required
preferredCarbonEmission Scope 2 carbon emission preference for the backend. When specified, the load balancer will optimize traffic flow by routing to regions that have carbon emission less than or equal to the specified category. However, when all other backends are not available it will route traffic to these regions anyway. This requires the backend to be attributed with azureRegion information. CarbonEmissionCategory_STATUS
Optional
priority The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified. int
Optional
weight The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified. int
Optional

BackendServiceFabricClusterProperties

Properties of the Service Fabric Type Backend.

Used by: BackendProperties.

Property Description Type
clientCertificateId The client certificate id for the management endpoint. string
Optional
clientCertificatethumbprint The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided string
Optional
managementEndpoints The cluster management endpoint. string[]
Required
maxPartitionResolutionRetries Maximum number of retries while attempting resolve the partition. int
Optional
serverCertificateThumbprints Thumbprints of certificates cluster management service uses for tls communication string[]
Optional
serverX509Names Server X509 Certificate Names Collection X509CertificateName[]
Optional

BackendServiceFabricClusterProperties_STATUS

Properties of the Service Fabric Type Backend.

Used by: BackendProperties_STATUS.

Property Description Type
clientCertificateId The client certificate id for the management endpoint. string
Optional
clientCertificatethumbprint The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided string
Optional
managementEndpoints The cluster management endpoint. string[]
Optional
maxPartitionResolutionRetries Maximum number of retries while attempting resolve the partition. int
Optional
serverCertificateThumbprints Thumbprints of certificates cluster management service uses for tls communication string[]
Optional
serverX509Names Server X509 Certificate Names Collection X509CertificateName_STATUS[]
Optional

BackendSessionAffinity

The session stickiness properties of the backend pool.

Used by: BackendPool.

Property Description Type
sessionId The id that identifies the requests belonging to the same session. BackendSessionId
Optional

BackendSessionAffinity_STATUS

The session stickiness properties of the backend pool.

Used by: BackendPool_STATUS.

Property Description Type
sessionId The id that identifies the requests belonging to the same session. BackendSessionId_STATUS
Optional

CircuitBreakerRule

Rule configuration to trip the backend.

Used by: BackendCircuitBreaker.

Property Description Type
acceptRetryAfter flag to accept Retry-After header from the backend. bool
Optional
failureCondition The conditions for tripping the circuit breaker. CircuitBreakerFailureCondition
Optional
failureResponse The response of the backend when the circuit breaker gets open. BackendFailureResponse
Optional
name The rule name. string
Optional
tripDuration The duration for which the circuit will be tripped. string
Optional

CircuitBreakerRule_STATUS

Rule configuration to trip the backend.

Used by: BackendCircuitBreaker_STATUS.

Property Description Type
acceptRetryAfter flag to accept Retry-After header from the backend. bool
Optional
failureCondition The conditions for tripping the circuit breaker. CircuitBreakerFailureCondition_STATUS
Optional
failureResponse The response of the backend when the circuit breaker gets open. BackendFailureResponse_STATUS
Optional
name The rule name. string
Optional
tripDuration The duration for which the circuit will be tripped. string
Optional

SystemData_CreatedByType_STATUS

Used by: SystemData_STATUS.

Value Description
“Application”
“Key”
“ManagedIdentity”
“User”

SystemData_LastModifiedByType_STATUS

Used by: SystemData_STATUS.

Value Description
“Application”
“Key”
“ManagedIdentity”
“User”

X509CertificateName

Properties of server X509Names.

Used by: BackendServiceFabricClusterProperties, and BackendTlsProperties.

Property Description Type
issuerCertificateThumbprint Thumbprint for the Issuer of the Certificate. string
Optional
name Common Name of the Certificate. string
Optional

X509CertificateName_STATUS

Properties of server X509Names.

Used by: BackendServiceFabricClusterProperties_STATUS, and BackendTlsProperties_STATUS.

Property Description Type
issuerCertificateThumbprint Thumbprint for the Issuer of the Certificate. string
Optional
name Common Name of the Certificate. string
Optional

BackendSessionId

The properties of the id that identifies the requests belonging to the same session.

Used by: BackendSessionAffinity.

Property Description Type
name Name of the variable that refers to the session id. string
Optional
source Source from where the session id is extracted. BackendSessionIdSource
Optional

BackendSessionId_STATUS

The properties of the id that identifies the requests belonging to the same session.

Used by: BackendSessionAffinity_STATUS.

Property Description Type
name Name of the variable that refers to the session id. string
Optional
source Source from where the session id is extracted. BackendSessionIdSource_STATUS
Optional

CarbonEmissionCategory

Scope 2 carbon emission preference for the backend. When specified, the load balancer will optimize traffic flow by routing to regions that have carbon emission less than or equal to the specified category. However, when all other backends are not available it will route traffic to these regions anyway. This requires the backend to be attributed with azureRegion information.

Used by: BackendPoolItem.

Value Description
“High”
“Low”
“Medium”
“VeryHigh”
“VeryLow”

CarbonEmissionCategory_STATUS

Scope 2 carbon emission preference for the backend. When specified, the load balancer will optimize traffic flow by routing to regions that have carbon emission less than or equal to the specified category. However, when all other backends are not available it will route traffic to these regions anyway. This requires the backend to be attributed with azureRegion information.

Used by: BackendPoolItem_STATUS.

Value Description
“High”
“Low”
“Medium”
“VeryHigh”
“VeryLow”

CircuitBreakerFailureCondition

The trip conditions of the circuit breaker

Used by: CircuitBreakerRule.

Property Description Type
count The threshold for opening the circuit. int
Optional
errorReasons The error reasons which are considered as failure. string[]
Optional
interval The interval during which the failures are counted. string
Optional
percentage The threshold for opening the circuit. int
Optional
statusCodeRanges The status code ranges which are considered as failure. FailureStatusCodeRange[]
Optional

CircuitBreakerFailureCondition_STATUS

The trip conditions of the circuit breaker

Used by: CircuitBreakerRule_STATUS.

Property Description Type
count The threshold for opening the circuit. int
Optional
errorReasons The error reasons which are considered as failure. string[]
Optional
interval The interval during which the failures are counted. string
Optional
percentage The threshold for opening the circuit. int
Optional
statusCodeRanges The status code ranges which are considered as failure. FailureStatusCodeRange_STATUS[]
Optional

BackendSessionIdSource

Source from where the session id is extracted.

Used by: BackendSessionId.

Value Description
“cookie”

BackendSessionIdSource_STATUS

Source from where the session id is extracted.

Used by: BackendSessionId_STATUS.

Value Description
“cookie”

FailureStatusCodeRange

The failure http status code range

Used by: CircuitBreakerFailureCondition.

Property Description Type
max The maximum http status code. int
Optional
min The minimum http status code. int
Optional

FailureStatusCodeRange_STATUS

The failure http status code range

Used by: CircuitBreakerFailureCondition_STATUS.

Property Description Type
max The maximum http status code. int
Optional
min The minimum http status code. int
Optional