Share via

BackendContract interface

Package:
@azure/arm-apimanagement

Backend details.

Extends
ProxyResource

Properties

circuitBreaker

Backend Circuit Breaker Configuration
credentials

Backend Credentials Contract Properties
description

Backend Description.
pool
properties

Backend Properties contract
protocol

Backend communication protocol.
proxy

Backend gateway Contract Properties
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.
title

Backend Title.
tls

Backend TLS Properties
typePropertiesType

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

Runtime Url of the Backend.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

circuitBreaker

Backend Circuit Breaker Configuration

circuitBreaker?: BackendCircuitBreaker

Property Value

BackendCircuitBreaker

credentials

Backend Credentials Contract Properties

credentials?: BackendCredentialsContract

Property Value

BackendCredentialsContract

description

Backend Description.

description?: string

Property Value

string

pool 

pool?: BackendBaseParametersPool

Property Value

BackendBaseParametersPool

properties

Backend Properties contract

properties?: BackendProperties

Property Value

BackendProperties

protocol

Backend communication protocol.

protocol?: string

Property Value

string

proxy

Backend gateway Contract Properties

proxy?: BackendProxyContract

Property Value

BackendProxyContract

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.

resourceId?: string

Property Value

string

title

Backend Title.

title?: string

Property Value

string

tls

Backend TLS Properties

tls?: BackendTlsProperties

Property Value

BackendTlsProperties

typePropertiesType

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

typePropertiesType?: string

Property Value

string

url

Runtime Url of the Backend.

url?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type