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

We recommend using Azure Native.

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

azure.appplatform.SpringCloudApiPortal

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

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

    Manages a Spring Cloud API Portal.

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    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,
});
const exampleSpringCloudApiPortal = new azure.appplatform.SpringCloudApiPortal("example", {
    name: "default",
    springCloudServiceId: exampleSpringCloudService.id,
    gatewayIds: [exampleSpringCloudGateway.id],
    httpsOnlyEnabled: false,
    publicNetworkAccessEnabled: true,
    instanceCount: 1,
    apiTryOutEnabled: true,
    sso: {
        clientId: "test",
        clientSecret: "secret",
        issuerUri: "https://www.example.com/issueToken",
        scopes: ["read"],
    },
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    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)
example_spring_cloud_api_portal = azure.appplatform.SpringCloudApiPortal("example",
    name="default",
    spring_cloud_service_id=example_spring_cloud_service.id,
    gateway_ids=[example_spring_cloud_gateway.id],
    https_only_enabled=False,
    public_network_access_enabled=True,
    instance_count=1,
    api_try_out_enabled=True,
    sso={
        "client_id": "test",
        "client_secret": "secret",
        "issuer_uri": "https://www.example.com/issueToken",
        "scopes": ["read"],
    })

    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-resources"),
			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
		}
		exampleSpringCloudGateway, err := appplatform.NewSpringCloudGateway(ctx, "example", &appplatform.SpringCloudGatewayArgs{
			Name:                 pulumi.String("default"),
			SpringCloudServiceId: exampleSpringCloudService.ID(),
		})
		if err != nil {
			return err
		}
		_, err = appplatform.NewSpringCloudApiPortal(ctx, "example", &appplatform.SpringCloudApiPortalArgs{
			Name:                 pulumi.String("default"),
			SpringCloudServiceId: exampleSpringCloudService.ID(),
			GatewayIds: pulumi.StringArray{
				exampleSpringCloudGateway.ID(),
			},
			HttpsOnlyEnabled:           pulumi.Bool(false),
			PublicNetworkAccessEnabled: pulumi.Bool(true),
			InstanceCount:              pulumi.Int(1),
			ApiTryOutEnabled:           pulumi.Bool(true),
			Sso: &appplatform.SpringCloudApiPortalSsoArgs{
				ClientId:     pulumi.String("test"),
				ClientSecret: pulumi.String("secret"),
				IssuerUri:    pulumi.String("https://www.example.com/issueToken"),
				Scopes: pulumi.StringArray{
					pulumi.String("read"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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-resources",
        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,
    });

    var exampleSpringCloudApiPortal = new Azure.AppPlatform.SpringCloudApiPortal("example", new()
    {
        Name = "default",
        SpringCloudServiceId = exampleSpringCloudService.Id,
        GatewayIds = new[]
        {
            exampleSpringCloudGateway.Id,
        },
        HttpsOnlyEnabled = false,
        PublicNetworkAccessEnabled = true,
        InstanceCount = 1,
        ApiTryOutEnabled = true,
        Sso = new Azure.AppPlatform.Inputs.SpringCloudApiPortalSsoArgs
        {
            ClientId = "test",
            ClientSecret = "secret",
            IssuerUri = "https://www.example.com/issueToken",
            Scopes = new[]
            {
                "read",
            },
        },
    });

});

    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.SpringCloudApiPortal;
import com.pulumi.azure.appplatform.SpringCloudApiPortalArgs;
import com.pulumi.azure.appplatform.inputs.SpringCloudApiPortalSsoArgs;
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-resources")
            .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())
            .build());

        var exampleSpringCloudApiPortal = new SpringCloudApiPortal("exampleSpringCloudApiPortal", SpringCloudApiPortalArgs.builder()
            .name("default")
            .springCloudServiceId(exampleSpringCloudService.id())
            .gatewayIds(exampleSpringCloudGateway.id())
            .httpsOnlyEnabled(false)
            .publicNetworkAccessEnabled(true)
            .instanceCount(1)
            .apiTryOutEnabled(true)
            .sso(SpringCloudApiPortalSsoArgs.builder()
                .clientId("test")
                .clientSecret("secret")
                .issuerUri("https://www.example.com/issueToken")
                .scopes("read")
                .build())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      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}
  exampleSpringCloudApiPortal:
    type: azure:appplatform:SpringCloudApiPortal
    name: example
    properties:
      name: default
      springCloudServiceId: ${exampleSpringCloudService.id}
      gatewayIds:
        - ${exampleSpringCloudGateway.id}
      httpsOnlyEnabled: false
      publicNetworkAccessEnabled: true
      instanceCount: 1
      apiTryOutEnabled: true
      sso:
        clientId: test
        clientSecret: secret
        issuerUri: https://www.example.com/issueToken
        scopes:
          - read

    Create SpringCloudApiPortal Resource

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

    Constructor syntax

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

@overload
def SpringCloudApiPortal(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         spring_cloud_service_id: Optional[str] = None,
                         api_try_out_enabled: Optional[bool] = None,
                         gateway_ids: Optional[Sequence[str]] = None,
                         https_only_enabled: Optional[bool] = None,
                         instance_count: Optional[int] = None,
                         name: Optional[str] = None,
                         public_network_access_enabled: Optional[bool] = None,
                         sso: Optional[SpringCloudApiPortalSsoArgs] = None)
    func NewSpringCloudApiPortal(ctx *Context, name string, args SpringCloudApiPortalArgs, opts ...ResourceOption) (*SpringCloudApiPortal, error)
    public SpringCloudApiPortal(string name, SpringCloudApiPortalArgs args, CustomResourceOptions? opts = null)
    public SpringCloudApiPortal(String name, SpringCloudApiPortalArgs args)
public SpringCloudApiPortal(String name, SpringCloudApiPortalArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args SpringCloudApiPortalArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SpringCloudApiPortalArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SpringCloudApiPortalArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SpringCloudApiPortalArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SpringCloudApiPortalArgs
    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 springCloudApiPortalResource = new Azure.AppPlatform.SpringCloudApiPortal("springCloudApiPortalResource", new()
{
    SpringCloudServiceId = "string",
    ApiTryOutEnabled = false,
    GatewayIds = new[]
    {
        "string",
    },
    HttpsOnlyEnabled = false,
    InstanceCount = 0,
    Name = "string",
    PublicNetworkAccessEnabled = false,
    Sso = new Azure.AppPlatform.Inputs.SpringCloudApiPortalSsoArgs
    {
        ClientId = "string",
        ClientSecret = "string",
        IssuerUri = "string",
        Scopes = new[]
        {
            "string",
        },
    },
});

    example, err := appplatform.NewSpringCloudApiPortal(ctx, "springCloudApiPortalResource", &appplatform.SpringCloudApiPortalArgs{
	SpringCloudServiceId: pulumi.String("string"),
	ApiTryOutEnabled:     pulumi.Bool(false),
	GatewayIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	HttpsOnlyEnabled:           pulumi.Bool(false),
	InstanceCount:              pulumi.Int(0),
	Name:                       pulumi.String("string"),
	PublicNetworkAccessEnabled: pulumi.Bool(false),
	Sso: &appplatform.SpringCloudApiPortalSsoArgs{
		ClientId:     pulumi.String("string"),
		ClientSecret: pulumi.String("string"),
		IssuerUri:    pulumi.String("string"),
		Scopes: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})

    var springCloudApiPortalResource = new SpringCloudApiPortal("springCloudApiPortalResource", SpringCloudApiPortalArgs.builder()
    .springCloudServiceId("string")
    .apiTryOutEnabled(false)
    .gatewayIds("string")
    .httpsOnlyEnabled(false)
    .instanceCount(0)
    .name("string")
    .publicNetworkAccessEnabled(false)
    .sso(SpringCloudApiPortalSsoArgs.builder()
        .clientId("string")
        .clientSecret("string")
        .issuerUri("string")
        .scopes("string")
        .build())
    .build());

    spring_cloud_api_portal_resource = azure.appplatform.SpringCloudApiPortal("springCloudApiPortalResource",
    spring_cloud_service_id="string",
    api_try_out_enabled=False,
    gateway_ids=["string"],
    https_only_enabled=False,
    instance_count=0,
    name="string",
    public_network_access_enabled=False,
    sso={
        "client_id": "string",
        "client_secret": "string",
        "issuer_uri": "string",
        "scopes": ["string"],
    })

    const springCloudApiPortalResource = new azure.appplatform.SpringCloudApiPortal("springCloudApiPortalResource", {
    springCloudServiceId: "string",
    apiTryOutEnabled: false,
    gatewayIds: ["string"],
    httpsOnlyEnabled: false,
    instanceCount: 0,
    name: "string",
    publicNetworkAccessEnabled: false,
    sso: {
        clientId: "string",
        clientSecret: "string",
        issuerUri: "string",
        scopes: ["string"],
    },
});

    type: azure:appplatform:SpringCloudApiPortal
properties:
    apiTryOutEnabled: false
    gatewayIds:
        - string
    httpsOnlyEnabled: false
    instanceCount: 0
    name: string
    publicNetworkAccessEnabled: false
    springCloudServiceId: string
    sso:
        clientId: string
        clientSecret: string
        issuerUri: string
        scopes:
            - string

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

    SpringCloudServiceId string
    The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
    ApiTryOutEnabled bool
    Specifies whether the API try-out feature is enabled. When enabled, users can try out the API by sending requests and viewing responses in API portal.
    GatewayIds List<string>
    Specifies a list of Spring Cloud Gateway.
    HttpsOnlyEnabled bool
    is only https is allowed?
    InstanceCount int
    Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between 1 and 500. Defaults to 1 if not specified.
    Name string
    The name which should be used for this Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal to be created. The only possible value is default.
    PublicNetworkAccessEnabled bool
    Is the public network access enabled?
    Sso SpringCloudApiPortalSso
    A sso block as defined below.
    SpringCloudServiceId string
    The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
    ApiTryOutEnabled bool
    Specifies whether the API try-out feature is enabled. When enabled, users can try out the API by sending requests and viewing responses in API portal.
    GatewayIds []string
    Specifies a list of Spring Cloud Gateway.
    HttpsOnlyEnabled bool
    is only https is allowed?
    InstanceCount int
    Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between 1 and 500. Defaults to 1 if not specified.
    Name string
    The name which should be used for this Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal to be created. The only possible value is default.
    PublicNetworkAccessEnabled bool
    Is the public network access enabled?
    Sso SpringCloudApiPortalSsoArgs
    A sso block as defined below.
    springCloudServiceId String
    The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
    apiTryOutEnabled Boolean
    Specifies whether the API try-out feature is enabled. When enabled, users can try out the API by sending requests and viewing responses in API portal.
    gatewayIds List<String>
    Specifies a list of Spring Cloud Gateway.
    httpsOnlyEnabled Boolean
    is only https is allowed?
    instanceCount Integer
    Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between 1 and 500. Defaults to 1 if not specified.
    name String
    The name which should be used for this Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal to be created. The only possible value is default.
    publicNetworkAccessEnabled Boolean
    Is the public network access enabled?
    sso SpringCloudApiPortalSso
    A sso block as defined below.
    springCloudServiceId string
    The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
    apiTryOutEnabled boolean
    Specifies whether the API try-out feature is enabled. When enabled, users can try out the API by sending requests and viewing responses in API portal.
    gatewayIds string[]
    Specifies a list of Spring Cloud Gateway.
    httpsOnlyEnabled boolean
    is only https is allowed?
    instanceCount number
    Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between 1 and 500. Defaults to 1 if not specified.
    name string
    The name which should be used for this Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal to be created. The only possible value is default.
    publicNetworkAccessEnabled boolean
    Is the public network access enabled?
    sso SpringCloudApiPortalSso
    A sso block as defined below.
    spring_cloud_service_id str
    The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
    api_try_out_enabled bool
    Specifies whether the API try-out feature is enabled. When enabled, users can try out the API by sending requests and viewing responses in API portal.
    gateway_ids Sequence[str]
    Specifies a list of Spring Cloud Gateway.
    https_only_enabled bool
    is only https is allowed?
    instance_count int
    Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between 1 and 500. Defaults to 1 if not specified.
    name str
    The name which should be used for this Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal to be created. The only possible value is default.
    public_network_access_enabled bool
    Is the public network access enabled?
    sso SpringCloudApiPortalSsoArgs
    A sso block as defined below.
    springCloudServiceId String
    The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
    apiTryOutEnabled Boolean
    Specifies whether the API try-out feature is enabled. When enabled, users can try out the API by sending requests and viewing responses in API portal.
    gatewayIds List<String>
    Specifies a list of Spring Cloud Gateway.
    httpsOnlyEnabled Boolean
    is only https is allowed?
    instanceCount Number
    Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between 1 and 500. Defaults to 1 if not specified.
    name String
    The name which should be used for this Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal to be created. The only possible value is default.
    publicNetworkAccessEnabled Boolean
    Is the public network access enabled?
    sso Property Map
    A sso block as defined below.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    TODO.
    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    TODO.
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    TODO.
    id string
    The provider-assigned unique ID for this managed resource.
    url string
    TODO.
    id str
    The provider-assigned unique ID for this managed resource.
    url str
    TODO.
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    TODO.

    Look up Existing SpringCloudApiPortal Resource

    Get an existing SpringCloudApiPortal 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?: SpringCloudApiPortalState, opts?: CustomResourceOptions): SpringCloudApiPortal
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_try_out_enabled: Optional[bool] = None,
        gateway_ids: Optional[Sequence[str]] = None,
        https_only_enabled: Optional[bool] = None,
        instance_count: Optional[int] = None,
        name: Optional[str] = None,
        public_network_access_enabled: Optional[bool] = None,
        spring_cloud_service_id: Optional[str] = None,
        sso: Optional[SpringCloudApiPortalSsoArgs] = None,
        url: Optional[str] = None) -> SpringCloudApiPortal
    func GetSpringCloudApiPortal(ctx *Context, name string, id IDInput, state *SpringCloudApiPortalState, opts ...ResourceOption) (*SpringCloudApiPortal, error)
    public static SpringCloudApiPortal Get(string name, Input<string> id, SpringCloudApiPortalState? state, CustomResourceOptions? opts = null)
    public static SpringCloudApiPortal get(String name, Output<String> id, SpringCloudApiPortalState state, CustomResourceOptions options)
    resources:  _:    type: azure:appplatform:SpringCloudApiPortal    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    ApiTryOutEnabled bool
    Specifies whether the API try-out feature is enabled. When enabled, users can try out the API by sending requests and viewing responses in API portal.
    GatewayIds List<string>
    Specifies a list of Spring Cloud Gateway.
    HttpsOnlyEnabled bool
    is only https is allowed?
    InstanceCount int
    Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between 1 and 500. Defaults to 1 if not specified.
    Name string
    The name which should be used for this Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal to be created. The only possible value is default.
    PublicNetworkAccessEnabled bool
    Is the public network access enabled?
    SpringCloudServiceId string
    The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
    Sso SpringCloudApiPortalSso
    A sso block as defined below.
    Url string
    TODO.
    ApiTryOutEnabled bool
    Specifies whether the API try-out feature is enabled. When enabled, users can try out the API by sending requests and viewing responses in API portal.
    GatewayIds []string
    Specifies a list of Spring Cloud Gateway.
    HttpsOnlyEnabled bool
    is only https is allowed?
    InstanceCount int
    Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between 1 and 500. Defaults to 1 if not specified.
    Name string
    The name which should be used for this Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal to be created. The only possible value is default.
    PublicNetworkAccessEnabled bool
    Is the public network access enabled?
    SpringCloudServiceId string
    The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
    Sso SpringCloudApiPortalSsoArgs
    A sso block as defined below.
    Url string
    TODO.
    apiTryOutEnabled Boolean
    Specifies whether the API try-out feature is enabled. When enabled, users can try out the API by sending requests and viewing responses in API portal.
    gatewayIds List<String>
    Specifies a list of Spring Cloud Gateway.
    httpsOnlyEnabled Boolean
    is only https is allowed?
    instanceCount Integer
    Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between 1 and 500. Defaults to 1 if not specified.
    name String
    The name which should be used for this Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal to be created. The only possible value is default.
    publicNetworkAccessEnabled Boolean
    Is the public network access enabled?
    springCloudServiceId String
    The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
    sso SpringCloudApiPortalSso
    A sso block as defined below.
    url String
    TODO.
    apiTryOutEnabled boolean
    Specifies whether the API try-out feature is enabled. When enabled, users can try out the API by sending requests and viewing responses in API portal.
    gatewayIds string[]
    Specifies a list of Spring Cloud Gateway.
    httpsOnlyEnabled boolean
    is only https is allowed?
    instanceCount number
    Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between 1 and 500. Defaults to 1 if not specified.
    name string
    The name which should be used for this Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal to be created. The only possible value is default.
    publicNetworkAccessEnabled boolean
    Is the public network access enabled?
    springCloudServiceId string
    The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
    sso SpringCloudApiPortalSso
    A sso block as defined below.
    url string
    TODO.
    api_try_out_enabled bool
    Specifies whether the API try-out feature is enabled. When enabled, users can try out the API by sending requests and viewing responses in API portal.
    gateway_ids Sequence[str]
    Specifies a list of Spring Cloud Gateway.
    https_only_enabled bool
    is only https is allowed?
    instance_count int
    Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between 1 and 500. Defaults to 1 if not specified.
    name str
    The name which should be used for this Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal to be created. The only possible value is default.
    public_network_access_enabled bool
    Is the public network access enabled?
    spring_cloud_service_id str
    The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
    sso SpringCloudApiPortalSsoArgs
    A sso block as defined below.
    url str
    TODO.
    apiTryOutEnabled Boolean
    Specifies whether the API try-out feature is enabled. When enabled, users can try out the API by sending requests and viewing responses in API portal.
    gatewayIds List<String>
    Specifies a list of Spring Cloud Gateway.
    httpsOnlyEnabled Boolean
    is only https is allowed?
    instanceCount Number
    Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between 1 and 500. Defaults to 1 if not specified.
    name String
    The name which should be used for this Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal to be created. The only possible value is default.
    publicNetworkAccessEnabled Boolean
    Is the public network access enabled?
    springCloudServiceId String
    The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
    sso Property Map
    A sso block as defined below.
    url String
    TODO.

    Supporting Types

    SpringCloudApiPortalSso, SpringCloudApiPortalSsoArgs

    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 API Portals can be imported using the resource id, e.g.

    $ pulumi import azure:appplatform/springCloudApiPortal:SpringCloudApiPortal example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.AppPlatform/spring/service1/apiPortals/apiPortal1

    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.
    azure logo

    We recommend using Azure Native.

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