Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

getBackend

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

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>
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]
func LookupBackend(ctx *Context, args *LookupBackendArgs, opts ...InvokeOption) (*LookupBackendResult, error)
func LookupBackendOutput(ctx *Context, args *LookupBackendOutputArgs, opts ...InvokeOption) LookupBackendResultOutput

> 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)
}
public static CompletableFuture<GetBackendResult> getBackend(GetBackendArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:apimanagement:getBackend
  Arguments:
    # Arguments dictionary

The following arguments are supported:

BackendId string

Identifier of the Backend entity. Must be unique in the current API Management service instance.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

BackendId string

Identifier of the Backend entity. Must be unique in the current API Management service instance.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

backendId String

Identifier of the Backend entity. Must be unique in the current API Management service instance.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

backendId string

Identifier of the Backend entity. Must be unique in the current API Management service instance.

resourceGroupName string

The name of the resource group.

serviceName string

The name of the API Management service.

backend_id str

Identifier of the Backend entity. Must be unique in the current API Management service instance.

resource_group_name str

The name of the resource group.

service_name str

The name of the API Management service.

backendId String

Identifier of the Backend entity. Must be unique in the current API Management service instance.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

getBackend Result

The following output properties are available:

Id string

Resource ID.

Name string

Resource name.

Properties Pulumi.AzureNative.ApiManagement.Outputs.BackendPropertiesResponse

Backend Properties contract

Protocol string

Backend communication protocol.

Type string

Resource type for API Management resource.

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

Backend TLS Properties

Id string

Resource ID.

Name string

Resource name.

Properties BackendPropertiesResponse

Backend Properties contract

Protocol string

Backend communication protocol.

Type string

Resource type for API Management resource.

Url string

Runtime Url of the Backend.

Credentials BackendCredentialsContractResponse

Backend Credentials Contract Properties

Description string

Backend Description.

Proxy BackendProxyContractResponse

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 BackendTlsPropertiesResponse

Backend TLS Properties

id String

Resource ID.

name String

Resource name.

properties BackendPropertiesResponse

Backend Properties contract

protocol String

Backend communication protocol.

type String

Resource type for API Management resource.

url String

Runtime Url of the Backend.

credentials BackendCredentialsContractResponse

Backend Credentials Contract Properties

description String

Backend Description.

proxy BackendProxyContractResponse

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 BackendTlsPropertiesResponse

Backend TLS Properties

id string

Resource ID.

name string

Resource name.

properties BackendPropertiesResponse

Backend Properties contract

protocol string

Backend communication protocol.

type string

Resource type for API Management resource.

url string

Runtime Url of the Backend.

credentials BackendCredentialsContractResponse

Backend Credentials Contract Properties

description string

Backend Description.

proxy BackendProxyContractResponse

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 BackendTlsPropertiesResponse

Backend TLS Properties

id str

Resource ID.

name str

Resource name.

properties BackendPropertiesResponse

Backend Properties contract

protocol str

Backend communication protocol.

type str

Resource type for API Management resource.

url str

Runtime Url of the Backend.

credentials BackendCredentialsContractResponse

Backend Credentials Contract Properties

description str

Backend Description.

proxy BackendProxyContractResponse

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 BackendTlsPropertiesResponse

Backend TLS Properties

id String

Resource ID.

name String

Resource name.

properties Property Map

Backend Properties contract

protocol String

Backend communication protocol.

type String

Resource type for API Management resource.

url String

Runtime Url of the Backend.

credentials Property Map

Backend Credentials Contract Properties

description String

Backend Description.

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

Supporting Types

BackendAuthorizationHeaderCredentialsResponse

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.

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

List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.

certificateIds List

List of Client Certificate Ids.

header Map>

Header Parameter description.

query Map>

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

List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.

certificateIds List

List of Client Certificate Ids.

header Map>

Header Parameter description.

query Map>

Query Parameter description.

BackendPropertiesResponse

serviceFabricCluster Property Map

Backend Service Fabric Cluster Properties

BackendProxyContractResponse

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

BackendServiceFabricClusterPropertiesResponse

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

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

Thumbprints of certificates cluster management service uses for tls communication

serverX509Names ListNameResponse>

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

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

Thumbprints of certificates cluster management service uses for tls communication

serverX509Names List

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
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0