Azure Native v2.21.1, Dec 6 23

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.21.1 published on Wednesday, Dec 6, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.appplatform.GatewayRouteConfig

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.21.1 published on Wednesday, Dec 6, 2023 by Pulumi

pulumi/pulumi-azure-native

Example Usage

GatewayRouteConfigs_CreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var gatewayRouteConfig = new AzureNative.AppPlatform.GatewayRouteConfig("gatewayRouteConfig", new()
    {
        GatewayName = "default",
        Properties = new AzureNative.AppPlatform.Inputs.GatewayRouteConfigPropertiesArgs
        {
            AppResourceId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp",
            OpenApi = new AzureNative.AppPlatform.Inputs.GatewayRouteConfigOpenApiPropertiesArgs
            {
                Uri = "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json",
            },
            Protocol = "HTTPS",
            Routes = new[]
            {
                new AzureNative.AppPlatform.Inputs.GatewayApiRouteArgs
                {
                    Filters = new[]
                    {
                        "StripPrefix=2",
                        "RateLimit=1,1s",
                    },
                    Predicates = new[]
                    {
                        "Path=/api5/customer/**",
                    },
                    SsoEnabled = true,
                    Title = "myApp route config",
                },
            },
        },
        ResourceGroupName = "myResourceGroup",
        RouteConfigName = "myRouteConfig",
        ServiceName = "myservice",
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure-native-sdk/appplatform/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := appplatform.NewGatewayRouteConfig(ctx, "gatewayRouteConfig", &appplatform.GatewayRouteConfigArgs{
			GatewayName: pulumi.String("default"),
			Properties: appplatform.GatewayRouteConfigPropertiesResponse{
				AppResourceId: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp"),
				OpenApi: &appplatform.GatewayRouteConfigOpenApiPropertiesArgs{
					Uri: pulumi.String("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json"),
				},
				Protocol: pulumi.String("HTTPS"),
				Routes: appplatform.GatewayApiRouteArray{
					&appplatform.GatewayApiRouteArgs{
						Filters: pulumi.StringArray{
							pulumi.String("StripPrefix=2"),
							pulumi.String("RateLimit=1,1s"),
						},
						Predicates: pulumi.StringArray{
							pulumi.String("Path=/api5/customer/**"),
						},
						SsoEnabled: pulumi.Bool(true),
						Title:      pulumi.String("myApp route config"),
					},
				},
			},
			ResourceGroupName: pulumi.String("myResourceGroup"),
			RouteConfigName:   pulumi.String("myRouteConfig"),
			ServiceName:       pulumi.String("myservice"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.appplatform.GatewayRouteConfig;
import com.pulumi.azurenative.appplatform.GatewayRouteConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var gatewayRouteConfig = new GatewayRouteConfig("gatewayRouteConfig", GatewayRouteConfigArgs.builder()        
            .gatewayName("default")
            .properties(Map.ofEntries(
                Map.entry("appResourceId", "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp"),
                Map.entry("openApi", Map.of("uri", "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json")),
                Map.entry("protocol", "HTTPS"),
                Map.entry("routes", Map.ofEntries(
                    Map.entry("filters",                     
                        "StripPrefix=2",
                        "RateLimit=1,1s"),
                    Map.entry("predicates", "Path=/api5/customer/**"),
                    Map.entry("ssoEnabled", true),
                    Map.entry("title", "myApp route config")
                ))
            ))
            .resourceGroupName("myResourceGroup")
            .routeConfigName("myRouteConfig")
            .serviceName("myservice")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

gateway_route_config = azure_native.appplatform.GatewayRouteConfig("gatewayRouteConfig",
    gateway_name="default",
    properties=azure_native.appplatform.GatewayRouteConfigPropertiesResponseArgs(
        app_resource_id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp",
        open_api=azure_native.appplatform.GatewayRouteConfigOpenApiPropertiesArgs(
            uri="https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json",
        ),
        protocol="HTTPS",
        routes=[azure_native.appplatform.GatewayApiRouteArgs(
            filters=[
                "StripPrefix=2",
                "RateLimit=1,1s",
            ],
            predicates=["Path=/api5/customer/**"],
            sso_enabled=True,
            title="myApp route config",
        )],
    ),
    resource_group_name="myResourceGroup",
    route_config_name="myRouteConfig",
    service_name="myservice")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const gatewayRouteConfig = new azure_native.appplatform.GatewayRouteConfig("gatewayRouteConfig", {
    gatewayName: "default",
    properties: {
        appResourceId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp",
        openApi: {
            uri: "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json",
        },
        protocol: "HTTPS",
        routes: [{
            filters: [
                "StripPrefix=2",
                "RateLimit=1,1s",
            ],
            predicates: ["Path=/api5/customer/**"],
            ssoEnabled: true,
            title: "myApp route config",
        }],
    },
    resourceGroupName: "myResourceGroup",
    routeConfigName: "myRouteConfig",
    serviceName: "myservice",
});

resources:
  gatewayRouteConfig:
    type: azure-native:appplatform:GatewayRouteConfig
    properties:
      gatewayName: default
      properties:
        appResourceId: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp
        openApi:
          uri: https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json
        protocol: HTTPS
        routes:
          - filters:
              - StripPrefix=2
              - RateLimit=1,1s
            predicates:
              - Path=/api5/customer/**
            ssoEnabled: true
            title: myApp route config
      resourceGroupName: myResourceGroup
      routeConfigName: myRouteConfig
      serviceName: myservice

Create GatewayRouteConfig Resource

new GatewayRouteConfig(name: string, args: GatewayRouteConfigArgs, opts?: CustomResourceOptions);

@overload
def GatewayRouteConfig(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       gateway_name: Optional[str] = None,
                       properties: Optional[GatewayRouteConfigPropertiesArgs] = None,
                       resource_group_name: Optional[str] = None,
                       route_config_name: Optional[str] = None,
                       service_name: Optional[str] = None)
@overload
def GatewayRouteConfig(resource_name: str,
                       args: GatewayRouteConfigArgs,
                       opts: Optional[ResourceOptions] = None)

func NewGatewayRouteConfig(ctx *Context, name string, args GatewayRouteConfigArgs, opts ...ResourceOption) (*GatewayRouteConfig, error)

public GatewayRouteConfig(string name, GatewayRouteConfigArgs args, CustomResourceOptions? opts = null)

public GatewayRouteConfig(String name, GatewayRouteConfigArgs args)
public GatewayRouteConfig(String name, GatewayRouteConfigArgs args, CustomResourceOptions options)

type: azure-native:appplatform:GatewayRouteConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GatewayRouteConfigArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args GatewayRouteConfigArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GatewayRouteConfigArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GatewayRouteConfigArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GatewayRouteConfigArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

GatewayRouteConfig Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The GatewayRouteConfig resource accepts the following input properties:

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.
ServiceName string: The name of the Service resource.
Properties Pulumi.AzureNative.AppPlatform.Inputs.GatewayRouteConfigProperties: API route config of the Spring Cloud Gateway
RouteConfigName string: The name of the Spring Cloud Gateway route config.

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.
ServiceName string: The name of the Service resource.
Properties GatewayRouteConfigPropertiesArgs: API route config of the Spring Cloud Gateway
RouteConfigName string: The name of the Spring Cloud Gateway route config.

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.
serviceName String: The name of the Service resource.
properties GatewayRouteConfigProperties: API route config of the Spring Cloud Gateway
routeConfigName String: The name of the Spring Cloud Gateway route config.

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.
serviceName string: The name of the Service resource.
properties GatewayRouteConfigProperties: API route config of the Spring Cloud Gateway
routeConfigName string: The name of the Spring Cloud Gateway route config.

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.
service_name str: The name of the Service resource.
properties GatewayRouteConfigPropertiesArgs: API route config of the Spring Cloud Gateway
route_config_name str: The name of the Spring Cloud Gateway route config.

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.
serviceName String: The name of the Service resource.
properties Property Map: API route config of the Spring Cloud Gateway
routeConfigName String: The name of the Spring Cloud Gateway route config.

Outputs

All input properties are implicitly available as output properties. Additionally, the GatewayRouteConfig resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the resource.
SystemData Pulumi.AzureNative.AppPlatform.Outputs.SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
Type string: The type of the resource.

Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the resource.
SystemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
Type string: The type of the resource.

id String: The provider-assigned unique ID for this managed resource.
name String: The name of the resource.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
type String: The type of the resource.

id string: The provider-assigned unique ID for this managed resource.
name string: The name of the resource.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
type string: The type of the resource.

id str: The provider-assigned unique ID for this managed resource.
name str: The name of the resource.
system_data SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
type str: The type of the resource.

id String: The provider-assigned unique ID for this managed resource.
name String: The name of the resource.
systemData Property Map: Metadata pertaining to creation and last modification of the resource.
type String: The type of the resource.

Supporting Types

GatewayApiRoute, GatewayApiRouteArgs

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.

GatewayApiRouteResponse, GatewayApiRouteResponseArgs

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.

GatewayRouteConfigOpenApiProperties, GatewayRouteConfigOpenApiPropertiesArgs

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.

GatewayRouteConfigOpenApiPropertiesResponse, GatewayRouteConfigOpenApiPropertiesResponseArgs

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.

GatewayRouteConfigProperties, GatewayRouteConfigPropertiesArgs

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.GatewayRouteConfigOpenApiProperties: 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 | Pulumi.AzureNative.AppPlatform.GatewayRouteConfigProtocol: Protocol of routed Azure Spring Apps applications.
Routes List<Pulumi.AzureNative.AppPlatform.Inputs.GatewayApiRoute>: Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.
SsoEnabled bool: Enable Single Sign-On in app level.

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 GatewayRouteConfigOpenApiProperties: 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 | GatewayRouteConfigProtocol: Protocol of routed Azure Spring Apps applications.
Routes []GatewayApiRoute: Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.
SsoEnabled bool: Enable Single Sign-On in app level.

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 GatewayRouteConfigOpenApiProperties: 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 | GatewayRouteConfigProtocol: Protocol of routed Azure Spring Apps applications.
routes List<GatewayApiRoute>: Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.
ssoEnabled Boolean: Enable Single Sign-On in app level.

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 GatewayRouteConfigOpenApiProperties: 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 | GatewayRouteConfigProtocol: Protocol of routed Azure Spring Apps applications.
routes GatewayApiRoute[]: Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.
ssoEnabled boolean: Enable Single Sign-On in app level.

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 GatewayRouteConfigOpenApiProperties: 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 | GatewayRouteConfigProtocol: Protocol of routed Azure Spring Apps applications.
routes Sequence[GatewayApiRoute]: 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.

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 | "HTTP" | "HTTPS": 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.

GatewayRouteConfigPropertiesResponse, GatewayRouteConfigPropertiesResponseArgs

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.

GatewayRouteConfigProtocol, GatewayRouteConfigProtocolArgs

HTTP: HTTP
HTTPS: HTTPS

GatewayRouteConfigProtocolHTTP: HTTP
GatewayRouteConfigProtocolHTTPS: HTTPS

HTTP: HTTP
HTTPS: HTTPS

HTTP: HTTP
HTTPS: HTTPS

HTTP: HTTP
HTTPS: HTTPS

"HTTP": HTTP
"HTTPS": HTTPS

SystemDataResponse, SystemDataResponseArgs

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.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:appplatform:GatewayRouteConfig myRouteConfig /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/routeConfigs/{routeConfigName}

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 v1 docs if using the v1 version of this package.

Azure Native v2.21.1 published on Wednesday, Dec 6, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.appplatform.GatewayRouteConfig

On this page

On this page

Example Usage

GatewayRouteConfigs_CreateOrUpdate

Create GatewayRouteConfig Resource

GatewayRouteConfig Resource Properties

Inputs

Outputs

Supporting Types

GatewayApiRoute, GatewayApiRouteArgs

GatewayApiRouteResponse, GatewayApiRouteResponseArgs

GatewayRouteConfigOpenApiProperties, GatewayRouteConfigOpenApiPropertiesArgs

GatewayRouteConfigOpenApiPropertiesResponse, GatewayRouteConfigOpenApiPropertiesResponseArgs

GatewayRouteConfigProperties, GatewayRouteConfigPropertiesArgs

GatewayRouteConfigPropertiesResponse, GatewayRouteConfigPropertiesResponseArgs

GatewayRouteConfigProtocol, GatewayRouteConfigProtocolArgs

SystemDataResponse, SystemDataResponseArgs

Import

Package Details

On this page

On this page