Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. appplatform
  5. getGatewayRouteConfig
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.appplatform.getGatewayRouteConfig

Explore with Pulumi AI

azure-native logo
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

    Get the Spring Cloud Gateway route configs.

    Uses Azure REST API version 2024-01-01-preview.

    Other available API versions: 2023-05-01-preview, 2023-07-01-preview, 2023-09-01-preview, 2023-11-01-preview, 2023-12-01, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native appplatform [ApiVersion]. See the version guide for details.

    Using getGatewayRouteConfig

    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 getGatewayRouteConfig(args: GetGatewayRouteConfigArgs, opts?: InvokeOptions): Promise<GetGatewayRouteConfigResult>
function getGatewayRouteConfigOutput(args: GetGatewayRouteConfigOutputArgs, opts?: InvokeOptions): Output<GetGatewayRouteConfigResult>
    def get_gateway_route_config(gateway_name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             route_config_name: Optional[str] = None,
                             service_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetGatewayRouteConfigResult
def get_gateway_route_config_output(gateway_name: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             route_config_name: Optional[pulumi.Input[str]] = None,
                             service_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetGatewayRouteConfigResult]
    func LookupGatewayRouteConfig(ctx *Context, args *LookupGatewayRouteConfigArgs, opts ...InvokeOption) (*LookupGatewayRouteConfigResult, error)
func LookupGatewayRouteConfigOutput(ctx *Context, args *LookupGatewayRouteConfigOutputArgs, opts ...InvokeOption) LookupGatewayRouteConfigResultOutput

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

    public static class GetGatewayRouteConfig 
{
    public static Task<GetGatewayRouteConfigResult> InvokeAsync(GetGatewayRouteConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayRouteConfigResult> Invoke(GetGatewayRouteConfigInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGatewayRouteConfigResult> getGatewayRouteConfig(GetGatewayRouteConfigArgs args, InvokeOptions options)
public static Output<GetGatewayRouteConfigResult> getGatewayRouteConfig(GetGatewayRouteConfigArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:appplatform:getGatewayRouteConfig
  arguments:
    # arguments dictionary

    The following arguments are supported:

    GatewayName string
    The name of Spring Cloud Gateway.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    RouteConfigName string
    The name of the Spring Cloud Gateway route config.
    ServiceName string
    The name of the Service resource.
    GatewayName string
    The name of Spring Cloud Gateway.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    RouteConfigName string
    The name of the Spring Cloud Gateway route config.
    ServiceName string
    The name of the Service resource.
    gatewayName String
    The name of Spring Cloud Gateway.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    routeConfigName String
    The name of the Spring Cloud Gateway route config.
    serviceName String
    The name of the Service resource.
    gatewayName string
    The name of Spring Cloud Gateway.
    resourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    routeConfigName string
    The name of the Spring Cloud Gateway route config.
    serviceName string
    The name of the Service resource.
    gateway_name str
    The name of Spring Cloud Gateway.
    resource_group_name str
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    route_config_name str
    The name of the Spring Cloud Gateway route config.
    service_name str
    The name of the Service resource.
    gatewayName String
    The name of Spring Cloud Gateway.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    routeConfigName String
    The name of the Spring Cloud Gateway route config.
    serviceName String
    The name of the Service resource.

    getGatewayRouteConfig 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.
    Name string
    The name of the resource.
    Properties Pulumi.AzureNative.AppPlatform.Outputs.GatewayRouteConfigPropertiesResponse
    API route config of the Spring Cloud Gateway
    SystemData Pulumi.AzureNative.AppPlatform.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource Id for the resource.
    Name string
    The name of the resource.
    Properties GatewayRouteConfigPropertiesResponse
    API route config of the Spring Cloud Gateway
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource Id for the resource.
    name String
    The name of the resource.
    properties GatewayRouteConfigPropertiesResponse
    API route config of the Spring Cloud Gateway
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource Id for the resource.
    name string
    The name of the resource.
    properties GatewayRouteConfigPropertiesResponse
    API route config of the Spring Cloud Gateway
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type string
    The type of the resource.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource Id for the resource.
    name str
    The name of the resource.
    properties GatewayRouteConfigPropertiesResponse
    API route config of the Spring Cloud Gateway
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type str
    The type of the resource.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource Id for the resource.
    name String
    The name of the resource.
    properties Property Map
    API route config of the Spring Cloud Gateway
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource.

    Supporting Types

    GatewayApiRouteResponse

    Description string
    A description, will be applied to methods in the generated OpenAPI documentation.
    Filters List<string>
    To modify the request before sending it to the target endpoint, or the received response.
    Order int
    Route processing order.
    Predicates List<string>
    A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.
    SsoEnabled bool
    Enable sso validation.
    Tags List<string>
    Classification tags, will be applied to methods in the generated OpenAPI documentation.
    Title string
    A title, will be applied to methods in the generated OpenAPI documentation.
    TokenRelay bool
    Pass currently-authenticated user's identity token to application service, default is 'false'
    Uri string
    Full uri, will override appName.
    Description string
    A description, will be applied to methods in the generated OpenAPI documentation.
    Filters []string
    To modify the request before sending it to the target endpoint, or the received response.
    Order int
    Route processing order.
    Predicates []string
    A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.
    SsoEnabled bool
    Enable sso validation.
    Tags []string
    Classification tags, will be applied to methods in the generated OpenAPI documentation.
    Title string
    A title, will be applied to methods in the generated OpenAPI documentation.
    TokenRelay bool
    Pass currently-authenticated user's identity token to application service, default is 'false'
    Uri string
    Full uri, will override appName.
    description String
    A description, will be applied to methods in the generated OpenAPI documentation.
    filters List<String>
    To modify the request before sending it to the target endpoint, or the received response.
    order Integer
    Route processing order.
    predicates List<String>
    A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.
    ssoEnabled Boolean
    Enable sso validation.
    tags List<String>
    Classification tags, will be applied to methods in the generated OpenAPI documentation.
    title String
    A title, will be applied to methods in the generated OpenAPI documentation.
    tokenRelay Boolean
    Pass currently-authenticated user's identity token to application service, default is 'false'
    uri String
    Full uri, will override appName.
    description string
    A description, will be applied to methods in the generated OpenAPI documentation.
    filters string[]
    To modify the request before sending it to the target endpoint, or the received response.
    order number
    Route processing order.
    predicates string[]
    A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.
    ssoEnabled boolean
    Enable sso validation.
    tags string[]
    Classification tags, will be applied to methods in the generated OpenAPI documentation.
    title string
    A title, will be applied to methods in the generated OpenAPI documentation.
    tokenRelay boolean
    Pass currently-authenticated user's identity token to application service, default is 'false'
    uri string
    Full uri, will override appName.
    description str
    A description, will be applied to methods in the generated OpenAPI documentation.
    filters Sequence[str]
    To modify the request before sending it to the target endpoint, or the received response.
    order int
    Route processing order.
    predicates Sequence[str]
    A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.
    sso_enabled bool
    Enable sso validation.
    tags Sequence[str]
    Classification tags, will be applied to methods in the generated OpenAPI documentation.
    title str
    A title, will be applied to methods in the generated OpenAPI documentation.
    token_relay bool
    Pass currently-authenticated user's identity token to application service, default is 'false'
    uri str
    Full uri, will override appName.
    description String
    A description, will be applied to methods in the generated OpenAPI documentation.
    filters List<String>
    To modify the request before sending it to the target endpoint, or the received response.
    order Number
    Route processing order.
    predicates List<String>
    A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.
    ssoEnabled Boolean
    Enable sso validation.
    tags List<String>
    Classification tags, will be applied to methods in the generated OpenAPI documentation.
    title String
    A title, will be applied to methods in the generated OpenAPI documentation.
    tokenRelay Boolean
    Pass currently-authenticated user's identity token to application service, default is 'false'
    uri String
    Full uri, will override appName.

    GatewayRouteConfigOpenApiPropertiesResponse

    Uri string
    The URI of OpenAPI specification.
    Uri string
    The URI of OpenAPI specification.
    uri String
    The URI of OpenAPI specification.
    uri string
    The URI of OpenAPI specification.
    uri str
    The URI of OpenAPI specification.
    uri String
    The URI of OpenAPI specification.

    GatewayRouteConfigPropertiesResponse

    ProvisioningState string
    State of the Spring Cloud Gateway route config.
    AppResourceId string
    The resource Id of the Azure Spring Apps app, required unless route defines uri.
    Filters List<string>
    To modify the request before sending it to the target endpoint, or the received response in app level.
    OpenApi Pulumi.AzureNative.AppPlatform.Inputs.GatewayRouteConfigOpenApiPropertiesResponse
    OpenAPI properties of Spring Cloud Gateway route config.
    Predicates List<string>
    A number of conditions to evaluate a route for each request in app level. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.
    Protocol string
    Protocol of routed Azure Spring Apps applications.
    Routes List<Pulumi.AzureNative.AppPlatform.Inputs.GatewayApiRouteResponse>
    Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.
    SsoEnabled bool
    Enable Single Sign-On in app level.
    ProvisioningState string
    State of the Spring Cloud Gateway route config.
    AppResourceId string
    The resource Id of the Azure Spring Apps app, required unless route defines uri.
    Filters []string
    To modify the request before sending it to the target endpoint, or the received response in app level.
    OpenApi GatewayRouteConfigOpenApiPropertiesResponse
    OpenAPI properties of Spring Cloud Gateway route config.
    Predicates []string
    A number of conditions to evaluate a route for each request in app level. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.
    Protocol string
    Protocol of routed Azure Spring Apps applications.
    Routes []GatewayApiRouteResponse
    Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.
    SsoEnabled bool
    Enable Single Sign-On in app level.
    provisioningState String
    State of the Spring Cloud Gateway route config.
    appResourceId String
    The resource Id of the Azure Spring Apps app, required unless route defines uri.
    filters List<String>
    To modify the request before sending it to the target endpoint, or the received response in app level.
    openApi GatewayRouteConfigOpenApiPropertiesResponse
    OpenAPI properties of Spring Cloud Gateway route config.
    predicates List<String>
    A number of conditions to evaluate a route for each request in app level. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.
    protocol String
    Protocol of routed Azure Spring Apps applications.
    routes List<GatewayApiRouteResponse>
    Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.
    ssoEnabled Boolean
    Enable Single Sign-On in app level.
    provisioningState string
    State of the Spring Cloud Gateway route config.
    appResourceId string
    The resource Id of the Azure Spring Apps app, required unless route defines uri.
    filters string[]
    To modify the request before sending it to the target endpoint, or the received response in app level.
    openApi GatewayRouteConfigOpenApiPropertiesResponse
    OpenAPI properties of Spring Cloud Gateway route config.
    predicates string[]
    A number of conditions to evaluate a route for each request in app level. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.
    protocol string
    Protocol of routed Azure Spring Apps applications.
    routes GatewayApiRouteResponse[]
    Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.
    ssoEnabled boolean
    Enable Single Sign-On in app level.
    provisioning_state str
    State of the Spring Cloud Gateway route config.
    app_resource_id str
    The resource Id of the Azure Spring Apps app, required unless route defines uri.
    filters Sequence[str]
    To modify the request before sending it to the target endpoint, or the received response in app level.
    open_api GatewayRouteConfigOpenApiPropertiesResponse
    OpenAPI properties of Spring Cloud Gateway route config.
    predicates Sequence[str]
    A number of conditions to evaluate a route for each request in app level. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.
    protocol str
    Protocol of routed Azure Spring Apps applications.
    routes Sequence[GatewayApiRouteResponse]
    Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.
    sso_enabled bool
    Enable Single Sign-On in app level.
    provisioningState String
    State of the Spring Cloud Gateway route config.
    appResourceId String
    The resource Id of the Azure Spring Apps app, required unless route defines uri.
    filters List<String>
    To modify the request before sending it to the target endpoint, or the received response in app level.
    openApi Property Map
    OpenAPI properties of Spring Cloud Gateway route config.
    predicates List<String>
    A number of conditions to evaluate a route for each request in app level. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.
    protocol String
    Protocol of routed Azure Spring Apps applications.
    routes List<Property Map>
    Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.
    ssoEnabled Boolean
    Enable Single Sign-On in app level.

    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 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 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 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 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 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 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
    azure-native logo
    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