azure-native.apimanagement.getBackend
Explore with Pulumi AI
Gets the details of the backend specified by its identifier.
Uses Azure REST API version 2022-09-01-preview.
Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]
. See the version guide for details.
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)
public static Output<GetBackendResult> getBackend(GetBackendArgs args, InvokeOptions options)
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. The name is case insensitive.
- 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. The name is case insensitive.
- 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. The name is case insensitive.
- 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. The name is case insensitive.
- 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. The name is case insensitive.
- 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. The name is case insensitive.
- service
Name String - The name of the API Management service.
getBackend Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- 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.
Azure Native. Api Management. Outputs. Backend Properties Response - 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.
- Circuit
Breaker Pulumi.Azure Native. Api Management. Outputs. Backend Circuit Breaker Response - Backend Circuit Breaker Configuration
- 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 gateway 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
- Azure
Api stringVersion - The Azure API version of the resource.
- 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
Backend
Properties Response - 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.
- Circuit
Breaker BackendCircuit Breaker Response - Backend Circuit Breaker Configuration
- Credentials
Backend
Credentials Contract Response - Backend Credentials Contract Properties
- Description string
- Backend Description.
- Proxy
Backend
Proxy Contract Response - Backend gateway 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
- azure
Api StringVersion - The Azure API version of the resource.
- 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
Backend
Properties Response - 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.
- circuit
Breaker BackendCircuit Breaker Response - Backend Circuit Breaker Configuration
- credentials
Backend
Credentials Contract Response - Backend Credentials Contract Properties
- description String
- Backend Description.
- proxy
Backend
Proxy Contract Response - Backend gateway 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
- azure
Api stringVersion - The Azure API version of the resource.
- 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
Backend
Properties Response - 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.
- circuit
Breaker BackendCircuit Breaker Response - Backend Circuit Breaker Configuration
- credentials
Backend
Credentials Contract Response - Backend Credentials Contract Properties
- description string
- Backend Description.
- proxy
Backend
Proxy Contract Response - Backend gateway 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
- azure_
api_ strversion - The Azure API version of the resource.
- 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
Backend
Properties Response - 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.
- circuit_
breaker BackendCircuit Breaker Response - Backend Circuit Breaker Configuration
- credentials
Backend
Credentials Contract Response - Backend Credentials Contract Properties
- description str
- Backend Description.
- proxy
Backend
Proxy Contract Response - 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
Backend
Tls Properties Response - Backend TLS Properties
- azure
Api StringVersion - The Azure API version of the resource.
- 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.
- circuit
Breaker Property Map - Backend Circuit Breaker Configuration
- credentials Property Map
- Backend Credentials Contract Properties
- description String
- Backend Description.
- proxy Property Map
- Backend gateway 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
BackendCircuitBreakerResponse
- Rules
List<Pulumi.
Azure Native. Api Management. Inputs. Circuit Breaker Rule Response> - The rules for tripping the backend.
- Rules
[]Circuit
Breaker Rule Response - The rules for tripping the backend.
- rules
List<Circuit
Breaker Rule Response> - The rules for tripping the backend.
- rules
Circuit
Breaker Rule Response[] - The rules for tripping the backend.
- rules
Sequence[Circuit
Breaker Rule Response] - The rules for tripping the backend.
- rules List<Property Map>
- The rules for tripping the backend.
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.
CircuitBreakerFailureConditionResponse
- Count double
- The threshold for opening the circuit.
- Error
Reasons List<string> - The error reasons which are considered as failure.
- Interval string
- The interval during which the failures are counted.
- Percentage double
- The threshold for opening the circuit.
- Status
Code List<Pulumi.Ranges Azure Native. Api Management. Inputs. Failure Status Code Range Response> - The status code ranges which are considered as failure.
- Count float64
- The threshold for opening the circuit.
- Error
Reasons []string - The error reasons which are considered as failure.
- Interval string
- The interval during which the failures are counted.
- Percentage float64
- The threshold for opening the circuit.
- Status
Code []FailureRanges Status Code Range Response - The status code ranges which are considered as failure.
- count Double
- The threshold for opening the circuit.
- error
Reasons List<String> - The error reasons which are considered as failure.
- interval String
- The interval during which the failures are counted.
- percentage Double
- The threshold for opening the circuit.
- status
Code List<FailureRanges Status Code Range Response> - The status code ranges which are considered as failure.
- count number
- The threshold for opening the circuit.
- error
Reasons string[] - The error reasons which are considered as failure.
- interval string
- The interval during which the failures are counted.
- percentage number
- The threshold for opening the circuit.
- status
Code FailureRanges Status Code Range Response[] - The status code ranges which are considered as failure.
- count float
- The threshold for opening the circuit.
- error_
reasons Sequence[str] - The error reasons which are considered as failure.
- interval str
- The interval during which the failures are counted.
- percentage float
- The threshold for opening the circuit.
- status_
code_ Sequence[Failureranges Status Code Range Response] - The status code ranges which are considered as failure.
- count Number
- The threshold for opening the circuit.
- error
Reasons List<String> - The error reasons which are considered as failure.
- interval String
- The interval during which the failures are counted.
- percentage Number
- The threshold for opening the circuit.
- status
Code List<Property Map>Ranges - The status code ranges which are considered as failure.
CircuitBreakerRuleResponse
- Accept
Retry boolAfter - flag to accept Retry-After header from the backend.
- Failure
Condition Pulumi.Azure Native. Api Management. Inputs. Circuit Breaker Failure Condition Response - The conditions for tripping the circuit breaker.
- Name string
- The rule name.
- Trip
Duration string - The duration for which the circuit will be tripped.
- Accept
Retry boolAfter - flag to accept Retry-After header from the backend.
- Failure
Condition CircuitBreaker Failure Condition Response - The conditions for tripping the circuit breaker.
- Name string
- The rule name.
- Trip
Duration string - The duration for which the circuit will be tripped.
- accept
Retry BooleanAfter - flag to accept Retry-After header from the backend.
- failure
Condition CircuitBreaker Failure Condition Response - The conditions for tripping the circuit breaker.
- name String
- The rule name.
- trip
Duration String - The duration for which the circuit will be tripped.
- accept
Retry booleanAfter - flag to accept Retry-After header from the backend.
- failure
Condition CircuitBreaker Failure Condition Response - The conditions for tripping the circuit breaker.
- name string
- The rule name.
- trip
Duration string - The duration for which the circuit will be tripped.
- accept_
retry_ boolafter - flag to accept Retry-After header from the backend.
- failure_
condition CircuitBreaker Failure Condition Response - The conditions for tripping the circuit breaker.
- name str
- The rule name.
- trip_
duration str - The duration for which the circuit will be tripped.
- accept
Retry BooleanAfter - flag to accept Retry-After header from the backend.
- failure
Condition Property Map - The conditions for tripping the circuit breaker.
- name String
- The rule name.
- trip
Duration String - The duration for which the circuit will be tripped.
FailureStatusCodeRangeResponse
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