Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. apimanagement
  5. Backend
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.Backend

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Backend details. API Version: 2020-12-01.

    Example Usage

    ApiManagementCreateBackendProxyBackend

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

return await Deployment.RunAsync(() => 
{
    var backend = new AzureNative.ApiManagement.Backend("backend", new()
    {
        BackendId = "proxybackend",
        Credentials = new AzureNative.ApiManagement.Inputs.BackendCredentialsContractArgs
        {
            Authorization = new AzureNative.ApiManagement.Inputs.BackendAuthorizationHeaderCredentialsArgs
            {
                Parameter = "opensesma",
                Scheme = "Basic",
            },
            Header = 
            {
                { "x-my-1", new[]
                {
                    "val1",
                    "val2",
                } },
            },
            Query = 
            {
                { "sv", new[]
                {
                    "xx",
                    "bb",
                    "cc",
                } },
            },
        },
        Description = "description5308",
        Protocol = "http",
        Proxy = new AzureNative.ApiManagement.Inputs.BackendProxyContractArgs
        {
            Password = "<password>",
            Url = "http://192.168.1.1:8080",
            Username = "Contoso\\admin",
        },
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
        Tls = new AzureNative.ApiManagement.Inputs.BackendTlsPropertiesArgs
        {
            ValidateCertificateChain = true,
            ValidateCertificateName = true,
        },
        Url = "https://backendname2644/",
    });

});

    package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewBackend(ctx, "backend", &apimanagement.BackendArgs{
			BackendId: pulumi.String("proxybackend"),
			Credentials: apimanagement.BackendCredentialsContractResponse{
				Authorization: &apimanagement.BackendAuthorizationHeaderCredentialsArgs{
					Parameter: pulumi.String("opensesma"),
					Scheme:    pulumi.String("Basic"),
				},
				Header: pulumi.StringArrayMap{
					"x-my-1": pulumi.StringArray{
						pulumi.String("val1"),
						pulumi.String("val2"),
					},
				},
				Query: pulumi.StringArrayMap{
					"sv": pulumi.StringArray{
						pulumi.String("xx"),
						pulumi.String("bb"),
						pulumi.String("cc"),
					},
				},
			},
			Description: pulumi.String("description5308"),
			Protocol:    pulumi.String("http"),
			Proxy: &apimanagement.BackendProxyContractArgs{
				Password: pulumi.String("<password>"),
				Url:      pulumi.String("http://192.168.1.1:8080"),
				Username: pulumi.String("Contoso\\admin"),
			},
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
			Tls: &apimanagement.BackendTlsPropertiesArgs{
				ValidateCertificateChain: pulumi.Bool(true),
				ValidateCertificateName:  pulumi.Bool(true),
			},
			Url: pulumi.String("https://backendname2644/"),
		})
		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.azurenative.apimanagement.Backend;
import com.pulumi.azurenative.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 backend = new Backend("backend", BackendArgs.builder()        
            .backendId("proxybackend")
            .credentials(Map.ofEntries(
                Map.entry("authorization", Map.ofEntries(
                    Map.entry("parameter", "opensesma"),
                    Map.entry("scheme", "Basic")
                )),
                Map.entry("header", Map.of("x-my-1",                 
                    "val1",
                    "val2")),
                Map.entry("query", Map.of("sv",                 
                    "xx",
                    "bb",
                    "cc"))
            ))
            .description("description5308")
            .protocol("http")
            .proxy(Map.ofEntries(
                Map.entry("password", "<password>"),
                Map.entry("url", "http://192.168.1.1:8080"),
                Map.entry("username", "Contoso\\admin")
            ))
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .tls(Map.ofEntries(
                Map.entry("validateCertificateChain", true),
                Map.entry("validateCertificateName", true)
            ))
            .url("https://backendname2644/")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

backend = azure_native.apimanagement.Backend("backend",
    backend_id="proxybackend",
    credentials=azure_native.apimanagement.BackendCredentialsContractResponseArgs(
        authorization=azure_native.apimanagement.BackendAuthorizationHeaderCredentialsArgs(
            parameter="opensesma",
            scheme="Basic",
        ),
        header={
            "x-my-1": [
                "val1",
                "val2",
            ],
        },
        query={
            "sv": [
                "xx",
                "bb",
                "cc",
            ],
        },
    ),
    description="description5308",
    protocol="http",
    proxy=azure_native.apimanagement.BackendProxyContractArgs(
        password="<password>",
        url="http://192.168.1.1:8080",
        username="Contoso\\admin",
    ),
    resource_group_name="rg1",
    service_name="apimService1",
    tls=azure_native.apimanagement.BackendTlsPropertiesArgs(
        validate_certificate_chain=True,
        validate_certificate_name=True,
    ),
    url="https://backendname2644/")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const backend = new azure_native.apimanagement.Backend("backend", {
    backendId: "proxybackend",
    credentials: {
        authorization: {
            parameter: "opensesma",
            scheme: "Basic",
        },
        header: {
            "x-my-1": [
                "val1",
                "val2",
            ],
        },
        query: {
            sv: [
                "xx",
                "bb",
                "cc",
            ],
        },
    },
    description: "description5308",
    protocol: "http",
    proxy: {
        password: "<password>",
        url: "http://192.168.1.1:8080",
        username: "Contoso\\admin",
    },
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    tls: {
        validateCertificateChain: true,
        validateCertificateName: true,
    },
    url: "https://backendname2644/",
});

    resources:
  backend:
    type: azure-native:apimanagement:Backend
    properties:
      backendId: proxybackend
      credentials:
        authorization:
          parameter: opensesma
          scheme: Basic
        header:
          x-my-1:
            - val1
            - val2
        query:
          sv:
            - xx
            - bb
            - cc
      description: description5308
      protocol: http
      proxy:
        password: <password>
        url: http://192.168.1.1:8080
        username: Contoso\admin
      resourceGroupName: rg1
      serviceName: apimService1
      tls:
        validateCertificateChain: true
        validateCertificateName: true
      url: https://backendname2644/

    ApiManagementCreateBackendServiceFabric

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

return await Deployment.RunAsync(() => 
{
    var backend = new AzureNative.ApiManagement.Backend("backend", new()
    {
        BackendId = "sfbackend",
        Description = "Service Fabric Test App 1",
        Properties = new AzureNative.ApiManagement.Inputs.BackendPropertiesArgs
        {
            ServiceFabricCluster = new AzureNative.ApiManagement.Inputs.BackendServiceFabricClusterPropertiesArgs
            {
                ClientCertificateId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
                ManagementEndpoints = new[]
                {
                    "https://somecluster.com",
                },
                MaxPartitionResolutionRetries = 5,
                ServerX509Names = new[]
                {
                    new AzureNative.ApiManagement.Inputs.X509CertificateNameArgs
                    {
                        IssuerCertificateThumbprint = "IssuerCertificateThumbprint1",
                        Name = "ServerCommonName1",
                    },
                },
            },
        },
        Protocol = "http",
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
        Url = "fabric:/mytestapp/mytestservice",
    });

});

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.Backend;
import com.pulumi.azurenative.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 backend = new Backend("backend", BackendArgs.builder()        
            .backendId("sfbackend")
            .description("Service Fabric Test App 1")
            .properties(Map.of("serviceFabricCluster", Map.ofEntries(
                Map.entry("clientCertificateId", "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1"),
                Map.entry("managementEndpoints", "https://somecluster.com"),
                Map.entry("maxPartitionResolutionRetries", 5),
                Map.entry("serverX509Names", Map.ofEntries(
                    Map.entry("issuerCertificateThumbprint", "IssuerCertificateThumbprint1"),
                    Map.entry("name", "ServerCommonName1")
                ))
            )))
            .protocol("http")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .url("fabric:/mytestapp/mytestservice")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

backend = azure_native.apimanagement.Backend("backend",
    backend_id="sfbackend",
    description="Service Fabric Test App 1",
    properties=azure_native.apimanagement.BackendPropertiesResponseArgs(
        service_fabric_cluster={
            "clientCertificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
            "managementEndpoints": ["https://somecluster.com"],
            "maxPartitionResolutionRetries": 5,
            "serverX509Names": [azure_native.apimanagement.X509CertificateNameArgs(
                issuer_certificate_thumbprint="IssuerCertificateThumbprint1",
                name="ServerCommonName1",
            )],
        },
    ),
    protocol="http",
    resource_group_name="rg1",
    service_name="apimService1",
    url="fabric:/mytestapp/mytestservice")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const backend = new azure_native.apimanagement.Backend("backend", {
    backendId: "sfbackend",
    description: "Service Fabric Test App 1",
    properties: {
        serviceFabricCluster: {
            clientCertificateId: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
            managementEndpoints: ["https://somecluster.com"],
            maxPartitionResolutionRetries: 5,
            serverX509Names: [{
                issuerCertificateThumbprint: "IssuerCertificateThumbprint1",
                name: "ServerCommonName1",
            }],
        },
    },
    protocol: "http",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    url: "fabric:/mytestapp/mytestservice",
});

    resources:
  backend:
    type: azure-native:apimanagement:Backend
    properties:
      backendId: sfbackend
      description: Service Fabric Test App 1
      properties:
        serviceFabricCluster:
          clientCertificateId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1
          managementEndpoints:
            - https://somecluster.com
          maxPartitionResolutionRetries: 5
          serverX509Names:
            - issuerCertificateThumbprint: IssuerCertificateThumbprint1
              name: ServerCommonName1
      protocol: http
      resourceGroupName: rg1
      serviceName: apimService1
      url: fabric:/mytestapp/mytestservice

    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,
            protocol: Optional[Union[str, BackendProtocol]] = None,
            resource_group_name: Optional[str] = None,
            service_name: Optional[str] = None,
            url: Optional[str] = None,
            backend_id: Optional[str] = None,
            credentials: Optional[BackendCredentialsContractArgs] = None,
            description: Optional[str] = None,
            properties: Optional[BackendPropertiesArgs] = None,
            proxy: Optional[BackendProxyContractArgs] = None,
            resource_id: Optional[str] = None,
            title: Optional[str] = None,
            tls: Optional[BackendTlsPropertiesArgs] = 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-native: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.

    Constructor example

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

    var backendResource = new AzureNative.Apimanagement.Backend("backendResource", new()
{
    Protocol = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    Url = "string",
    BackendId = "string",
    Credentials = 
    {
        { "authorization", 
        {
            { "parameter", "string" },
            { "scheme", "string" },
        } },
        { "certificate", new[]
        {
            "string",
        } },
        { "certificateIds", new[]
        {
            "string",
        } },
        { "header", 
        {
            { "string", new[]
            {
                "string",
            } },
        } },
        { "query", 
        {
            { "string", new[]
            {
                "string",
            } },
        } },
    },
    Description = "string",
    Properties = 
    {
        { "serviceFabricCluster", 
        {
            { "managementEndpoints", new[]
            {
                "string",
            } },
            { "clientCertificateId", "string" },
            { "clientCertificatethumbprint", "string" },
            { "maxPartitionResolutionRetries", 0 },
            { "serverCertificateThumbprints", new[]
            {
                "string",
            } },
            { "serverX509Names", new[]
            {
                
                {
                    { "issuerCertificateThumbprint", "string" },
                    { "name", "string" },
                },
            } },
        } },
    },
    Proxy = 
    {
        { "url", "string" },
        { "password", "string" },
        { "username", "string" },
    },
    ResourceId = "string",
    Title = "string",
    Tls = 
    {
        { "validateCertificateChain", false },
        { "validateCertificateName", false },
    },
});

    example, err := apimanagement.NewBackend(ctx, "backendResource", &apimanagement.BackendArgs{
	Protocol:          "string",
	ResourceGroupName: "string",
	ServiceName:       "string",
	Url:               "string",
	BackendId:         "string",
	Credentials: map[string]interface{}{
		"authorization": map[string]interface{}{
			"parameter": "string",
			"scheme":    "string",
		},
		"certificate": []string{
			"string",
		},
		"certificateIds": []string{
			"string",
		},
		"header": map[string]interface{}{
			"string": []string{
				"string",
			},
		},
		"query": map[string]interface{}{
			"string": []string{
				"string",
			},
		},
	},
	Description: "string",
	Properties: map[string]interface{}{
		"serviceFabricCluster": map[string]interface{}{
			"managementEndpoints": []string{
				"string",
			},
			"clientCertificateId":           "string",
			"clientCertificatethumbprint":   "string",
			"maxPartitionResolutionRetries": 0,
			"serverCertificateThumbprints": []string{
				"string",
			},
			"serverX509Names": []map[string]interface{}{
				map[string]interface{}{
					"issuerCertificateThumbprint": "string",
					"name":                        "string",
				},
			},
		},
	},
	Proxy: map[string]interface{}{
		"url":      "string",
		"password": "string",
		"username": "string",
	},
	ResourceId: "string",
	Title:      "string",
	Tls: map[string]interface{}{
		"validateCertificateChain": false,
		"validateCertificateName":  false,
	},
})

    var backendResource = new Backend("backendResource", BackendArgs.builder()
    .protocol("string")
    .resourceGroupName("string")
    .serviceName("string")
    .url("string")
    .backendId("string")
    .credentials(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .description("string")
    .properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .proxy(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .resourceId("string")
    .title("string")
    .tls(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());

    backend_resource = azure_native.apimanagement.Backend("backendResource",
    protocol=string,
    resource_group_name=string,
    service_name=string,
    url=string,
    backend_id=string,
    credentials={
        authorization: {
            parameter: string,
            scheme: string,
        },
        certificate: [string],
        certificateIds: [string],
        header: {
            string: [string],
        },
        query: {
            string: [string],
        },
    },
    description=string,
    properties={
        serviceFabricCluster: {
            managementEndpoints: [string],
            clientCertificateId: string,
            clientCertificatethumbprint: string,
            maxPartitionResolutionRetries: 0,
            serverCertificateThumbprints: [string],
            serverX509Names: [{
                issuerCertificateThumbprint: string,
                name: string,
            }],
        },
    },
    proxy={
        url: string,
        password: string,
        username: string,
    },
    resource_id=string,
    title=string,
    tls={
        validateCertificateChain: False,
        validateCertificateName: False,
    })

    const backendResource = new azure_native.apimanagement.Backend("backendResource", {
    protocol: "string",
    resourceGroupName: "string",
    serviceName: "string",
    url: "string",
    backendId: "string",
    credentials: {
        authorization: {
            parameter: "string",
            scheme: "string",
        },
        certificate: ["string"],
        certificateIds: ["string"],
        header: {
            string: ["string"],
        },
        query: {
            string: ["string"],
        },
    },
    description: "string",
    properties: {
        serviceFabricCluster: {
            managementEndpoints: ["string"],
            clientCertificateId: "string",
            clientCertificatethumbprint: "string",
            maxPartitionResolutionRetries: 0,
            serverCertificateThumbprints: ["string"],
            serverX509Names: [{
                issuerCertificateThumbprint: "string",
                name: "string",
            }],
        },
    },
    proxy: {
        url: "string",
        password: "string",
        username: "string",
    },
    resourceId: "string",
    title: "string",
    tls: {
        validateCertificateChain: false,
        validateCertificateName: false,
    },
});

    type: azure-native:apimanagement:Backend
properties:
    backendId: string
    credentials:
        authorization:
            parameter: string
            scheme: string
        certificate:
            - string
        certificateIds:
            - string
        header:
            string:
                - string
        query:
            string:
                - string
    description: string
    properties:
        serviceFabricCluster:
            clientCertificateId: string
            clientCertificatethumbprint: string
            managementEndpoints:
                - string
            maxPartitionResolutionRetries: 0
            serverCertificateThumbprints:
                - string
            serverX509Names:
                - issuerCertificateThumbprint: string
                  name: string
    protocol: string
    proxy:
        password: string
        url: string
        username: string
    resourceGroupName: string
    resourceId: string
    serviceName: 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Backend resource accepts the following input properties:

    Protocol string | Pulumi.AzureNative.ApiManagement.BackendProtocol
    Backend communication protocol.
    ResourceGroupName string
    The name of the resource group.
    ServiceName string
    The name of the API Management service.
    Url string
    Runtime Url of the Backend.
    BackendId string
    Identifier of the Backend entity. Must be unique in the current API Management service instance.
    Credentials Pulumi.AzureNative.ApiManagement.Inputs.BackendCredentialsContract
    Backend Credentials Contract Properties
    Description string
    Backend Description.
    Properties Pulumi.AzureNative.ApiManagement.Inputs.BackendProperties
    Backend Properties contract
    Proxy Pulumi.AzureNative.ApiManagement.Inputs.BackendProxyContract
    Backend Proxy Contract Properties
    ResourceId string
    Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.
    Title string
    Backend Title.
    Tls Pulumi.AzureNative.ApiManagement.Inputs.BackendTlsProperties
    Backend TLS Properties
    Protocol string | BackendProtocol
    Backend communication protocol.
    ResourceGroupName string
    The name of the resource group.
    ServiceName string
    The name of the API Management service.
    Url string
    Runtime Url of the Backend.
    BackendId string
    Identifier of the Backend entity. Must be unique in the current API Management service instance.
    Credentials BackendCredentialsContractArgs
    Backend Credentials Contract Properties
    Description string
    Backend Description.
    Properties BackendPropertiesArgs
    Backend Properties contract
    Proxy BackendProxyContractArgs
    Backend Proxy Contract Properties
    ResourceId string
    Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.
    Title string
    Backend Title.
    Tls BackendTlsPropertiesArgs
    Backend TLS Properties
    protocol String | BackendProtocol
    Backend communication protocol.
    resourceGroupName String
    The name of the resource group.
    serviceName String
    The name of the API Management service.
    url String
    Runtime Url of the Backend.
    backendId String
    Identifier of the Backend entity. Must be unique in the current API Management service instance.
    credentials BackendCredentialsContract
    Backend Credentials Contract Properties
    description String
    Backend Description.
    properties BackendProperties
    Backend Properties contract
    proxy BackendProxyContract
    Backend Proxy Contract Properties
    resourceId String
    Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.
    title String
    Backend Title.
    tls BackendTlsProperties
    Backend TLS Properties
    protocol string | BackendProtocol
    Backend communication protocol.
    resourceGroupName string
    The name of the resource group.
    serviceName string
    The name of the API Management service.
    url string
    Runtime Url of the Backend.
    backendId string
    Identifier of the Backend entity. Must be unique in the current API Management service instance.
    credentials BackendCredentialsContract
    Backend Credentials Contract Properties
    description string
    Backend Description.
    properties BackendProperties
    Backend Properties contract
    proxy BackendProxyContract
    Backend Proxy Contract Properties
    resourceId string
    Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.
    title string
    Backend Title.
    tls BackendTlsProperties
    Backend TLS Properties
    protocol str | BackendProtocol
    Backend communication protocol.
    resource_group_name str
    The name of the resource group.
    service_name str
    The name of the API Management service.
    url str
    Runtime Url of the Backend.
    backend_id str
    Identifier of the Backend entity. Must be unique in the current API Management service instance.
    credentials BackendCredentialsContractArgs
    Backend Credentials Contract Properties
    description str
    Backend Description.
    properties BackendPropertiesArgs
    Backend Properties contract
    proxy BackendProxyContractArgs
    Backend Proxy Contract Properties
    resource_id str
    Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.
    title str
    Backend Title.
    tls BackendTlsPropertiesArgs
    Backend TLS Properties
    protocol String | "http" | "soap"
    Backend communication protocol.
    resourceGroupName String
    The name of the resource group.
    serviceName String
    The name of the API Management service.
    url String
    Runtime Url of the Backend.
    backendId String
    Identifier of the Backend entity. Must be unique in the current API Management service instance.
    credentials Property Map
    Backend Credentials Contract Properties
    description String
    Backend Description.
    properties Property Map
    Backend Properties contract
    proxy Property Map
    Backend Proxy Contract Properties
    resourceId String
    Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.
    title String
    Backend Title.
    tls Property Map
    Backend TLS Properties

    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.
    Name string
    Resource name.
    Type string
    Resource type for API Management resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    Type string
    Resource type for API Management resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    type String
    Resource type for API Management resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name.
    type string
    Resource type for API Management resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name.
    type str
    Resource type for API Management resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    type String
    Resource type for API Management resource.

    Supporting Types

    BackendAuthorizationHeaderCredentials, BackendAuthorizationHeaderCredentialsArgs

    Parameter string
    Authentication Parameter value.
    Scheme string
    Authentication Scheme name.
    Parameter string
    Authentication Parameter value.
    Scheme string
    Authentication Scheme name.
    parameter String
    Authentication Parameter value.
    scheme String
    Authentication Scheme name.
    parameter string
    Authentication Parameter value.
    scheme string
    Authentication Scheme name.
    parameter str
    Authentication Parameter value.
    scheme str
    Authentication Scheme name.
    parameter String
    Authentication Parameter value.
    scheme String
    Authentication Scheme name.

    BackendAuthorizationHeaderCredentialsResponse, BackendAuthorizationHeaderCredentialsResponseArgs

    Parameter string
    Authentication Parameter value.
    Scheme string
    Authentication Scheme name.
    Parameter string
    Authentication Parameter value.
    Scheme string
    Authentication Scheme name.
    parameter String
    Authentication Parameter value.
    scheme String
    Authentication Scheme name.
    parameter string
    Authentication Parameter value.
    scheme string
    Authentication Scheme name.
    parameter str
    Authentication Parameter value.
    scheme str
    Authentication Scheme name.
    parameter String
    Authentication Parameter value.
    scheme String
    Authentication Scheme name.

    BackendCredentialsContract, BackendCredentialsContractArgs

    Authorization Pulumi.AzureNative.ApiManagement.Inputs.BackendAuthorizationHeaderCredentials
    Authorization header authentication
    Certificate List<string>
    List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
    CertificateIds List<string>
    List of Client Certificate Ids.
    Header Dictionary<string, ImmutableArray<string>>
    Header Parameter description.
    Query Dictionary<string, ImmutableArray<string>>
    Query Parameter description.
    Authorization BackendAuthorizationHeaderCredentials
    Authorization header authentication
    Certificate []string
    List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
    CertificateIds []string
    List of Client Certificate Ids.
    Header map[string][]string
    Header Parameter description.
    Query map[string][]string
    Query Parameter description.
    authorization BackendAuthorizationHeaderCredentials
    Authorization header authentication
    certificate List<String>
    List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
    certificateIds List<String>
    List of Client Certificate Ids.
    header Map<String,List<String>>
    Header Parameter description.
    query Map<String,List<String>>
    Query Parameter description.
    authorization BackendAuthorizationHeaderCredentials
    Authorization header authentication
    certificate string[]
    List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
    certificateIds string[]
    List of Client Certificate Ids.
    header {[key: string]: string[]}
    Header Parameter description.
    query {[key: string]: string[]}
    Query Parameter description.
    authorization BackendAuthorizationHeaderCredentials
    Authorization header authentication
    certificate Sequence[str]
    List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
    certificate_ids Sequence[str]
    List of Client Certificate Ids.
    header Mapping[str, Sequence[str]]
    Header Parameter description.
    query Mapping[str, Sequence[str]]
    Query Parameter description.
    authorization Property Map
    Authorization header authentication
    certificate List<String>
    List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
    certificateIds List<String>
    List of Client Certificate Ids.
    header Map<List<String>>
    Header Parameter description.
    query Map<List<String>>
    Query Parameter description.

    BackendCredentialsContractResponse, BackendCredentialsContractResponseArgs

    Authorization Pulumi.AzureNative.ApiManagement.Inputs.BackendAuthorizationHeaderCredentialsResponse
    Authorization header authentication
    Certificate List<string>
    List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
    CertificateIds List<string>
    List of Client Certificate Ids.
    Header Dictionary<string, ImmutableArray<string>>
    Header Parameter description.
    Query Dictionary<string, ImmutableArray<string>>
    Query Parameter description.
    Authorization BackendAuthorizationHeaderCredentialsResponse
    Authorization header authentication
    Certificate []string
    List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
    CertificateIds []string
    List of Client Certificate Ids.
    Header map[string][]string
    Header Parameter description.
    Query map[string][]string
    Query Parameter description.
    authorization BackendAuthorizationHeaderCredentialsResponse
    Authorization header authentication
    certificate List<String>
    List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
    certificateIds List<String>
    List of Client Certificate Ids.
    header Map<String,List<String>>
    Header Parameter description.
    query Map<String,List<String>>
    Query Parameter description.
    authorization BackendAuthorizationHeaderCredentialsResponse
    Authorization header authentication
    certificate string[]
    List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
    certificateIds string[]
    List of Client Certificate Ids.
    header {[key: string]: string[]}
    Header Parameter description.
    query {[key: string]: string[]}
    Query Parameter description.
    authorization BackendAuthorizationHeaderCredentialsResponse
    Authorization header authentication
    certificate Sequence[str]
    List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
    certificate_ids Sequence[str]
    List of Client Certificate Ids.
    header Mapping[str, Sequence[str]]
    Header Parameter description.
    query Mapping[str, Sequence[str]]
    Query Parameter description.
    authorization Property Map
    Authorization header authentication
    certificate List<String>
    List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
    certificateIds List<String>
    List of Client Certificate Ids.
    header Map<List<String>>
    Header Parameter description.
    query Map<List<String>>
    Query Parameter description.

    BackendProperties, BackendPropertiesArgs

    ServiceFabricCluster BackendServiceFabricClusterProperties
    Backend Service Fabric Cluster Properties
    serviceFabricCluster BackendServiceFabricClusterProperties
    Backend Service Fabric Cluster Properties
    serviceFabricCluster BackendServiceFabricClusterProperties
    Backend Service Fabric Cluster Properties
    service_fabric_cluster BackendServiceFabricClusterProperties
    Backend Service Fabric Cluster Properties
    serviceFabricCluster Property Map
    Backend Service Fabric Cluster Properties

    BackendPropertiesResponse, BackendPropertiesResponseArgs

    serviceFabricCluster Property Map
    Backend Service Fabric Cluster Properties

    BackendProtocol, BackendProtocolArgs

    Http
    httpThe Backend is a RESTful service.
    Soap
    soapThe Backend is a SOAP service.
    BackendProtocolHttp
    httpThe Backend is a RESTful service.
    BackendProtocolSoap
    soapThe Backend is a SOAP service.
    Http
    httpThe Backend is a RESTful service.
    Soap
    soapThe Backend is a SOAP service.
    Http
    httpThe Backend is a RESTful service.
    Soap
    soapThe Backend is a SOAP service.
    HTTP
    httpThe Backend is a RESTful service.
    SOAP
    soapThe Backend is a SOAP service.
    "http"
    httpThe Backend is a RESTful service.
    "soap"
    soapThe Backend is a SOAP service.

    BackendProxyContract, BackendProxyContractArgs

    Url string
    WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.
    Password string
    Password to connect to the WebProxy Server
    Username string
    Username to connect to the WebProxy server
    Url string
    WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.
    Password string
    Password to connect to the WebProxy Server
    Username string
    Username to connect to the WebProxy server
    url String
    WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.
    password String
    Password to connect to the WebProxy Server
    username String
    Username to connect to the WebProxy server
    url string
    WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.
    password string
    Password to connect to the WebProxy Server
    username string
    Username to connect to the WebProxy server
    url str
    WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.
    password str
    Password to connect to the WebProxy Server
    username str
    Username to connect to the WebProxy server
    url String
    WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.
    password String
    Password to connect to the WebProxy Server
    username String
    Username to connect to the WebProxy server

    BackendProxyContractResponse, BackendProxyContractResponseArgs

    Url string
    WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.
    Password string
    Password to connect to the WebProxy Server
    Username string
    Username to connect to the WebProxy server
    Url string
    WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.
    Password string
    Password to connect to the WebProxy Server
    Username string
    Username to connect to the WebProxy server
    url String
    WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.
    password String
    Password to connect to the WebProxy Server
    username String
    Username to connect to the WebProxy server
    url string
    WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.
    password string
    Password to connect to the WebProxy Server
    username string
    Username to connect to the WebProxy server
    url str
    WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.
    password str
    Password to connect to the WebProxy Server
    username str
    Username to connect to the WebProxy server
    url String
    WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.
    password String
    Password to connect to the WebProxy Server
    username String
    Username to connect to the WebProxy server

    BackendServiceFabricClusterProperties, BackendServiceFabricClusterPropertiesArgs

    ManagementEndpoints List<string>
    The cluster management endpoint.
    ClientCertificateId string
    The client certificate id for the management endpoint.
    ClientCertificatethumbprint string
    The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
    MaxPartitionResolutionRetries int
    Maximum number of retries while attempting resolve the partition.
    ServerCertificateThumbprints List<string>
    Thumbprints of certificates cluster management service uses for tls communication
    ServerX509Names List<Pulumi.AzureNative.ApiManagement.Inputs.X509CertificateName>
    Server X509 Certificate Names Collection
    ManagementEndpoints []string
    The cluster management endpoint.
    ClientCertificateId string
    The client certificate id for the management endpoint.
    ClientCertificatethumbprint string
    The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
    MaxPartitionResolutionRetries int
    Maximum number of retries while attempting resolve the partition.
    ServerCertificateThumbprints []string
    Thumbprints of certificates cluster management service uses for tls communication
    ServerX509Names []X509CertificateName
    Server X509 Certificate Names Collection
    managementEndpoints List<String>
    The cluster management endpoint.
    clientCertificateId String
    The client certificate id for the management endpoint.
    clientCertificatethumbprint String
    The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
    maxPartitionResolutionRetries Integer
    Maximum number of retries while attempting resolve the partition.
    serverCertificateThumbprints List<String>
    Thumbprints of certificates cluster management service uses for tls communication
    serverX509Names List<X509CertificateName>
    Server X509 Certificate Names Collection
    managementEndpoints string[]
    The cluster management endpoint.
    clientCertificateId string
    The client certificate id for the management endpoint.
    clientCertificatethumbprint string
    The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
    maxPartitionResolutionRetries number
    Maximum number of retries while attempting resolve the partition.
    serverCertificateThumbprints string[]
    Thumbprints of certificates cluster management service uses for tls communication
    serverX509Names X509CertificateName[]
    Server X509 Certificate Names Collection
    management_endpoints Sequence[str]
    The cluster management endpoint.
    client_certificate_id str
    The client certificate id for the management endpoint.
    client_certificatethumbprint str
    The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
    max_partition_resolution_retries int
    Maximum number of retries while attempting resolve the partition.
    server_certificate_thumbprints Sequence[str]
    Thumbprints of certificates cluster management service uses for tls communication
    server_x509_names Sequence[X509CertificateName]
    Server X509 Certificate Names Collection
    managementEndpoints List<String>
    The cluster management endpoint.
    clientCertificateId String
    The client certificate id for the management endpoint.
    clientCertificatethumbprint String
    The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
    maxPartitionResolutionRetries Number
    Maximum number of retries while attempting resolve the partition.
    serverCertificateThumbprints List<String>
    Thumbprints of certificates cluster management service uses for tls communication
    serverX509Names List<Property Map>
    Server X509 Certificate Names Collection

    BackendServiceFabricClusterPropertiesResponse, BackendServiceFabricClusterPropertiesResponseArgs

    ManagementEndpoints List<string>
    The cluster management endpoint.
    ClientCertificateId string
    The client certificate id for the management endpoint.
    ClientCertificatethumbprint string
    The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
    MaxPartitionResolutionRetries int
    Maximum number of retries while attempting resolve the partition.
    ServerCertificateThumbprints List<string>
    Thumbprints of certificates cluster management service uses for tls communication
    ServerX509Names List<Pulumi.AzureNative.ApiManagement.Inputs.X509CertificateNameResponse>
    Server X509 Certificate Names Collection
    ManagementEndpoints []string
    The cluster management endpoint.
    ClientCertificateId string
    The client certificate id for the management endpoint.
    ClientCertificatethumbprint string
    The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
    MaxPartitionResolutionRetries int
    Maximum number of retries while attempting resolve the partition.
    ServerCertificateThumbprints []string
    Thumbprints of certificates cluster management service uses for tls communication
    ServerX509Names []X509CertificateNameResponse
    Server X509 Certificate Names Collection
    managementEndpoints List<String>
    The cluster management endpoint.
    clientCertificateId String
    The client certificate id for the management endpoint.
    clientCertificatethumbprint String
    The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
    maxPartitionResolutionRetries Integer
    Maximum number of retries while attempting resolve the partition.
    serverCertificateThumbprints List<String>
    Thumbprints of certificates cluster management service uses for tls communication
    serverX509Names List<X509CertificateNameResponse>
    Server X509 Certificate Names Collection
    managementEndpoints string[]
    The cluster management endpoint.
    clientCertificateId string
    The client certificate id for the management endpoint.
    clientCertificatethumbprint string
    The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
    maxPartitionResolutionRetries number
    Maximum number of retries while attempting resolve the partition.
    serverCertificateThumbprints string[]
    Thumbprints of certificates cluster management service uses for tls communication
    serverX509Names X509CertificateNameResponse[]
    Server X509 Certificate Names Collection
    management_endpoints Sequence[str]
    The cluster management endpoint.
    client_certificate_id str
    The client certificate id for the management endpoint.
    client_certificatethumbprint str
    The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
    max_partition_resolution_retries int
    Maximum number of retries while attempting resolve the partition.
    server_certificate_thumbprints Sequence[str]
    Thumbprints of certificates cluster management service uses for tls communication
    server_x509_names Sequence[X509CertificateNameResponse]
    Server X509 Certificate Names Collection
    managementEndpoints List<String>
    The cluster management endpoint.
    clientCertificateId String
    The client certificate id for the management endpoint.
    clientCertificatethumbprint String
    The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
    maxPartitionResolutionRetries Number
    Maximum number of retries while attempting resolve the partition.
    serverCertificateThumbprints List<String>
    Thumbprints of certificates cluster management service uses for tls communication
    serverX509Names List<Property Map>
    Server X509 Certificate Names Collection

    BackendTlsProperties, BackendTlsPropertiesArgs

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

    BackendTlsPropertiesResponse, BackendTlsPropertiesResponseArgs

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

    X509CertificateName, X509CertificateNameArgs

    IssuerCertificateThumbprint string
    Thumbprint for the Issuer of the Certificate.
    Name string
    Common Name of the Certificate.
    IssuerCertificateThumbprint string
    Thumbprint for the Issuer of the Certificate.
    Name string
    Common Name of the Certificate.
    issuerCertificateThumbprint String
    Thumbprint for the Issuer of the Certificate.
    name String
    Common Name of the Certificate.
    issuerCertificateThumbprint string
    Thumbprint for the Issuer of the Certificate.
    name string
    Common Name of the Certificate.
    issuer_certificate_thumbprint str
    Thumbprint for the Issuer of the Certificate.
    name str
    Common Name of the Certificate.
    issuerCertificateThumbprint String
    Thumbprint for the Issuer of the Certificate.
    name String
    Common Name of the Certificate.

    X509CertificateNameResponse, X509CertificateNameResponseArgs

    IssuerCertificateThumbprint string
    Thumbprint for the Issuer of the Certificate.
    Name string
    Common Name of the Certificate.
    IssuerCertificateThumbprint string
    Thumbprint for the Issuer of the Certificate.
    Name string
    Common Name of the Certificate.
    issuerCertificateThumbprint String
    Thumbprint for the Issuer of the Certificate.
    name String
    Common Name of the Certificate.
    issuerCertificateThumbprint string
    Thumbprint for the Issuer of the Certificate.
    name string
    Common Name of the Certificate.
    issuer_certificate_thumbprint str
    Thumbprint for the Issuer of the Certificate.
    name str
    Common Name of the Certificate.
    issuerCertificateThumbprint String
    Thumbprint for the Issuer of the Certificate.
    name String
    Common Name of the Certificate.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:apimanagement:Backend sfbackend /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend

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

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native