azure-native.appplatform.getGatewayRouteConfig
Spring Cloud Gateway route config resource API Version: 2022-01-01-preview.
Using getGatewayRouteConfig
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getGatewayRouteConfig(args: GetGatewayRouteConfigArgs, opts?: InvokeOptions): Promise<GetGatewayRouteConfigResult>
function getGatewayRouteConfigOutput(args: GetGatewayRouteConfigOutputArgs, opts?: InvokeOptions): Output<GetGatewayRouteConfigResult>
def get_gateway_route_config(gateway_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
route_config_name: Optional[str] = None,
service_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetGatewayRouteConfigResult
def get_gateway_route_config_output(gateway_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
route_config_name: Optional[pulumi.Input[str]] = None,
service_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGatewayRouteConfigResult]
func LookupGatewayRouteConfig(ctx *Context, args *LookupGatewayRouteConfigArgs, opts ...InvokeOption) (*LookupGatewayRouteConfigResult, error)
func LookupGatewayRouteConfigOutput(ctx *Context, args *LookupGatewayRouteConfigOutputArgs, opts ...InvokeOption) LookupGatewayRouteConfigResultOutput
> Note: This function is named LookupGatewayRouteConfig
in the Go SDK.
public static class GetGatewayRouteConfig
{
public static Task<GetGatewayRouteConfigResult> InvokeAsync(GetGatewayRouteConfigArgs args, InvokeOptions? opts = null)
public static Output<GetGatewayRouteConfigResult> Invoke(GetGatewayRouteConfigInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGatewayRouteConfigResult> getGatewayRouteConfig(GetGatewayRouteConfigArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:appplatform:getGatewayRouteConfig
arguments:
# arguments dictionary
The following arguments are supported:
- 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.
- Route
Config stringName The name of the Spring Cloud Gateway route config.
- Service
Name string The name of the Service resource.
- 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.
- Route
Config stringName The name of the Spring Cloud Gateway route config.
- Service
Name string The name of the Service resource.
- 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.
- route
Config StringName The name of the Spring Cloud Gateway route config.
- service
Name String The name of the Service resource.
- 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.
- route
Config stringName The name of the Spring Cloud Gateway route config.
- service
Name string The name of the Service resource.
- 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.
- route_
config_ strname The name of the Spring Cloud Gateway route config.
- service_
name str The name of the Service resource.
- 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.
- route
Config StringName The name of the Spring Cloud Gateway route config.
- service
Name String The name of the Service resource.
getGatewayRouteConfig Result
The following output properties are available:
- Id string
Fully qualified resource Id for the resource.
- Name string
The name of the resource.
- Properties
Pulumi.
Azure Native. App Platform. Outputs. Gateway Route Config Properties Response API route config of the Spring Cloud Gateway
- 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
Fully qualified resource Id for the resource.
- Name string
The name of the resource.
- Properties
Gateway
Route Config Properties Response API route config of the Spring Cloud Gateway
- System
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- Type string
The type of the resource.
- id String
Fully qualified resource Id for the resource.
- name String
The name of the resource.
- properties
Gateway
Route Config Properties Response API route config of the Spring Cloud Gateway
- system
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type String
The type of the resource.
- id string
Fully qualified resource Id for the resource.
- name string
The name of the resource.
- properties
Gateway
Route Config Properties Response API route config of the Spring Cloud Gateway
- system
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type string
The type of the resource.
- id str
Fully qualified resource Id for the resource.
- name str
The name of the resource.
- properties
Gateway
Route Config Properties Response API route config of the Spring Cloud Gateway
- system_
data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type str
The type of the resource.
- id String
Fully qualified resource Id for the resource.
- name String
The name of the resource.
- properties Property Map
API route config of the Spring Cloud Gateway
- system
Data Property Map Metadata pertaining to creation and last modification of the resource.
- type String
The type of the resource.
Supporting Types
GatewayApiRouteResponse
- Description string
A description, will be applied to methods in the generated OpenAPI documentation.
- Filters List<string>
To modify the request before sending it to the target endpoint, or the received response.
- Order int
Route processing order.
- Predicates List<string>
A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.
- 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
.
GatewayRouteConfigPropertiesResponse
- Provisioning
State string State of the Spring Cloud Gateway route config.
- App
Resource stringId The resource Id of the Azure Spring Cloud app, required unless route defines
uri
.- 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
.
- Provisioning
State string State of the Spring Cloud Gateway route config.
- App
Resource stringId The resource Id of the Azure Spring Cloud app, required unless route defines
uri
.- Routes
[]Gateway
Api Route Response Array of API routes, each route contains properties such as
title
,uri
,ssoEnabled
,predicates
,filters
.
- provisioning
State String State of the Spring Cloud Gateway route config.
- app
Resource StringId The resource Id of the Azure Spring Cloud app, required unless route defines
uri
.- routes
List<Gateway
Api Route Response> Array of API routes, each route contains properties such as
title
,uri
,ssoEnabled
,predicates
,filters
.
- provisioning
State string State of the Spring Cloud Gateway route config.
- app
Resource stringId The resource Id of the Azure Spring Cloud app, required unless route defines
uri
.- routes
Gateway
Api Route Response[] Array of API routes, each route contains properties such as
title
,uri
,ssoEnabled
,predicates
,filters
.
- provisioning_
state str State of the Spring Cloud Gateway route config.
- app_
resource_ strid The resource Id of the Azure Spring Cloud app, required unless route defines
uri
.- routes
Sequence[Gateway
Api Route Response] Array of API routes, each route contains properties such as
title
,uri
,ssoEnabled
,predicates
,filters
.
- provisioning
State String State of the Spring Cloud Gateway route config.
- app
Resource StringId The resource Id of the Azure Spring Cloud app, required unless route defines
uri
.- routes List<Property Map>
Array of API routes, each route contains properties such as
title
,uri
,ssoEnabled
,predicates
,filters
.
SystemDataResponse
- 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 last 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 last 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 last 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 last 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 last 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 last 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.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0