1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. Backend

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.apimanagement.Backend

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages a backend within an API Management Service.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleService = new azure.apimanagement.Service("example", {
        name: "example-apim",
        location: example.location,
        resourceGroupName: example.name,
        publisherName: "My Company",
        publisherEmail: "company@exmaple.com",
        skuName: "Developer_1",
    });
    const exampleBackend = new azure.apimanagement.Backend("example", {
        name: "example-backend",
        resourceGroupName: example.name,
        apiManagementName: exampleService.name,
        protocol: "http",
        url: "https://backend",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_service = azure.apimanagement.Service("example",
        name="example-apim",
        location=example.location,
        resource_group_name=example.name,
        publisher_name="My Company",
        publisher_email="company@exmaple.com",
        sku_name="Developer_1")
    example_backend = azure.apimanagement.Backend("example",
        name="example-backend",
        resource_group_name=example.name,
        api_management_name=example_service.name,
        protocol="http",
        url="https://backend")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
    			Name:              pulumi.String("example-apim"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			PublisherName:     pulumi.String("My Company"),
    			PublisherEmail:    pulumi.String("company@exmaple.com"),
    			SkuName:           pulumi.String("Developer_1"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = apimanagement.NewBackend(ctx, "example", &apimanagement.BackendArgs{
    			Name:              pulumi.String("example-backend"),
    			ResourceGroupName: example.Name,
    			ApiManagementName: exampleService.Name,
    			Protocol:          pulumi.String("http"),
    			Url:               pulumi.String("https://backend"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleService = new Azure.ApiManagement.Service("example", new()
        {
            Name = "example-apim",
            Location = example.Location,
            ResourceGroupName = example.Name,
            PublisherName = "My Company",
            PublisherEmail = "company@exmaple.com",
            SkuName = "Developer_1",
        });
    
        var exampleBackend = new Azure.ApiManagement.Backend("example", new()
        {
            Name = "example-backend",
            ResourceGroupName = example.Name,
            ApiManagementName = exampleService.Name,
            Protocol = "http",
            Url = "https://backend",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.apimanagement.Service;
    import com.pulumi.azure.apimanagement.ServiceArgs;
    import com.pulumi.azure.apimanagement.Backend;
    import com.pulumi.azure.apimanagement.BackendArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleService = new Service("exampleService", ServiceArgs.builder()
                .name("example-apim")
                .location(example.location())
                .resourceGroupName(example.name())
                .publisherName("My Company")
                .publisherEmail("company@exmaple.com")
                .skuName("Developer_1")
                .build());
    
            var exampleBackend = new Backend("exampleBackend", BackendArgs.builder()
                .name("example-backend")
                .resourceGroupName(example.name())
                .apiManagementName(exampleService.name())
                .protocol("http")
                .url("https://backend")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleService:
        type: azure:apimanagement:Service
        name: example
        properties:
          name: example-apim
          location: ${example.location}
          resourceGroupName: ${example.name}
          publisherName: My Company
          publisherEmail: company@exmaple.com
          skuName: Developer_1
      exampleBackend:
        type: azure:apimanagement:Backend
        name: example
        properties:
          name: example-backend
          resourceGroupName: ${example.name}
          apiManagementName: ${exampleService.name}
          protocol: http
          url: https://backend
    

    Create Backend Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Backend(name: string, args: BackendArgs, opts?: CustomResourceOptions);
    @overload
    def Backend(resource_name: str,
                args: BackendArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Backend(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                api_management_name: Optional[str] = None,
                protocol: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                url: Optional[str] = None,
                credentials: Optional[BackendCredentialsArgs] = None,
                description: Optional[str] = None,
                name: Optional[str] = None,
                proxy: Optional[BackendProxyArgs] = None,
                resource_id: Optional[str] = None,
                service_fabric_cluster: Optional[BackendServiceFabricClusterArgs] = None,
                title: Optional[str] = None,
                tls: Optional[BackendTlsArgs] = None)
    func NewBackend(ctx *Context, name string, args BackendArgs, opts ...ResourceOption) (*Backend, error)
    public Backend(string name, BackendArgs args, CustomResourceOptions? opts = null)
    public Backend(String name, BackendArgs args)
    public Backend(String name, BackendArgs args, CustomResourceOptions options)
    
    type: azure:apimanagement:Backend
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args BackendArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BackendArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BackendArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackendArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackendArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var backendResource = new Azure.ApiManagement.Backend("backendResource", new()
    {
        ApiManagementName = "string",
        Protocol = "string",
        ResourceGroupName = "string",
        Url = "string",
        Credentials = new Azure.ApiManagement.Inputs.BackendCredentialsArgs
        {
            Authorization = new Azure.ApiManagement.Inputs.BackendCredentialsAuthorizationArgs
            {
                Parameter = "string",
                Scheme = "string",
            },
            Certificates = new[]
            {
                "string",
            },
            Header = 
            {
                { "string", "string" },
            },
            Query = 
            {
                { "string", "string" },
            },
        },
        Description = "string",
        Name = "string",
        Proxy = new Azure.ApiManagement.Inputs.BackendProxyArgs
        {
            Url = "string",
            Username = "string",
            Password = "string",
        },
        ResourceId = "string",
        ServiceFabricCluster = new Azure.ApiManagement.Inputs.BackendServiceFabricClusterArgs
        {
            ManagementEndpoints = new[]
            {
                "string",
            },
            MaxPartitionResolutionRetries = 0,
            ClientCertificateId = "string",
            ClientCertificateThumbprint = "string",
            ServerCertificateThumbprints = new[]
            {
                "string",
            },
            ServerX509Names = new[]
            {
                new Azure.ApiManagement.Inputs.BackendServiceFabricClusterServerX509NameArgs
                {
                    IssuerCertificateThumbprint = "string",
                    Name = "string",
                },
            },
        },
        Title = "string",
        Tls = new Azure.ApiManagement.Inputs.BackendTlsArgs
        {
            ValidateCertificateChain = false,
            ValidateCertificateName = false,
        },
    });
    
    example, err := apimanagement.NewBackend(ctx, "backendResource", &apimanagement.BackendArgs{
    	ApiManagementName: pulumi.String("string"),
    	Protocol:          pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	Url:               pulumi.String("string"),
    	Credentials: &apimanagement.BackendCredentialsArgs{
    		Authorization: &apimanagement.BackendCredentialsAuthorizationArgs{
    			Parameter: pulumi.String("string"),
    			Scheme:    pulumi.String("string"),
    		},
    		Certificates: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		Header: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    		Query: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    	},
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Proxy: &apimanagement.BackendProxyArgs{
    		Url:      pulumi.String("string"),
    		Username: pulumi.String("string"),
    		Password: pulumi.String("string"),
    	},
    	ResourceId: pulumi.String("string"),
    	ServiceFabricCluster: &apimanagement.BackendServiceFabricClusterArgs{
    		ManagementEndpoints: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		MaxPartitionResolutionRetries: pulumi.Int(0),
    		ClientCertificateId:           pulumi.String("string"),
    		ClientCertificateThumbprint:   pulumi.String("string"),
    		ServerCertificateThumbprints: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		ServerX509Names: apimanagement.BackendServiceFabricClusterServerX509NameArray{
    			&apimanagement.BackendServiceFabricClusterServerX509NameArgs{
    				IssuerCertificateThumbprint: pulumi.String("string"),
    				Name:                        pulumi.String("string"),
    			},
    		},
    	},
    	Title: pulumi.String("string"),
    	Tls: &apimanagement.BackendTlsArgs{
    		ValidateCertificateChain: pulumi.Bool(false),
    		ValidateCertificateName:  pulumi.Bool(false),
    	},
    })
    
    var backendResource = new Backend("backendResource", BackendArgs.builder()
        .apiManagementName("string")
        .protocol("string")
        .resourceGroupName("string")
        .url("string")
        .credentials(BackendCredentialsArgs.builder()
            .authorization(BackendCredentialsAuthorizationArgs.builder()
                .parameter("string")
                .scheme("string")
                .build())
            .certificates("string")
            .header(Map.of("string", "string"))
            .query(Map.of("string", "string"))
            .build())
        .description("string")
        .name("string")
        .proxy(BackendProxyArgs.builder()
            .url("string")
            .username("string")
            .password("string")
            .build())
        .resourceId("string")
        .serviceFabricCluster(BackendServiceFabricClusterArgs.builder()
            .managementEndpoints("string")
            .maxPartitionResolutionRetries(0)
            .clientCertificateId("string")
            .clientCertificateThumbprint("string")
            .serverCertificateThumbprints("string")
            .serverX509Names(BackendServiceFabricClusterServerX509NameArgs.builder()
                .issuerCertificateThumbprint("string")
                .name("string")
                .build())
            .build())
        .title("string")
        .tls(BackendTlsArgs.builder()
            .validateCertificateChain(false)
            .validateCertificateName(false)
            .build())
        .build());
    
    backend_resource = azure.apimanagement.Backend("backendResource",
        api_management_name="string",
        protocol="string",
        resource_group_name="string",
        url="string",
        credentials=azure.apimanagement.BackendCredentialsArgs(
            authorization=azure.apimanagement.BackendCredentialsAuthorizationArgs(
                parameter="string",
                scheme="string",
            ),
            certificates=["string"],
            header={
                "string": "string",
            },
            query={
                "string": "string",
            },
        ),
        description="string",
        name="string",
        proxy=azure.apimanagement.BackendProxyArgs(
            url="string",
            username="string",
            password="string",
        ),
        resource_id="string",
        service_fabric_cluster=azure.apimanagement.BackendServiceFabricClusterArgs(
            management_endpoints=["string"],
            max_partition_resolution_retries=0,
            client_certificate_id="string",
            client_certificate_thumbprint="string",
            server_certificate_thumbprints=["string"],
            server_x509_names=[azure.apimanagement.BackendServiceFabricClusterServerX509NameArgs(
                issuer_certificate_thumbprint="string",
                name="string",
            )],
        ),
        title="string",
        tls=azure.apimanagement.BackendTlsArgs(
            validate_certificate_chain=False,
            validate_certificate_name=False,
        ))
    
    const backendResource = new azure.apimanagement.Backend("backendResource", {
        apiManagementName: "string",
        protocol: "string",
        resourceGroupName: "string",
        url: "string",
        credentials: {
            authorization: {
                parameter: "string",
                scheme: "string",
            },
            certificates: ["string"],
            header: {
                string: "string",
            },
            query: {
                string: "string",
            },
        },
        description: "string",
        name: "string",
        proxy: {
            url: "string",
            username: "string",
            password: "string",
        },
        resourceId: "string",
        serviceFabricCluster: {
            managementEndpoints: ["string"],
            maxPartitionResolutionRetries: 0,
            clientCertificateId: "string",
            clientCertificateThumbprint: "string",
            serverCertificateThumbprints: ["string"],
            serverX509Names: [{
                issuerCertificateThumbprint: "string",
                name: "string",
            }],
        },
        title: "string",
        tls: {
            validateCertificateChain: false,
            validateCertificateName: false,
        },
    });
    
    type: azure:apimanagement:Backend
    properties:
        apiManagementName: string
        credentials:
            authorization:
                parameter: string
                scheme: string
            certificates:
                - string
            header:
                string: string
            query:
                string: string
        description: string
        name: string
        protocol: string
        proxy:
            password: string
            url: string
            username: string
        resourceGroupName: string
        resourceId: string
        serviceFabricCluster:
            clientCertificateId: string
            clientCertificateThumbprint: string
            managementEndpoints:
                - string
            maxPartitionResolutionRetries: 0
            serverCertificateThumbprints:
                - string
            serverX509Names:
                - issuerCertificateThumbprint: string
                  name: string
        title: string
        tls:
            validateCertificateChain: false
            validateCertificateName: false
        url: string
    

    Backend Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Backend resource accepts the following input properties:

    ApiManagementName string
    The Name of the API Management Service where this backend should be created. Changing this forces a new resource to be created.
    Protocol string
    The protocol used by the backend host. Possible values are http or soap.
    ResourceGroupName string
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    Url string
    The URL of the backend host.
    Credentials BackendCredentials
    A credentials block as documented below.
    Description string
    The description of the backend.
    Name string
    The name of the API Management backend. Changing this forces a new resource to be created.
    Proxy BackendProxy
    A proxy block as documented below.
    ResourceId string
    The management URI of the backend host in an external system. This URI can be the ARM Resource ID of Logic Apps, Function Apps or API Apps, or the management endpoint of a Service Fabric cluster.
    ServiceFabricCluster BackendServiceFabricCluster
    A service_fabric_cluster block as documented below.
    Title string
    The title of the backend.
    Tls BackendTls
    A tls block as documented below.
    ApiManagementName string
    The Name of the API Management Service where this backend should be created. Changing this forces a new resource to be created.
    Protocol string
    The protocol used by the backend host. Possible values are http or soap.
    ResourceGroupName string
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    Url string
    The URL of the backend host.
    Credentials BackendCredentialsArgs
    A credentials block as documented below.
    Description string
    The description of the backend.
    Name string
    The name of the API Management backend. Changing this forces a new resource to be created.
    Proxy BackendProxyArgs
    A proxy block as documented below.
    ResourceId string
    The management URI of the backend host in an external system. This URI can be the ARM Resource ID of Logic Apps, Function Apps or API Apps, or the management endpoint of a Service Fabric cluster.
    ServiceFabricCluster BackendServiceFabricClusterArgs
    A service_fabric_cluster block as documented below.
    Title string
    The title of the backend.
    Tls BackendTlsArgs
    A tls block as documented below.
    apiManagementName String
    The Name of the API Management Service where this backend should be created. Changing this forces a new resource to be created.
    protocol String
    The protocol used by the backend host. Possible values are http or soap.
    resourceGroupName String
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    url String
    The URL of the backend host.
    credentials BackendCredentials
    A credentials block as documented below.
    description String
    The description of the backend.
    name String
    The name of the API Management backend. Changing this forces a new resource to be created.
    proxy BackendProxy
    A proxy block as documented below.
    resourceId String
    The management URI of the backend host in an external system. This URI can be the ARM Resource ID of Logic Apps, Function Apps or API Apps, or the management endpoint of a Service Fabric cluster.
    serviceFabricCluster BackendServiceFabricCluster
    A service_fabric_cluster block as documented below.
    title String
    The title of the backend.
    tls BackendTls
    A tls block as documented below.
    apiManagementName string
    The Name of the API Management Service where this backend should be created. Changing this forces a new resource to be created.
    protocol string
    The protocol used by the backend host. Possible values are http or soap.
    resourceGroupName string
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    url string
    The URL of the backend host.
    credentials BackendCredentials
    A credentials block as documented below.
    description string
    The description of the backend.
    name string
    The name of the API Management backend. Changing this forces a new resource to be created.
    proxy BackendProxy
    A proxy block as documented below.
    resourceId string
    The management URI of the backend host in an external system. This URI can be the ARM Resource ID of Logic Apps, Function Apps or API Apps, or the management endpoint of a Service Fabric cluster.
    serviceFabricCluster BackendServiceFabricCluster
    A service_fabric_cluster block as documented below.
    title string
    The title of the backend.
    tls BackendTls
    A tls block as documented below.
    api_management_name str
    The Name of the API Management Service where this backend should be created. Changing this forces a new resource to be created.
    protocol str
    The protocol used by the backend host. Possible values are http or soap.
    resource_group_name str
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    url str
    The URL of the backend host.
    credentials BackendCredentialsArgs
    A credentials block as documented below.
    description str
    The description of the backend.
    name str
    The name of the API Management backend. Changing this forces a new resource to be created.
    proxy BackendProxyArgs
    A proxy block as documented below.
    resource_id str
    The management URI of the backend host in an external system. This URI can be the ARM Resource ID of Logic Apps, Function Apps or API Apps, or the management endpoint of a Service Fabric cluster.
    service_fabric_cluster BackendServiceFabricClusterArgs
    A service_fabric_cluster block as documented below.
    title str
    The title of the backend.
    tls BackendTlsArgs
    A tls block as documented below.
    apiManagementName String
    The Name of the API Management Service where this backend should be created. Changing this forces a new resource to be created.
    protocol String
    The protocol used by the backend host. Possible values are http or soap.
    resourceGroupName String
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    url String
    The URL of the backend host.
    credentials Property Map
    A credentials block as documented below.
    description String
    The description of the backend.
    name String
    The name of the API Management backend. Changing this forces a new resource to be created.
    proxy Property Map
    A proxy block as documented below.
    resourceId String
    The management URI of the backend host in an external system. This URI can be the ARM Resource ID of Logic Apps, Function Apps or API Apps, or the management endpoint of a Service Fabric cluster.
    serviceFabricCluster Property Map
    A service_fabric_cluster block as documented below.
    title String
    The title of the backend.
    tls Property Map
    A tls block as documented below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Backend resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Backend Resource

    Get an existing Backend resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BackendState, opts?: CustomResourceOptions): Backend
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_management_name: Optional[str] = None,
            credentials: Optional[BackendCredentialsArgs] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            protocol: Optional[str] = None,
            proxy: Optional[BackendProxyArgs] = None,
            resource_group_name: Optional[str] = None,
            resource_id: Optional[str] = None,
            service_fabric_cluster: Optional[BackendServiceFabricClusterArgs] = None,
            title: Optional[str] = None,
            tls: Optional[BackendTlsArgs] = None,
            url: Optional[str] = None) -> Backend
    func GetBackend(ctx *Context, name string, id IDInput, state *BackendState, opts ...ResourceOption) (*Backend, error)
    public static Backend Get(string name, Input<string> id, BackendState? state, CustomResourceOptions? opts = null)
    public static Backend get(String name, Output<String> id, BackendState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiManagementName string
    The Name of the API Management Service where this backend should be created. Changing this forces a new resource to be created.
    Credentials BackendCredentials
    A credentials block as documented below.
    Description string
    The description of the backend.
    Name string
    The name of the API Management backend. Changing this forces a new resource to be created.
    Protocol string
    The protocol used by the backend host. Possible values are http or soap.
    Proxy BackendProxy
    A proxy block as documented below.
    ResourceGroupName string
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    ResourceId string
    The management URI of the backend host in an external system. This URI can be the ARM Resource ID of Logic Apps, Function Apps or API Apps, or the management endpoint of a Service Fabric cluster.
    ServiceFabricCluster BackendServiceFabricCluster
    A service_fabric_cluster block as documented below.
    Title string
    The title of the backend.
    Tls BackendTls
    A tls block as documented below.
    Url string
    The URL of the backend host.
    ApiManagementName string
    The Name of the API Management Service where this backend should be created. Changing this forces a new resource to be created.
    Credentials BackendCredentialsArgs
    A credentials block as documented below.
    Description string
    The description of the backend.
    Name string
    The name of the API Management backend. Changing this forces a new resource to be created.
    Protocol string
    The protocol used by the backend host. Possible values are http or soap.
    Proxy BackendProxyArgs
    A proxy block as documented below.
    ResourceGroupName string
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    ResourceId string
    The management URI of the backend host in an external system. This URI can be the ARM Resource ID of Logic Apps, Function Apps or API Apps, or the management endpoint of a Service Fabric cluster.
    ServiceFabricCluster BackendServiceFabricClusterArgs
    A service_fabric_cluster block as documented below.
    Title string
    The title of the backend.
    Tls BackendTlsArgs
    A tls block as documented below.
    Url string
    The URL of the backend host.
    apiManagementName String
    The Name of the API Management Service where this backend should be created. Changing this forces a new resource to be created.
    credentials BackendCredentials
    A credentials block as documented below.
    description String
    The description of the backend.
    name String
    The name of the API Management backend. Changing this forces a new resource to be created.
    protocol String
    The protocol used by the backend host. Possible values are http or soap.
    proxy BackendProxy
    A proxy block as documented below.
    resourceGroupName String
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    resourceId String
    The management URI of the backend host in an external system. This URI can be the ARM Resource ID of Logic Apps, Function Apps or API Apps, or the management endpoint of a Service Fabric cluster.
    serviceFabricCluster BackendServiceFabricCluster
    A service_fabric_cluster block as documented below.
    title String
    The title of the backend.
    tls BackendTls
    A tls block as documented below.
    url String
    The URL of the backend host.
    apiManagementName string
    The Name of the API Management Service where this backend should be created. Changing this forces a new resource to be created.
    credentials BackendCredentials
    A credentials block as documented below.
    description string
    The description of the backend.
    name string
    The name of the API Management backend. Changing this forces a new resource to be created.
    protocol string
    The protocol used by the backend host. Possible values are http or soap.
    proxy BackendProxy
    A proxy block as documented below.
    resourceGroupName string
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    resourceId string
    The management URI of the backend host in an external system. This URI can be the ARM Resource ID of Logic Apps, Function Apps or API Apps, or the management endpoint of a Service Fabric cluster.
    serviceFabricCluster BackendServiceFabricCluster
    A service_fabric_cluster block as documented below.
    title string
    The title of the backend.
    tls BackendTls
    A tls block as documented below.
    url string
    The URL of the backend host.
    api_management_name str
    The Name of the API Management Service where this backend should be created. Changing this forces a new resource to be created.
    credentials BackendCredentialsArgs
    A credentials block as documented below.
    description str
    The description of the backend.
    name str
    The name of the API Management backend. Changing this forces a new resource to be created.
    protocol str
    The protocol used by the backend host. Possible values are http or soap.
    proxy BackendProxyArgs
    A proxy block as documented below.
    resource_group_name str
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    resource_id str
    The management URI of the backend host in an external system. This URI can be the ARM Resource ID of Logic Apps, Function Apps or API Apps, or the management endpoint of a Service Fabric cluster.
    service_fabric_cluster BackendServiceFabricClusterArgs
    A service_fabric_cluster block as documented below.
    title str
    The title of the backend.
    tls BackendTlsArgs
    A tls block as documented below.
    url str
    The URL of the backend host.
    apiManagementName String
    The Name of the API Management Service where this backend should be created. Changing this forces a new resource to be created.
    credentials Property Map
    A credentials block as documented below.
    description String
    The description of the backend.
    name String
    The name of the API Management backend. Changing this forces a new resource to be created.
    protocol String
    The protocol used by the backend host. Possible values are http or soap.
    proxy Property Map
    A proxy block as documented below.
    resourceGroupName String
    The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.
    resourceId String
    The management URI of the backend host in an external system. This URI can be the ARM Resource ID of Logic Apps, Function Apps or API Apps, or the management endpoint of a Service Fabric cluster.
    serviceFabricCluster Property Map
    A service_fabric_cluster block as documented below.
    title String
    The title of the backend.
    tls Property Map
    A tls block as documented below.
    url String
    The URL of the backend host.

    Supporting Types

    BackendCredentials, BackendCredentialsArgs

    Authorization BackendCredentialsAuthorization
    An authorization block as defined below.
    Certificates List<string>
    A list of client certificate thumbprints to present to the backend host. The certificates must exist within the API Management Service.
    Header Dictionary<string, string>
    A mapping of header parameters to pass to the backend host. The keys are the header names and the values are a comma separated string of header values. This is converted to a list before being passed to the API.
    Query Dictionary<string, string>
    A mapping of query parameters to pass to the backend host. The keys are the query names and the values are a comma separated string of query values. This is converted to a list before being passed to the API.
    Authorization BackendCredentialsAuthorization
    An authorization block as defined below.
    Certificates []string
    A list of client certificate thumbprints to present to the backend host. The certificates must exist within the API Management Service.
    Header map[string]string
    A mapping of header parameters to pass to the backend host. The keys are the header names and the values are a comma separated string of header values. This is converted to a list before being passed to the API.
    Query map[string]string
    A mapping of query parameters to pass to the backend host. The keys are the query names and the values are a comma separated string of query values. This is converted to a list before being passed to the API.
    authorization BackendCredentialsAuthorization
    An authorization block as defined below.
    certificates List<String>
    A list of client certificate thumbprints to present to the backend host. The certificates must exist within the API Management Service.
    header Map<String,String>
    A mapping of header parameters to pass to the backend host. The keys are the header names and the values are a comma separated string of header values. This is converted to a list before being passed to the API.
    query Map<String,String>
    A mapping of query parameters to pass to the backend host. The keys are the query names and the values are a comma separated string of query values. This is converted to a list before being passed to the API.
    authorization BackendCredentialsAuthorization
    An authorization block as defined below.
    certificates string[]
    A list of client certificate thumbprints to present to the backend host. The certificates must exist within the API Management Service.
    header {[key: string]: string}
    A mapping of header parameters to pass to the backend host. The keys are the header names and the values are a comma separated string of header values. This is converted to a list before being passed to the API.
    query {[key: string]: string}
    A mapping of query parameters to pass to the backend host. The keys are the query names and the values are a comma separated string of query values. This is converted to a list before being passed to the API.
    authorization BackendCredentialsAuthorization
    An authorization block as defined below.
    certificates Sequence[str]
    A list of client certificate thumbprints to present to the backend host. The certificates must exist within the API Management Service.
    header Mapping[str, str]
    A mapping of header parameters to pass to the backend host. The keys are the header names and the values are a comma separated string of header values. This is converted to a list before being passed to the API.
    query Mapping[str, str]
    A mapping of query parameters to pass to the backend host. The keys are the query names and the values are a comma separated string of query values. This is converted to a list before being passed to the API.
    authorization Property Map
    An authorization block as defined below.
    certificates List<String>
    A list of client certificate thumbprints to present to the backend host. The certificates must exist within the API Management Service.
    header Map<String>
    A mapping of header parameters to pass to the backend host. The keys are the header names and the values are a comma separated string of header values. This is converted to a list before being passed to the API.
    query Map<String>
    A mapping of query parameters to pass to the backend host. The keys are the query names and the values are a comma separated string of query values. This is converted to a list before being passed to the API.

    BackendCredentialsAuthorization, BackendCredentialsAuthorizationArgs

    Parameter string
    The authentication Parameter value.
    Scheme string
    The authentication Scheme name.
    Parameter string
    The authentication Parameter value.
    Scheme string
    The authentication Scheme name.
    parameter String
    The authentication Parameter value.
    scheme String
    The authentication Scheme name.
    parameter string
    The authentication Parameter value.
    scheme string
    The authentication Scheme name.
    parameter str
    The authentication Parameter value.
    scheme str
    The authentication Scheme name.
    parameter String
    The authentication Parameter value.
    scheme String
    The authentication Scheme name.

    BackendProxy, BackendProxyArgs

    Url string
    The URL of the proxy server.
    Username string
    The username to connect to the proxy server.
    Password string
    The password to connect to the proxy server.
    Url string
    The URL of the proxy server.
    Username string
    The username to connect to the proxy server.
    Password string
    The password to connect to the proxy server.
    url String
    The URL of the proxy server.
    username String
    The username to connect to the proxy server.
    password String
    The password to connect to the proxy server.
    url string
    The URL of the proxy server.
    username string
    The username to connect to the proxy server.
    password string
    The password to connect to the proxy server.
    url str
    The URL of the proxy server.
    username str
    The username to connect to the proxy server.
    password str
    The password to connect to the proxy server.
    url String
    The URL of the proxy server.
    username String
    The username to connect to the proxy server.
    password String
    The password to connect to the proxy server.

    BackendServiceFabricCluster, BackendServiceFabricClusterArgs

    ManagementEndpoints List<string>
    A list of cluster management endpoints.
    MaxPartitionResolutionRetries int
    The maximum number of retries when attempting resolve the partition.
    ClientCertificateId string

    The client certificate resource id for the management endpoint.

    Note: At least one of client_certificate_thumbprint, and client_certificate_id must be set.

    ClientCertificateThumbprint string
    The client certificate thumbprint for the management endpoint.
    ServerCertificateThumbprints List<string>
    A list of thumbprints of the server certificates of the Service Fabric cluster.
    ServerX509Names List<BackendServiceFabricClusterServerX509Name>
    One or more server_x509_name blocks as documented below.
    ManagementEndpoints []string
    A list of cluster management endpoints.
    MaxPartitionResolutionRetries int
    The maximum number of retries when attempting resolve the partition.
    ClientCertificateId string

    The client certificate resource id for the management endpoint.

    Note: At least one of client_certificate_thumbprint, and client_certificate_id must be set.

    ClientCertificateThumbprint string
    The client certificate thumbprint for the management endpoint.
    ServerCertificateThumbprints []string
    A list of thumbprints of the server certificates of the Service Fabric cluster.
    ServerX509Names []BackendServiceFabricClusterServerX509Name
    One or more server_x509_name blocks as documented below.
    managementEndpoints List<String>
    A list of cluster management endpoints.
    maxPartitionResolutionRetries Integer
    The maximum number of retries when attempting resolve the partition.
    clientCertificateId String

    The client certificate resource id for the management endpoint.

    Note: At least one of client_certificate_thumbprint, and client_certificate_id must be set.

    clientCertificateThumbprint String
    The client certificate thumbprint for the management endpoint.
    serverCertificateThumbprints List<String>
    A list of thumbprints of the server certificates of the Service Fabric cluster.
    serverX509Names List<BackendServiceFabricClusterServerX509Name>
    One or more server_x509_name blocks as documented below.
    managementEndpoints string[]
    A list of cluster management endpoints.
    maxPartitionResolutionRetries number
    The maximum number of retries when attempting resolve the partition.
    clientCertificateId string

    The client certificate resource id for the management endpoint.

    Note: At least one of client_certificate_thumbprint, and client_certificate_id must be set.

    clientCertificateThumbprint string
    The client certificate thumbprint for the management endpoint.
    serverCertificateThumbprints string[]
    A list of thumbprints of the server certificates of the Service Fabric cluster.
    serverX509Names BackendServiceFabricClusterServerX509Name[]
    One or more server_x509_name blocks as documented below.
    management_endpoints Sequence[str]
    A list of cluster management endpoints.
    max_partition_resolution_retries int
    The maximum number of retries when attempting resolve the partition.
    client_certificate_id str

    The client certificate resource id for the management endpoint.

    Note: At least one of client_certificate_thumbprint, and client_certificate_id must be set.

    client_certificate_thumbprint str
    The client certificate thumbprint for the management endpoint.
    server_certificate_thumbprints Sequence[str]
    A list of thumbprints of the server certificates of the Service Fabric cluster.
    server_x509_names Sequence[BackendServiceFabricClusterServerX509Name]
    One or more server_x509_name blocks as documented below.
    managementEndpoints List<String>
    A list of cluster management endpoints.
    maxPartitionResolutionRetries Number
    The maximum number of retries when attempting resolve the partition.
    clientCertificateId String

    The client certificate resource id for the management endpoint.

    Note: At least one of client_certificate_thumbprint, and client_certificate_id must be set.

    clientCertificateThumbprint String
    The client certificate thumbprint for the management endpoint.
    serverCertificateThumbprints List<String>
    A list of thumbprints of the server certificates of the Service Fabric cluster.
    serverX509Names List<Property Map>
    One or more server_x509_name blocks as documented below.

    BackendServiceFabricClusterServerX509Name, BackendServiceFabricClusterServerX509NameArgs

    IssuerCertificateThumbprint string
    The thumbprint for the issuer of the certificate.
    Name string
    The common name of the certificate.
    IssuerCertificateThumbprint string
    The thumbprint for the issuer of the certificate.
    Name string
    The common name of the certificate.
    issuerCertificateThumbprint String
    The thumbprint for the issuer of the certificate.
    name String
    The common name of the certificate.
    issuerCertificateThumbprint string
    The thumbprint for the issuer of the certificate.
    name string
    The common name of the certificate.
    issuer_certificate_thumbprint str
    The thumbprint for the issuer of the certificate.
    name str
    The common name of the certificate.
    issuerCertificateThumbprint String
    The thumbprint for the issuer of the certificate.
    name String
    The common name of the certificate.

    BackendTls, BackendTlsArgs

    ValidateCertificateChain bool
    Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for the backend host.
    ValidateCertificateName bool
    Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for the backend host.
    ValidateCertificateChain bool
    Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for the backend host.
    ValidateCertificateName bool
    Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for the backend host.
    validateCertificateChain Boolean
    Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for the backend host.
    validateCertificateName Boolean
    Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for the backend host.
    validateCertificateChain boolean
    Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for the backend host.
    validateCertificateName boolean
    Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for the backend host.
    validate_certificate_chain bool
    Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for the backend host.
    validate_certificate_name bool
    Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for the backend host.
    validateCertificateChain Boolean
    Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for the backend host.
    validateCertificateName Boolean
    Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for the backend host.

    Import

    API Management backends can be imported using the resource id, e.g.

    $ pulumi import azure:apimanagement/backend:Backend example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/backends/backend1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi