We recommend using Azure Native.
azure.appplatform.SpringCloudApiPortalCustomDomain
Explore with Pulumi AI
Manages a Spring Cloud API Portal Domain.
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],
});
const exampleSpringCloudApiPortalCustomDomain = new azure.appplatform.SpringCloudApiPortalCustomDomain("example", {
name: "example.com",
springCloudApiPortalId: exampleSpringCloudApiPortal.id,
});
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])
example_spring_cloud_api_portal_custom_domain = azure.appplatform.SpringCloudApiPortalCustomDomain("example",
name="example.com",
spring_cloud_api_portal_id=example_spring_cloud_api_portal.id)
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
}
exampleSpringCloudApiPortal, err := appplatform.NewSpringCloudApiPortal(ctx, "example", &appplatform.SpringCloudApiPortalArgs{
Name: pulumi.String("default"),
SpringCloudServiceId: exampleSpringCloudService.ID(),
GatewayIds: pulumi.StringArray{
exampleSpringCloudGateway.ID(),
},
})
if err != nil {
return err
}
_, err = appplatform.NewSpringCloudApiPortalCustomDomain(ctx, "example", &appplatform.SpringCloudApiPortalCustomDomainArgs{
Name: pulumi.String("example.com"),
SpringCloudApiPortalId: exampleSpringCloudApiPortal.ID(),
})
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,
},
});
var exampleSpringCloudApiPortalCustomDomain = new Azure.AppPlatform.SpringCloudApiPortalCustomDomain("example", new()
{
Name = "example.com",
SpringCloudApiPortalId = exampleSpringCloudApiPortal.Id,
});
});
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.SpringCloudApiPortalCustomDomain;
import com.pulumi.azure.appplatform.SpringCloudApiPortalCustomDomainArgs;
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())
.build());
var exampleSpringCloudApiPortalCustomDomain = new SpringCloudApiPortalCustomDomain("exampleSpringCloudApiPortalCustomDomain", SpringCloudApiPortalCustomDomainArgs.builder()
.name("example.com")
.springCloudApiPortalId(exampleSpringCloudApiPortal.id())
.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}
exampleSpringCloudApiPortalCustomDomain:
type: azure:appplatform:SpringCloudApiPortalCustomDomain
name: example
properties:
name: example.com
springCloudApiPortalId: ${exampleSpringCloudApiPortal.id}
Create SpringCloudApiPortalCustomDomain Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SpringCloudApiPortalCustomDomain(name: string, args: SpringCloudApiPortalCustomDomainArgs, opts?: CustomResourceOptions);
@overload
def SpringCloudApiPortalCustomDomain(resource_name: str,
args: SpringCloudApiPortalCustomDomainArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SpringCloudApiPortalCustomDomain(resource_name: str,
opts: Optional[ResourceOptions] = None,
spring_cloud_api_portal_id: Optional[str] = None,
name: Optional[str] = None,
thumbprint: Optional[str] = None)
func NewSpringCloudApiPortalCustomDomain(ctx *Context, name string, args SpringCloudApiPortalCustomDomainArgs, opts ...ResourceOption) (*SpringCloudApiPortalCustomDomain, error)
public SpringCloudApiPortalCustomDomain(string name, SpringCloudApiPortalCustomDomainArgs args, CustomResourceOptions? opts = null)
public SpringCloudApiPortalCustomDomain(String name, SpringCloudApiPortalCustomDomainArgs args)
public SpringCloudApiPortalCustomDomain(String name, SpringCloudApiPortalCustomDomainArgs args, CustomResourceOptions options)
type: azure:appplatform:SpringCloudApiPortalCustomDomain
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 SpringCloudApiPortalCustomDomainArgs
- 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 SpringCloudApiPortalCustomDomainArgs
- 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 SpringCloudApiPortalCustomDomainArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SpringCloudApiPortalCustomDomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SpringCloudApiPortalCustomDomainArgs
- 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 springCloudApiPortalCustomDomainResource = new Azure.AppPlatform.SpringCloudApiPortalCustomDomain("springCloudApiPortalCustomDomainResource", new()
{
SpringCloudApiPortalId = "string",
Name = "string",
Thumbprint = "string",
});
example, err := appplatform.NewSpringCloudApiPortalCustomDomain(ctx, "springCloudApiPortalCustomDomainResource", &appplatform.SpringCloudApiPortalCustomDomainArgs{
SpringCloudApiPortalId: pulumi.String("string"),
Name: pulumi.String("string"),
Thumbprint: pulumi.String("string"),
})
var springCloudApiPortalCustomDomainResource = new SpringCloudApiPortalCustomDomain("springCloudApiPortalCustomDomainResource", SpringCloudApiPortalCustomDomainArgs.builder()
.springCloudApiPortalId("string")
.name("string")
.thumbprint("string")
.build());
spring_cloud_api_portal_custom_domain_resource = azure.appplatform.SpringCloudApiPortalCustomDomain("springCloudApiPortalCustomDomainResource",
spring_cloud_api_portal_id="string",
name="string",
thumbprint="string")
const springCloudApiPortalCustomDomainResource = new azure.appplatform.SpringCloudApiPortalCustomDomain("springCloudApiPortalCustomDomainResource", {
springCloudApiPortalId: "string",
name: "string",
thumbprint: "string",
});
type: azure:appplatform:SpringCloudApiPortalCustomDomain
properties:
name: string
springCloudApiPortalId: string
thumbprint: string
SpringCloudApiPortalCustomDomain 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 SpringCloudApiPortalCustomDomain resource accepts the following input properties:
- Spring
Cloud stringApi Portal Id - The ID of the Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal Domain to be created.
- Name string
- The name which should be used for this Spring Cloud API Portal Domain. Changing this forces a new Spring Cloud API Portal Domain to be created.
- Thumbprint string
- Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud API Portal Domain.
- Spring
Cloud stringApi Portal Id - The ID of the Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal Domain to be created.
- Name string
- The name which should be used for this Spring Cloud API Portal Domain. Changing this forces a new Spring Cloud API Portal Domain to be created.
- Thumbprint string
- Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud API Portal Domain.
- spring
Cloud StringApi Portal Id - The ID of the Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal Domain to be created.
- name String
- The name which should be used for this Spring Cloud API Portal Domain. Changing this forces a new Spring Cloud API Portal Domain to be created.
- thumbprint String
- Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud API Portal Domain.
- spring
Cloud stringApi Portal Id - The ID of the Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal Domain to be created.
- name string
- The name which should be used for this Spring Cloud API Portal Domain. Changing this forces a new Spring Cloud API Portal Domain to be created.
- thumbprint string
- Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud API Portal Domain.
- spring_
cloud_ strapi_ portal_ id - The ID of the Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal Domain to be created.
- name str
- The name which should be used for this Spring Cloud API Portal Domain. Changing this forces a new Spring Cloud API Portal Domain to be created.
- thumbprint str
- Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud API Portal Domain.
- spring
Cloud StringApi Portal Id - The ID of the Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal Domain to be created.
- name String
- The name which should be used for this Spring Cloud API Portal Domain. Changing this forces a new Spring Cloud API Portal Domain to be created.
- thumbprint String
- Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud API Portal Domain.
Outputs
All input properties are implicitly available as output properties. Additionally, the SpringCloudApiPortalCustomDomain resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing SpringCloudApiPortalCustomDomain Resource
Get an existing SpringCloudApiPortalCustomDomain 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?: SpringCloudApiPortalCustomDomainState, opts?: CustomResourceOptions): SpringCloudApiPortalCustomDomain
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
name: Optional[str] = None,
spring_cloud_api_portal_id: Optional[str] = None,
thumbprint: Optional[str] = None) -> SpringCloudApiPortalCustomDomain
func GetSpringCloudApiPortalCustomDomain(ctx *Context, name string, id IDInput, state *SpringCloudApiPortalCustomDomainState, opts ...ResourceOption) (*SpringCloudApiPortalCustomDomain, error)
public static SpringCloudApiPortalCustomDomain Get(string name, Input<string> id, SpringCloudApiPortalCustomDomainState? state, CustomResourceOptions? opts = null)
public static SpringCloudApiPortalCustomDomain get(String name, Output<String> id, SpringCloudApiPortalCustomDomainState 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.
- Name string
- The name which should be used for this Spring Cloud API Portal Domain. Changing this forces a new Spring Cloud API Portal Domain to be created.
- Spring
Cloud stringApi Portal Id - The ID of the Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal Domain to be created.
- Thumbprint string
- Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud API Portal Domain.
- Name string
- The name which should be used for this Spring Cloud API Portal Domain. Changing this forces a new Spring Cloud API Portal Domain to be created.
- Spring
Cloud stringApi Portal Id - The ID of the Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal Domain to be created.
- Thumbprint string
- Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud API Portal Domain.
- name String
- The name which should be used for this Spring Cloud API Portal Domain. Changing this forces a new Spring Cloud API Portal Domain to be created.
- spring
Cloud StringApi Portal Id - The ID of the Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal Domain to be created.
- thumbprint String
- Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud API Portal Domain.
- name string
- The name which should be used for this Spring Cloud API Portal Domain. Changing this forces a new Spring Cloud API Portal Domain to be created.
- spring
Cloud stringApi Portal Id - The ID of the Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal Domain to be created.
- thumbprint string
- Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud API Portal Domain.
- name str
- The name which should be used for this Spring Cloud API Portal Domain. Changing this forces a new Spring Cloud API Portal Domain to be created.
- spring_
cloud_ strapi_ portal_ id - The ID of the Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal Domain to be created.
- thumbprint str
- Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud API Portal Domain.
- name String
- The name which should be used for this Spring Cloud API Portal Domain. Changing this forces a new Spring Cloud API Portal Domain to be created.
- spring
Cloud StringApi Portal Id - The ID of the Spring Cloud API Portal. Changing this forces a new Spring Cloud API Portal Domain to be created.
- thumbprint String
- Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud API Portal Domain.
Import
Spring Cloud API Portal Domains can be imported using the resource id
, e.g.
$ pulumi import azure:appplatform/springCloudApiPortalCustomDomain:SpringCloudApiPortalCustomDomain example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.AppPlatform/spring/service1/apiPortals/apiPortal1/domains/domain1
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.