Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. apimanagement
  5. getBackend
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.apimanagement.getBackend

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the details of the backend specified by its identifier. Azure REST API version: 2022-08-01.

Other available API versions: 2016-10-10, 2018-01-01, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.

Using getBackend

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getBackend(args: GetBackendArgs, opts?: InvokeOptions): Promise<GetBackendResult>
function getBackendOutput(args: GetBackendOutputArgs, opts?: InvokeOptions): Output<GetBackendResult>
Copy
def get_backend(backend_id: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                service_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetBackendResult
def get_backend_output(backend_id: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                service_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetBackendResult]
Copy
func LookupBackend(ctx *Context, args *LookupBackendArgs, opts ...InvokeOption) (*LookupBackendResult, error)
func LookupBackendOutput(ctx *Context, args *LookupBackendOutputArgs, opts ...InvokeOption) LookupBackendResultOutput
Copy

> Note: This function is named LookupBackend in the Go SDK.

public static class GetBackend 
{
    public static Task<GetBackendResult> InvokeAsync(GetBackendArgs args, InvokeOptions? opts = null)
    public static Output<GetBackendResult> Invoke(GetBackendInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBackendResult> getBackend(GetBackendArgs args, InvokeOptions options)
public static Output<GetBackendResult> getBackend(GetBackendArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getBackend
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BackendId
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the Backend entity. Must be unique in the current API Management service instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
BackendId
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the Backend entity. Must be unique in the current API Management service instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
backendId
This property is required.
Changes to this property will trigger replacement.
String
Identifier of the Backend entity. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
backendId
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the Backend entity. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
backend_id
This property is required.
Changes to this property will trigger replacement.
str
Identifier of the Backend entity. Must be unique in the current API Management service instance.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
backendId
This property is required.
Changes to this property will trigger replacement.
String
Identifier of the Backend entity. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.

getBackend Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Properties Pulumi.AzureNative.ApiManagement.Outputs.BackendPropertiesResponse
Backend Properties contract
Protocol string
Backend communication protocol.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Url string
Runtime Url of the Backend.
Credentials Pulumi.AzureNative.ApiManagement.Outputs.BackendCredentialsContractResponse
Backend Credentials Contract Properties
Description string
Backend Description.
Proxy Pulumi.AzureNative.ApiManagement.Outputs.BackendProxyContractResponse
Backend gateway 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.Outputs.BackendTlsPropertiesResponse
Backend TLS Properties
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Properties BackendPropertiesResponse
Backend Properties contract
Protocol string
Backend communication protocol.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Url string
Runtime Url of the Backend.
Credentials BackendCredentialsContractResponse
Backend Credentials Contract Properties
Description string
Backend Description.
Proxy BackendProxyContractResponse
Backend gateway 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 BackendTlsPropertiesResponse
Backend TLS Properties
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
properties BackendPropertiesResponse
Backend Properties contract
protocol String
Backend communication protocol.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
url String
Runtime Url of the Backend.
credentials BackendCredentialsContractResponse
Backend Credentials Contract Properties
description String
Backend Description.
proxy BackendProxyContractResponse
Backend gateway 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 BackendTlsPropertiesResponse
Backend TLS Properties
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
properties BackendPropertiesResponse
Backend Properties contract
protocol string
Backend communication protocol.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
url string
Runtime Url of the Backend.
credentials BackendCredentialsContractResponse
Backend Credentials Contract Properties
description string
Backend Description.
proxy BackendProxyContractResponse
Backend gateway 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 BackendTlsPropertiesResponse
Backend TLS Properties
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
properties BackendPropertiesResponse
Backend Properties contract
protocol str
Backend communication protocol.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
url str
Runtime Url of the Backend.
credentials BackendCredentialsContractResponse
Backend Credentials Contract Properties
description str
Backend Description.
proxy BackendProxyContractResponse
Backend gateway 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 BackendTlsPropertiesResponse
Backend TLS Properties
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
properties Property Map
Backend Properties contract
protocol String
Backend communication protocol.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
url String
Runtime Url of the Backend.
credentials Property Map
Backend Credentials Contract Properties
description String
Backend Description.
proxy Property Map
Backend gateway 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

Supporting Types

BackendAuthorizationHeaderCredentialsResponse

Parameter This property is required. string
Authentication Parameter value.
Scheme This property is required. string
Authentication Scheme name.
Parameter This property is required. string
Authentication Parameter value.
Scheme This property is required. string
Authentication Scheme name.
parameter This property is required. String
Authentication Parameter value.
scheme This property is required. String
Authentication Scheme name.
parameter This property is required. string
Authentication Parameter value.
scheme This property is required. string
Authentication Scheme name.
parameter This property is required. str
Authentication Parameter value.
scheme This property is required. str
Authentication Scheme name.
parameter This property is required. String
Authentication Parameter value.
scheme This property is required. String
Authentication Scheme name.

BackendCredentialsContractResponse

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.

BackendPropertiesResponse

serviceFabricCluster Property Map
Backend Service Fabric Cluster Properties

BackendProxyContractResponse

Url This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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

BackendServiceFabricClusterPropertiesResponse

ManagementEndpoints This property is required. 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 This property is required. []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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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

BackendTlsPropertiesResponse

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.

X509CertificateNameResponse

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.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native