azure-native.cdn.getRoute
Explore with Pulumi AI
Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint. Azure REST API version: 2023-05-01.
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:cdn:getRoute
arguments:
# arguments dictionary
The following arguments are supported:
- Endpoint
Name string Name of the endpoint under the profile which is unique globally.
- Profile
Name string Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
- Resource
Group stringName Name of the Resource group within the Azure subscription.
- Route
Name string Name of the routing rule.
- Endpoint
Name string Name of the endpoint under the profile which is unique globally.
- Profile
Name string Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
- Resource
Group stringName Name of the Resource group within the Azure subscription.
- Route
Name string Name of the routing rule.
- endpoint
Name String Name of the endpoint under the profile which is unique globally.
- profile
Name String Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
- resource
Group StringName Name of the Resource group within the Azure subscription.
- route
Name String Name of the routing rule.
- endpoint
Name string Name of the endpoint under the profile which is unique globally.
- profile
Name string Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
- resource
Group stringName Name of the Resource group within the Azure subscription.
- route
Name 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_ strname Name of the Resource group within the Azure subscription.
- route_
name str Name of the routing rule.
- endpoint
Name String Name of the endpoint under the profile which is unique globally.
- profile
Name String Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
- resource
Group StringName Name of the Resource group within the Azure subscription.
- route
Name String Name of the routing rule.
getRoute Result
The following output properties are available:
- Deployment
Status string - Endpoint
Name string The name of the endpoint which holds the route.
- Id string
Resource ID.
- Name string
Resource name.
- Origin
Group Pulumi.Azure Native. Cdn. Outputs. Resource Reference Response A reference to the origin group.
- Provisioning
State string Provisioning status
- System
Data Pulumi.Azure Native. Cdn. Outputs. System Data Response Read only system data
- Type string
Resource type.
- Cache
Configuration Pulumi.Azure Native. Cdn. Outputs. Afd Route Cache Configuration Response The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
- Custom
Domains List<Pulumi.Azure Native. Cdn. Outputs. Activated Resource Reference Response> Domains referenced by this endpoint.
- Enabled
State string Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
- Forwarding
Protocol string Protocol this rule will use when forwarding traffic to backends.
- Https
Redirect 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.
- Link
To stringDefault Domain whether this route will be linked to the default endpoint domain.
- Origin
Path string A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
- Patterns
To List<string>Match The route patterns of the rule.
- Rule
Sets List<Pulumi.Azure Native. Cdn. Outputs. Resource Reference Response> rule sets referenced by this endpoint.
- Supported
Protocols List<string> List of supported protocols for this route.
- Deployment
Status string - Endpoint
Name string The name of the endpoint which holds the route.
- Id string
Resource ID.
- Name string
Resource name.
- Origin
Group ResourceReference Response A reference to the origin group.
- Provisioning
State string Provisioning status
- System
Data SystemData Response Read only system data
- Type string
Resource type.
- Cache
Configuration AfdRoute Cache Configuration Response The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
- Custom
Domains []ActivatedResource Reference Response Domains referenced by this endpoint.
- Enabled
State string Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
- Forwarding
Protocol string Protocol this rule will use when forwarding traffic to backends.
- Https
Redirect 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.
- Link
To stringDefault Domain whether this route will be linked to the default endpoint domain.
- Origin
Path string A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
- Patterns
To []stringMatch The route patterns of the rule.
- Rule
Sets []ResourceReference Response rule sets referenced by this endpoint.
- Supported
Protocols []string List of supported protocols for this route.
- deployment
Status String - endpoint
Name String The name of the endpoint which holds the route.
- id String
Resource ID.
- name String
Resource name.
- origin
Group ResourceReference Response A reference to the origin group.
- provisioning
State String Provisioning status
- system
Data SystemData Response Read only system data
- type String
Resource type.
- cache
Configuration AfdRoute Cache Configuration Response The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
- custom
Domains List<ActivatedResource Reference Response> Domains referenced by this endpoint.
- enabled
State String Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
- forwarding
Protocol String Protocol this rule will use when forwarding traffic to backends.
- https
Redirect 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.
- link
To StringDefault Domain whether this route will be linked to the default endpoint domain.
- origin
Path String A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
- patterns
To List<String>Match The route patterns of the rule.
- rule
Sets List<ResourceReference Response> rule sets referenced by this endpoint.
- supported
Protocols List<String> List of supported protocols for this route.
- deployment
Status string - endpoint
Name string The name of the endpoint which holds the route.
- id string
Resource ID.
- name string
Resource name.
- origin
Group ResourceReference Response A reference to the origin group.
- provisioning
State string Provisioning status
- system
Data SystemData Response Read only system data
- type string
Resource type.
- cache
Configuration AfdRoute Cache Configuration Response The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
- custom
Domains ActivatedResource Reference Response[] Domains referenced by this endpoint.
- enabled
State string Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
- forwarding
Protocol string Protocol this rule will use when forwarding traffic to backends.
- https
Redirect 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.
- link
To stringDefault Domain whether this route will be linked to the default endpoint domain.
- origin
Path string A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
- patterns
To string[]Match The route patterns of the rule.
- rule
Sets ResourceReference Response[] rule sets referenced by this endpoint.
- supported
Protocols string[] List of supported protocols for this route.
- 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 ResourceReference Response A reference to the origin group.
- provisioning_
state str Provisioning status
- system_
data SystemData Response Read only system data
- type str
Resource type.
- cache_
configuration AfdRoute Cache Configuration Response The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
- custom_
domains Sequence[ActivatedResource Reference Response] 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_ strdefault_ domain 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_ Sequence[str]match The route patterns of the rule.
- rule_
sets Sequence[ResourceReference Response] rule sets referenced by this endpoint.
- supported_
protocols Sequence[str] List of supported protocols for this route.
- deployment
Status String - endpoint
Name String The name of the endpoint which holds the route.
- id String
Resource ID.
- name String
Resource name.
- origin
Group Property Map A reference to the origin group.
- provisioning
State String Provisioning status
- system
Data Property Map Read only system data
- type String
Resource type.
- cache
Configuration Property Map The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
- custom
Domains List<Property Map> Domains referenced by this endpoint.
- enabled
State String Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
- forwarding
Protocol String Protocol this rule will use when forwarding traffic to backends.
- https
Redirect 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.
- link
To StringDefault Domain whether this route will be linked to the default endpoint domain.
- origin
Path String A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
- patterns
To List<String>Match The route patterns of the rule.
- rule
Sets List<Property Map> rule sets referenced by this endpoint.
- supported
Protocols List<String> List of supported protocols for this route.
Supporting Types
ActivatedResourceReferenceResponse
AfdRouteCacheConfigurationResponse
- Compression
Settings Pulumi.Azure Native. Cdn. Inputs. Compression Settings Response compression settings.
- Query
Parameters string query parameters to include or exclude (comma separated).
- Query
String stringCaching Behavior 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 CompressionSettings Response compression settings.
- Query
Parameters string query parameters to include or exclude (comma separated).
- Query
String stringCaching Behavior 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 CompressionSettings Response compression settings.
- query
Parameters String query parameters to include or exclude (comma separated).
- query
String StringCaching Behavior 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 CompressionSettings Response compression settings.
- query
Parameters string query parameters to include or exclude (comma separated).
- query
String stringCaching Behavior 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 CompressionSettings Response compression settings.
- query_
parameters str query parameters to include or exclude (comma separated).
- query_
string_ strcaching_ behavior 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 Property Map compression settings.
- query
Parameters String query parameters to include or exclude (comma separated).
- query
String StringCaching Behavior 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
- Content
Types List<string>To Compress List of content types on which compression applies. The value should be a valid MIME type.
- Is
Compression boolEnabled 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 []stringTo Compress List of content types on which compression applies. The value should be a valid MIME type.
- Is
Compression boolEnabled 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 List<String>To Compress List of content types on which compression applies. The value should be a valid MIME type.
- is
Compression BooleanEnabled 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 string[]To Compress List of content types on which compression applies. The value should be a valid MIME type.
- is
Compression booleanEnabled 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_ Sequence[str]to_ compress List of content types on which compression applies. The value should be a valid MIME type.
- is_
compression_ boolenabled 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 List<String>To Compress List of content types on which compression applies. The value should be a valid MIME type.
- is
Compression BooleanEnabled 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
- Created
At string The timestamp of resource creation (UTC)
- Created
By string An identifier for the identity that created the resource
- Created
By stringType The type of identity that created the resource
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy An identifier for the identity that last modified the resource
- Last
Modified stringBy Type The type of identity that last modified the resource
- Created
At string The timestamp of resource creation (UTC)
- Created
By string An identifier for the identity that created the resource
- Created
By stringType The type of identity that created the resource
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy An identifier for the identity that last modified the resource
- Last
Modified stringBy Type The type of identity that last modified the resource
- created
At String The timestamp of resource creation (UTC)
- created
By String An identifier for the identity that created the resource
- created
By StringType The type of identity that created the resource
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy An identifier for the identity that last modified the resource
- last
Modified StringBy Type The type of identity that last modified the resource
- created
At string The timestamp of resource creation (UTC)
- created
By string An identifier for the identity that created the resource
- created
By stringType The type of identity that created the resource
- last
Modified stringAt The timestamp of resource last modification (UTC)
- last
Modified stringBy An identifier for the identity that last modified the resource
- last
Modified stringBy Type 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_ strtype The type of identity that created the resource
- last_
modified_ strat The timestamp of resource last modification (UTC)
- last_
modified_ strby An identifier for the identity that last modified the resource
- last_
modified_ strby_ type The type of identity that last modified the resource
- created
At String The timestamp of resource creation (UTC)
- created
By String An identifier for the identity that created the resource
- created
By StringType The type of identity that created the resource
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy An identifier for the identity that last modified the resource
- last
Modified StringBy Type The type of identity that last modified the resource
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0