1. Packages
  2. Azure Classic
  3. API Docs
  4. appplatform
  5. SpringCloudApiPortalCustomDomain

We recommend using Azure Native.

Azure Classic v5.67.0 published on Wednesday, Feb 21, 2024 by Pulumi

azure.appplatform.SpringCloudApiPortalCustomDomain

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.67.0 published on Wednesday, Feb 21, 2024 by Pulumi

    Manages a Spring Cloud API Portal Domain.

    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,
            },
        });
    
        var exampleSpringCloudApiPortalCustomDomain = new Azure.AppPlatform.SpringCloudApiPortalCustomDomain("exampleSpringCloudApiPortalCustomDomain", new()
        {
            SpringCloudApiPortalId = exampleSpringCloudApiPortal.Id,
        });
    
    });
    
    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
    		}
    		exampleSpringCloudApiPortal, err := appplatform.NewSpringCloudApiPortal(ctx, "exampleSpringCloudApiPortal", &appplatform.SpringCloudApiPortalArgs{
    			SpringCloudServiceId: exampleSpringCloudService.ID(),
    			GatewayIds: pulumi.StringArray{
    				exampleSpringCloudGateway.ID(),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = appplatform.NewSpringCloudApiPortalCustomDomain(ctx, "exampleSpringCloudApiPortalCustomDomain", &appplatform.SpringCloudApiPortalCustomDomainArgs{
    			SpringCloudApiPortalId: exampleSpringCloudApiPortal.ID(),
    		})
    		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.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 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())
                .build());
    
            var exampleSpringCloudApiPortalCustomDomain = new SpringCloudApiPortalCustomDomain("exampleSpringCloudApiPortalCustomDomain", SpringCloudApiPortalCustomDomainArgs.builder()        
                .springCloudApiPortalId(exampleSpringCloudApiPortal.id())
                .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])
    example_spring_cloud_api_portal_custom_domain = azure.appplatform.SpringCloudApiPortalCustomDomain("exampleSpringCloudApiPortalCustomDomain", spring_cloud_api_portal_id=example_spring_cloud_api_portal.id)
    
    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],
    });
    const exampleSpringCloudApiPortalCustomDomain = new azure.appplatform.SpringCloudApiPortalCustomDomain("exampleSpringCloudApiPortalCustomDomain", {springCloudApiPortalId: exampleSpringCloudApiPortal.id});
    
    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}
      exampleSpringCloudApiPortalCustomDomain:
        type: azure:appplatform:SpringCloudApiPortalCustomDomain
        properties:
          springCloudApiPortalId: ${exampleSpringCloudApiPortal.id}
    

    Create SpringCloudApiPortalCustomDomain Resource

    new SpringCloudApiPortalCustomDomain(name: string, args: SpringCloudApiPortalCustomDomainArgs, opts?: CustomResourceOptions);
    @overload
    def SpringCloudApiPortalCustomDomain(resource_name: str,
                                         opts: Optional[ResourceOptions] = None,
                                         name: Optional[str] = None,
                                         spring_cloud_api_portal_id: Optional[str] = None,
                                         thumbprint: Optional[str] = None)
    @overload
    def SpringCloudApiPortalCustomDomain(resource_name: str,
                                         args: SpringCloudApiPortalCustomDomainArgs,
                                         opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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

    The SpringCloudApiPortalCustomDomain resource accepts the following input properties:

    SpringCloudApiPortalId string
    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.
    SpringCloudApiPortalId string
    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.
    springCloudApiPortalId String
    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.
    springCloudApiPortalId string
    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_api_portal_id str
    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.
    springCloudApiPortalId String
    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.
    The following state arguments are supported:
    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.
    SpringCloudApiPortalId string
    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.
    SpringCloudApiPortalId string
    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.
    springCloudApiPortalId String
    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.
    springCloudApiPortalId string
    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_api_portal_id str
    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.
    springCloudApiPortalId String
    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
    

    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 Classic v5.67.0 published on Wednesday, Feb 21, 2024 by Pulumi