azure-native.apimanagement.getBackend
Explore with Pulumi AI
Gets the details of the backend specified by its identifier. 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:
- Backend
Id string Identifier of the Backend entity. Must be unique in the current API Management service instance.
- Resource
Group stringName The name of the resource group.
- Service
Name string The name of the API Management service.
- Backend
Id string Identifier of the Backend entity. Must be unique in the current API Management service instance.
- Resource
Group stringName The name of the resource group.
- Service
Name string The name of the API Management service.
- backend
Id String Identifier of the Backend entity. Must be unique in the current API Management service instance.
- resource
Group StringName The name of the resource group.
- service
Name String The name of the API Management service.
- backend
Id string Identifier of the Backend entity. Must be unique in the current API Management service instance.
- resource
Group stringName The name of the resource group.
- service
Name 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_ strname The name of the resource group.
- service_
name str The name of the API Management service.
- backend
Id String Identifier of the Backend entity. Must be unique in the current API Management service instance.
- resource
Group StringName The name of the resource group.
- service
Name 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.
Azure Native. Api Management. Outputs. Backend Properties Response 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.
Azure Native. Api Management. Outputs. Backend Credentials Contract Response Backend Credentials Contract Properties
- Description string
Backend Description.
- Proxy
Pulumi.
Azure Native. Api Management. Outputs. Backend Proxy Contract Response Backend Proxy Contract Properties
- Resource
Id 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.
Azure Native. Api Management. Outputs. Backend Tls Properties Response Backend TLS Properties
- Id string
Resource ID.
- Name string
Resource name.
- Properties
Backend
Properties Response Backend Properties contract
- Protocol string
Backend communication protocol.
- Type string
Resource type for API Management resource.
- Url string
Runtime Url of the Backend.
- Credentials
Backend
Credentials Contract Response Backend Credentials Contract Properties
- Description string
Backend Description.
- Proxy
Backend
Proxy Contract Response Backend Proxy Contract Properties
- Resource
Id 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
Backend
Tls Properties Response Backend TLS Properties
- id String
Resource ID.
- name String
Resource name.
- properties
Backend
Properties Response Backend Properties contract
- protocol String
Backend communication protocol.
- type String
Resource type for API Management resource.
- url String
Runtime Url of the Backend.
- credentials
Backend
Credentials Contract Response Backend Credentials Contract Properties
- description String
Backend Description.
- proxy
Backend
Proxy Contract Response Backend Proxy Contract Properties
- resource
Id 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
Backend
Tls Properties Response Backend TLS Properties
- id string
Resource ID.
- name string
Resource name.
- properties
Backend
Properties Response Backend Properties contract
- protocol string
Backend communication protocol.
- type string
Resource type for API Management resource.
- url string
Runtime Url of the Backend.
- credentials
Backend
Credentials Contract Response Backend Credentials Contract Properties
- description string
Backend Description.
- proxy
Backend
Proxy Contract Response Backend Proxy Contract Properties
- resource
Id 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
Backend
Tls Properties Response Backend TLS Properties
- id str
Resource ID.
- name str
Resource name.
- properties
Backend
Properties Response Backend Properties contract
- protocol str
Backend communication protocol.
- type str
Resource type for API Management resource.
- url str
Runtime Url of the Backend.
- credentials
Backend
Credentials Contract Response Backend Credentials Contract Properties
- description str
Backend Description.
- proxy
Backend
Proxy Contract Response 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
Backend
Tls Properties Response 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
- resource
Id 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
BackendCredentialsContractResponse
- Pulumi.
Azure Native. Api Management. Inputs. Backend Authorization Header Credentials Response Authorization header authentication
- Certificate List<string>
List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
- Certificate
Ids List<string> List of Client Certificate Ids.
- Header
Dictionary<string, Immutable
Array<string>> Header Parameter description.
- Query
Dictionary<string, Immutable
Array<string>> Query Parameter description.
- Backend
Authorization Header Credentials Response Authorization header authentication
- Certificate []string
List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
- Certificate
Ids []string List of Client Certificate Ids.
- Header map[string][]string
Header Parameter description.
- Query map[string][]string
Query Parameter description.
- Backend
Authorization Header Credentials Response Authorization header authentication
- certificate List<String>
List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
- certificate
Ids List<String> List of Client Certificate Ids.
- header Map<String,List<String>>
Header Parameter description.
- query Map<String,List<String>>
Query Parameter description.
- Backend
Authorization Header Credentials Response Authorization header authentication
- certificate string[]
List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
- certificate
Ids string[] List of Client Certificate Ids.
- header {[key: string]: string[]}
Header Parameter description.
- query {[key: string]: string[]}
Query Parameter description.
- Backend
Authorization Header Credentials Response 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.
- Property Map
Authorization header authentication
- certificate List<String>
List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
- certificate
Ids List<String> List of Client Certificate Ids.
- header Map<List<String>>
Header Parameter description.
- query Map<List<String>>
Query Parameter description.
BackendPropertiesResponse
- Service
Fabric Pulumi.Cluster Azure Native. Api Management. Inputs. Backend Service Fabric Cluster Properties Response Backend Service Fabric Cluster Properties
- Service
Fabric BackendCluster Service Fabric Cluster Properties Response Backend Service Fabric Cluster Properties
- service
Fabric BackendCluster Service Fabric Cluster Properties Response Backend Service Fabric Cluster Properties
- service
Fabric BackendCluster Service Fabric Cluster Properties Response Backend Service Fabric Cluster Properties
- service_
fabric_ Backendcluster Service Fabric Cluster Properties Response Backend Service Fabric Cluster Properties
- service
Fabric Property MapCluster Backend Service Fabric Cluster Properties
BackendProxyContractResponse
BackendServiceFabricClusterPropertiesResponse
- Management
Endpoints List<string> The cluster management endpoint.
- Client
Certificate stringId The client certificate id for the management endpoint.
- Client
Certificatethumbprint string The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
- Max
Partition intResolution Retries Maximum number of retries while attempting resolve the partition.
- Server
Certificate List<string>Thumbprints Thumbprints of certificates cluster management service uses for tls communication
- Server
X509Names List<Pulumi.Azure Native. Api Management. Inputs. X509Certificate Name Response> Server X509 Certificate Names Collection
- Management
Endpoints []string The cluster management endpoint.
- Client
Certificate stringId The client certificate id for the management endpoint.
- Client
Certificatethumbprint string The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
- Max
Partition intResolution Retries Maximum number of retries while attempting resolve the partition.
- Server
Certificate []stringThumbprints Thumbprints of certificates cluster management service uses for tls communication
- Server
X509Names []X509CertificateName Response Server X509 Certificate Names Collection
- management
Endpoints List<String> The cluster management endpoint.
- client
Certificate StringId The client certificate id for the management endpoint.
- client
Certificatethumbprint String The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
- max
Partition IntegerResolution Retries Maximum number of retries while attempting resolve the partition.
- server
Certificate List<String>Thumbprints Thumbprints of certificates cluster management service uses for tls communication
- server
X509Names List<X509CertificateName Response> Server X509 Certificate Names Collection
- management
Endpoints string[] The cluster management endpoint.
- client
Certificate stringId The client certificate id for the management endpoint.
- client
Certificatethumbprint string The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
- max
Partition numberResolution Retries Maximum number of retries while attempting resolve the partition.
- server
Certificate string[]Thumbprints Thumbprints of certificates cluster management service uses for tls communication
- server
X509Names X509CertificateName Response[] Server X509 Certificate Names Collection
- management_
endpoints Sequence[str] The cluster management endpoint.
- client_
certificate_ strid 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_ intresolution_ retries Maximum number of retries while attempting resolve the partition.
- server_
certificate_ Sequence[str]thumbprints Thumbprints of certificates cluster management service uses for tls communication
- server_
x509_ Sequence[X509Certificatenames Name Response] Server X509 Certificate Names Collection
- management
Endpoints List<String> The cluster management endpoint.
- client
Certificate StringId The client certificate id for the management endpoint.
- client
Certificatethumbprint String The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
- max
Partition NumberResolution Retries Maximum number of retries while attempting resolve the partition.
- server
Certificate List<String>Thumbprints Thumbprints of certificates cluster management service uses for tls communication
- server
X509Names List<Property Map> Server X509 Certificate Names Collection
BackendTlsPropertiesResponse
- Validate
Certificate boolChain Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- Validate
Certificate boolName Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
- Validate
Certificate boolChain Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- Validate
Certificate boolName Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
- validate
Certificate BooleanChain Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- validate
Certificate BooleanName Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
- validate
Certificate booleanChain Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- validate
Certificate booleanName Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
- validate_
certificate_ boolchain Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- validate_
certificate_ boolname Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
- validate
Certificate BooleanChain Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- validate
Certificate BooleanName Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
X509CertificateNameResponse
- Issuer
Certificate stringThumbprint Thumbprint for the Issuer of the Certificate.
- Name string
Common Name of the Certificate.
- Issuer
Certificate stringThumbprint Thumbprint for the Issuer of the Certificate.
- Name string
Common Name of the Certificate.
- issuer
Certificate StringThumbprint Thumbprint for the Issuer of the Certificate.
- name String
Common Name of the Certificate.
- issuer
Certificate stringThumbprint Thumbprint for the Issuer of the Certificate.
- name string
Common Name of the Certificate.
- issuer_
certificate_ strthumbprint Thumbprint for the Issuer of the Certificate.
- name str
Common Name of the Certificate.
- issuer
Certificate StringThumbprint Thumbprint for the Issuer of the Certificate.
- name String
Common Name of the Certificate.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0