GradientEdge CDK Utils
    Preparing search index...

    Interface ApiManagementBackendProps

    Properties for creating an API Management backend

    [Pulumi Azure Native API Management Backend]https://www.pulumi.com/registry/packages/azure-native/api-docs/apimanagement/backend/

    interface ApiManagementBackendProps {
        apiManagementId?: string;
        backendId?: Input<string | undefined>;
        backendUrlPath?: string;
        circuitBreaker?: any;
        credentials?: Input<BackendCredentialsContractArgs | undefined>;
        description?: Input<string | undefined>;
        pool?: Input<BackendBaseParametersPoolArgs | undefined>;
        properties?: Input<BackendPropertiesArgs | undefined>;
        protocol?: Input<string | undefined>;
        proxy?: Input<BackendProxyContractArgs | undefined>;
        resourceGroupName: Input<string>;
        resourceId?: Input<string | undefined>;
        serviceName: Input<string>;
        title?: Input<string | undefined>;
        tls?: Input<BackendTlsPropertiesArgs | undefined>;
        type?: Input<string | undefined>;
        url?: Input<string | undefined>;
    }

    Hierarchy

    • BackendArgs
      • ApiManagementBackendProps
    Index
    apiManagementId? backendId? backendUrlPath? circuitBreaker? credentials? description? pool? properties? protocol? proxy? resourceGroupName resourceId? serviceName title? tls? type? url?
    apiManagementId?: string

    API Management service resource ID

    backendId?: Input<string | undefined>

    Identifier of the Backend entity. Must be unique in the current API Management service instance.

    backendUrlPath?: string

    URL path appended to the backend base URL

    circuitBreaker?: any

    Circuit breaker configuration for backend fault tolerance

    credentials?: Input<BackendCredentialsContractArgs | undefined>

    Backend Credentials Contract Properties

    description?: Input<string | undefined>

    Backend Description.

    pool?: Input<BackendBaseParametersPoolArgs | undefined>
    properties?: Input<BackendPropertiesArgs | undefined>

    Backend Properties contract

    protocol?: Input<string | undefined>

    Backend communication protocol. Required when backend type is 'Single'.

    proxy?: Input<BackendProxyContractArgs | undefined>

    Backend gateway Contract Properties

    resourceGroupName: Input<string>

    The name of the resource group. The name is case insensitive.

    resourceId?: Input<string | undefined>

    Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.

    serviceName: Input<string>

    The name of the API Management service.

    title?: Input<string | undefined>

    Backend Title.

    tls?: Input<BackendTlsPropertiesArgs | undefined>

    Backend TLS Properties

    type?: Input<string | undefined>

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

    url?: Input<string | undefined>

    Runtime Url of the Backend. Required when backend type is 'Single'.

    Settings
    Member Visibility

    On This Page
    Properties