pulumi-azure-kotlin/com.pulumi.azure.apimanagement.kotlin/BackendArgs

BackendArgs

data class BackendArgs(val apiManagementName: Output<String>? = null, val credentials: Output<BackendCredentialsArgs>? = null, val description: Output<String>? = null, val name: Output<String>? = null, val protocol: Output<String>? = null, val proxy: Output<BackendProxyArgs>? = null, val resourceGroupName: Output<String>? = null, val resourceId: Output<String>? = null, val serviceFabricCluster: Output<BackendServiceFabricClusterArgs>? = null, val title: Output<String>? = null, val tls: Output<BackendTlsArgs>? = null, val url: Output<String>? = null) : ConvertibleToJava<BackendArgs>

Manages a backend within an API Management Service.

Example Usage

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

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

Constructors

BackendArgs

fun BackendArgs(apiManagementName: Output<String>? = null, credentials: Output<BackendCredentialsArgs>? = null, description: Output<String>? = null, name: Output<String>? = null, protocol: Output<String>? = null, proxy: Output<BackendProxyArgs>? = null, resourceGroupName: Output<String>? = null, resourceId: Output<String>? = null, serviceFabricCluster: Output<BackendServiceFabricClusterArgs>? = null, title: Output<String>? = null, tls: Output<BackendTlsArgs>? = null, url: Output<String>? = null)

Functions

toJava

open override fun toJava(): BackendArgs

Properties

apiManagementName

val apiManagementName: Output<String>? = null

The Name of the API Management Service where this backend should be created. Changing this forces a new resource to be created.

credentials

val credentials: Output<BackendCredentialsArgs>? = null

A credentials block as documented below.

description

val description: Output<String>? = null

The description of the backend.

name

val name: Output<String>? = null

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

protocol

val protocol: Output<String>? = null

The protocol used by the backend host. Possible values are http or soap.

proxy

val proxy: Output<BackendProxyArgs>? = null

A proxy block as documented below.

resourceGroupName

val resourceGroupName: Output<String>? = null

The Name of the Resource Group where the API Management Service exists. Changing this forces a new resource to be created.

resourceId

val resourceId: Output<String>? = null

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

val serviceFabricCluster: Output<BackendServiceFabricClusterArgs>? = null

A service_fabric_cluster block as documented below.

title

val title: Output<String>? = null

The title of the backend.

tls

val tls: Output<BackendTlsArgs>? = null

A tls block as documented below.

url

val url: Output<String>? = null

The URL of the backend host.