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

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.appplatform.SpringCloudGatewayCustomDomain

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages a Spring Cloud Gateway Custom 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",
        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 exampleSpringCloudGatewayCustomDomain = new azure.appplatform.SpringCloudGatewayCustomDomain("example", {
        name: "example.com",
        springCloudGatewayId: exampleSpringCloudGateway.id,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example",
        location="West Europe")
    example_spring_cloud_service = azure.appplatform.SpringCloudService("example",
        name="example",
        location=example.location,
        resource_group_name=example.name,
        sku_name="E0")
    example_spring_cloud_gateway = azure.appplatform.SpringCloudGateway("example",
        name="default",
        spring_cloud_service_id=example_spring_cloud_service.id)
    example_spring_cloud_gateway_custom_domain = azure.appplatform.SpringCloudGatewayCustomDomain("example",
        name="example.com",
        spring_cloud_gateway_id=example_spring_cloud_gateway.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 {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleSpringCloudService, err := appplatform.NewSpringCloudService(ctx, "example", &appplatform.SpringCloudServiceArgs{
    			Name:              pulumi.String("example"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			SkuName:           pulumi.String("E0"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleSpringCloudGateway, err := appplatform.NewSpringCloudGateway(ctx, "example", &appplatform.SpringCloudGatewayArgs{
    			Name:                 pulumi.String("default"),
    			SpringCloudServiceId: exampleSpringCloudService.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = appplatform.NewSpringCloudGatewayCustomDomain(ctx, "example", &appplatform.SpringCloudGatewayCustomDomainArgs{
    			Name:                 pulumi.String("example.com"),
    			SpringCloudGatewayId: exampleSpringCloudGateway.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",
            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 exampleSpringCloudGatewayCustomDomain = new Azure.AppPlatform.SpringCloudGatewayCustomDomain("example", new()
        {
            Name = "example.com",
            SpringCloudGatewayId = exampleSpringCloudGateway.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.SpringCloudGatewayCustomDomain;
    import com.pulumi.azure.appplatform.SpringCloudGatewayCustomDomainArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example")
                .location("West Europe")
                .build());
    
            var exampleSpringCloudService = new SpringCloudService("exampleSpringCloudService", SpringCloudServiceArgs.builder()
                .name("example")
                .location(example.location())
                .resourceGroupName(example.name())
                .skuName("E0")
                .build());
    
            var exampleSpringCloudGateway = new SpringCloudGateway("exampleSpringCloudGateway", SpringCloudGatewayArgs.builder()
                .name("default")
                .springCloudServiceId(exampleSpringCloudService.id())
                .build());
    
            var exampleSpringCloudGatewayCustomDomain = new SpringCloudGatewayCustomDomain("exampleSpringCloudGatewayCustomDomain", SpringCloudGatewayCustomDomainArgs.builder()
                .name("example.com")
                .springCloudGatewayId(exampleSpringCloudGateway.id())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example
          location: West Europe
      exampleSpringCloudService:
        type: azure:appplatform:SpringCloudService
        name: example
        properties:
          name: example
          location: ${example.location}
          resourceGroupName: ${example.name}
          skuName: E0
      exampleSpringCloudGateway:
        type: azure:appplatform:SpringCloudGateway
        name: example
        properties:
          name: default
          springCloudServiceId: ${exampleSpringCloudService.id}
      exampleSpringCloudGatewayCustomDomain:
        type: azure:appplatform:SpringCloudGatewayCustomDomain
        name: example
        properties:
          name: example.com
          springCloudGatewayId: ${exampleSpringCloudGateway.id}
    

    Create SpringCloudGatewayCustomDomain Resource

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

    Constructor syntax

    new SpringCloudGatewayCustomDomain(name: string, args: SpringCloudGatewayCustomDomainArgs, opts?: CustomResourceOptions);
    @overload
    def SpringCloudGatewayCustomDomain(resource_name: str,
                                       args: SpringCloudGatewayCustomDomainArgs,
                                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def SpringCloudGatewayCustomDomain(resource_name: str,
                                       opts: Optional[ResourceOptions] = None,
                                       spring_cloud_gateway_id: Optional[str] = None,
                                       name: Optional[str] = None,
                                       thumbprint: Optional[str] = None)
    func NewSpringCloudGatewayCustomDomain(ctx *Context, name string, args SpringCloudGatewayCustomDomainArgs, opts ...ResourceOption) (*SpringCloudGatewayCustomDomain, error)
    public SpringCloudGatewayCustomDomain(string name, SpringCloudGatewayCustomDomainArgs args, CustomResourceOptions? opts = null)
    public SpringCloudGatewayCustomDomain(String name, SpringCloudGatewayCustomDomainArgs args)
    public SpringCloudGatewayCustomDomain(String name, SpringCloudGatewayCustomDomainArgs args, CustomResourceOptions options)
    
    type: azure:appplatform:SpringCloudGatewayCustomDomain
    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 SpringCloudGatewayCustomDomainArgs
    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 SpringCloudGatewayCustomDomainArgs
    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 SpringCloudGatewayCustomDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SpringCloudGatewayCustomDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SpringCloudGatewayCustomDomainArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var springCloudGatewayCustomDomainResource = new Azure.AppPlatform.SpringCloudGatewayCustomDomain("springCloudGatewayCustomDomainResource", new()
    {
        SpringCloudGatewayId = "string",
        Name = "string",
        Thumbprint = "string",
    });
    
    example, err := appplatform.NewSpringCloudGatewayCustomDomain(ctx, "springCloudGatewayCustomDomainResource", &appplatform.SpringCloudGatewayCustomDomainArgs{
    	SpringCloudGatewayId: pulumi.String("string"),
    	Name:                 pulumi.String("string"),
    	Thumbprint:           pulumi.String("string"),
    })
    
    var springCloudGatewayCustomDomainResource = new SpringCloudGatewayCustomDomain("springCloudGatewayCustomDomainResource", SpringCloudGatewayCustomDomainArgs.builder()
        .springCloudGatewayId("string")
        .name("string")
        .thumbprint("string")
        .build());
    
    spring_cloud_gateway_custom_domain_resource = azure.appplatform.SpringCloudGatewayCustomDomain("springCloudGatewayCustomDomainResource",
        spring_cloud_gateway_id="string",
        name="string",
        thumbprint="string")
    
    const springCloudGatewayCustomDomainResource = new azure.appplatform.SpringCloudGatewayCustomDomain("springCloudGatewayCustomDomainResource", {
        springCloudGatewayId: "string",
        name: "string",
        thumbprint: "string",
    });
    
    type: azure:appplatform:SpringCloudGatewayCustomDomain
    properties:
        name: string
        springCloudGatewayId: string
        thumbprint: string
    

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

    SpringCloudGatewayId string
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    Name string
    The name which should be used for this Spring Cloud Gateway Custom Domain. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    Thumbprint string
    Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud Gateway Custom Domain.
    SpringCloudGatewayId string
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    Name string
    The name which should be used for this Spring Cloud Gateway Custom Domain. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    Thumbprint string
    Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud Gateway Custom Domain.
    springCloudGatewayId String
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    name String
    The name which should be used for this Spring Cloud Gateway Custom Domain. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    thumbprint String
    Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud Gateway Custom Domain.
    springCloudGatewayId string
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    name string
    The name which should be used for this Spring Cloud Gateway Custom Domain. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    thumbprint string
    Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud Gateway Custom Domain.
    spring_cloud_gateway_id str
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    name str
    The name which should be used for this Spring Cloud Gateway Custom Domain. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    thumbprint str
    Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud Gateway Custom Domain.
    springCloudGatewayId String
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    name String
    The name which should be used for this Spring Cloud Gateway Custom Domain. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    thumbprint String
    Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud Gateway Custom Domain.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SpringCloudGatewayCustomDomain 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 SpringCloudGatewayCustomDomain Resource

    Get an existing SpringCloudGatewayCustomDomain 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?: SpringCloudGatewayCustomDomainState, opts?: CustomResourceOptions): SpringCloudGatewayCustomDomain
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            spring_cloud_gateway_id: Optional[str] = None,
            thumbprint: Optional[str] = None) -> SpringCloudGatewayCustomDomain
    func GetSpringCloudGatewayCustomDomain(ctx *Context, name string, id IDInput, state *SpringCloudGatewayCustomDomainState, opts ...ResourceOption) (*SpringCloudGatewayCustomDomain, error)
    public static SpringCloudGatewayCustomDomain Get(string name, Input<string> id, SpringCloudGatewayCustomDomainState? state, CustomResourceOptions? opts = null)
    public static SpringCloudGatewayCustomDomain get(String name, Output<String> id, SpringCloudGatewayCustomDomainState 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 Gateway Custom Domain. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    SpringCloudGatewayId string
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    Thumbprint string
    Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud Gateway Custom Domain.
    Name string
    The name which should be used for this Spring Cloud Gateway Custom Domain. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    SpringCloudGatewayId string
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    Thumbprint string
    Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud Gateway Custom Domain.
    name String
    The name which should be used for this Spring Cloud Gateway Custom Domain. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    springCloudGatewayId String
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    thumbprint String
    Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud Gateway Custom Domain.
    name string
    The name which should be used for this Spring Cloud Gateway Custom Domain. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    springCloudGatewayId string
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    thumbprint string
    Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud Gateway Custom Domain.
    name str
    The name which should be used for this Spring Cloud Gateway Custom Domain. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    spring_cloud_gateway_id str
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    thumbprint str
    Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud Gateway Custom Domain.
    name String
    The name which should be used for this Spring Cloud Gateway Custom Domain. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    springCloudGatewayId String
    The ID of the Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway Custom Domain to be created.
    thumbprint String
    Specifies the thumbprint of the Spring Cloud Certificate that binds to the Spring Cloud Gateway Custom Domain.

    Import

    Spring Cloud Gateway Custom Domains can be imported using the resource id, e.g.

    $ pulumi import azure:appplatform/springCloudGatewayCustomDomain:SpringCloudGatewayCustomDomain example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.AppPlatform/spring/service1/gateways/gateway1/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.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi