azure-native.appplatform.GatewayRouteConfig
Explore with Pulumi AI
Spring Cloud Gateway route config resource Azure REST API version: 2023-05-01-preview. Prior API version in Azure Native 1.x: 2022-01-01-preview.
Other available API versions: 2023-07-01-preview, 2023-09-01-preview, 2023-11-01-preview, 2023-12-01, 2024-01-01-preview, 2024-05-01-preview.
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 = AzureNative.AppPlatform.GatewayRouteConfigProtocol.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 (
appplatform "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.GatewayRouteConfigPropertiesArgs{
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(appplatform.GatewayRouteConfigProtocolHTTPS),
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 com.pulumi.azurenative.appplatform.inputs.GatewayRouteConfigPropertiesArgs;
import com.pulumi.azurenative.appplatform.inputs.GatewayRouteConfigOpenApiPropertiesArgs;
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(GatewayRouteConfigPropertiesArgs.builder()
.appResourceId("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp")
.openApi(GatewayRouteConfigOpenApiPropertiesArgs.builder()
.uri("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json")
.build())
.protocol("HTTPS")
.routes(GatewayApiRouteArgs.builder()
.filters(
"StripPrefix=2",
"RateLimit=1,1s")
.predicates("Path=/api5/customer/**")
.ssoEnabled(true)
.title("myApp route config")
.build())
.build())
.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={
"app_resource_id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp",
"open_api": {
"uri": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json",
},
"protocol": azure_native.appplatform.GatewayRouteConfigProtocol.HTTPS,
"routes": [{
"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: azure_native.appplatform.GatewayRouteConfigProtocol.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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GatewayRouteConfig(name: string, args: GatewayRouteConfigArgs, opts?: CustomResourceOptions);
@overload
def GatewayRouteConfig(resource_name: str,
args: GatewayRouteConfigArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GatewayRouteConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
gateway_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
service_name: Optional[str] = None,
properties: Optional[GatewayRouteConfigPropertiesArgs] = None,
route_config_name: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var gatewayRouteConfigResource = new AzureNative.AppPlatform.GatewayRouteConfig("gatewayRouteConfigResource", new()
{
GatewayName = "string",
ResourceGroupName = "string",
ServiceName = "string",
Properties = new AzureNative.AppPlatform.Inputs.GatewayRouteConfigPropertiesArgs
{
AppResourceId = "string",
Filters = new[]
{
"string",
},
OpenApi = new AzureNative.AppPlatform.Inputs.GatewayRouteConfigOpenApiPropertiesArgs
{
Uri = "string",
},
Predicates = new[]
{
"string",
},
Protocol = "string",
Routes = new[]
{
new AzureNative.AppPlatform.Inputs.GatewayApiRouteArgs
{
Description = "string",
Filters = new[]
{
"string",
},
Order = 0,
Predicates = new[]
{
"string",
},
SsoEnabled = false,
Tags = new[]
{
"string",
},
Title = "string",
TokenRelay = false,
Uri = "string",
},
},
SsoEnabled = false,
},
RouteConfigName = "string",
});
example, err := appplatform.NewGatewayRouteConfig(ctx, "gatewayRouteConfigResource", &appplatform.GatewayRouteConfigArgs{
GatewayName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
ServiceName: pulumi.String("string"),
Properties: &appplatform.GatewayRouteConfigPropertiesArgs{
AppResourceId: pulumi.String("string"),
Filters: pulumi.StringArray{
pulumi.String("string"),
},
OpenApi: &appplatform.GatewayRouteConfigOpenApiPropertiesArgs{
Uri: pulumi.String("string"),
},
Predicates: pulumi.StringArray{
pulumi.String("string"),
},
Protocol: pulumi.String("string"),
Routes: appplatform.GatewayApiRouteArray{
&appplatform.GatewayApiRouteArgs{
Description: pulumi.String("string"),
Filters: pulumi.StringArray{
pulumi.String("string"),
},
Order: pulumi.Int(0),
Predicates: pulumi.StringArray{
pulumi.String("string"),
},
SsoEnabled: pulumi.Bool(false),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Title: pulumi.String("string"),
TokenRelay: pulumi.Bool(false),
Uri: pulumi.String("string"),
},
},
SsoEnabled: pulumi.Bool(false),
},
RouteConfigName: pulumi.String("string"),
})
var gatewayRouteConfigResource = new GatewayRouteConfig("gatewayRouteConfigResource", GatewayRouteConfigArgs.builder()
.gatewayName("string")
.resourceGroupName("string")
.serviceName("string")
.properties(GatewayRouteConfigPropertiesArgs.builder()
.appResourceId("string")
.filters("string")
.openApi(GatewayRouteConfigOpenApiPropertiesArgs.builder()
.uri("string")
.build())
.predicates("string")
.protocol("string")
.routes(GatewayApiRouteArgs.builder()
.description("string")
.filters("string")
.order(0)
.predicates("string")
.ssoEnabled(false)
.tags("string")
.title("string")
.tokenRelay(false)
.uri("string")
.build())
.ssoEnabled(false)
.build())
.routeConfigName("string")
.build());
gateway_route_config_resource = azure_native.appplatform.GatewayRouteConfig("gatewayRouteConfigResource",
gateway_name="string",
resource_group_name="string",
service_name="string",
properties={
"app_resource_id": "string",
"filters": ["string"],
"open_api": {
"uri": "string",
},
"predicates": ["string"],
"protocol": "string",
"routes": [{
"description": "string",
"filters": ["string"],
"order": 0,
"predicates": ["string"],
"sso_enabled": False,
"tags": ["string"],
"title": "string",
"token_relay": False,
"uri": "string",
}],
"sso_enabled": False,
},
route_config_name="string")
const gatewayRouteConfigResource = new azure_native.appplatform.GatewayRouteConfig("gatewayRouteConfigResource", {
gatewayName: "string",
resourceGroupName: "string",
serviceName: "string",
properties: {
appResourceId: "string",
filters: ["string"],
openApi: {
uri: "string",
},
predicates: ["string"],
protocol: "string",
routes: [{
description: "string",
filters: ["string"],
order: 0,
predicates: ["string"],
ssoEnabled: false,
tags: ["string"],
title: "string",
tokenRelay: false,
uri: "string",
}],
ssoEnabled: false,
},
routeConfigName: "string",
});
type: azure-native:appplatform:GatewayRouteConfig
properties:
gatewayName: string
properties:
appResourceId: string
filters:
- string
openApi:
uri: string
predicates:
- string
protocol: string
routes:
- description: string
filters:
- string
order: 0
predicates:
- string
ssoEnabled: false
tags:
- string
title: string
tokenRelay: false
uri: string
ssoEnabled: false
resourceGroupName: string
routeConfigName: string
serviceName: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The GatewayRouteConfig resource accepts the following input properties:
- Gateway
Name string - The name of Spring Cloud Gateway.
- Resource
Group stringName - 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 string - The name of the Service resource.
- Properties
Pulumi.
Azure Native. App Platform. Inputs. Gateway Route Config Properties - API route config of the Spring Cloud Gateway
- Route
Config stringName - The name of the Spring Cloud Gateway route config.
- Gateway
Name string - The name of Spring Cloud Gateway.
- Resource
Group stringName - 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 string - The name of the Service resource.
- Properties
Gateway
Route Config Properties Args - API route config of the Spring Cloud Gateway
- Route
Config stringName - The name of the Spring Cloud Gateway route config.
- gateway
Name String - The name of Spring Cloud Gateway.
- resource
Group StringName - 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 String - The name of the Service resource.
- properties
Gateway
Route Config Properties - API route config of the Spring Cloud Gateway
- route
Config StringName - The name of the Spring Cloud Gateway route config.
- gateway
Name string - The name of Spring Cloud Gateway.
- resource
Group stringName - 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 string - The name of the Service resource.
- properties
Gateway
Route Config Properties - API route config of the Spring Cloud Gateway
- route
Config stringName - The name of the Spring Cloud Gateway route config.
- gateway_
name str - The name of Spring Cloud Gateway.
- resource_
group_ strname - 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
Gateway
Route Config Properties Args - API route config of the Spring Cloud Gateway
- route_
config_ strname - The name of the Spring Cloud Gateway route config.
- gateway
Name String - The name of Spring Cloud Gateway.
- resource
Group StringName - 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 String - The name of the Service resource.
- properties Property Map
- API route config of the Spring Cloud Gateway
- route
Config StringName - 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.
- System
Data Pulumi.Azure Native. App Platform. Outputs. System Data Response - 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.
- System
Data SystemData Response - 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.
- system
Data SystemData Response - 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.
- system
Data SystemData Response - 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 SystemData Response - 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.
- system
Data 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.
- Sso
Enabled bool - Enable sso validation.
- 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.
- Token
Relay 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.
- Sso
Enabled bool - Enable sso validation.
- []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.
- Token
Relay 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.
- sso
Enabled Boolean - Enable sso validation.
- 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.
- token
Relay 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.
- sso
Enabled boolean - Enable sso validation.
- 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.
- token
Relay 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.
- 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.
- sso
Enabled Boolean - Enable sso validation.
- 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.
- token
Relay 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.
- Sso
Enabled bool - Enable sso validation.
- 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.
- Token
Relay 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.
- Sso
Enabled bool - Enable sso validation.
- []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.
- Token
Relay 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.
- sso
Enabled Boolean - Enable sso validation.
- 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.
- token
Relay 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.
- sso
Enabled boolean - Enable sso validation.
- 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.
- token
Relay 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.
- 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.
- sso
Enabled Boolean - Enable sso validation.
- 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.
- token
Relay 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
- App
Resource stringId - 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.
- Open
Api Pulumi.Azure Native. App Platform. Inputs. Gateway Route Config Open Api Properties - 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.
Azure Native. App Platform. Gateway Route Config Protocol - Protocol of routed Azure Spring Apps applications.
- Routes
List<Pulumi.
Azure Native. App Platform. Inputs. Gateway Api Route> - 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.
- App
Resource stringId - 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.
- Open
Api GatewayRoute Config Open Api Properties - 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 | Gateway
Route Config Protocol - Protocol of routed Azure Spring Apps applications.
- Routes
[]Gateway
Api Route - 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.
- app
Resource StringId - 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.
- open
Api GatewayRoute Config Open Api Properties - 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 | Gateway
Route Config Protocol - Protocol of routed Azure Spring Apps applications.
- routes
List<Gateway
Api Route> - Array of API routes, each route contains properties such as
title
,uri
,ssoEnabled
,predicates
,filters
. - sso
Enabled Boolean - Enable Single Sign-On in app level.
- app
Resource stringId - 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.
- open
Api GatewayRoute Config Open Api Properties - 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 | Gateway
Route Config Protocol - Protocol of routed Azure Spring Apps applications.
- routes
Gateway
Api Route[] - Array of API routes, each route contains properties such as
title
,uri
,ssoEnabled
,predicates
,filters
. - sso
Enabled boolean - Enable Single Sign-On in app level.
- app_
resource_ strid - 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 GatewayRoute Config Open Api Properties - 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 | Gateway
Route Config Protocol - Protocol of routed Azure Spring Apps applications.
- routes
Sequence[Gateway
Api Route] - 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.
- app
Resource StringId - 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.
- open
Api 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
. - sso
Enabled Boolean - Enable Single Sign-On in app level.
GatewayRouteConfigPropertiesResponse, GatewayRouteConfigPropertiesResponseArgs
- Provisioning
State string - State of the Spring Cloud Gateway route config.
- App
Resource stringId - 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.
- Open
Api Pulumi.Azure Native. App Platform. Inputs. Gateway Route Config Open Api Properties Response - 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.
Azure Native. App Platform. Inputs. Gateway Api Route Response> - 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.
- Provisioning
State string - State of the Spring Cloud Gateway route config.
- App
Resource stringId - 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.
- Open
Api GatewayRoute Config Open Api Properties Response - 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
[]Gateway
Api Route Response - 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.
- provisioning
State String - State of the Spring Cloud Gateway route config.
- app
Resource StringId - 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.
- open
Api GatewayRoute Config Open Api Properties Response - 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<Gateway
Api Route Response> - Array of API routes, each route contains properties such as
title
,uri
,ssoEnabled
,predicates
,filters
. - sso
Enabled Boolean - Enable Single Sign-On in app level.
- provisioning
State string - State of the Spring Cloud Gateway route config.
- app
Resource stringId - 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.
- open
Api GatewayRoute Config Open Api Properties Response - 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
Gateway
Api Route Response[] - Array of API routes, each route contains properties such as
title
,uri
,ssoEnabled
,predicates
,filters
. - sso
Enabled boolean - Enable Single Sign-On in app level.
- provisioning_
state str - State of the Spring Cloud Gateway route config.
- app_
resource_ strid - 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 GatewayRoute Config Open Api Properties Response - 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[Gateway
Api Route Response] - 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.
- provisioning
State String - State of the Spring Cloud Gateway route config.
- app
Resource StringId - 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.
- open
Api 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
. - sso
Enabled Boolean - Enable Single Sign-On in app level.
GatewayRouteConfigProtocol, GatewayRouteConfigProtocolArgs
- HTTP
- HTTP
- HTTPS
- HTTPS
- Gateway
Route Config Protocol HTTP - HTTP
- Gateway
Route Config Protocol HTTPS - HTTPS
- HTTP
- HTTP
- HTTPS
- HTTPS
- HTTP
- HTTP
- HTTPS
- HTTPS
- HTTP
- HTTP
- HTTPS
- HTTPS
- "HTTP"
- HTTP
- "HTTPS"
- HTTPS
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource modification (UTC).
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource modification (UTC).
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource modification (UTC).
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource modification (UTC).
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource modification (UTC).
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource modification (UTC).
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0