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

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.Backend

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi
pulumi/pulumi-azure

    Manages a backend within an API Management Service.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleService = new Azure.ApiManagement.Service("exampleService", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        PublisherName = "My Company",
        PublisherEmail = "company@exmaple.com",
        SkuName = "Developer_1",
    });

    var exampleBackend = new Azure.ApiManagement.Backend("exampleBackend", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        ApiManagementName = exampleService.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 {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleService, err := apimanagement.NewService(ctx, "exampleService", &apimanagement.ServiceArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.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, "exampleBackend", &apimanagement.BackendArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			ApiManagementName: exampleService.Name,
			Protocol:          pulumi.String("http"),
			Url:               pulumi.String("https://backend"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .publisherName("My Company")
            .publisherEmail("company@exmaple.com")
            .skuName("Developer_1")
            .build());

        var exampleBackend = new Backend("exampleBackend", BackendArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .apiManagementName(exampleService.name())
            .protocol("http")
            .url("https://backend")
            .build());

    }
}

    import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="My Company",
    publisher_email="company@exmaple.com",
    sku_name="Developer_1")
example_backend = azure.apimanagement.Backend("exampleBackend",
    resource_group_name=example_resource_group.name,
    api_management_name=example_service.name,
    protocol="http",
    url="https://backend")

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "My Company",
    publisherEmail: "company@exmaple.com",
    skuName: "Developer_1",
});
const exampleBackend = new azure.apimanagement.Backend("exampleBackend", {
    resourceGroupName: exampleResourceGroup.name,
    apiManagementName: exampleService.name,
    protocol: "http",
    url: "https://backend",
});

    resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleService:
    type: azure:apimanagement:Service
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      publisherName: My Company
      publisherEmail: company@exmaple.com
      skuName: Developer_1
  exampleBackend:
    type: azure:apimanagement:Backend
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      apiManagementName: ${exampleService.name}
      protocol: http
      url: https://backend

    Create Backend Resource

    new Backend(name: string, args: BackendArgs, opts?: CustomResourceOptions);
    @overload
def Backend(resource_name: 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)
@overload
def Backend(resource_name: str,
            args: BackendArgs,
            opts: Optional[ResourceOptions] = 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.
    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.

    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 name of the API Management backend. Changing this forces a new resource to be created.

    IssuerCertificateThumbprint string

    The thumbprint for the issuer of the certificate.

    Name string

    The name of the API Management backend. Changing this forces a new resource to be created.

    issuerCertificateThumbprint String

    The thumbprint for the issuer of the certificate.

    name String

    The name of the API Management backend. Changing this forces a new resource to be created.

    issuerCertificateThumbprint string

    The thumbprint for the issuer of the certificate.

    name string

    The name of the API Management backend. Changing this forces a new resource to be created.

    issuer_certificate_thumbprint str

    The thumbprint for the issuer of the certificate.

    name str

    The name of the API Management backend. Changing this forces a new resource to be created.

    issuerCertificateThumbprint String

    The thumbprint for the issuer of the certificate.

    name String

    The name of the API Management backend. Changing this forces a new resource to be created.

    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

    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.58.0 published on Saturday, Dec 2, 2023 by Pulumi
    pulumi/pulumi-azure