Class Backend

Manages a backend within an API Management Service.

Inheritance

System.Object

Resource

CustomResource

Backend

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.ApiManagement

Assembly: Pulumi.Azure.dll

Syntax

public class Backend : CustomResource

Constructors

Backend(String, BackendArgs, CustomResourceOptions)

Create a Backend resource with the given unique name, arguments, and options.

Declaration

public Backend(string name, BackendArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
BackendArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ApiManagementName

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

Declaration

public Output<string> ApiManagementName { get; }

Property Value

Type	Description
Output<System.String>

Credentials

A credentials block as documented below.

Declaration

public Output<BackendCredentials> Credentials { get; }

Property Value

Type	Description
Output<BackendCredentials>

Description

The description of the backend.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Name

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

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Protocol

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

Declaration

public Output<string> Protocol { get; }

Property Value

Type	Description
Output<System.String>

Proxy

A proxy block as documented below.

Declaration

public Output<BackendProxy> Proxy { get; }

Property Value

Type	Description
Output<BackendProxy>

ResourceGroupName

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

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

ResourceId

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.

Declaration

public Output<string> ResourceId { get; }

Property Value

Type	Description
Output<System.String>

ServiceFabricCluster

A service_fabric_cluster block as documented below.

Declaration

public Output<BackendServiceFabricCluster> ServiceFabricCluster { get; }

Property Value

Type	Description
Output<BackendServiceFabricCluster>

Title

The title of the backend.

Declaration

public Output<string> Title { get; }

Property Value

Type	Description
Output<System.String>

Tls

A tls block as documented below.

Declaration

public Output<BackendTls> Tls { get; }

Property Value

Type	Description
Output<BackendTls>

Url

The URL of the backend host.

Declaration

public Output<string> Url { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, BackendState, CustomResourceOptions)

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

Declaration

public static Backend Get(string name, Input<string> id, BackendState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
BackendState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Backend