Backend

Manages a backend within an API Management Service.

Create a Backend Resource

new Backend(name: string, args: BackendArgs, opts?: CustomResourceOptions);

def Backend(resource_name, opts=None, api_management_name=None, credentials=None, description=None, name=None, protocol=None, proxy=None, resource_group_name=None, resource_id=None, service_fabric_cluster=None, title=None, tls=None, url=None, __props__=None);

func NewBackend(ctx *Context, name string, args BackendArgs, opts ...ResourceOption) (*Backend, error)

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

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.
opts ResourceOptions: A bag of options that control this 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.

Backend Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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 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 Dict[BackendCredentials]: 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 Dict[BackendProxy]: 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 Dict[BackendServiceFabricCluster]: A service_fabric_cluster block as documented below.
title str: The title of the backend.
tls Dict[BackendTls]: 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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, api_management_name=None, credentials=None, description=None, name=None, protocol=None, proxy=None, resource_group_name=None, resource_id=None, service_fabric_cluster=None, title=None, tls=None, url=None, __props__=None);

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)

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.

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 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 Dict[BackendCredentials]: 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 Dict[BackendProxy]: 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 Dict[BackendServiceFabricCluster]: A service_fabric_cluster block as documented below.
title str: The title of the backend.
tls Dict[BackendTls]: A tls block as documented below.
url str: The URL of the backend host.

Supporting Types

BackendCredentials

See the input and output API doc for this type.

Authorization BackendCredentialsAuthorizationArgs: 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 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 Dict[BackendCredentialsAuthorization]: An authorization block as defined below.
certificates List[str]: A list of client certificate thumbprints to present to the backend host. The certificates must exist within the API Management Service.
header Dict[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 Dict[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.

BackendCredentialsAuthorization

See the input and output API doc for this type.

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.

BackendProxy

See the input and output API doc for this type.

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.

BackendServiceFabricCluster

See the input and output API doc for this type.

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

ClientCertificateThumbprint string: The client certificate thumbprint for the management endpoint.
ManagementEndpoints []string: A list of cluster management endpoints.
MaxPartitionResolutionRetries int: The maximum number of retries when attempting resolve the partition.
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.

clientCertificateThumbprint string: The client certificate thumbprint for the management endpoint.
managementEndpoints string[]: A list of cluster management endpoints.
maxPartitionResolutionRetries number: The maximum number of retries when attempting resolve the partition.
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.

clientCertificateThumbprint str: The client certificate thumbprint for the management endpoint.
managementEndpoints List[str]: A list of cluster management endpoints.
maxPartitionResolutionRetries float: The maximum number of retries when attempting resolve the partition.
serverCertificateThumbprints List[str]: 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.

BackendServiceFabricClusterServerX509Name

See the input and output API doc for this type.

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 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.

BackendTls

See the input and output API doc for this type.

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 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.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Backend

Create a Backend Resource

Backend Resource Properties

Inputs

Outputs

Look up an Existing Backend Resource

Supporting Types

BackendCredentials

BackendCredentialsAuthorization

BackendProxy

BackendServiceFabricCluster

BackendServiceFabricClusterServerX509Name

BackendTls

Package Details

On This Page