Azure Native

v1.79.2 published on Thursday, Sep 29, 2022 by Pulumi

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:

GatewayName string

The name of Spring Cloud Gateway.

ResourceGroupName string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

RouteConfigName string

The name of the Spring Cloud Gateway route config.

ServiceName string

The name of the Service resource.

GatewayName string

The name of Spring Cloud Gateway.

ResourceGroupName string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

RouteConfigName string

The name of the Spring Cloud Gateway route config.

ServiceName string

The name of the Service resource.

gatewayName String

The name of Spring Cloud Gateway.

resourceGroupName String

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

routeConfigName String

The name of the Spring Cloud Gateway route config.

serviceName String

The name of the Service resource.

gatewayName string

The name of Spring Cloud Gateway.

resourceGroupName string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

routeConfigName string

The name of the Spring Cloud Gateway route config.

serviceName string

The name of the Service resource.

gateway_name str

The name of Spring Cloud Gateway.

resource_group_name str

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

route_config_name str

The name of the Spring Cloud Gateway route config.

service_name str

The name of the Service resource.

gatewayName String

The name of Spring Cloud Gateway.

resourceGroupName String

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

routeConfigName String

The name of the Spring Cloud Gateway route config.

serviceName String

The name of the Service resource.

getGatewayRouteConfig Result

The following output properties are available:

Id string

Fully qualified resource Id for the resource.

Name string

The name of the resource.

Properties Pulumi.AzureNative.AppPlatform.Outputs.GatewayRouteConfigPropertiesResponse

API route config of the Spring Cloud Gateway

SystemData Pulumi.AzureNative.AppPlatform.Outputs.SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

Type string

The type of the resource.

Id string

Fully qualified resource Id for the resource.

Name string

The name of the resource.

Properties GatewayRouteConfigPropertiesResponse

API route config of the Spring Cloud Gateway

SystemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

Type string

The type of the resource.

id String

Fully qualified resource Id for the resource.

name String

The name of the resource.

properties GatewayRouteConfigPropertiesResponse

API route config of the Spring Cloud Gateway

systemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

type String

The type of the resource.

id string

Fully qualified resource Id for the resource.

name string

The name of the resource.

properties GatewayRouteConfigPropertiesResponse

API route config of the Spring Cloud Gateway

systemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

type string

The type of the resource.

id str

Fully qualified resource Id for the resource.

name str

The name of the resource.

properties GatewayRouteConfigPropertiesResponse

API route config of the Spring Cloud Gateway

system_data SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

type str

The type of the resource.

id String

Fully qualified resource Id for the resource.

name String

The name of the resource.

properties Property Map

API route config of the Spring Cloud Gateway

systemData Property Map

Metadata pertaining to creation and last modification of the resource.

type String

The type of the resource.

Supporting Types

GatewayApiRouteResponse

Description string

A description, will be applied to methods in the generated OpenAPI documentation.

Filters List<string>

To modify the request before sending it to the target endpoint, or the received response.

Order int

Route processing order.

Predicates List<string>

A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.

SsoEnabled bool

Enable sso validation.

Tags List<string>

Classification tags, will be applied to methods in the generated OpenAPI documentation.

Title string

A title, will be applied to methods in the generated OpenAPI documentation.

TokenRelay bool

Pass currently-authenticated user's identity token to application service, default is 'false'

Uri string

Full uri, will override appName.

Description string

A description, will be applied to methods in the generated OpenAPI documentation.

Filters []string

To modify the request before sending it to the target endpoint, or the received response.

Order int

Route processing order.

Predicates []string

A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.

SsoEnabled bool

Enable sso validation.

Tags []string

Classification tags, will be applied to methods in the generated OpenAPI documentation.

Title string

A title, will be applied to methods in the generated OpenAPI documentation.

TokenRelay bool

Pass currently-authenticated user's identity token to application service, default is 'false'

Uri string

Full uri, will override appName.

description String

A description, will be applied to methods in the generated OpenAPI documentation.

filters List<String>

To modify the request before sending it to the target endpoint, or the received response.

order Integer

Route processing order.

predicates List<String>

A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.

ssoEnabled Boolean

Enable sso validation.

tags List<String>

Classification tags, will be applied to methods in the generated OpenAPI documentation.

title String

A title, will be applied to methods in the generated OpenAPI documentation.

tokenRelay Boolean

Pass currently-authenticated user's identity token to application service, default is 'false'

uri String

Full uri, will override appName.

description string

A description, will be applied to methods in the generated OpenAPI documentation.

filters string[]

To modify the request before sending it to the target endpoint, or the received response.

order number

Route processing order.

predicates string[]

A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.

ssoEnabled boolean

Enable sso validation.

tags string[]

Classification tags, will be applied to methods in the generated OpenAPI documentation.

title string

A title, will be applied to methods in the generated OpenAPI documentation.

tokenRelay boolean

Pass currently-authenticated user's identity token to application service, default is 'false'

uri string

Full uri, will override appName.

description str

A description, will be applied to methods in the generated OpenAPI documentation.

filters Sequence[str]

To modify the request before sending it to the target endpoint, or the received response.

order int

Route processing order.

predicates Sequence[str]

A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.

sso_enabled bool

Enable sso validation.

tags Sequence[str]

Classification tags, will be applied to methods in the generated OpenAPI documentation.

title str

A title, will be applied to methods in the generated OpenAPI documentation.

token_relay bool

Pass currently-authenticated user's identity token to application service, default is 'false'

uri str

Full uri, will override appName.

description String

A description, will be applied to methods in the generated OpenAPI documentation.

filters List<String>

To modify the request before sending it to the target endpoint, or the received response.

order Number

Route processing order.

predicates List<String>

A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request.

ssoEnabled Boolean

Enable sso validation.

tags List<String>

Classification tags, will be applied to methods in the generated OpenAPI documentation.

title String

A title, will be applied to methods in the generated OpenAPI documentation.

tokenRelay Boolean

Pass currently-authenticated user's identity token to application service, default is 'false'

uri String

Full uri, will override appName.

GatewayRouteConfigPropertiesResponse

ProvisioningState string

State of the Spring Cloud Gateway route config.

AppResourceId string

The resource Id of the Azure Spring Cloud app, required unless route defines uri.

Routes List<Pulumi.AzureNative.AppPlatform.Inputs.GatewayApiRouteResponse>

Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.

ProvisioningState string

State of the Spring Cloud Gateway route config.

AppResourceId string

The resource Id of the Azure Spring Cloud app, required unless route defines uri.

Routes []GatewayApiRouteResponse

Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.

provisioningState String

State of the Spring Cloud Gateway route config.

appResourceId String

The resource Id of the Azure Spring Cloud app, required unless route defines uri.

routes List<GatewayApiRouteResponse>

Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.

provisioningState string

State of the Spring Cloud Gateway route config.

appResourceId string

The resource Id of the Azure Spring Cloud app, required unless route defines uri.

routes GatewayApiRouteResponse[]

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_id str

The resource Id of the Azure Spring Cloud app, required unless route defines uri.

routes Sequence[GatewayApiRouteResponse]

Array of API routes, each route contains properties such as title, uri, ssoEnabled, predicates, filters.

provisioningState String

State of the Spring Cloud Gateway route config.

appResourceId String

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

CreatedAt string

The timestamp of resource creation (UTC).

CreatedBy string

The identity that created the resource.

CreatedByType string

The type of identity that created the resource.

LastModifiedAt string

The timestamp of resource last modification (UTC)

LastModifiedBy string

The identity that last modified the resource.

LastModifiedByType string

The type of identity that last modified the resource.

CreatedAt string

The timestamp of resource creation (UTC).

CreatedBy string

The identity that created the resource.

CreatedByType string

The type of identity that created the resource.

LastModifiedAt string

The timestamp of resource last modification (UTC)

LastModifiedBy string

The identity that last modified the resource.

LastModifiedByType string

The type of identity that last modified the resource.

createdAt String

The timestamp of resource creation (UTC).

createdBy String

The identity that created the resource.

createdByType String

The type of identity that created the resource.

lastModifiedAt String

The timestamp of resource last modification (UTC)

lastModifiedBy String

The identity that last modified the resource.

lastModifiedByType String

The type of identity that last modified the resource.

createdAt string

The timestamp of resource creation (UTC).

createdBy string

The identity that created the resource.

createdByType string

The type of identity that created the resource.

lastModifiedAt string

The timestamp of resource last modification (UTC)

lastModifiedBy string

The identity that last modified the resource.

lastModifiedByType string

The type of identity that last modified the resource.

created_at str

The timestamp of resource creation (UTC).

created_by str

The identity that created the resource.

created_by_type str

The type of identity that created the resource.

last_modified_at str

The timestamp of resource last modification (UTC)

last_modified_by str

The identity that last modified the resource.

last_modified_by_type str

The type of identity that last modified the resource.

createdAt String

The timestamp of resource creation (UTC).

createdBy String

The identity that created the resource.

createdByType String

The type of identity that created the resource.

lastModifiedAt String

The timestamp of resource last modification (UTC)

lastModifiedBy String

The identity that last modified the resource.

lastModifiedByType String

The type of identity that last modified the resource.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0