Azure Native v3.3.0, Apr 28 25

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.3.0 published on Monday, Apr 28, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.cdn.getRoute

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.3.0 published on Monday, Apr 28, 2025 by Pulumi

pulumi/pulumi-azure-native

Using getRoute

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 getRoute(args: GetRouteArgs, opts?: InvokeOptions): Promise<GetRouteResult>
function getRouteOutput(args: GetRouteOutputArgs, opts?: InvokeOptions): Output<GetRouteResult>

def get_route(endpoint_name: Optional[str] = None,
              profile_name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              route_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetRouteResult
def get_route_output(endpoint_name: Optional[pulumi.Input[str]] = None,
              profile_name: Optional[pulumi.Input[str]] = None,
              resource_group_name: Optional[pulumi.Input[str]] = None,
              route_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetRouteResult]

func LookupRoute(ctx *Context, args *LookupRouteArgs, opts ...InvokeOption) (*LookupRouteResult, error)
func LookupRouteOutput(ctx *Context, args *LookupRouteOutputArgs, opts ...InvokeOption) LookupRouteResultOutput

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

public static class GetRoute 
{
    public static Task<GetRouteResult> InvokeAsync(GetRouteArgs args, InvokeOptions? opts = null)
    public static Output<GetRouteResult> Invoke(GetRouteInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRouteResult> getRoute(GetRouteArgs args, InvokeOptions options)
public static Output<GetRouteResult> getRoute(GetRouteArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:cdn:getRoute
  arguments:
    # arguments dictionary

The following arguments are supported:

EndpointName string: Name of the endpoint under the profile which is unique globally.
ProfileName string: Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
ResourceGroupName string: Name of the Resource group within the Azure subscription.
RouteName string: Name of the routing rule.

EndpointName string: Name of the endpoint under the profile which is unique globally.
ProfileName string: Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
ResourceGroupName string: Name of the Resource group within the Azure subscription.
RouteName string: Name of the routing rule.

endpointName String: Name of the endpoint under the profile which is unique globally.
profileName String: Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
resourceGroupName String: Name of the Resource group within the Azure subscription.
routeName String: Name of the routing rule.

endpointName string: Name of the endpoint under the profile which is unique globally.
profileName string: Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
resourceGroupName string: Name of the Resource group within the Azure subscription.
routeName string: Name of the routing rule.

endpoint_name str: Name of the endpoint under the profile which is unique globally.
profile_name str: Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
resource_group_name str: Name of the Resource group within the Azure subscription.
route_name str: Name of the routing rule.

endpointName String: Name of the endpoint under the profile which is unique globally.
profileName String: Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
resourceGroupName String: Name of the Resource group within the Azure subscription.
routeName String: Name of the routing rule.

getRoute Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
DeploymentStatus string
EndpointName string: The name of the endpoint which holds the route.
Id string: Resource ID.
Name string: Resource name.
OriginGroup Pulumi.AzureNative.Cdn.Outputs.ResourceReferenceResponse: A reference to the origin group.
ProvisioningState string: Provisioning status
SystemData Pulumi.AzureNative.Cdn.Outputs.SystemDataResponse: Read only system data
Type string: Resource type.
CacheConfiguration Pulumi.AzureNative.Cdn.Outputs.AfdRouteCacheConfigurationResponse: The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
CustomDomains List<Pulumi.AzureNative.Cdn.Outputs.ActivatedResourceReferenceResponse>: Domains referenced by this endpoint.
EnabledState string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
ForwardingProtocol string: Protocol this rule will use when forwarding traffic to backends.
HttpsRedirect string: Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.
LinkToDefaultDomain string: whether this route will be linked to the default endpoint domain.
OriginPath string: A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
PatternsToMatch List<string>: The route patterns of the rule.
RuleSets List<Pulumi.AzureNative.Cdn.Outputs.ResourceReferenceResponse>: rule sets referenced by this endpoint.
SupportedProtocols List<string>: List of supported protocols for this route.

AzureApiVersion string: The Azure API version of the resource.
DeploymentStatus string
EndpointName string: The name of the endpoint which holds the route.
Id string: Resource ID.
Name string: Resource name.
OriginGroup ResourceReferenceResponse: A reference to the origin group.
ProvisioningState string: Provisioning status
SystemData SystemDataResponse: Read only system data
Type string: Resource type.
CacheConfiguration AfdRouteCacheConfigurationResponse: The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
CustomDomains []ActivatedResourceReferenceResponse: Domains referenced by this endpoint.
EnabledState string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
ForwardingProtocol string: Protocol this rule will use when forwarding traffic to backends.
HttpsRedirect string: Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.
LinkToDefaultDomain string: whether this route will be linked to the default endpoint domain.
OriginPath string: A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
PatternsToMatch []string: The route patterns of the rule.
RuleSets []ResourceReferenceResponse: rule sets referenced by this endpoint.
SupportedProtocols []string: List of supported protocols for this route.

azureApiVersion String: The Azure API version of the resource.
deploymentStatus String
endpointName String: The name of the endpoint which holds the route.
id String: Resource ID.
name String: Resource name.
originGroup ResourceReferenceResponse: A reference to the origin group.
provisioningState String: Provisioning status
systemData SystemDataResponse: Read only system data
type String: Resource type.
cacheConfiguration AfdRouteCacheConfigurationResponse: The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
customDomains List<ActivatedResourceReferenceResponse>: Domains referenced by this endpoint.
enabledState String: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
forwardingProtocol String: Protocol this rule will use when forwarding traffic to backends.
httpsRedirect String: Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.
linkToDefaultDomain String: whether this route will be linked to the default endpoint domain.
originPath String: A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
patternsToMatch List<String>: The route patterns of the rule.
ruleSets List<ResourceReferenceResponse>: rule sets referenced by this endpoint.
supportedProtocols List<String>: List of supported protocols for this route.

azureApiVersion string: The Azure API version of the resource.
deploymentStatus string
endpointName string: The name of the endpoint which holds the route.
id string: Resource ID.
name string: Resource name.
originGroup ResourceReferenceResponse: A reference to the origin group.
provisioningState string: Provisioning status
systemData SystemDataResponse: Read only system data
type string: Resource type.
cacheConfiguration AfdRouteCacheConfigurationResponse: The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
customDomains ActivatedResourceReferenceResponse[]: Domains referenced by this endpoint.
enabledState string: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
forwardingProtocol string: Protocol this rule will use when forwarding traffic to backends.
httpsRedirect string: Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.
linkToDefaultDomain string: whether this route will be linked to the default endpoint domain.
originPath string: A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
patternsToMatch string[]: The route patterns of the rule.
ruleSets ResourceReferenceResponse[]: rule sets referenced by this endpoint.
supportedProtocols string[]: List of supported protocols for this route.

azure_api_version str: The Azure API version of the resource.
deployment_status str
endpoint_name str: The name of the endpoint which holds the route.
id str: Resource ID.
name str: Resource name.
origin_group ResourceReferenceResponse: A reference to the origin group.
provisioning_state str: Provisioning status
system_data SystemDataResponse: Read only system data
type str: Resource type.
cache_configuration AfdRouteCacheConfigurationResponse: The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
custom_domains Sequence[ActivatedResourceReferenceResponse]: Domains referenced by this endpoint.
enabled_state str: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
forwarding_protocol str: Protocol this rule will use when forwarding traffic to backends.
https_redirect str: Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.
link_to_default_domain str: whether this route will be linked to the default endpoint domain.
origin_path str: A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
patterns_to_match Sequence[str]: The route patterns of the rule.
rule_sets Sequence[ResourceReferenceResponse]: rule sets referenced by this endpoint.
supported_protocols Sequence[str]: List of supported protocols for this route.

azureApiVersion String: The Azure API version of the resource.
deploymentStatus String
endpointName String: The name of the endpoint which holds the route.
id String: Resource ID.
name String: Resource name.
originGroup Property Map: A reference to the origin group.
provisioningState String: Provisioning status
systemData Property Map: Read only system data
type String: Resource type.
cacheConfiguration Property Map: The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
customDomains List<Property Map>: Domains referenced by this endpoint.
enabledState String: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
forwardingProtocol String: Protocol this rule will use when forwarding traffic to backends.
httpsRedirect String: Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.
linkToDefaultDomain String: whether this route will be linked to the default endpoint domain.
originPath String: A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
patternsToMatch List<String>: The route patterns of the rule.
ruleSets List<Property Map>: rule sets referenced by this endpoint.
supportedProtocols List<String>: List of supported protocols for this route.

Supporting Types

ActivatedResourceReferenceResponse

IsActive bool: Whether the resource is active or inactive
Id string: Resource ID.

IsActive bool: Whether the resource is active or inactive
Id string: Resource ID.

isActive Boolean: Whether the resource is active or inactive
id String: Resource ID.

isActive boolean: Whether the resource is active or inactive
id string: Resource ID.

is_active bool: Whether the resource is active or inactive
id str: Resource ID.

isActive Boolean: Whether the resource is active or inactive
id String: Resource ID.

AfdRouteCacheConfigurationResponse

CompressionSettings Pulumi.AzureNative.Cdn.Inputs.CompressionSettingsResponse: compression settings.
QueryParameters string: query parameters to include or exclude (comma separated).
QueryStringCachingBehavior string: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.

CompressionSettings CompressionSettingsResponse: compression settings.
QueryParameters string: query parameters to include or exclude (comma separated).
QueryStringCachingBehavior string: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.

compressionSettings CompressionSettingsResponse: compression settings.
queryParameters String: query parameters to include or exclude (comma separated).
queryStringCachingBehavior String: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.

compressionSettings CompressionSettingsResponse: compression settings.
queryParameters string: query parameters to include or exclude (comma separated).
queryStringCachingBehavior string: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.

compression_settings CompressionSettingsResponse: compression settings.
query_parameters str: query parameters to include or exclude (comma separated).
query_string_caching_behavior str: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.

compressionSettings Property Map: compression settings.
queryParameters String: query parameters to include or exclude (comma separated).
queryStringCachingBehavior String: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.

CompressionSettingsResponse

ContentTypesToCompress List<string>: List of content types on which compression applies. The value should be a valid MIME type.
IsCompressionEnabled bool: Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.

ContentTypesToCompress []string: List of content types on which compression applies. The value should be a valid MIME type.
IsCompressionEnabled bool: Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.

contentTypesToCompress List<String>: List of content types on which compression applies. The value should be a valid MIME type.
isCompressionEnabled Boolean: Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.

contentTypesToCompress string[]: List of content types on which compression applies. The value should be a valid MIME type.
isCompressionEnabled boolean: Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.

content_types_to_compress Sequence[str]: List of content types on which compression applies. The value should be a valid MIME type.
is_compression_enabled bool: Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.

contentTypesToCompress List<String>: List of content types on which compression applies. The value should be a valid MIME type.
isCompressionEnabled Boolean: Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.

ResourceReferenceResponse

Id string: Resource ID.

Id string: Resource ID.

id String: Resource ID.

id string: Resource ID.

id str: Resource ID.

id String: Resource ID.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC)
CreatedBy string: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for 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: An identifier for 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.3.0 published on Monday, Apr 28, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.cdn.getRoute

On this page

On this page

Using getRoute

getRoute Result

Supporting Types

ActivatedResourceReferenceResponse

AfdRouteCacheConfigurationResponse

CompressionSettingsResponse

ResourceReferenceResponse

SystemDataResponse

Package Details

On this page

On this page