Spring
data class SpringCloudGatewayArgs(val apiMetadata: Output<SpringCloudGatewayApiMetadataArgs>? = null, val applicationPerformanceMonitoringIds: Output<List<String>>? = null, val applicationPerformanceMonitoringTypes: Output<List<String>>? = null, val clientAuthorization: Output<SpringCloudGatewayClientAuthorizationArgs>? = null, val cors: Output<SpringCloudGatewayCorsArgs>? = null, val environmentVariables: Output<Map<String, String>>? = null, val httpsOnly: Output<Boolean>? = null, val instanceCount: Output<Int>? = null, val localResponseCachePerInstance: Output<SpringCloudGatewayLocalResponseCachePerInstanceArgs>? = null, val localResponseCachePerRoute: Output<SpringCloudGatewayLocalResponseCachePerRouteArgs>? = null, val name: Output<String>? = null, val publicNetworkAccessEnabled: Output<Boolean>? = null, val quota: Output<SpringCloudGatewayQuotaArgs>? = null, val sensitiveEnvironmentVariables: Output<Map<String, String>>? = null, val springCloudServiceId: Output<String>? = null, val sso: Output<SpringCloudGatewaySsoArgs>? = null) : ConvertibleToJava<SpringCloudGatewayArgs>
Note: This resource is applicable only for Spring Cloud Service with enterprise tier. Manages a Spring Cloud Gateway. !>Note: Azure Spring Apps is now deprecated and will be retired on 2028-05-31 - as such the
azure.appplatform.SpringCloudGatewayresource is deprecated and will be removed in a future major version of the AzureRM Provider. See https://aka.ms/asaretirement for more information.
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",
},
});Content copied to clipboard
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",
})Content copied to clipboard
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",
},
});
});Content copied to clipboard
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
})
}Content copied to clipboard
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());
}
}Content copied to clipboard
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: 30sContent copied to clipboard
API Providers
This resource uses the following Azure API Providers:
Microsoft.AppPlatform: 2024-01-01-preview
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/gateway1Content copied to clipboard
Constructors
Link copied to clipboard
constructor(apiMetadata: Output<SpringCloudGatewayApiMetadataArgs>? = null, applicationPerformanceMonitoringIds: Output<List<String>>? = null, applicationPerformanceMonitoringTypes: Output<List<String>>? = null, clientAuthorization: Output<SpringCloudGatewayClientAuthorizationArgs>? = null, cors: Output<SpringCloudGatewayCorsArgs>? = null, environmentVariables: Output<Map<String, String>>? = null, httpsOnly: Output<Boolean>? = null, instanceCount: Output<Int>? = null, localResponseCachePerInstance: Output<SpringCloudGatewayLocalResponseCachePerInstanceArgs>? = null, localResponseCachePerRoute: Output<SpringCloudGatewayLocalResponseCachePerRouteArgs>? = null, name: Output<String>? = null, publicNetworkAccessEnabled: Output<Boolean>? = null, quota: Output<SpringCloudGatewayQuotaArgs>? = null, sensitiveEnvironmentVariables: Output<Map<String, String>>? = null, springCloudServiceId: Output<String>? = null, sso: Output<SpringCloudGatewaySsoArgs>? = null)
Properties
Link copied to clipboard
A api_metadata block as defined below.
Link copied to clipboard
Specifies a list of Spring Cloud Application Performance Monitoring IDs.
Link copied to clipboard
Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are AppDynamics, ApplicationInsights, Dynatrace, ElasticAPM and NewRelic.
Link copied to clipboard
A client_authorization block as defined below.
Link copied to clipboard
A cors block as defined below.
Link copied to clipboard
Specifies the environment variables of the Spring Cloud Gateway as a map of key-value pairs.
Link copied to clipboard
Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between 1 and 500. Defaults to 1 if not specified.
Link copied to clipboard
val localResponseCachePerInstance: Output<SpringCloudGatewayLocalResponseCachePerInstanceArgs>? = null
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.
Link copied to clipboard
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.
Link copied to clipboard
Indicates whether the Spring Cloud Gateway exposes endpoint.
Link copied to clipboard
A quota block as defined below.
Link copied to clipboard
Specifies the sensitive environment variables of the Spring Cloud Gateway as a map of key-value pairs.
Link copied to clipboard
The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
Link copied to clipboard
A sso block as defined below.