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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.appplatform.SpringCloudGateway

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

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

Manages a Spring Cloud Gateway.

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 exampleSpringCloudGateway = new azure.appplatform.SpringCloudGateway("example", {
    name: "default",
    springCloudServiceId: exampleSpringCloudService.id,
    httpsOnly: false,
    publicNetworkAccessEnabled: true,
    instanceCount: 2,
    apiMetadata: {
        description: "example description",
        documentationUrl: "https://www.example.com/docs",
        serverUrl: "https://wwww.example.com",
        title: "example title",
        version: "1.0",
    },
    cors: {
        credentialsAllowed: false,
        allowedHeaders: ["*"],
        allowedMethods: ["PUT"],
        allowedOrigins: ["example.com"],
        exposedHeaders: ["x-example-header"],
        maxAgeSeconds: 86400,
    },
    quota: {
        cpu: "1",
        memory: "2Gi",
    },
    sso: {
        clientId: "example id",
        clientSecret: "example secret",
        issuerUri: "https://www.test.com/issueToken",
        scopes: ["read"],
    },
    localResponseCachePerInstance: {
        size: "100MB",
        timeToLive: "30s",
    },
});
Copy
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_gateway = azure.appplatform.SpringCloudGateway("example",
    name="default",
    spring_cloud_service_id=example_spring_cloud_service.id,
    https_only=False,
    public_network_access_enabled=True,
    instance_count=2,
    api_metadata={
        "description": "example description",
        "documentation_url": "https://www.example.com/docs",
        "server_url": "https://wwww.example.com",
        "title": "example title",
        "version": "1.0",
    },
    cors={
        "credentials_allowed": False,
        "allowed_headers": ["*"],
        "allowed_methods": ["PUT"],
        "allowed_origins": ["example.com"],
        "exposed_headers": ["x-example-header"],
        "max_age_seconds": 86400,
    },
    quota={
        "cpu": "1",
        "memory": "2Gi",
    },
    sso={
        "client_id": "example id",
        "client_secret": "example secret",
        "issuer_uri": "https://www.test.com/issueToken",
        "scopes": ["read"],
    },
    local_response_cache_per_instance={
        "size": "100MB",
        "time_to_live": "30s",
    })
Copy
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
		}
		_, err = appplatform.NewSpringCloudGateway(ctx, "example", &appplatform.SpringCloudGatewayArgs{
			Name:                       pulumi.String("default"),
			SpringCloudServiceId:       exampleSpringCloudService.ID(),
			HttpsOnly:                  pulumi.Bool(false),
			PublicNetworkAccessEnabled: pulumi.Bool(true),
			InstanceCount:              pulumi.Int(2),
			ApiMetadata: &appplatform.SpringCloudGatewayApiMetadataArgs{
				Description:      pulumi.String("example description"),
				DocumentationUrl: pulumi.String("https://www.example.com/docs"),
				ServerUrl:        pulumi.String("https://wwww.example.com"),
				Title:            pulumi.String("example title"),
				Version:          pulumi.String("1.0"),
			},
			Cors: &appplatform.SpringCloudGatewayCorsArgs{
				CredentialsAllowed: pulumi.Bool(false),
				AllowedHeaders: pulumi.StringArray{
					pulumi.String("*"),
				},
				AllowedMethods: pulumi.StringArray{
					pulumi.String("PUT"),
				},
				AllowedOrigins: pulumi.StringArray{
					pulumi.String("example.com"),
				},
				ExposedHeaders: pulumi.StringArray{
					pulumi.String("x-example-header"),
				},
				MaxAgeSeconds: pulumi.Int(86400),
			},
			Quota: &appplatform.SpringCloudGatewayQuotaArgs{
				Cpu:    pulumi.String("1"),
				Memory: pulumi.String("2Gi"),
			},
			Sso: &appplatform.SpringCloudGatewaySsoArgs{
				ClientId:     pulumi.String("example id"),
				ClientSecret: pulumi.String("example secret"),
				IssuerUri:    pulumi.String("https://www.test.com/issueToken"),
				Scopes: pulumi.StringArray{
					pulumi.String("read"),
				},
			},
			LocalResponseCachePerInstance: &appplatform.SpringCloudGatewayLocalResponseCachePerInstanceArgs{
				Size:       pulumi.String("100MB"),
				TimeToLive: pulumi.String("30s"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 exampleSpringCloudGateway = new Azure.AppPlatform.SpringCloudGateway("example", new()
    {
        Name = "default",
        SpringCloudServiceId = exampleSpringCloudService.Id,
        HttpsOnly = false,
        PublicNetworkAccessEnabled = true,
        InstanceCount = 2,
        ApiMetadata = new Azure.AppPlatform.Inputs.SpringCloudGatewayApiMetadataArgs
        {
            Description = "example description",
            DocumentationUrl = "https://www.example.com/docs",
            ServerUrl = "https://wwww.example.com",
            Title = "example title",
            Version = "1.0",
        },
        Cors = new Azure.AppPlatform.Inputs.SpringCloudGatewayCorsArgs
        {
            CredentialsAllowed = false,
            AllowedHeaders = new[]
            {
                "*",
            },
            AllowedMethods = new[]
            {
                "PUT",
            },
            AllowedOrigins = new[]
            {
                "example.com",
            },
            ExposedHeaders = new[]
            {
                "x-example-header",
            },
            MaxAgeSeconds = 86400,
        },
        Quota = new Azure.AppPlatform.Inputs.SpringCloudGatewayQuotaArgs
        {
            Cpu = "1",
            Memory = "2Gi",
        },
        Sso = new Azure.AppPlatform.Inputs.SpringCloudGatewaySsoArgs
        {
            ClientId = "example id",
            ClientSecret = "example secret",
            IssuerUri = "https://www.test.com/issueToken",
            Scopes = new[]
            {
                "read",
            },
        },
        LocalResponseCachePerInstance = new Azure.AppPlatform.Inputs.SpringCloudGatewayLocalResponseCachePerInstanceArgs
        {
            Size = "100MB",
            TimeToLive = "30s",
        },
    });

});
Copy
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.SpringCloudGateway;
import com.pulumi.azure.appplatform.SpringCloudGatewayArgs;
import com.pulumi.azure.appplatform.inputs.SpringCloudGatewayApiMetadataArgs;
import com.pulumi.azure.appplatform.inputs.SpringCloudGatewayCorsArgs;
import com.pulumi.azure.appplatform.inputs.SpringCloudGatewayQuotaArgs;
import com.pulumi.azure.appplatform.inputs.SpringCloudGatewaySsoArgs;
import com.pulumi.azure.appplatform.inputs.SpringCloudGatewayLocalResponseCachePerInstanceArgs;
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 exampleSpringCloudGateway = new SpringCloudGateway("exampleSpringCloudGateway", SpringCloudGatewayArgs.builder()
            .name("default")
            .springCloudServiceId(exampleSpringCloudService.id())
            .httpsOnly(false)
            .publicNetworkAccessEnabled(true)
            .instanceCount(2)
            .apiMetadata(SpringCloudGatewayApiMetadataArgs.builder()
                .description("example description")
                .documentationUrl("https://www.example.com/docs")
                .serverUrl("https://wwww.example.com")
                .title("example title")
                .version("1.0")
                .build())
            .cors(SpringCloudGatewayCorsArgs.builder()
                .credentialsAllowed(false)
                .allowedHeaders("*")
                .allowedMethods("PUT")
                .allowedOrigins("example.com")
                .exposedHeaders("x-example-header")
                .maxAgeSeconds(86400)
                .build())
            .quota(SpringCloudGatewayQuotaArgs.builder()
                .cpu("1")
                .memory("2Gi")
                .build())
            .sso(SpringCloudGatewaySsoArgs.builder()
                .clientId("example id")
                .clientSecret("example secret")
                .issuerUri("https://www.test.com/issueToken")
                .scopes("read")
                .build())
            .localResponseCachePerInstance(SpringCloudGatewayLocalResponseCachePerInstanceArgs.builder()
                .size("100MB")
                .timeToLive("30s")
                .build())
            .build());

    }
}
Copy
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
  exampleSpringCloudGateway:
    type: azure:appplatform:SpringCloudGateway
    name: example
    properties:
      name: default
      springCloudServiceId: ${exampleSpringCloudService.id}
      httpsOnly: false
      publicNetworkAccessEnabled: true
      instanceCount: 2
      apiMetadata:
        description: example description
        documentationUrl: https://www.example.com/docs
        serverUrl: https://wwww.example.com
        title: example title
        version: '1.0'
      cors:
        credentialsAllowed: false
        allowedHeaders:
          - '*'
        allowedMethods:
          - PUT
        allowedOrigins:
          - example.com
        exposedHeaders:
          - x-example-header
        maxAgeSeconds: 86400
      quota:
        cpu: '1'
        memory: 2Gi
      sso:
        clientId: example id
        clientSecret: example secret
        issuerUri: https://www.test.com/issueToken
        scopes:
          - read
      localResponseCachePerInstance:
        size: 100MB
        timeToLive: 30s
Copy

Create SpringCloudGateway Resource

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

Constructor syntax

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

@overload
def SpringCloudGateway(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       spring_cloud_service_id: Optional[str] = None,
                       local_response_cache_per_instance: Optional[SpringCloudGatewayLocalResponseCachePerInstanceArgs] = None,
                       local_response_cache_per_route: Optional[SpringCloudGatewayLocalResponseCachePerRouteArgs] = None,
                       client_authorization: Optional[SpringCloudGatewayClientAuthorizationArgs] = None,
                       cors: Optional[SpringCloudGatewayCorsArgs] = None,
                       environment_variables: Optional[Mapping[str, str]] = None,
                       https_only: Optional[bool] = None,
                       application_performance_monitoring_types: Optional[Sequence[str]] = None,
                       api_metadata: Optional[SpringCloudGatewayApiMetadataArgs] = None,
                       instance_count: Optional[int] = None,
                       name: Optional[str] = None,
                       public_network_access_enabled: Optional[bool] = None,
                       quota: Optional[SpringCloudGatewayQuotaArgs] = None,
                       sensitive_environment_variables: Optional[Mapping[str, str]] = None,
                       application_performance_monitoring_ids: Optional[Sequence[str]] = None,
                       sso: Optional[SpringCloudGatewaySsoArgs] = None)
func NewSpringCloudGateway(ctx *Context, name string, args SpringCloudGatewayArgs, opts ...ResourceOption) (*SpringCloudGateway, error)
public SpringCloudGateway(string name, SpringCloudGatewayArgs args, CustomResourceOptions? opts = null)
public SpringCloudGateway(String name, SpringCloudGatewayArgs args)
public SpringCloudGateway(String name, SpringCloudGatewayArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SpringCloudGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SpringCloudGatewayArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SpringCloudGatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SpringCloudGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SpringCloudGatewayArgs
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 springCloudGatewayResource = new Azure.AppPlatform.SpringCloudGateway("springCloudGatewayResource", new()
{
    SpringCloudServiceId = "string",
    LocalResponseCachePerInstance = new Azure.AppPlatform.Inputs.SpringCloudGatewayLocalResponseCachePerInstanceArgs
    {
        Size = "string",
        TimeToLive = "string",
    },
    LocalResponseCachePerRoute = new Azure.AppPlatform.Inputs.SpringCloudGatewayLocalResponseCachePerRouteArgs
    {
        Size = "string",
        TimeToLive = "string",
    },
    ClientAuthorization = new Azure.AppPlatform.Inputs.SpringCloudGatewayClientAuthorizationArgs
    {
        CertificateIds = new[]
        {
            "string",
        },
        VerificationEnabled = false,
    },
    Cors = new Azure.AppPlatform.Inputs.SpringCloudGatewayCorsArgs
    {
        AllowedHeaders = new[]
        {
            "string",
        },
        AllowedMethods = new[]
        {
            "string",
        },
        AllowedOriginPatterns = new[]
        {
            "string",
        },
        AllowedOrigins = new[]
        {
            "string",
        },
        CredentialsAllowed = false,
        ExposedHeaders = new[]
        {
            "string",
        },
        MaxAgeSeconds = 0,
    },
    EnvironmentVariables = 
    {
        { "string", "string" },
    },
    HttpsOnly = false,
    ApplicationPerformanceMonitoringTypes = new[]
    {
        "string",
    },
    ApiMetadata = new Azure.AppPlatform.Inputs.SpringCloudGatewayApiMetadataArgs
    {
        Description = "string",
        DocumentationUrl = "string",
        ServerUrl = "string",
        Title = "string",
        Version = "string",
    },
    InstanceCount = 0,
    Name = "string",
    PublicNetworkAccessEnabled = false,
    Quota = new Azure.AppPlatform.Inputs.SpringCloudGatewayQuotaArgs
    {
        Cpu = "string",
        Memory = "string",
    },
    SensitiveEnvironmentVariables = 
    {
        { "string", "string" },
    },
    ApplicationPerformanceMonitoringIds = new[]
    {
        "string",
    },
    Sso = new Azure.AppPlatform.Inputs.SpringCloudGatewaySsoArgs
    {
        ClientId = "string",
        ClientSecret = "string",
        IssuerUri = "string",
        Scopes = new[]
        {
            "string",
        },
    },
});
Copy
example, err := appplatform.NewSpringCloudGateway(ctx, "springCloudGatewayResource", &appplatform.SpringCloudGatewayArgs{
	SpringCloudServiceId: pulumi.String("string"),
	LocalResponseCachePerInstance: &appplatform.SpringCloudGatewayLocalResponseCachePerInstanceArgs{
		Size:       pulumi.String("string"),
		TimeToLive: pulumi.String("string"),
	},
	LocalResponseCachePerRoute: &appplatform.SpringCloudGatewayLocalResponseCachePerRouteArgs{
		Size:       pulumi.String("string"),
		TimeToLive: pulumi.String("string"),
	},
	ClientAuthorization: &appplatform.SpringCloudGatewayClientAuthorizationArgs{
		CertificateIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		VerificationEnabled: pulumi.Bool(false),
	},
	Cors: &appplatform.SpringCloudGatewayCorsArgs{
		AllowedHeaders: pulumi.StringArray{
			pulumi.String("string"),
		},
		AllowedMethods: pulumi.StringArray{
			pulumi.String("string"),
		},
		AllowedOriginPatterns: pulumi.StringArray{
			pulumi.String("string"),
		},
		AllowedOrigins: pulumi.StringArray{
			pulumi.String("string"),
		},
		CredentialsAllowed: pulumi.Bool(false),
		ExposedHeaders: pulumi.StringArray{
			pulumi.String("string"),
		},
		MaxAgeSeconds: pulumi.Int(0),
	},
	EnvironmentVariables: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	HttpsOnly: pulumi.Bool(false),
	ApplicationPerformanceMonitoringTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	ApiMetadata: &appplatform.SpringCloudGatewayApiMetadataArgs{
		Description:      pulumi.String("string"),
		DocumentationUrl: pulumi.String("string"),
		ServerUrl:        pulumi.String("string"),
		Title:            pulumi.String("string"),
		Version:          pulumi.String("string"),
	},
	InstanceCount:              pulumi.Int(0),
	Name:                       pulumi.String("string"),
	PublicNetworkAccessEnabled: pulumi.Bool(false),
	Quota: &appplatform.SpringCloudGatewayQuotaArgs{
		Cpu:    pulumi.String("string"),
		Memory: pulumi.String("string"),
	},
	SensitiveEnvironmentVariables: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ApplicationPerformanceMonitoringIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Sso: &appplatform.SpringCloudGatewaySsoArgs{
		ClientId:     pulumi.String("string"),
		ClientSecret: pulumi.String("string"),
		IssuerUri:    pulumi.String("string"),
		Scopes: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})
Copy
var springCloudGatewayResource = new SpringCloudGateway("springCloudGatewayResource", SpringCloudGatewayArgs.builder()
    .springCloudServiceId("string")
    .localResponseCachePerInstance(SpringCloudGatewayLocalResponseCachePerInstanceArgs.builder()
        .size("string")
        .timeToLive("string")
        .build())
    .localResponseCachePerRoute(SpringCloudGatewayLocalResponseCachePerRouteArgs.builder()
        .size("string")
        .timeToLive("string")
        .build())
    .clientAuthorization(SpringCloudGatewayClientAuthorizationArgs.builder()
        .certificateIds("string")
        .verificationEnabled(false)
        .build())
    .cors(SpringCloudGatewayCorsArgs.builder()
        .allowedHeaders("string")
        .allowedMethods("string")
        .allowedOriginPatterns("string")
        .allowedOrigins("string")
        .credentialsAllowed(false)
        .exposedHeaders("string")
        .maxAgeSeconds(0)
        .build())
    .environmentVariables(Map.of("string", "string"))
    .httpsOnly(false)
    .applicationPerformanceMonitoringTypes("string")
    .apiMetadata(SpringCloudGatewayApiMetadataArgs.builder()
        .description("string")
        .documentationUrl("string")
        .serverUrl("string")
        .title("string")
        .version("string")
        .build())
    .instanceCount(0)
    .name("string")
    .publicNetworkAccessEnabled(false)
    .quota(SpringCloudGatewayQuotaArgs.builder()
        .cpu("string")
        .memory("string")
        .build())
    .sensitiveEnvironmentVariables(Map.of("string", "string"))
    .applicationPerformanceMonitoringIds("string")
    .sso(SpringCloudGatewaySsoArgs.builder()
        .clientId("string")
        .clientSecret("string")
        .issuerUri("string")
        .scopes("string")
        .build())
    .build());
Copy
spring_cloud_gateway_resource = azure.appplatform.SpringCloudGateway("springCloudGatewayResource",
    spring_cloud_service_id="string",
    local_response_cache_per_instance={
        "size": "string",
        "time_to_live": "string",
    },
    local_response_cache_per_route={
        "size": "string",
        "time_to_live": "string",
    },
    client_authorization={
        "certificate_ids": ["string"],
        "verification_enabled": False,
    },
    cors={
        "allowed_headers": ["string"],
        "allowed_methods": ["string"],
        "allowed_origin_patterns": ["string"],
        "allowed_origins": ["string"],
        "credentials_allowed": False,
        "exposed_headers": ["string"],
        "max_age_seconds": 0,
    },
    environment_variables={
        "string": "string",
    },
    https_only=False,
    application_performance_monitoring_types=["string"],
    api_metadata={
        "description": "string",
        "documentation_url": "string",
        "server_url": "string",
        "title": "string",
        "version": "string",
    },
    instance_count=0,
    name="string",
    public_network_access_enabled=False,
    quota={
        "cpu": "string",
        "memory": "string",
    },
    sensitive_environment_variables={
        "string": "string",
    },
    application_performance_monitoring_ids=["string"],
    sso={
        "client_id": "string",
        "client_secret": "string",
        "issuer_uri": "string",
        "scopes": ["string"],
    })
Copy
const springCloudGatewayResource = new azure.appplatform.SpringCloudGateway("springCloudGatewayResource", {
    springCloudServiceId: "string",
    localResponseCachePerInstance: {
        size: "string",
        timeToLive: "string",
    },
    localResponseCachePerRoute: {
        size: "string",
        timeToLive: "string",
    },
    clientAuthorization: {
        certificateIds: ["string"],
        verificationEnabled: false,
    },
    cors: {
        allowedHeaders: ["string"],
        allowedMethods: ["string"],
        allowedOriginPatterns: ["string"],
        allowedOrigins: ["string"],
        credentialsAllowed: false,
        exposedHeaders: ["string"],
        maxAgeSeconds: 0,
    },
    environmentVariables: {
        string: "string",
    },
    httpsOnly: false,
    applicationPerformanceMonitoringTypes: ["string"],
    apiMetadata: {
        description: "string",
        documentationUrl: "string",
        serverUrl: "string",
        title: "string",
        version: "string",
    },
    instanceCount: 0,
    name: "string",
    publicNetworkAccessEnabled: false,
    quota: {
        cpu: "string",
        memory: "string",
    },
    sensitiveEnvironmentVariables: {
        string: "string",
    },
    applicationPerformanceMonitoringIds: ["string"],
    sso: {
        clientId: "string",
        clientSecret: "string",
        issuerUri: "string",
        scopes: ["string"],
    },
});
Copy
type: azure:appplatform:SpringCloudGateway
properties:
    apiMetadata:
        description: string
        documentationUrl: string
        serverUrl: string
        title: string
        version: string
    applicationPerformanceMonitoringIds:
        - string
    applicationPerformanceMonitoringTypes:
        - string
    clientAuthorization:
        certificateIds:
            - string
        verificationEnabled: false
    cors:
        allowedHeaders:
            - string
        allowedMethods:
            - string
        allowedOriginPatterns:
            - string
        allowedOrigins:
            - string
        credentialsAllowed: false
        exposedHeaders:
            - string
        maxAgeSeconds: 0
    environmentVariables:
        string: string
    httpsOnly: false
    instanceCount: 0
    localResponseCachePerInstance:
        size: string
        timeToLive: string
    localResponseCachePerRoute:
        size: string
        timeToLive: string
    name: string
    publicNetworkAccessEnabled: false
    quota:
        cpu: string
        memory: string
    sensitiveEnvironmentVariables:
        string: string
    springCloudServiceId: string
    sso:
        clientId: string
        clientSecret: string
        issuerUri: string
        scopes:
            - string
Copy

SpringCloudGateway 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 SpringCloudGateway resource accepts the following input properties:

SpringCloudServiceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
ApiMetadata SpringCloudGatewayApiMetadata
A api_metadata block as defined below.
ApplicationPerformanceMonitoringIds List<string>
Specifies a list of Spring Cloud Application Performance Monitoring IDs.
ApplicationPerformanceMonitoringTypes List<string>
Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are AppDynamics, ApplicationInsights, Dynatrace, ElasticAPM and NewRelic.
ClientAuthorization SpringCloudGatewayClientAuthorization
A client_authorization block as defined below.
Cors SpringCloudGatewayCors
A cors block as defined below.
EnvironmentVariables Dictionary<string, string>
Specifies the environment variables of the Spring Cloud Gateway as a map of key-value pairs.
HttpsOnly bool
is only https is allowed?
InstanceCount int
Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between 1 and 500. Defaults to 1 if not specified.
LocalResponseCachePerInstance SpringCloudGatewayLocalResponseCachePerInstance
A local_response_cache_per_instance block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
LocalResponseCachePerRoute SpringCloudGatewayLocalResponseCachePerRoute
A local_response_cache_per_route block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
Name Changes to this property will trigger replacement. string
The name which should be used for this Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway to be created. The only possible value is default.
PublicNetworkAccessEnabled bool
Indicates whether the Spring Cloud Gateway exposes endpoint.
Quota SpringCloudGatewayQuota
A quota block as defined below.
SensitiveEnvironmentVariables Dictionary<string, string>
Specifies the sensitive environment variables of the Spring Cloud Gateway as a map of key-value pairs.
Sso SpringCloudGatewaySso
A sso block as defined below.
SpringCloudServiceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
ApiMetadata SpringCloudGatewayApiMetadataArgs
A api_metadata block as defined below.
ApplicationPerformanceMonitoringIds []string
Specifies a list of Spring Cloud Application Performance Monitoring IDs.
ApplicationPerformanceMonitoringTypes []string
Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are AppDynamics, ApplicationInsights, Dynatrace, ElasticAPM and NewRelic.
ClientAuthorization SpringCloudGatewayClientAuthorizationArgs
A client_authorization block as defined below.
Cors SpringCloudGatewayCorsArgs
A cors block as defined below.
EnvironmentVariables map[string]string
Specifies the environment variables of the Spring Cloud Gateway as a map of key-value pairs.
HttpsOnly bool
is only https is allowed?
InstanceCount int
Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between 1 and 500. Defaults to 1 if not specified.
LocalResponseCachePerInstance SpringCloudGatewayLocalResponseCachePerInstanceArgs
A local_response_cache_per_instance block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
LocalResponseCachePerRoute SpringCloudGatewayLocalResponseCachePerRouteArgs
A local_response_cache_per_route block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
Name Changes to this property will trigger replacement. string
The name which should be used for this Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway to be created. The only possible value is default.
PublicNetworkAccessEnabled bool
Indicates whether the Spring Cloud Gateway exposes endpoint.
Quota SpringCloudGatewayQuotaArgs
A quota block as defined below.
SensitiveEnvironmentVariables map[string]string
Specifies the sensitive environment variables of the Spring Cloud Gateway as a map of key-value pairs.
Sso SpringCloudGatewaySsoArgs
A sso block as defined below.
springCloudServiceId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
apiMetadata SpringCloudGatewayApiMetadata
A api_metadata block as defined below.
applicationPerformanceMonitoringIds List<String>
Specifies a list of Spring Cloud Application Performance Monitoring IDs.
applicationPerformanceMonitoringTypes List<String>
Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are AppDynamics, ApplicationInsights, Dynatrace, ElasticAPM and NewRelic.
clientAuthorization SpringCloudGatewayClientAuthorization
A client_authorization block as defined below.
cors SpringCloudGatewayCors
A cors block as defined below.
environmentVariables Map<String,String>
Specifies the environment variables of the Spring Cloud Gateway as a map of key-value pairs.
httpsOnly Boolean
is only https is allowed?
instanceCount Integer
Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between 1 and 500. Defaults to 1 if not specified.
localResponseCachePerInstance SpringCloudGatewayLocalResponseCachePerInstance
A local_response_cache_per_instance block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
localResponseCachePerRoute SpringCloudGatewayLocalResponseCachePerRoute
A local_response_cache_per_route block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
name Changes to this property will trigger replacement. String
The name which should be used for this Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway to be created. The only possible value is default.
publicNetworkAccessEnabled Boolean
Indicates whether the Spring Cloud Gateway exposes endpoint.
quota SpringCloudGatewayQuota
A quota block as defined below.
sensitiveEnvironmentVariables Map<String,String>
Specifies the sensitive environment variables of the Spring Cloud Gateway as a map of key-value pairs.
sso SpringCloudGatewaySso
A sso block as defined below.
springCloudServiceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
apiMetadata SpringCloudGatewayApiMetadata
A api_metadata block as defined below.
applicationPerformanceMonitoringIds string[]
Specifies a list of Spring Cloud Application Performance Monitoring IDs.
applicationPerformanceMonitoringTypes string[]
Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are AppDynamics, ApplicationInsights, Dynatrace, ElasticAPM and NewRelic.
clientAuthorization SpringCloudGatewayClientAuthorization
A client_authorization block as defined below.
cors SpringCloudGatewayCors
A cors block as defined below.
environmentVariables {[key: string]: string}
Specifies the environment variables of the Spring Cloud Gateway as a map of key-value pairs.
httpsOnly boolean
is only https is allowed?
instanceCount number
Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between 1 and 500. Defaults to 1 if not specified.
localResponseCachePerInstance SpringCloudGatewayLocalResponseCachePerInstance
A local_response_cache_per_instance block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
localResponseCachePerRoute SpringCloudGatewayLocalResponseCachePerRoute
A local_response_cache_per_route block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
name Changes to this property will trigger replacement. string
The name which should be used for this Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway to be created. The only possible value is default.
publicNetworkAccessEnabled boolean
Indicates whether the Spring Cloud Gateway exposes endpoint.
quota SpringCloudGatewayQuota
A quota block as defined below.
sensitiveEnvironmentVariables {[key: string]: string}
Specifies the sensitive environment variables of the Spring Cloud Gateway as a map of key-value pairs.
sso SpringCloudGatewaySso
A sso block as defined below.
spring_cloud_service_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
api_metadata SpringCloudGatewayApiMetadataArgs
A api_metadata block as defined below.
application_performance_monitoring_ids Sequence[str]
Specifies a list of Spring Cloud Application Performance Monitoring IDs.
application_performance_monitoring_types Sequence[str]
Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are AppDynamics, ApplicationInsights, Dynatrace, ElasticAPM and NewRelic.
client_authorization SpringCloudGatewayClientAuthorizationArgs
A client_authorization block as defined below.
cors SpringCloudGatewayCorsArgs
A cors block as defined below.
environment_variables Mapping[str, str]
Specifies the environment variables of the Spring Cloud Gateway as a map of key-value pairs.
https_only bool
is only https is allowed?
instance_count int
Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between 1 and 500. Defaults to 1 if not specified.
local_response_cache_per_instance SpringCloudGatewayLocalResponseCachePerInstanceArgs
A local_response_cache_per_instance block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
local_response_cache_per_route SpringCloudGatewayLocalResponseCachePerRouteArgs
A local_response_cache_per_route block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
name Changes to this property will trigger replacement. str
The name which should be used for this Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway to be created. The only possible value is default.
public_network_access_enabled bool
Indicates whether the Spring Cloud Gateway exposes endpoint.
quota SpringCloudGatewayQuotaArgs
A quota block as defined below.
sensitive_environment_variables Mapping[str, str]
Specifies the sensitive environment variables of the Spring Cloud Gateway as a map of key-value pairs.
sso SpringCloudGatewaySsoArgs
A sso block as defined below.
springCloudServiceId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
apiMetadata Property Map
A api_metadata block as defined below.
applicationPerformanceMonitoringIds List<String>
Specifies a list of Spring Cloud Application Performance Monitoring IDs.
applicationPerformanceMonitoringTypes List<String>
Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are AppDynamics, ApplicationInsights, Dynatrace, ElasticAPM and NewRelic.
clientAuthorization Property Map
A client_authorization block as defined below.
cors Property Map
A cors block as defined below.
environmentVariables Map<String>
Specifies the environment variables of the Spring Cloud Gateway as a map of key-value pairs.
httpsOnly Boolean
is only https is allowed?
instanceCount Number
Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between 1 and 500. Defaults to 1 if not specified.
localResponseCachePerInstance Property Map
A local_response_cache_per_instance block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
localResponseCachePerRoute Property Map
A local_response_cache_per_route block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
name Changes to this property will trigger replacement. String
The name which should be used for this Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway to be created. The only possible value is default.
publicNetworkAccessEnabled Boolean
Indicates whether the Spring Cloud Gateway exposes endpoint.
quota Property Map
A quota block as defined below.
sensitiveEnvironmentVariables Map<String>
Specifies the sensitive environment variables of the Spring Cloud Gateway as a map of key-value pairs.
sso Property Map
A sso block as defined below.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Url string
URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.
Id string
The provider-assigned unique ID for this managed resource.
Url string
URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.
id String
The provider-assigned unique ID for this managed resource.
url String
URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.
id string
The provider-assigned unique ID for this managed resource.
url string
URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.
id str
The provider-assigned unique ID for this managed resource.
url str
URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.
id String
The provider-assigned unique ID for this managed resource.
url String
URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.

Look up Existing SpringCloudGateway Resource

Get an existing SpringCloudGateway 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?: SpringCloudGatewayState, opts?: CustomResourceOptions): SpringCloudGateway
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_metadata: Optional[SpringCloudGatewayApiMetadataArgs] = None,
        application_performance_monitoring_ids: Optional[Sequence[str]] = None,
        application_performance_monitoring_types: Optional[Sequence[str]] = None,
        client_authorization: Optional[SpringCloudGatewayClientAuthorizationArgs] = None,
        cors: Optional[SpringCloudGatewayCorsArgs] = None,
        environment_variables: Optional[Mapping[str, str]] = None,
        https_only: Optional[bool] = None,
        instance_count: Optional[int] = None,
        local_response_cache_per_instance: Optional[SpringCloudGatewayLocalResponseCachePerInstanceArgs] = None,
        local_response_cache_per_route: Optional[SpringCloudGatewayLocalResponseCachePerRouteArgs] = None,
        name: Optional[str] = None,
        public_network_access_enabled: Optional[bool] = None,
        quota: Optional[SpringCloudGatewayQuotaArgs] = None,
        sensitive_environment_variables: Optional[Mapping[str, str]] = None,
        spring_cloud_service_id: Optional[str] = None,
        sso: Optional[SpringCloudGatewaySsoArgs] = None,
        url: Optional[str] = None) -> SpringCloudGateway
func GetSpringCloudGateway(ctx *Context, name string, id IDInput, state *SpringCloudGatewayState, opts ...ResourceOption) (*SpringCloudGateway, error)
public static SpringCloudGateway Get(string name, Input<string> id, SpringCloudGatewayState? state, CustomResourceOptions? opts = null)
public static SpringCloudGateway get(String name, Output<String> id, SpringCloudGatewayState state, CustomResourceOptions options)
resources:  _:    type: azure:appplatform:SpringCloudGateway    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ApiMetadata SpringCloudGatewayApiMetadata
A api_metadata block as defined below.
ApplicationPerformanceMonitoringIds List<string>
Specifies a list of Spring Cloud Application Performance Monitoring IDs.
ApplicationPerformanceMonitoringTypes List<string>
Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are AppDynamics, ApplicationInsights, Dynatrace, ElasticAPM and NewRelic.
ClientAuthorization SpringCloudGatewayClientAuthorization
A client_authorization block as defined below.
Cors SpringCloudGatewayCors
A cors block as defined below.
EnvironmentVariables Dictionary<string, string>
Specifies the environment variables of the Spring Cloud Gateway as a map of key-value pairs.
HttpsOnly bool
is only https is allowed?
InstanceCount int
Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between 1 and 500. Defaults to 1 if not specified.
LocalResponseCachePerInstance SpringCloudGatewayLocalResponseCachePerInstance
A local_response_cache_per_instance block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
LocalResponseCachePerRoute SpringCloudGatewayLocalResponseCachePerRoute
A local_response_cache_per_route block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
Name Changes to this property will trigger replacement. string
The name which should be used for this Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway to be created. The only possible value is default.
PublicNetworkAccessEnabled bool
Indicates whether the Spring Cloud Gateway exposes endpoint.
Quota SpringCloudGatewayQuota
A quota block as defined below.
SensitiveEnvironmentVariables Dictionary<string, string>
Specifies the sensitive environment variables of the Spring Cloud Gateway as a map of key-value pairs.
SpringCloudServiceId Changes to this property will trigger replacement. string
The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
Sso SpringCloudGatewaySso
A sso block as defined below.
Url string
URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.
ApiMetadata SpringCloudGatewayApiMetadataArgs
A api_metadata block as defined below.
ApplicationPerformanceMonitoringIds []string
Specifies a list of Spring Cloud Application Performance Monitoring IDs.
ApplicationPerformanceMonitoringTypes []string
Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are AppDynamics, ApplicationInsights, Dynatrace, ElasticAPM and NewRelic.
ClientAuthorization SpringCloudGatewayClientAuthorizationArgs
A client_authorization block as defined below.
Cors SpringCloudGatewayCorsArgs
A cors block as defined below.
EnvironmentVariables map[string]string
Specifies the environment variables of the Spring Cloud Gateway as a map of key-value pairs.
HttpsOnly bool
is only https is allowed?
InstanceCount int
Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between 1 and 500. Defaults to 1 if not specified.
LocalResponseCachePerInstance SpringCloudGatewayLocalResponseCachePerInstanceArgs
A local_response_cache_per_instance block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
LocalResponseCachePerRoute SpringCloudGatewayLocalResponseCachePerRouteArgs
A local_response_cache_per_route block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
Name Changes to this property will trigger replacement. string
The name which should be used for this Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway to be created. The only possible value is default.
PublicNetworkAccessEnabled bool
Indicates whether the Spring Cloud Gateway exposes endpoint.
Quota SpringCloudGatewayQuotaArgs
A quota block as defined below.
SensitiveEnvironmentVariables map[string]string
Specifies the sensitive environment variables of the Spring Cloud Gateway as a map of key-value pairs.
SpringCloudServiceId Changes to this property will trigger replacement. string
The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
Sso SpringCloudGatewaySsoArgs
A sso block as defined below.
Url string
URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.
apiMetadata SpringCloudGatewayApiMetadata
A api_metadata block as defined below.
applicationPerformanceMonitoringIds List<String>
Specifies a list of Spring Cloud Application Performance Monitoring IDs.
applicationPerformanceMonitoringTypes List<String>
Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are AppDynamics, ApplicationInsights, Dynatrace, ElasticAPM and NewRelic.
clientAuthorization SpringCloudGatewayClientAuthorization
A client_authorization block as defined below.
cors SpringCloudGatewayCors
A cors block as defined below.
environmentVariables Map<String,String>
Specifies the environment variables of the Spring Cloud Gateway as a map of key-value pairs.
httpsOnly Boolean
is only https is allowed?
instanceCount Integer
Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between 1 and 500. Defaults to 1 if not specified.
localResponseCachePerInstance SpringCloudGatewayLocalResponseCachePerInstance
A local_response_cache_per_instance block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
localResponseCachePerRoute SpringCloudGatewayLocalResponseCachePerRoute
A local_response_cache_per_route block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
name Changes to this property will trigger replacement. String
The name which should be used for this Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway to be created. The only possible value is default.
publicNetworkAccessEnabled Boolean
Indicates whether the Spring Cloud Gateway exposes endpoint.
quota SpringCloudGatewayQuota
A quota block as defined below.
sensitiveEnvironmentVariables Map<String,String>
Specifies the sensitive environment variables of the Spring Cloud Gateway as a map of key-value pairs.
springCloudServiceId Changes to this property will trigger replacement. String
The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
sso SpringCloudGatewaySso
A sso block as defined below.
url String
URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.
apiMetadata SpringCloudGatewayApiMetadata
A api_metadata block as defined below.
applicationPerformanceMonitoringIds string[]
Specifies a list of Spring Cloud Application Performance Monitoring IDs.
applicationPerformanceMonitoringTypes string[]
Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are AppDynamics, ApplicationInsights, Dynatrace, ElasticAPM and NewRelic.
clientAuthorization SpringCloudGatewayClientAuthorization
A client_authorization block as defined below.
cors SpringCloudGatewayCors
A cors block as defined below.
environmentVariables {[key: string]: string}
Specifies the environment variables of the Spring Cloud Gateway as a map of key-value pairs.
httpsOnly boolean
is only https is allowed?
instanceCount number
Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between 1 and 500. Defaults to 1 if not specified.
localResponseCachePerInstance SpringCloudGatewayLocalResponseCachePerInstance
A local_response_cache_per_instance block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
localResponseCachePerRoute SpringCloudGatewayLocalResponseCachePerRoute
A local_response_cache_per_route block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
name Changes to this property will trigger replacement. string
The name which should be used for this Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway to be created. The only possible value is default.
publicNetworkAccessEnabled boolean
Indicates whether the Spring Cloud Gateway exposes endpoint.
quota SpringCloudGatewayQuota
A quota block as defined below.
sensitiveEnvironmentVariables {[key: string]: string}
Specifies the sensitive environment variables of the Spring Cloud Gateway as a map of key-value pairs.
springCloudServiceId Changes to this property will trigger replacement. string
The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
sso SpringCloudGatewaySso
A sso block as defined below.
url string
URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.
api_metadata SpringCloudGatewayApiMetadataArgs
A api_metadata block as defined below.
application_performance_monitoring_ids Sequence[str]
Specifies a list of Spring Cloud Application Performance Monitoring IDs.
application_performance_monitoring_types Sequence[str]
Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are AppDynamics, ApplicationInsights, Dynatrace, ElasticAPM and NewRelic.
client_authorization SpringCloudGatewayClientAuthorizationArgs
A client_authorization block as defined below.
cors SpringCloudGatewayCorsArgs
A cors block as defined below.
environment_variables Mapping[str, str]
Specifies the environment variables of the Spring Cloud Gateway as a map of key-value pairs.
https_only bool
is only https is allowed?
instance_count int
Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between 1 and 500. Defaults to 1 if not specified.
local_response_cache_per_instance SpringCloudGatewayLocalResponseCachePerInstanceArgs
A local_response_cache_per_instance block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
local_response_cache_per_route SpringCloudGatewayLocalResponseCachePerRouteArgs
A local_response_cache_per_route block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
name Changes to this property will trigger replacement. str
The name which should be used for this Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway to be created. The only possible value is default.
public_network_access_enabled bool
Indicates whether the Spring Cloud Gateway exposes endpoint.
quota SpringCloudGatewayQuotaArgs
A quota block as defined below.
sensitive_environment_variables Mapping[str, str]
Specifies the sensitive environment variables of the Spring Cloud Gateway as a map of key-value pairs.
spring_cloud_service_id Changes to this property will trigger replacement. str
The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
sso SpringCloudGatewaySsoArgs
A sso block as defined below.
url str
URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.
apiMetadata Property Map
A api_metadata block as defined below.
applicationPerformanceMonitoringIds List<String>
Specifies a list of Spring Cloud Application Performance Monitoring IDs.
applicationPerformanceMonitoringTypes List<String>
Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are AppDynamics, ApplicationInsights, Dynatrace, ElasticAPM and NewRelic.
clientAuthorization Property Map
A client_authorization block as defined below.
cors Property Map
A cors block as defined below.
environmentVariables Map<String>
Specifies the environment variables of the Spring Cloud Gateway as a map of key-value pairs.
httpsOnly Boolean
is only https is allowed?
instanceCount Number
Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between 1 and 500. Defaults to 1 if not specified.
localResponseCachePerInstance Property Map
A local_response_cache_per_instance block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
localResponseCachePerRoute Property Map
A local_response_cache_per_route block as defined below. Only one of local_response_cache_per_instance or local_response_cache_per_route can be specified.
name Changes to this property will trigger replacement. String
The name which should be used for this Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway to be created. The only possible value is default.
publicNetworkAccessEnabled Boolean
Indicates whether the Spring Cloud Gateway exposes endpoint.
quota Property Map
A quota block as defined below.
sensitiveEnvironmentVariables Map<String>
Specifies the sensitive environment variables of the Spring Cloud Gateway as a map of key-value pairs.
springCloudServiceId Changes to this property will trigger replacement. String
The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
sso Property Map
A sso block as defined below.
url String
URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.

Supporting Types

SpringCloudGatewayApiMetadata
, SpringCloudGatewayApiMetadataArgs

Description string
Detailed description of the APIs available on the Gateway instance.
DocumentationUrl string
Location of additional documentation for the APIs available on the Gateway instance.
ServerUrl string
Base URL that API consumers will use to access APIs on the Gateway instance.
Title string
Specifies the title describing the context of the APIs available on the Gateway instance.
Version string
Specifies the version of APIs available on this Gateway instance.
Description string
Detailed description of the APIs available on the Gateway instance.
DocumentationUrl string
Location of additional documentation for the APIs available on the Gateway instance.
ServerUrl string
Base URL that API consumers will use to access APIs on the Gateway instance.
Title string
Specifies the title describing the context of the APIs available on the Gateway instance.
Version string
Specifies the version of APIs available on this Gateway instance.
description String
Detailed description of the APIs available on the Gateway instance.
documentationUrl String
Location of additional documentation for the APIs available on the Gateway instance.
serverUrl String
Base URL that API consumers will use to access APIs on the Gateway instance.
title String
Specifies the title describing the context of the APIs available on the Gateway instance.
version String
Specifies the version of APIs available on this Gateway instance.
description string
Detailed description of the APIs available on the Gateway instance.
documentationUrl string
Location of additional documentation for the APIs available on the Gateway instance.
serverUrl string
Base URL that API consumers will use to access APIs on the Gateway instance.
title string
Specifies the title describing the context of the APIs available on the Gateway instance.
version string
Specifies the version of APIs available on this Gateway instance.
description str
Detailed description of the APIs available on the Gateway instance.
documentation_url str
Location of additional documentation for the APIs available on the Gateway instance.
server_url str
Base URL that API consumers will use to access APIs on the Gateway instance.
title str
Specifies the title describing the context of the APIs available on the Gateway instance.
version str
Specifies the version of APIs available on this Gateway instance.
description String
Detailed description of the APIs available on the Gateway instance.
documentationUrl String
Location of additional documentation for the APIs available on the Gateway instance.
serverUrl String
Base URL that API consumers will use to access APIs on the Gateway instance.
title String
Specifies the title describing the context of the APIs available on the Gateway instance.
version String
Specifies the version of APIs available on this Gateway instance.

SpringCloudGatewayClientAuthorization
, SpringCloudGatewayClientAuthorizationArgs

CertificateIds List<string>
Specifies the Spring Cloud Certificate IDs of the Spring Cloud Gateway.
VerificationEnabled bool
Specifies whether the client certificate verification is enabled.
CertificateIds []string
Specifies the Spring Cloud Certificate IDs of the Spring Cloud Gateway.
VerificationEnabled bool
Specifies whether the client certificate verification is enabled.
certificateIds List<String>
Specifies the Spring Cloud Certificate IDs of the Spring Cloud Gateway.
verificationEnabled Boolean
Specifies whether the client certificate verification is enabled.
certificateIds string[]
Specifies the Spring Cloud Certificate IDs of the Spring Cloud Gateway.
verificationEnabled boolean
Specifies whether the client certificate verification is enabled.
certificate_ids Sequence[str]
Specifies the Spring Cloud Certificate IDs of the Spring Cloud Gateway.
verification_enabled bool
Specifies whether the client certificate verification is enabled.
certificateIds List<String>
Specifies the Spring Cloud Certificate IDs of the Spring Cloud Gateway.
verificationEnabled Boolean
Specifies whether the client certificate verification is enabled.

SpringCloudGatewayCors
, SpringCloudGatewayCorsArgs

AllowedHeaders List<string>
Allowed headers in cross-site requests. The special value * allows actual requests to send any header.
AllowedMethods List<string>
Allowed HTTP methods on cross-site requests. The special value * allows all methods. If not set, GET and HEAD are allowed by default. Possible values are DELETE, GET, HEAD, MERGE, POST, OPTIONS and PUT.
AllowedOriginPatterns List<string>
Allowed origin patterns to make cross-site requests.
AllowedOrigins List<string>
Allowed origins to make cross-site requests. The special value * allows all domains.
CredentialsAllowed bool
is user credentials are supported on cross-site requests?
ExposedHeaders List<string>
HTTP response headers to expose for cross-site requests.
MaxAgeSeconds int
How long, in seconds, the response from a pre-flight request can be cached by clients.
AllowedHeaders []string
Allowed headers in cross-site requests. The special value * allows actual requests to send any header.
AllowedMethods []string
Allowed HTTP methods on cross-site requests. The special value * allows all methods. If not set, GET and HEAD are allowed by default. Possible values are DELETE, GET, HEAD, MERGE, POST, OPTIONS and PUT.
AllowedOriginPatterns []string
Allowed origin patterns to make cross-site requests.
AllowedOrigins []string
Allowed origins to make cross-site requests. The special value * allows all domains.
CredentialsAllowed bool
is user credentials are supported on cross-site requests?
ExposedHeaders []string
HTTP response headers to expose for cross-site requests.
MaxAgeSeconds int
How long, in seconds, the response from a pre-flight request can be cached by clients.
allowedHeaders List<String>
Allowed headers in cross-site requests. The special value * allows actual requests to send any header.
allowedMethods List<String>
Allowed HTTP methods on cross-site requests. The special value * allows all methods. If not set, GET and HEAD are allowed by default. Possible values are DELETE, GET, HEAD, MERGE, POST, OPTIONS and PUT.
allowedOriginPatterns List<String>
Allowed origin patterns to make cross-site requests.
allowedOrigins List<String>
Allowed origins to make cross-site requests. The special value * allows all domains.
credentialsAllowed Boolean
is user credentials are supported on cross-site requests?
exposedHeaders List<String>
HTTP response headers to expose for cross-site requests.
maxAgeSeconds Integer
How long, in seconds, the response from a pre-flight request can be cached by clients.
allowedHeaders string[]
Allowed headers in cross-site requests. The special value * allows actual requests to send any header.
allowedMethods string[]
Allowed HTTP methods on cross-site requests. The special value * allows all methods. If not set, GET and HEAD are allowed by default. Possible values are DELETE, GET, HEAD, MERGE, POST, OPTIONS and PUT.
allowedOriginPatterns string[]
Allowed origin patterns to make cross-site requests.
allowedOrigins string[]
Allowed origins to make cross-site requests. The special value * allows all domains.
credentialsAllowed boolean
is user credentials are supported on cross-site requests?
exposedHeaders string[]
HTTP response headers to expose for cross-site requests.
maxAgeSeconds number
How long, in seconds, the response from a pre-flight request can be cached by clients.
allowed_headers Sequence[str]
Allowed headers in cross-site requests. The special value * allows actual requests to send any header.
allowed_methods Sequence[str]
Allowed HTTP methods on cross-site requests. The special value * allows all methods. If not set, GET and HEAD are allowed by default. Possible values are DELETE, GET, HEAD, MERGE, POST, OPTIONS and PUT.
allowed_origin_patterns Sequence[str]
Allowed origin patterns to make cross-site requests.
allowed_origins Sequence[str]
Allowed origins to make cross-site requests. The special value * allows all domains.
credentials_allowed bool
is user credentials are supported on cross-site requests?
exposed_headers Sequence[str]
HTTP response headers to expose for cross-site requests.
max_age_seconds int
How long, in seconds, the response from a pre-flight request can be cached by clients.
allowedHeaders List<String>
Allowed headers in cross-site requests. The special value * allows actual requests to send any header.
allowedMethods List<String>
Allowed HTTP methods on cross-site requests. The special value * allows all methods. If not set, GET and HEAD are allowed by default. Possible values are DELETE, GET, HEAD, MERGE, POST, OPTIONS and PUT.
allowedOriginPatterns List<String>
Allowed origin patterns to make cross-site requests.
allowedOrigins List<String>
Allowed origins to make cross-site requests. The special value * allows all domains.
credentialsAllowed Boolean
is user credentials are supported on cross-site requests?
exposedHeaders List<String>
HTTP response headers to expose for cross-site requests.
maxAgeSeconds Number
How long, in seconds, the response from a pre-flight request can be cached by clients.

SpringCloudGatewayLocalResponseCachePerInstance
, SpringCloudGatewayLocalResponseCachePerInstanceArgs

Size string
Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
TimeToLive string
Specifies the time before a cached entry is expired (300s, 5m, 1h...).
Size string
Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
TimeToLive string
Specifies the time before a cached entry is expired (300s, 5m, 1h...).
size String
Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
timeToLive String
Specifies the time before a cached entry is expired (300s, 5m, 1h...).
size string
Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
timeToLive string
Specifies the time before a cached entry is expired (300s, 5m, 1h...).
size str
Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
time_to_live str
Specifies the time before a cached entry is expired (300s, 5m, 1h...).
size String
Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
timeToLive String
Specifies the time before a cached entry is expired (300s, 5m, 1h...).

SpringCloudGatewayLocalResponseCachePerRoute
, SpringCloudGatewayLocalResponseCachePerRouteArgs

Size string
Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
TimeToLive string
Specifies the time before a cached entry is expired (300s, 5m, 1h...).
Size string
Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
TimeToLive string
Specifies the time before a cached entry is expired (300s, 5m, 1h...).
size String
Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
timeToLive String
Specifies the time before a cached entry is expired (300s, 5m, 1h...).
size string
Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
timeToLive string
Specifies the time before a cached entry is expired (300s, 5m, 1h...).
size str
Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
time_to_live str
Specifies the time before a cached entry is expired (300s, 5m, 1h...).
size String
Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
timeToLive String
Specifies the time before a cached entry is expired (300s, 5m, 1h...).

SpringCloudGatewayQuota
, SpringCloudGatewayQuotaArgs

Cpu string

Specifies the required cpu of the Spring Cloud Deployment. Possible Values are 500m, 1, 2, 3 and 4. Defaults to 1 if not specified.

Note: cpu supports 500m and 1 for Basic tier, 500m, 1, 2, 3 and 4 for Standard tier.

Memory string

Specifies the required memory size of the Spring Cloud Deployment. Possible Values are 512Mi, 1Gi, 2Gi, 3Gi, 4Gi, 5Gi, 6Gi, 7Gi, and 8Gi. Defaults to 2Gi if not specified.

Note: memory supports 512Mi, 1Gi and 2Gi for Basic tier, 512Mi, 1Gi, 2Gi, 3Gi, 4Gi, 5Gi, 6Gi, 7Gi, and 8Gi for Standard tier.

Cpu string

Specifies the required cpu of the Spring Cloud Deployment. Possible Values are 500m, 1, 2, 3 and 4. Defaults to 1 if not specified.

Note: cpu supports 500m and 1 for Basic tier, 500m, 1, 2, 3 and 4 for Standard tier.

Memory string

Specifies the required memory size of the Spring Cloud Deployment. Possible Values are 512Mi, 1Gi, 2Gi, 3Gi, 4Gi, 5Gi, 6Gi, 7Gi, and 8Gi. Defaults to 2Gi if not specified.

Note: memory supports 512Mi, 1Gi and 2Gi for Basic tier, 512Mi, 1Gi, 2Gi, 3Gi, 4Gi, 5Gi, 6Gi, 7Gi, and 8Gi for Standard tier.

cpu String

Specifies the required cpu of the Spring Cloud Deployment. Possible Values are 500m, 1, 2, 3 and 4. Defaults to 1 if not specified.

Note: cpu supports 500m and 1 for Basic tier, 500m, 1, 2, 3 and 4 for Standard tier.

memory String

Specifies the required memory size of the Spring Cloud Deployment. Possible Values are 512Mi, 1Gi, 2Gi, 3Gi, 4Gi, 5Gi, 6Gi, 7Gi, and 8Gi. Defaults to 2Gi if not specified.

Note: memory supports 512Mi, 1Gi and 2Gi for Basic tier, 512Mi, 1Gi, 2Gi, 3Gi, 4Gi, 5Gi, 6Gi, 7Gi, and 8Gi for Standard tier.

cpu string

Specifies the required cpu of the Spring Cloud Deployment. Possible Values are 500m, 1, 2, 3 and 4. Defaults to 1 if not specified.

Note: cpu supports 500m and 1 for Basic tier, 500m, 1, 2, 3 and 4 for Standard tier.

memory string

Specifies the required memory size of the Spring Cloud Deployment. Possible Values are 512Mi, 1Gi, 2Gi, 3Gi, 4Gi, 5Gi, 6Gi, 7Gi, and 8Gi. Defaults to 2Gi if not specified.

Note: memory supports 512Mi, 1Gi and 2Gi for Basic tier, 512Mi, 1Gi, 2Gi, 3Gi, 4Gi, 5Gi, 6Gi, 7Gi, and 8Gi for Standard tier.

cpu str

Specifies the required cpu of the Spring Cloud Deployment. Possible Values are 500m, 1, 2, 3 and 4. Defaults to 1 if not specified.

Note: cpu supports 500m and 1 for Basic tier, 500m, 1, 2, 3 and 4 for Standard tier.

memory str

Specifies the required memory size of the Spring Cloud Deployment. Possible Values are 512Mi, 1Gi, 2Gi, 3Gi, 4Gi, 5Gi, 6Gi, 7Gi, and 8Gi. Defaults to 2Gi if not specified.

Note: memory supports 512Mi, 1Gi and 2Gi for Basic tier, 512Mi, 1Gi, 2Gi, 3Gi, 4Gi, 5Gi, 6Gi, 7Gi, and 8Gi for Standard tier.

cpu String

Specifies the required cpu of the Spring Cloud Deployment. Possible Values are 500m, 1, 2, 3 and 4. Defaults to 1 if not specified.

Note: cpu supports 500m and 1 for Basic tier, 500m, 1, 2, 3 and 4 for Standard tier.

memory String

Specifies the required memory size of the Spring Cloud Deployment. Possible Values are 512Mi, 1Gi, 2Gi, 3Gi, 4Gi, 5Gi, 6Gi, 7Gi, and 8Gi. Defaults to 2Gi if not specified.

Note: memory supports 512Mi, 1Gi and 2Gi for Basic tier, 512Mi, 1Gi, 2Gi, 3Gi, 4Gi, 5Gi, 6Gi, 7Gi, and 8Gi for Standard tier.

SpringCloudGatewaySso
, SpringCloudGatewaySsoArgs

ClientId string
The public identifier for the application.
ClientSecret string
The secret known only to the application and the authorization server.
IssuerUri string
The URI of Issuer Identifier.
Scopes List<string>
It defines the specific actions applications can be allowed to do on a user's behalf.
ClientId string
The public identifier for the application.
ClientSecret string
The secret known only to the application and the authorization server.
IssuerUri string
The URI of Issuer Identifier.
Scopes []string
It defines the specific actions applications can be allowed to do on a user's behalf.
clientId String
The public identifier for the application.
clientSecret String
The secret known only to the application and the authorization server.
issuerUri String
The URI of Issuer Identifier.
scopes List<String>
It defines the specific actions applications can be allowed to do on a user's behalf.
clientId string
The public identifier for the application.
clientSecret string
The secret known only to the application and the authorization server.
issuerUri string
The URI of Issuer Identifier.
scopes string[]
It defines the specific actions applications can be allowed to do on a user's behalf.
client_id str
The public identifier for the application.
client_secret str
The secret known only to the application and the authorization server.
issuer_uri str
The URI of Issuer Identifier.
scopes Sequence[str]
It defines the specific actions applications can be allowed to do on a user's behalf.
clientId String
The public identifier for the application.
clientSecret String
The secret known only to the application and the authorization server.
issuerUri String
The URI of Issuer Identifier.
scopes List<String>
It defines the specific actions applications can be allowed to do on a user's behalf.

Import

Spring Cloud Gateways can be imported using the resource id, e.g.

$ pulumi import azure:appplatform/springCloudGateway:SpringCloudGateway example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resourceGroup1/providers/Microsoft.AppPlatform/spring/service1/gateways/gateway1
Copy

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.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure