1. Packages
  2. Azure Native
  3. API Docs
  4. app
  5. getHttpRouteConfig
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.app.getHttpRouteConfig

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Advanced Ingress routing for path/header based routing for a Container App Environment

Uses Azure REST API version 2024-10-02-preview.

Using getHttpRouteConfig

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 getHttpRouteConfig(args: GetHttpRouteConfigArgs, opts?: InvokeOptions): Promise<GetHttpRouteConfigResult>
function getHttpRouteConfigOutput(args: GetHttpRouteConfigOutputArgs, opts?: InvokeOptions): Output<GetHttpRouteConfigResult>
Copy
def get_http_route_config(environment_name: Optional[str] = None,
                          http_route_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetHttpRouteConfigResult
def get_http_route_config_output(environment_name: Optional[pulumi.Input[str]] = None,
                          http_route_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetHttpRouteConfigResult]
Copy
func LookupHttpRouteConfig(ctx *Context, args *LookupHttpRouteConfigArgs, opts ...InvokeOption) (*LookupHttpRouteConfigResult, error)
func LookupHttpRouteConfigOutput(ctx *Context, args *LookupHttpRouteConfigOutputArgs, opts ...InvokeOption) LookupHttpRouteConfigResultOutput
Copy

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

public static class GetHttpRouteConfig 
{
    public static Task<GetHttpRouteConfigResult> InvokeAsync(GetHttpRouteConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetHttpRouteConfigResult> Invoke(GetHttpRouteConfigInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetHttpRouteConfigResult> getHttpRouteConfig(GetHttpRouteConfigArgs args, InvokeOptions options)
public static Output<GetHttpRouteConfigResult> getHttpRouteConfig(GetHttpRouteConfigArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:app:getHttpRouteConfig
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EnvironmentName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Managed Environment.
HttpRouteName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Http Route Config Resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
EnvironmentName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Managed Environment.
HttpRouteName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Http Route Config Resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
environmentName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Managed Environment.
httpRouteName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Http Route Config Resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
environmentName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Managed Environment.
httpRouteName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Http Route Config Resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
environment_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Managed Environment.
http_route_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Http Route Config Resource.
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.
environmentName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Managed Environment.
httpRouteName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Http Route Config Resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getHttpRouteConfig Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
Properties Pulumi.AzureNative.App.Outputs.HttpRouteConfigResponseProperties
Http Route Config properties
SystemData Pulumi.AzureNative.App.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
Properties HttpRouteConfigResponseProperties
Http Route Config properties
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
properties HttpRouteConfigResponseProperties
Http Route Config properties
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name string
The name of the resource
properties HttpRouteConfigResponseProperties
Http Route Config properties
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name str
The name of the resource
properties HttpRouteConfigResponseProperties
Http Route Config properties
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
properties Property Map
Http Route Config properties
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

CustomDomainResponse

Name This property is required. string
Hostname.
BindingType string
Custom Domain binding type.
CertificateId string
Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment.
Name This property is required. string
Hostname.
BindingType string
Custom Domain binding type.
CertificateId string
Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment.
name This property is required. String
Hostname.
bindingType String
Custom Domain binding type.
certificateId String
Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment.
name This property is required. string
Hostname.
bindingType string
Custom Domain binding type.
certificateId string
Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment.
name This property is required. str
Hostname.
binding_type str
Custom Domain binding type.
certificate_id str
Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment.
name This property is required. String
Hostname.
bindingType String
Custom Domain binding type.
certificateId String
Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment.

HttpRouteActionResponse

PrefixRewrite string
Rewrite prefix, default is no rewrites
PrefixRewrite string
Rewrite prefix, default is no rewrites
prefixRewrite String
Rewrite prefix, default is no rewrites
prefixRewrite string
Rewrite prefix, default is no rewrites
prefix_rewrite str
Rewrite prefix, default is no rewrites
prefixRewrite String
Rewrite prefix, default is no rewrites

HttpRouteConfigResponseProperties

Fqdn This property is required. string
FQDN of the route resource.
ProvisioningErrors This property is required. List<Pulumi.AzureNative.App.Inputs.HttpRouteProvisioningErrorsResponse>
List of errors when trying to reconcile http routes
ProvisioningState This property is required. string
The provisioning state of the Http Route Config in cluster
CustomDomains List<Pulumi.AzureNative.App.Inputs.CustomDomainResponse>
Custom domain bindings for http Routes' hostnames.
Rules List<Pulumi.AzureNative.App.Inputs.HttpRouteRuleResponse>
Routing Rules for http route resource.
Fqdn This property is required. string
FQDN of the route resource.
ProvisioningErrors This property is required. []HttpRouteProvisioningErrorsResponse
List of errors when trying to reconcile http routes
ProvisioningState This property is required. string
The provisioning state of the Http Route Config in cluster
CustomDomains []CustomDomainResponse
Custom domain bindings for http Routes' hostnames.
Rules []HttpRouteRuleResponse
Routing Rules for http route resource.
fqdn This property is required. String
FQDN of the route resource.
provisioningErrors This property is required. List<HttpRouteProvisioningErrorsResponse>
List of errors when trying to reconcile http routes
provisioningState This property is required. String
The provisioning state of the Http Route Config in cluster
customDomains List<CustomDomainResponse>
Custom domain bindings for http Routes' hostnames.
rules List<HttpRouteRuleResponse>
Routing Rules for http route resource.
fqdn This property is required. string
FQDN of the route resource.
provisioningErrors This property is required. HttpRouteProvisioningErrorsResponse[]
List of errors when trying to reconcile http routes
provisioningState This property is required. string
The provisioning state of the Http Route Config in cluster
customDomains CustomDomainResponse[]
Custom domain bindings for http Routes' hostnames.
rules HttpRouteRuleResponse[]
Routing Rules for http route resource.
fqdn This property is required. str
FQDN of the route resource.
provisioning_errors This property is required. Sequence[HttpRouteProvisioningErrorsResponse]
List of errors when trying to reconcile http routes
provisioning_state This property is required. str
The provisioning state of the Http Route Config in cluster
custom_domains Sequence[CustomDomainResponse]
Custom domain bindings for http Routes' hostnames.
rules Sequence[HttpRouteRuleResponse]
Routing Rules for http route resource.
fqdn This property is required. String
FQDN of the route resource.
provisioningErrors This property is required. List<Property Map>
List of errors when trying to reconcile http routes
provisioningState This property is required. String
The provisioning state of the Http Route Config in cluster
customDomains List<Property Map>
Custom domain bindings for http Routes' hostnames.
rules List<Property Map>
Routing Rules for http route resource.

HttpRouteMatchResponse

CaseSensitive bool
path case sensitive, default is true
Path string
match on exact path
PathSeparatedPrefix string
match on all prefix's. Not exact
Prefix string
match on all prefix's. Not exact
CaseSensitive bool
path case sensitive, default is true
Path string
match on exact path
PathSeparatedPrefix string
match on all prefix's. Not exact
Prefix string
match on all prefix's. Not exact
caseSensitive Boolean
path case sensitive, default is true
path String
match on exact path
pathSeparatedPrefix String
match on all prefix's. Not exact
prefix String
match on all prefix's. Not exact
caseSensitive boolean
path case sensitive, default is true
path string
match on exact path
pathSeparatedPrefix string
match on all prefix's. Not exact
prefix string
match on all prefix's. Not exact
case_sensitive bool
path case sensitive, default is true
path str
match on exact path
path_separated_prefix str
match on all prefix's. Not exact
prefix str
match on all prefix's. Not exact
caseSensitive Boolean
path case sensitive, default is true
path String
match on exact path
pathSeparatedPrefix String
match on all prefix's. Not exact
prefix String
match on all prefix's. Not exact

HttpRouteProvisioningErrorsResponse

Message This property is required. string
Description or error message
Timestamp This property is required. string
Timestamp error occured at
Message This property is required. string
Description or error message
Timestamp This property is required. string
Timestamp error occured at
message This property is required. String
Description or error message
timestamp This property is required. String
Timestamp error occured at
message This property is required. string
Description or error message
timestamp This property is required. string
Timestamp error occured at
message This property is required. str
Description or error message
timestamp This property is required. str
Timestamp error occured at
message This property is required. String
Description or error message
timestamp This property is required. String
Timestamp error occured at

HttpRouteResponse

Action Pulumi.AzureNative.App.Inputs.HttpRouteActionResponse
Once route is matched, what is the desired action
Match Pulumi.AzureNative.App.Inputs.HttpRouteMatchResponse
Conditions route will match on
Action HttpRouteActionResponse
Once route is matched, what is the desired action
Match HttpRouteMatchResponse
Conditions route will match on
action HttpRouteActionResponse
Once route is matched, what is the desired action
match HttpRouteMatchResponse
Conditions route will match on
action HttpRouteActionResponse
Once route is matched, what is the desired action
match HttpRouteMatchResponse
Conditions route will match on
action HttpRouteActionResponse
Once route is matched, what is the desired action
match HttpRouteMatchResponse
Conditions route will match on
action Property Map
Once route is matched, what is the desired action
match Property Map
Conditions route will match on

HttpRouteRuleResponse

Description string
Description of rule. Optional.
Routes List<Pulumi.AzureNative.App.Inputs.HttpRouteResponse>
Routing configuration that will allow matches on specific paths/headers.
Targets List<Pulumi.AzureNative.App.Inputs.HttpRouteTargetResponse>
Targets- container apps, revisions, labels
Description string
Description of rule. Optional.
Routes []HttpRouteResponse
Routing configuration that will allow matches on specific paths/headers.
Targets []HttpRouteTargetResponse
Targets- container apps, revisions, labels
description String
Description of rule. Optional.
routes List<HttpRouteResponse>
Routing configuration that will allow matches on specific paths/headers.
targets List<HttpRouteTargetResponse>
Targets- container apps, revisions, labels
description string
Description of rule. Optional.
routes HttpRouteResponse[]
Routing configuration that will allow matches on specific paths/headers.
targets HttpRouteTargetResponse[]
Targets- container apps, revisions, labels
description str
Description of rule. Optional.
routes Sequence[HttpRouteResponse]
Routing configuration that will allow matches on specific paths/headers.
targets Sequence[HttpRouteTargetResponse]
Targets- container apps, revisions, labels
description String
Description of rule. Optional.
routes List<Property Map>
Routing configuration that will allow matches on specific paths/headers.
targets List<Property Map>
Targets- container apps, revisions, labels

HttpRouteTargetResponse

ContainerApp This property is required. string
Container App Name to route requests to
Label string
Label/Revision to route requests to
Revision string
Revision to route requests to
Weight int
Weighted routing
ContainerApp This property is required. string
Container App Name to route requests to
Label string
Label/Revision to route requests to
Revision string
Revision to route requests to
Weight int
Weighted routing
containerApp This property is required. String
Container App Name to route requests to
label String
Label/Revision to route requests to
revision String
Revision to route requests to
weight Integer
Weighted routing
containerApp This property is required. string
Container App Name to route requests to
label string
Label/Revision to route requests to
revision string
Revision to route requests to
weight number
Weighted routing
container_app This property is required. str
Container App Name to route requests to
label str
Label/Revision to route requests to
revision str
Revision to route requests to
weight int
Weighted routing
containerApp This property is required. String
Container App Name to route requests to
label String
Label/Revision to route requests to
revision String
Revision to route requests to
weight Number
Weighted routing

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi