Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. appplatform
  5. SpringCloudGatewayRouteConfig

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.appplatform.SpringCloudGatewayRouteConfig

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Spring Cloud Gateway Route Config.

    NOTE: This resource is applicable only for Spring Cloud Service with enterprise tier.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example",
    location: "West Europe",
});
const exampleSpringCloudService = new azure.appplatform.SpringCloudService("example", {
    name: "example",
    location: example.location,
    resourceGroupName: example.name,
    skuName: "E0",
});
const exampleSpringCloudApp = new azure.appplatform.SpringCloudApp("example", {
    name: "example",
    resourceGroupName: example.name,
    serviceName: exampleSpringCloudService.name,
});
const exampleSpringCloudGateway = new azure.appplatform.SpringCloudGateway("example", {
    name: "default",
    springCloudServiceId: exampleSpringCloudService.id,
});
const exampleSpringCloudGatewayRouteConfig = new azure.appplatform.SpringCloudGatewayRouteConfig("example", {
    name: "example",
    springCloudGatewayId: exampleSpringCloudGateway.id,
    springCloudAppId: exampleSpringCloudApp.id,
    protocol: "HTTPS",
    routes: [{
        description: "example description",
        filters: [
            "StripPrefix=2",
            "RateLimit=1,1s",
        ],
        order: 1,
        predicates: ["Path=/api5/customer/**"],
        ssoValidationEnabled: true,
        title: "myApp route config",
        tokenRelay: true,
        uri: "https://www.example.com",
        classificationTags: [
            "tag1",
            "tag2",
        ],
    }],
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example",
    location="West Europe")
example_spring_cloud_service = azure.appplatform.SpringCloudService("example",
    name="example",
    location=example.location,
    resource_group_name=example.name,
    sku_name="E0")
example_spring_cloud_app = azure.appplatform.SpringCloudApp("example",
    name="example",
    resource_group_name=example.name,
    service_name=example_spring_cloud_service.name)
example_spring_cloud_gateway = azure.appplatform.SpringCloudGateway("example",
    name="default",
    spring_cloud_service_id=example_spring_cloud_service.id)
example_spring_cloud_gateway_route_config = azure.appplatform.SpringCloudGatewayRouteConfig("example",
    name="example",
    spring_cloud_gateway_id=example_spring_cloud_gateway.id,
    spring_cloud_app_id=example_spring_cloud_app.id,
    protocol="HTTPS",
    routes=[{
        "description": "example description",
        "filters": [
            "StripPrefix=2",
            "RateLimit=1,1s",
        ],
        "order": 1,
        "predicates": ["Path=/api5/customer/**"],
        "sso_validation_enabled": True,
        "title": "myApp route config",
        "token_relay": True,
        "uri": "https://www.example.com",
        "classification_tags": [
            "tag1",
            "tag2",
        ],
    }])

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/appplatform"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleSpringCloudService, err := appplatform.NewSpringCloudService(ctx, "example", &appplatform.SpringCloudServiceArgs{
			Name:              pulumi.String("example"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			SkuName:           pulumi.String("E0"),
		})
		if err != nil {
			return err
		}
		exampleSpringCloudApp, err := appplatform.NewSpringCloudApp(ctx, "example", &appplatform.SpringCloudAppArgs{
			Name:              pulumi.String("example"),
			ResourceGroupName: example.Name,
			ServiceName:       exampleSpringCloudService.Name,
		})
		if err != nil {
			return err
		}
		exampleSpringCloudGateway, err := appplatform.NewSpringCloudGateway(ctx, "example", &appplatform.SpringCloudGatewayArgs{
			Name:                 pulumi.String("default"),
			SpringCloudServiceId: exampleSpringCloudService.ID(),
		})
		if err != nil {
			return err
		}
		_, err = appplatform.NewSpringCloudGatewayRouteConfig(ctx, "example", &appplatform.SpringCloudGatewayRouteConfigArgs{
			Name:                 pulumi.String("example"),
			SpringCloudGatewayId: exampleSpringCloudGateway.ID(),
			SpringCloudAppId:     exampleSpringCloudApp.ID(),
			Protocol:             pulumi.String("HTTPS"),
			Routes: appplatform.SpringCloudGatewayRouteConfigRouteArray{
				&appplatform.SpringCloudGatewayRouteConfigRouteArgs{
					Description: pulumi.String("example description"),
					Filters: pulumi.StringArray{
						pulumi.String("StripPrefix=2"),
						pulumi.String("RateLimit=1,1s"),
					},
					Order: pulumi.Int(1),
					Predicates: pulumi.StringArray{
						pulumi.String("Path=/api5/customer/**"),
					},
					SsoValidationEnabled: pulumi.Bool(true),
					Title:                pulumi.String("myApp route config"),
					TokenRelay:           pulumi.Bool(true),
					Uri:                  pulumi.String("https://www.example.com"),
					ClassificationTags: pulumi.StringArray{
						pulumi.String("tag1"),
						pulumi.String("tag2"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example",
        Location = "West Europe",
    });

    var exampleSpringCloudService = new Azure.AppPlatform.SpringCloudService("example", new()
    {
        Name = "example",
        Location = example.Location,
        ResourceGroupName = example.Name,
        SkuName = "E0",
    });

    var exampleSpringCloudApp = new Azure.AppPlatform.SpringCloudApp("example", new()
    {
        Name = "example",
        ResourceGroupName = example.Name,
        ServiceName = exampleSpringCloudService.Name,
    });

    var exampleSpringCloudGateway = new Azure.AppPlatform.SpringCloudGateway("example", new()
    {
        Name = "default",
        SpringCloudServiceId = exampleSpringCloudService.Id,
    });

    var exampleSpringCloudGatewayRouteConfig = new Azure.AppPlatform.SpringCloudGatewayRouteConfig("example", new()
    {
        Name = "example",
        SpringCloudGatewayId = exampleSpringCloudGateway.Id,
        SpringCloudAppId = exampleSpringCloudApp.Id,
        Protocol = "HTTPS",
        Routes = new[]
        {
            new Azure.AppPlatform.Inputs.SpringCloudGatewayRouteConfigRouteArgs
            {
                Description = "example description",
                Filters = new[]
                {
                    "StripPrefix=2",
                    "RateLimit=1,1s",
                },
                Order = 1,
                Predicates = new[]
                {
                    "Path=/api5/customer/**",
                },
                SsoValidationEnabled = true,
                Title = "myApp route config",
                TokenRelay = true,
                Uri = "https://www.example.com",
                ClassificationTags = new[]
                {
                    "tag1",
                    "tag2",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.appplatform.SpringCloudService;
import com.pulumi.azure.appplatform.SpringCloudServiceArgs;
import com.pulumi.azure.appplatform.SpringCloudApp;
import com.pulumi.azure.appplatform.SpringCloudAppArgs;
import com.pulumi.azure.appplatform.SpringCloudGateway;
import com.pulumi.azure.appplatform.SpringCloudGatewayArgs;
import com.pulumi.azure.appplatform.SpringCloudGatewayRouteConfig;
import com.pulumi.azure.appplatform.SpringCloudGatewayRouteConfigArgs;
import com.pulumi.azure.appplatform.inputs.SpringCloudGatewayRouteConfigRouteArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example")
            .location("West Europe")
            .build());

        var exampleSpringCloudService = new SpringCloudService("exampleSpringCloudService", SpringCloudServiceArgs.builder()
            .name("example")
            .location(example.location())
            .resourceGroupName(example.name())
            .skuName("E0")
            .build());

        var exampleSpringCloudApp = new SpringCloudApp("exampleSpringCloudApp", SpringCloudAppArgs.builder()
            .name("example")
            .resourceGroupName(example.name())
            .serviceName(exampleSpringCloudService.name())
            .build());

        var exampleSpringCloudGateway = new SpringCloudGateway("exampleSpringCloudGateway", SpringCloudGatewayArgs.builder()
            .name("default")
            .springCloudServiceId(exampleSpringCloudService.id())
            .build());

        var exampleSpringCloudGatewayRouteConfig = new SpringCloudGatewayRouteConfig("exampleSpringCloudGatewayRouteConfig", SpringCloudGatewayRouteConfigArgs.builder()
            .name("example")
            .springCloudGatewayId(exampleSpringCloudGateway.id())
            .springCloudAppId(exampleSpringCloudApp.id())
            .protocol("HTTPS")
            .routes(SpringCloudGatewayRouteConfigRouteArgs.builder()
                .description("example description")
                .filters(                
                    "StripPrefix=2",
                    "RateLimit=1,1s")
                .order(1)
                .predicates("Path=/api5/customer/**")
                .ssoValidationEnabled(true)
                .title("myApp route config")
                .tokenRelay(true)
                .uri("https://www.example.com")
                .classificationTags(                
                    "tag1",
                    "tag2")
                .build())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example
      location: West Europe
  exampleSpringCloudService:
    type: azure:appplatform:SpringCloudService
    name: example
    properties:
      name: example
      location: ${example.location}
      resourceGroupName: ${example.name}
      skuName: E0
  exampleSpringCloudApp:
    type: azure:appplatform:SpringCloudApp
    name: example
    properties:
      name: example
      resourceGroupName: ${example.name}
      serviceName: ${exampleSpringCloudService.name}
  exampleSpringCloudGateway:
    type: azure:appplatform:SpringCloudGateway
    name: example
    properties:
      name: default
      springCloudServiceId: ${exampleSpringCloudService.id}
  exampleSpringCloudGatewayRouteConfig:
    type: azure:appplatform:SpringCloudGatewayRouteConfig
    name: example
    properties:
      name: example
      springCloudGatewayId: ${exampleSpringCloudGateway.id}
      springCloudAppId: ${exampleSpringCloudApp.id}
      protocol: HTTPS
      routes:
        - description: example description
          filters:
            - StripPrefix=2
            - RateLimit=1,1s
          order: 1
          predicates:
            - Path=/api5/customer/**
          ssoValidationEnabled: true
          title: myApp route config
          tokenRelay: true
          uri: https://www.example.com
          classificationTags:
            - tag1
            - tag2

    Create SpringCloudGatewayRouteConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SpringCloudGatewayRouteConfig(name: string, args: SpringCloudGatewayRouteConfigArgs, opts?: CustomResourceOptions);
    @overload
def SpringCloudGatewayRouteConfig(resource_name: str,
                                  args: SpringCloudGatewayRouteConfigArgs,
                                  opts: Optional[ResourceOptions] = None)

@overload
def SpringCloudGatewayRouteConfig(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  protocol: Optional[str] = None,
                                  spring_cloud_gateway_id: Optional[str] = None,
                                  filters: Optional[Sequence[str]] = None,
                                  name: Optional[str] = None,
                                  open_api: Optional[SpringCloudGatewayRouteConfigOpenApiArgs] = None,
                                  predicates: Optional[Sequence[str]] = None,
                                  routes: Optional[Sequence[SpringCloudGatewayRouteConfigRouteArgs]] = None,
                                  spring_cloud_app_id: Optional[str] = None,
                                  sso_validation_enabled: Optional[bool] = None)
    func NewSpringCloudGatewayRouteConfig(ctx *Context, name string, args SpringCloudGatewayRouteConfigArgs, opts ...ResourceOption) (*SpringCloudGatewayRouteConfig, error)
    public SpringCloudGatewayRouteConfig(string name, SpringCloudGatewayRouteConfigArgs args, CustomResourceOptions? opts = null)
    public SpringCloudGatewayRouteConfig(String name, SpringCloudGatewayRouteConfigArgs args)
public SpringCloudGatewayRouteConfig(String name, SpringCloudGatewayRouteConfigArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args SpringCloudGatewayRouteConfigArgs
    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 SpringCloudGatewayRouteConfigArgs
    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 SpringCloudGatewayRouteConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SpringCloudGatewayRouteConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SpringCloudGatewayRouteConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var springCloudGatewayRouteConfigResource = new Azure.AppPlatform.SpringCloudGatewayRouteConfig("springCloudGatewayRouteConfigResource", new()
{
    Protocol = "string",
    SpringCloudGatewayId = "string",
    Filters = new[]
    {
        "string",
    },
    Name = "string",
    OpenApi = new Azure.AppPlatform.Inputs.SpringCloudGatewayRouteConfigOpenApiArgs
    {
        Uri = "string",
    },
    Predicates = new[]
    {
        "string",
    },
    Routes = new[]
    {
        new Azure.AppPlatform.Inputs.SpringCloudGatewayRouteConfigRouteArgs
        {
            Order = 0,
            ClassificationTags = new[]
            {
                "string",
            },
            Description = "string",
            Filters = new[]
            {
                "string",
            },
            Predicates = new[]
            {
                "string",
            },
            SsoValidationEnabled = false,
            Title = "string",
            TokenRelay = false,
            Uri = "string",
        },
    },
    SpringCloudAppId = "string",
    SsoValidationEnabled = false,
});

    example, err := appplatform.NewSpringCloudGatewayRouteConfig(ctx, "springCloudGatewayRouteConfigResource", &appplatform.SpringCloudGatewayRouteConfigArgs{
	Protocol:             pulumi.String("string"),
	SpringCloudGatewayId: pulumi.String("string"),
	Filters: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	OpenApi: &appplatform.SpringCloudGatewayRouteConfigOpenApiArgs{
		Uri: pulumi.String("string"),
	},
	Predicates: pulumi.StringArray{
		pulumi.String("string"),
	},
	Routes: appplatform.SpringCloudGatewayRouteConfigRouteArray{
		&appplatform.SpringCloudGatewayRouteConfigRouteArgs{
			Order: pulumi.Int(0),
			ClassificationTags: pulumi.StringArray{
				pulumi.String("string"),
			},
			Description: pulumi.String("string"),
			Filters: pulumi.StringArray{
				pulumi.String("string"),
			},
			Predicates: pulumi.StringArray{
				pulumi.String("string"),
			},
			SsoValidationEnabled: pulumi.Bool(false),
			Title:                pulumi.String("string"),
			TokenRelay:           pulumi.Bool(false),
			Uri:                  pulumi.String("string"),
		},
	},
	SpringCloudAppId:     pulumi.String("string"),
	SsoValidationEnabled: pulumi.Bool(false),
})

    var springCloudGatewayRouteConfigResource = new SpringCloudGatewayRouteConfig("springCloudGatewayRouteConfigResource", SpringCloudGatewayRouteConfigArgs.builder()
    .protocol("string")
    .springCloudGatewayId("string")
    .filters("string")
    .name("string")
    .openApi(SpringCloudGatewayRouteConfigOpenApiArgs.builder()
        .uri("string")
        .build())
    .predicates("string")
    .routes(SpringCloudGatewayRouteConfigRouteArgs.builder()
        .order(0)
        .classificationTags("string")
        .description("string")
        .filters("string")
        .predicates("string")
        .ssoValidationEnabled(false)
        .title("string")
        .tokenRelay(false)
        .uri("string")
        .build())
    .springCloudAppId("string")
    .ssoValidationEnabled(false)
    .build());

    spring_cloud_gateway_route_config_resource = azure.appplatform.SpringCloudGatewayRouteConfig("springCloudGatewayRouteConfigResource",
    protocol="string",
    spring_cloud_gateway_id="string",
    filters=["string"],
    name="string",
    open_api={
        "uri": "string",
    },
    predicates=["string"],
    routes=[{
        "order": 0,
        "classification_tags": ["string"],
        "description": "string",
        "filters": ["string"],
        "predicates": ["string"],
        "sso_validation_enabled": False,
        "title": "string",
        "token_relay": False,
        "uri": "string",
    }],
    spring_cloud_app_id="string",
    sso_validation_enabled=False)

    const springCloudGatewayRouteConfigResource = new azure.appplatform.SpringCloudGatewayRouteConfig("springCloudGatewayRouteConfigResource", {
    protocol: "string",
    springCloudGatewayId: "string",
    filters: ["string"],
    name: "string",
    openApi: {
        uri: "string",
    },
    predicates: ["string"],
    routes: [{
        order: 0,
        classificationTags: ["string"],
        description: "string",
        filters: ["string"],
        predicates: ["string"],
        ssoValidationEnabled: false,
        title: "string",
        tokenRelay: false,
        uri: "string",
    }],
    springCloudAppId: "string",
    ssoValidationEnabled: false,
});

    type: azure:appplatform:SpringCloudGatewayRouteConfig
properties:
    filters:
        - string
    name: string
    openApi:
        uri: string
    predicates:
        - string
    protocol: string
    routes:
        - classificationTags:
            - string
          description: string
          filters:
            - string
          order: 0
          predicates:
            - string
          ssoValidationEnabled: false
          title: string
          tokenRelay: false
          uri: string
    springCloudAppId: string
    springCloudGatewayId: string
    ssoValidationEnabled: false

    SpringCloudGatewayRouteConfig Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SpringCloudGatewayRouteConfig resource accepts the following input properties:

    Protocol string

    Specifies the protocol of routed Spring Cloud App. Allowed values are HTTP and HTTPS. Defaults to HTTP.

    Note: You likely want to use HTTPS in a production environment, since HTTP offers no encryption.

    SpringCloudGatewayId string
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    Filters List<string>
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response in app level.
    Name string
    The name which should be used for this Spring Cloud Gateway Route Config. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    OpenApi SpringCloudGatewayRouteConfigOpenApi
    One or more open_api blocks as defined below.
    Predicates List<string>
    Specifies a list 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.
    Routes List<SpringCloudGatewayRouteConfigRoute>
    One or more route blocks as defined below.
    SpringCloudAppId string
    The ID of the Spring Cloud App.
    SsoValidationEnabled bool
    Should the sso validation be enabled in app level?
    Protocol string

    Specifies the protocol of routed Spring Cloud App. Allowed values are HTTP and HTTPS. Defaults to HTTP.

    Note: You likely want to use HTTPS in a production environment, since HTTP offers no encryption.

    SpringCloudGatewayId string
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    Filters []string
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response in app level.
    Name string
    The name which should be used for this Spring Cloud Gateway Route Config. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    OpenApi SpringCloudGatewayRouteConfigOpenApiArgs
    One or more open_api blocks as defined below.
    Predicates []string
    Specifies a list 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.
    Routes []SpringCloudGatewayRouteConfigRouteArgs
    One or more route blocks as defined below.
    SpringCloudAppId string
    The ID of the Spring Cloud App.
    SsoValidationEnabled bool
    Should the sso validation be enabled in app level?
    protocol String

    Specifies the protocol of routed Spring Cloud App. Allowed values are HTTP and HTTPS. Defaults to HTTP.

    Note: You likely want to use HTTPS in a production environment, since HTTP offers no encryption.

    springCloudGatewayId String
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    filters List<String>
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response in app level.
    name String
    The name which should be used for this Spring Cloud Gateway Route Config. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    openApi SpringCloudGatewayRouteConfigOpenApi
    One or more open_api blocks as defined below.
    predicates List<String>
    Specifies a list 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.
    routes List<SpringCloudGatewayRouteConfigRoute>
    One or more route blocks as defined below.
    springCloudAppId String
    The ID of the Spring Cloud App.
    ssoValidationEnabled Boolean
    Should the sso validation be enabled in app level?
    protocol string

    Specifies the protocol of routed Spring Cloud App. Allowed values are HTTP and HTTPS. Defaults to HTTP.

    Note: You likely want to use HTTPS in a production environment, since HTTP offers no encryption.

    springCloudGatewayId string
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    filters string[]
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response in app level.
    name string
    The name which should be used for this Spring Cloud Gateway Route Config. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    openApi SpringCloudGatewayRouteConfigOpenApi
    One or more open_api blocks as defined below.
    predicates string[]
    Specifies a list 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.
    routes SpringCloudGatewayRouteConfigRoute[]
    One or more route blocks as defined below.
    springCloudAppId string
    The ID of the Spring Cloud App.
    ssoValidationEnabled boolean
    Should the sso validation be enabled in app level?
    protocol str

    Specifies the protocol of routed Spring Cloud App. Allowed values are HTTP and HTTPS. Defaults to HTTP.

    Note: You likely want to use HTTPS in a production environment, since HTTP offers no encryption.

    spring_cloud_gateway_id str
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    filters Sequence[str]
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response in app level.
    name str
    The name which should be used for this Spring Cloud Gateway Route Config. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    open_api SpringCloudGatewayRouteConfigOpenApiArgs
    One or more open_api blocks as defined below.
    predicates Sequence[str]
    Specifies a list 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.
    routes Sequence[SpringCloudGatewayRouteConfigRouteArgs]
    One or more route blocks as defined below.
    spring_cloud_app_id str
    The ID of the Spring Cloud App.
    sso_validation_enabled bool
    Should the sso validation be enabled in app level?
    protocol String

    Specifies the protocol of routed Spring Cloud App. Allowed values are HTTP and HTTPS. Defaults to HTTP.

    Note: You likely want to use HTTPS in a production environment, since HTTP offers no encryption.

    springCloudGatewayId String
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    filters List<String>
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response in app level.
    name String
    The name which should be used for this Spring Cloud Gateway Route Config. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    openApi Property Map
    One or more open_api blocks as defined below.
    predicates List<String>
    Specifies a list 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.
    routes List<Property Map>
    One or more route blocks as defined below.
    springCloudAppId String
    The ID of the Spring Cloud App.
    ssoValidationEnabled Boolean
    Should the sso validation be enabled in app level?

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SpringCloudGatewayRouteConfig Resource

    Get an existing SpringCloudGatewayRouteConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SpringCloudGatewayRouteConfigState, opts?: CustomResourceOptions): SpringCloudGatewayRouteConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        filters: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        open_api: Optional[SpringCloudGatewayRouteConfigOpenApiArgs] = None,
        predicates: Optional[Sequence[str]] = None,
        protocol: Optional[str] = None,
        routes: Optional[Sequence[SpringCloudGatewayRouteConfigRouteArgs]] = None,
        spring_cloud_app_id: Optional[str] = None,
        spring_cloud_gateway_id: Optional[str] = None,
        sso_validation_enabled: Optional[bool] = None) -> SpringCloudGatewayRouteConfig
    func GetSpringCloudGatewayRouteConfig(ctx *Context, name string, id IDInput, state *SpringCloudGatewayRouteConfigState, opts ...ResourceOption) (*SpringCloudGatewayRouteConfig, error)
    public static SpringCloudGatewayRouteConfig Get(string name, Input<string> id, SpringCloudGatewayRouteConfigState? state, CustomResourceOptions? opts = null)
    public static SpringCloudGatewayRouteConfig get(String name, Output<String> id, SpringCloudGatewayRouteConfigState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Filters List<string>
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response in app level.
    Name string
    The name which should be used for this Spring Cloud Gateway Route Config. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    OpenApi SpringCloudGatewayRouteConfigOpenApi
    One or more open_api blocks as defined below.
    Predicates List<string>
    Specifies a list 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

    Specifies the protocol of routed Spring Cloud App. Allowed values are HTTP and HTTPS. Defaults to HTTP.

    Note: You likely want to use HTTPS in a production environment, since HTTP offers no encryption.

    Routes List<SpringCloudGatewayRouteConfigRoute>
    One or more route blocks as defined below.
    SpringCloudAppId string
    The ID of the Spring Cloud App.
    SpringCloudGatewayId string
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    SsoValidationEnabled bool
    Should the sso validation be enabled in app level?
    Filters []string
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response in app level.
    Name string
    The name which should be used for this Spring Cloud Gateway Route Config. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    OpenApi SpringCloudGatewayRouteConfigOpenApiArgs
    One or more open_api blocks as defined below.
    Predicates []string
    Specifies a list 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

    Specifies the protocol of routed Spring Cloud App. Allowed values are HTTP and HTTPS. Defaults to HTTP.

    Note: You likely want to use HTTPS in a production environment, since HTTP offers no encryption.

    Routes []SpringCloudGatewayRouteConfigRouteArgs
    One or more route blocks as defined below.
    SpringCloudAppId string
    The ID of the Spring Cloud App.
    SpringCloudGatewayId string
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    SsoValidationEnabled bool
    Should the sso validation be enabled in app level?
    filters List<String>
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response in app level.
    name String
    The name which should be used for this Spring Cloud Gateway Route Config. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    openApi SpringCloudGatewayRouteConfigOpenApi
    One or more open_api blocks as defined below.
    predicates List<String>
    Specifies a list 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

    Specifies the protocol of routed Spring Cloud App. Allowed values are HTTP and HTTPS. Defaults to HTTP.

    Note: You likely want to use HTTPS in a production environment, since HTTP offers no encryption.

    routes List<SpringCloudGatewayRouteConfigRoute>
    One or more route blocks as defined below.
    springCloudAppId String
    The ID of the Spring Cloud App.
    springCloudGatewayId String
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    ssoValidationEnabled Boolean
    Should the sso validation be enabled in app level?
    filters string[]
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response in app level.
    name string
    The name which should be used for this Spring Cloud Gateway Route Config. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    openApi SpringCloudGatewayRouteConfigOpenApi
    One or more open_api blocks as defined below.
    predicates string[]
    Specifies a list 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

    Specifies the protocol of routed Spring Cloud App. Allowed values are HTTP and HTTPS. Defaults to HTTP.

    Note: You likely want to use HTTPS in a production environment, since HTTP offers no encryption.

    routes SpringCloudGatewayRouteConfigRoute[]
    One or more route blocks as defined below.
    springCloudAppId string
    The ID of the Spring Cloud App.
    springCloudGatewayId string
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    ssoValidationEnabled boolean
    Should the sso validation be enabled in app level?
    filters Sequence[str]
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response in app level.
    name str
    The name which should be used for this Spring Cloud Gateway Route Config. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    open_api SpringCloudGatewayRouteConfigOpenApiArgs
    One or more open_api blocks as defined below.
    predicates Sequence[str]
    Specifies a list 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

    Specifies the protocol of routed Spring Cloud App. Allowed values are HTTP and HTTPS. Defaults to HTTP.

    Note: You likely want to use HTTPS in a production environment, since HTTP offers no encryption.

    routes Sequence[SpringCloudGatewayRouteConfigRouteArgs]
    One or more route blocks as defined below.
    spring_cloud_app_id str
    The ID of the Spring Cloud App.
    spring_cloud_gateway_id str
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    sso_validation_enabled bool
    Should the sso validation be enabled in app level?
    filters List<String>
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response in app level.
    name String
    The name which should be used for this Spring Cloud Gateway Route Config. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    openApi Property Map
    One or more open_api blocks as defined below.
    predicates List<String>
    Specifies a list 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

    Specifies the protocol of routed Spring Cloud App. Allowed values are HTTP and HTTPS. Defaults to HTTP.

    Note: You likely want to use HTTPS in a production environment, since HTTP offers no encryption.

    routes List<Property Map>
    One or more route blocks as defined below.
    springCloudAppId String
    The ID of the Spring Cloud App.
    springCloudGatewayId String
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Route Config to be created.
    ssoValidationEnabled Boolean
    Should the sso validation be enabled in app level?

    Supporting Types

    SpringCloudGatewayRouteConfigOpenApi, SpringCloudGatewayRouteConfigOpenApiArgs

    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.

    SpringCloudGatewayRouteConfigRoute, SpringCloudGatewayRouteConfigRouteArgs

    Order int
    Specifies the route processing order.
    ClassificationTags List<string>
    Specifies the classification tags which will be applied to methods in the generated OpenAPI documentation.
    Description string
    Specifies the description which will be applied to methods in the generated OpenAPI documentation.
    Filters List<string>
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response.
    Predicates List<string>
    Specifies a list 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.
    SsoValidationEnabled bool
    Should the sso validation be enabled?
    Title string
    Specifies the title which will be applied to methods in the generated OpenAPI documentation.
    TokenRelay bool
    Should pass currently-authenticated user's identity token to application service?
    Uri string
    Specifies the full uri which will override appName.
    Order int
    Specifies the route processing order.
    ClassificationTags []string
    Specifies the classification tags which will be applied to methods in the generated OpenAPI documentation.
    Description string
    Specifies the description which will be applied to methods in the generated OpenAPI documentation.
    Filters []string
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response.
    Predicates []string
    Specifies a list 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.
    SsoValidationEnabled bool
    Should the sso validation be enabled?
    Title string
    Specifies the title which will be applied to methods in the generated OpenAPI documentation.
    TokenRelay bool
    Should pass currently-authenticated user's identity token to application service?
    Uri string
    Specifies the full uri which will override appName.
    order Integer
    Specifies the route processing order.
    classificationTags List<String>
    Specifies the classification tags which will be applied to methods in the generated OpenAPI documentation.
    description String
    Specifies the description which will be applied to methods in the generated OpenAPI documentation.
    filters List<String>
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response.
    predicates List<String>
    Specifies a list 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.
    ssoValidationEnabled Boolean
    Should the sso validation be enabled?
    title String
    Specifies the title which will be applied to methods in the generated OpenAPI documentation.
    tokenRelay Boolean
    Should pass currently-authenticated user's identity token to application service?
    uri String
    Specifies the full uri which will override appName.
    order number
    Specifies the route processing order.
    classificationTags string[]
    Specifies the classification tags which will be applied to methods in the generated OpenAPI documentation.
    description string
    Specifies the description which will be applied to methods in the generated OpenAPI documentation.
    filters string[]
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response.
    predicates string[]
    Specifies a list 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.
    ssoValidationEnabled boolean
    Should the sso validation be enabled?
    title string
    Specifies the title which will be applied to methods in the generated OpenAPI documentation.
    tokenRelay boolean
    Should pass currently-authenticated user's identity token to application service?
    uri string
    Specifies the full uri which will override appName.
    order int
    Specifies the route processing order.
    classification_tags Sequence[str]
    Specifies the classification tags which will be applied to methods in the generated OpenAPI documentation.
    description str
    Specifies the description which will be applied to methods in the generated OpenAPI documentation.
    filters Sequence[str]
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response.
    predicates Sequence[str]
    Specifies a list 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_validation_enabled bool
    Should the sso validation be enabled?
    title str
    Specifies the title which will be applied to methods in the generated OpenAPI documentation.
    token_relay bool
    Should pass currently-authenticated user's identity token to application service?
    uri str
    Specifies the full uri which will override appName.
    order Number
    Specifies the route processing order.
    classificationTags List<String>
    Specifies the classification tags which will be applied to methods in the generated OpenAPI documentation.
    description String
    Specifies the description which will be applied to methods in the generated OpenAPI documentation.
    filters List<String>
    Specifies a list of filters which are used to modify the request before sending it to the target endpoint, or the received response.
    predicates List<String>
    Specifies a list 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.
    ssoValidationEnabled Boolean
    Should the sso validation be enabled?
    title String
    Specifies the title which will be applied to methods in the generated OpenAPI documentation.
    tokenRelay Boolean
    Should pass currently-authenticated user's identity token to application service?
    uri String
    Specifies the full uri which will override appName.

    Import

    Spring Cloud Gateway Route Configs can be imported using the resource id, e.g.

    $ pulumi import azure:appplatform/springCloudGatewayRouteConfig:SpringCloudGatewayRouteConfig example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.AppPlatform/spring/service1/gateways/gateway1/routeConfigs/routeConfig1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure