Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. appplatform
  5. GatewayCustomDomain
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.appplatform.GatewayCustomDomain

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Custom domain of the Spring Cloud Gateway Azure REST API version: 2023-05-01-preview. Prior API version in Azure Native 1.x: 2022-01-01-preview.

Other available API versions: 2023-07-01-preview, 2023-09-01-preview, 2023-11-01-preview, 2023-12-01, 2024-01-01-preview, 2024-05-01-preview.

Example Usage

GatewayCustomDomains_CreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var gatewayCustomDomain = new AzureNative.AppPlatform.GatewayCustomDomain("gatewayCustomDomain", new()
    {
        DomainName = "myDomainName",
        GatewayName = "default",
        Properties = new AzureNative.AppPlatform.Inputs.GatewayCustomDomainPropertiesArgs
        {
            Thumbprint = "*",
        },
        ResourceGroupName = "myResourceGroup",
        ServiceName = "myservice",
    });

});
Copy
package main

import (
	appplatform "github.com/pulumi/pulumi-azure-native-sdk/appplatform/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := appplatform.NewGatewayCustomDomain(ctx, "gatewayCustomDomain", &appplatform.GatewayCustomDomainArgs{
			DomainName:  pulumi.String("myDomainName"),
			GatewayName: pulumi.String("default"),
			Properties: &appplatform.GatewayCustomDomainPropertiesArgs{
				Thumbprint: pulumi.String("*"),
			},
			ResourceGroupName: pulumi.String("myResourceGroup"),
			ServiceName:       pulumi.String("myservice"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.appplatform.GatewayCustomDomain;
import com.pulumi.azurenative.appplatform.GatewayCustomDomainArgs;
import com.pulumi.azurenative.appplatform.inputs.GatewayCustomDomainPropertiesArgs;
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 gatewayCustomDomain = new GatewayCustomDomain("gatewayCustomDomain", GatewayCustomDomainArgs.builder()
            .domainName("myDomainName")
            .gatewayName("default")
            .properties(GatewayCustomDomainPropertiesArgs.builder()
                .thumbprint("*")
                .build())
            .resourceGroupName("myResourceGroup")
            .serviceName("myservice")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const gatewayCustomDomain = new azure_native.appplatform.GatewayCustomDomain("gatewayCustomDomain", {
    domainName: "myDomainName",
    gatewayName: "default",
    properties: {
        thumbprint: "*",
    },
    resourceGroupName: "myResourceGroup",
    serviceName: "myservice",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

gateway_custom_domain = azure_native.appplatform.GatewayCustomDomain("gatewayCustomDomain",
    domain_name="myDomainName",
    gateway_name="default",
    properties={
        "thumbprint": "*",
    },
    resource_group_name="myResourceGroup",
    service_name="myservice")
Copy
resources:
  gatewayCustomDomain:
    type: azure-native:appplatform:GatewayCustomDomain
    properties:
      domainName: myDomainName
      gatewayName: default
      properties:
        thumbprint: '*'
      resourceGroupName: myResourceGroup
      serviceName: myservice
Copy

Create GatewayCustomDomain Resource

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

Constructor syntax

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

@overload
def GatewayCustomDomain(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        gateway_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        service_name: Optional[str] = None,
                        domain_name: Optional[str] = None,
                        properties: Optional[GatewayCustomDomainPropertiesArgs] = None)
func NewGatewayCustomDomain(ctx *Context, name string, args GatewayCustomDomainArgs, opts ...ResourceOption) (*GatewayCustomDomain, error)
public GatewayCustomDomain(string name, GatewayCustomDomainArgs args, CustomResourceOptions? opts = null)
public GatewayCustomDomain(String name, GatewayCustomDomainArgs args)
public GatewayCustomDomain(String name, GatewayCustomDomainArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayCustomDomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GatewayCustomDomainArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayCustomDomainArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayCustomDomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GatewayCustomDomainArgs
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 gatewayCustomDomainResource = new AzureNative.Appplatform.GatewayCustomDomain("gatewayCustomDomainResource", new()
{
    GatewayName = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    DomainName = "string",
    Properties = 
    {
        { "thumbprint", "string" },
    },
});
Copy
example, err := appplatform.NewGatewayCustomDomain(ctx, "gatewayCustomDomainResource", &appplatform.GatewayCustomDomainArgs{
	GatewayName:       "string",
	ResourceGroupName: "string",
	ServiceName:       "string",
	DomainName:        "string",
	Properties: map[string]interface{}{
		"thumbprint": "string",
	},
})
Copy
var gatewayCustomDomainResource = new GatewayCustomDomain("gatewayCustomDomainResource", GatewayCustomDomainArgs.builder()
    .gatewayName("string")
    .resourceGroupName("string")
    .serviceName("string")
    .domainName("string")
    .properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());
Copy
gateway_custom_domain_resource = azure_native.appplatform.GatewayCustomDomain("gatewayCustomDomainResource",
    gateway_name=string,
    resource_group_name=string,
    service_name=string,
    domain_name=string,
    properties={
        thumbprint: string,
    })
Copy
const gatewayCustomDomainResource = new azure_native.appplatform.GatewayCustomDomain("gatewayCustomDomainResource", {
    gatewayName: "string",
    resourceGroupName: "string",
    serviceName: "string",
    domainName: "string",
    properties: {
        thumbprint: "string",
    },
});
Copy
type: azure-native:appplatform:GatewayCustomDomain
properties:
    domainName: string
    gatewayName: string
    properties:
        thumbprint: string
    resourceGroupName: string
    serviceName: string
Copy

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

GatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of Spring Cloud Gateway.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
DomainName Changes to this property will trigger replacement. string
The name of the Spring Cloud Gateway custom domain.
Properties Pulumi.AzureNative.AppPlatform.Inputs.GatewayCustomDomainProperties
The properties of custom domain for Spring Cloud Gateway
GatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of Spring Cloud Gateway.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
DomainName Changes to this property will trigger replacement. string
The name of the Spring Cloud Gateway custom domain.
Properties GatewayCustomDomainPropertiesArgs
The properties of custom domain for Spring Cloud Gateway
gatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of Spring Cloud Gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Service resource.
domainName Changes to this property will trigger replacement. String
The name of the Spring Cloud Gateway custom domain.
properties GatewayCustomDomainProperties
The properties of custom domain for Spring Cloud Gateway
gatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of Spring Cloud Gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
domainName Changes to this property will trigger replacement. string
The name of the Spring Cloud Gateway custom domain.
properties GatewayCustomDomainProperties
The properties of custom domain for Spring Cloud Gateway
gateway_name
This property is required.
Changes to this property will trigger replacement.
str
The name of Spring Cloud Gateway.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Service resource.
domain_name Changes to this property will trigger replacement. str
The name of the Spring Cloud Gateway custom domain.
properties GatewayCustomDomainPropertiesArgs
The properties of custom domain for Spring Cloud Gateway
gatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of Spring Cloud Gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Service resource.
domainName Changes to this property will trigger replacement. String
The name of the Spring Cloud Gateway custom domain.
properties Property Map
The properties of custom domain for Spring Cloud Gateway

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource.
SystemData Pulumi.AzureNative.AppPlatform.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource.

Supporting Types

GatewayCustomDomainProperties
, GatewayCustomDomainPropertiesArgs

Thumbprint string
The thumbprint of bound certificate.
Thumbprint string
The thumbprint of bound certificate.
thumbprint String
The thumbprint of bound certificate.
thumbprint string
The thumbprint of bound certificate.
thumbprint str
The thumbprint of bound certificate.
thumbprint String
The thumbprint of bound certificate.

GatewayCustomDomainPropertiesResponse
, GatewayCustomDomainPropertiesResponseArgs

Thumbprint string
The thumbprint of bound certificate.
Thumbprint string
The thumbprint of bound certificate.
thumbprint String
The thumbprint of bound certificate.
thumbprint string
The thumbprint of bound certificate.
thumbprint str
The thumbprint of bound certificate.
thumbprint String
The thumbprint of bound certificate.

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource modification (UTC).
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource modification (UTC).
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource modification (UTC).
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource modification (UTC).
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource modification (UTC).
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource modification (UTC).
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:appplatform:GatewayCustomDomain myDomainName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/domains/{domainName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native