We recommend using Azure Native.
azure.appplatform.SpringCloudApiPortal
Explore with Pulumi AI
Manages a Spring Cloud API Portal.
NOTE: This resource is applicable only for Spring Cloud Service with enterprise tier.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleSpringCloudService = new Azure.AppPlatform.SpringCloudService("exampleSpringCloudService", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
SkuName = "E0",
});
var exampleSpringCloudGateway = new Azure.AppPlatform.SpringCloudGateway("exampleSpringCloudGateway", new()
{
SpringCloudServiceId = exampleSpringCloudService.Id,
});
var exampleSpringCloudApiPortal = new Azure.AppPlatform.SpringCloudApiPortal("exampleSpringCloudApiPortal", new()
{
SpringCloudServiceId = exampleSpringCloudService.Id,
GatewayIds = new[]
{
exampleSpringCloudGateway.Id,
},
HttpsOnlyEnabled = false,
PublicNetworkAccessEnabled = true,
InstanceCount = 1,
Sso = new Azure.AppPlatform.Inputs.SpringCloudApiPortalSsoArgs
{
ClientId = "test",
ClientSecret = "secret",
IssuerUri = "https://www.example.com/issueToken",
Scopes = new[]
{
"read",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/appplatform"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleSpringCloudService, err := appplatform.NewSpringCloudService(ctx, "exampleSpringCloudService", &appplatform.SpringCloudServiceArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
SkuName: pulumi.String("E0"),
})
if err != nil {
return err
}
exampleSpringCloudGateway, err := appplatform.NewSpringCloudGateway(ctx, "exampleSpringCloudGateway", &appplatform.SpringCloudGatewayArgs{
SpringCloudServiceId: exampleSpringCloudService.ID(),
})
if err != nil {
return err
}
_, err = appplatform.NewSpringCloudApiPortal(ctx, "exampleSpringCloudApiPortal", &appplatform.SpringCloudApiPortalArgs{
SpringCloudServiceId: exampleSpringCloudService.ID(),
GatewayIds: pulumi.StringArray{
exampleSpringCloudGateway.ID(),
},
HttpsOnlyEnabled: pulumi.Bool(false),
PublicNetworkAccessEnabled: pulumi.Bool(true),
InstanceCount: pulumi.Int(1),
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
})
}
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleSpringCloudService = new SpringCloudService("exampleSpringCloudService", SpringCloudServiceArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.skuName("E0")
.build());
var exampleSpringCloudGateway = new SpringCloudGateway("exampleSpringCloudGateway", SpringCloudGatewayArgs.builder()
.springCloudServiceId(exampleSpringCloudService.id())
.build());
var exampleSpringCloudApiPortal = new SpringCloudApiPortal("exampleSpringCloudApiPortal", SpringCloudApiPortalArgs.builder()
.springCloudServiceId(exampleSpringCloudService.id())
.gatewayIds(exampleSpringCloudGateway.id())
.httpsOnlyEnabled(false)
.publicNetworkAccessEnabled(true)
.instanceCount(1)
.sso(SpringCloudApiPortalSsoArgs.builder()
.clientId("test")
.clientSecret("secret")
.issuerUri("https://www.example.com/issueToken")
.scopes("read")
.build())
.build());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_spring_cloud_service = azure.appplatform.SpringCloudService("exampleSpringCloudService",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
sku_name="E0")
example_spring_cloud_gateway = azure.appplatform.SpringCloudGateway("exampleSpringCloudGateway", spring_cloud_service_id=example_spring_cloud_service.id)
example_spring_cloud_api_portal = azure.appplatform.SpringCloudApiPortal("exampleSpringCloudApiPortal",
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,
sso=azure.appplatform.SpringCloudApiPortalSsoArgs(
client_id="test",
client_secret="secret",
issuer_uri="https://www.example.com/issueToken",
scopes=["read"],
))
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleSpringCloudService = new azure.appplatform.SpringCloudService("exampleSpringCloudService", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
skuName: "E0",
});
const exampleSpringCloudGateway = new azure.appplatform.SpringCloudGateway("exampleSpringCloudGateway", {springCloudServiceId: exampleSpringCloudService.id});
const exampleSpringCloudApiPortal = new azure.appplatform.SpringCloudApiPortal("exampleSpringCloudApiPortal", {
springCloudServiceId: exampleSpringCloudService.id,
gatewayIds: [exampleSpringCloudGateway.id],
httpsOnlyEnabled: false,
publicNetworkAccessEnabled: true,
instanceCount: 1,
sso: {
clientId: "test",
clientSecret: "secret",
issuerUri: "https://www.example.com/issueToken",
scopes: ["read"],
},
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleSpringCloudService:
type: azure:appplatform:SpringCloudService
properties:
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
skuName: E0
exampleSpringCloudGateway:
type: azure:appplatform:SpringCloudGateway
properties:
springCloudServiceId: ${exampleSpringCloudService.id}
exampleSpringCloudApiPortal:
type: azure:appplatform:SpringCloudApiPortal
properties:
springCloudServiceId: ${exampleSpringCloudService.id}
gatewayIds:
- ${exampleSpringCloudGateway.id}
httpsOnlyEnabled: false
publicNetworkAccessEnabled: true
instanceCount: 1
sso:
clientId: test
clientSecret: secret
issuerUri: https://www.example.com/issueToken
scopes:
- read
Create SpringCloudApiPortal Resource
new SpringCloudApiPortal(name: string, args: SpringCloudApiPortalArgs, opts?: CustomResourceOptions);
@overload
def SpringCloudApiPortal(resource_name: str,
opts: Optional[ResourceOptions] = 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)
@overload
def SpringCloudApiPortal(resource_name: str,
args: SpringCloudApiPortalArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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
The SpringCloudApiPortal resource accepts the following input properties:
- Spring
Cloud stringService Id The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
- Gateway
Ids List<string> Specifies a list of Spring Cloud Gateway.
- Https
Only boolEnabled is only https is allowed?
- Instance
Count int Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between
1
and500
. Defaults to1
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
.- Public
Network boolAccess Enabled Is the public network access enabled?
- Sso
Spring
Cloud Api Portal Sso A
sso
block as defined below.
- Spring
Cloud stringService Id The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
- Gateway
Ids []string Specifies a list of Spring Cloud Gateway.
- Https
Only boolEnabled is only https is allowed?
- Instance
Count int Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between
1
and500
. Defaults to1
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
.- Public
Network boolAccess Enabled Is the public network access enabled?
- Sso
Spring
Cloud Api Portal Sso Args A
sso
block as defined below.
- spring
Cloud StringService Id The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
- gateway
Ids List<String> Specifies a list of Spring Cloud Gateway.
- https
Only BooleanEnabled is only https is allowed?
- instance
Count Integer Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between
1
and500
. Defaults to1
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
.- public
Network BooleanAccess Enabled Is the public network access enabled?
- sso
Spring
Cloud Api Portal Sso A
sso
block as defined below.
- spring
Cloud stringService Id The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
- gateway
Ids string[] Specifies a list of Spring Cloud Gateway.
- https
Only booleanEnabled is only https is allowed?
- instance
Count number Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between
1
and500
. Defaults to1
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
.- public
Network booleanAccess Enabled Is the public network access enabled?
- sso
Spring
Cloud Api Portal Sso A
sso
block as defined below.
- spring_
cloud_ strservice_ id The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
- gateway_
ids Sequence[str] Specifies a list of Spring Cloud Gateway.
- https_
only_ boolenabled is only https is allowed?
- instance_
count int Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between
1
and500
. Defaults to1
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_ boolaccess_ enabled Is the public network access enabled?
- sso
Spring
Cloud Api Portal Sso Args A
sso
block as defined below.
- spring
Cloud StringService Id The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
- gateway
Ids List<String> Specifies a list of Spring Cloud Gateway.
- https
Only BooleanEnabled is only https is allowed?
- instance
Count Number Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between
1
and500
. Defaults to1
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
.- public
Network BooleanAccess Enabled 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:
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,
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)
Resource lookup is not supported in YAML
- 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.
- Gateway
Ids List<string> Specifies a list of Spring Cloud Gateway.
- Https
Only boolEnabled is only https is allowed?
- Instance
Count int Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between
1
and500
. Defaults to1
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
.- Public
Network boolAccess Enabled Is the public network access enabled?
- Spring
Cloud stringService Id The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
- Sso
Spring
Cloud Api Portal Sso A
sso
block as defined below.- Url string
TODO.
- Gateway
Ids []string Specifies a list of Spring Cloud Gateway.
- Https
Only boolEnabled is only https is allowed?
- Instance
Count int Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between
1
and500
. Defaults to1
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
.- Public
Network boolAccess Enabled Is the public network access enabled?
- Spring
Cloud stringService Id The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
- Sso
Spring
Cloud Api Portal Sso Args A
sso
block as defined below.- Url string
TODO.
- gateway
Ids List<String> Specifies a list of Spring Cloud Gateway.
- https
Only BooleanEnabled is only https is allowed?
- instance
Count Integer Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between
1
and500
. Defaults to1
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
.- public
Network BooleanAccess Enabled Is the public network access enabled?
- spring
Cloud StringService Id The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
- sso
Spring
Cloud Api Portal Sso A
sso
block as defined below.- url String
TODO.
- gateway
Ids string[] Specifies a list of Spring Cloud Gateway.
- https
Only booleanEnabled is only https is allowed?
- instance
Count number Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between
1
and500
. Defaults to1
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
.- public
Network booleanAccess Enabled Is the public network access enabled?
- spring
Cloud stringService Id The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
- sso
Spring
Cloud Api Portal Sso A
sso
block as defined below.- url string
TODO.
- gateway_
ids Sequence[str] Specifies a list of Spring Cloud Gateway.
- https_
only_ boolenabled is only https is allowed?
- instance_
count int Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between
1
and500
. Defaults to1
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_ boolaccess_ enabled Is the public network access enabled?
- spring_
cloud_ strservice_ id The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud API Portal to be created.
- sso
Spring
Cloud Api Portal Sso Args A
sso
block as defined below.- url str
TODO.
- gateway
Ids List<String> Specifies a list of Spring Cloud Gateway.
- https
Only BooleanEnabled is only https is allowed?
- instance
Count Number Specifies the required instance count of the Spring Cloud API Portal. Possible Values are between
1
and500
. Defaults to1
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
.- public
Network BooleanAccess Enabled Is the public network access enabled?
- spring
Cloud StringService Id 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
- Client
Id string The public identifier for the application.
- Client
Secret string The secret known only to the application and the authorization server.
- Issuer
Uri 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.
- Client
Id string The public identifier for the application.
- Client
Secret string The secret known only to the application and the authorization server.
- Issuer
Uri 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 String The public identifier for the application.
- client
Secret String The secret known only to the application and the authorization server.
- issuer
Uri 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.
- client
Id string The public identifier for the application.
- client
Secret string The secret known only to the application and the authorization server.
- issuer
Uri 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.
- client
Id String The public identifier for the application.
- client
Secret String The secret known only to the application and the authorization server.
- issuer
Uri 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
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.