1. Packages
  2. Azure Classic
  3. API Docs
  4. containerapp
  5. CustomDomain

We recommend using Azure Native.

Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi

azure.containerapp.CustomDomain

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi

    Manages a Container App Custom Domain.

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    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.dns.Zone;
    import com.pulumi.azure.dns.ZoneArgs;
    import com.pulumi.azure.operationalinsights.AnalyticsWorkspace;
    import com.pulumi.azure.operationalinsights.AnalyticsWorkspaceArgs;
    import com.pulumi.azure.containerapp.Environment;
    import com.pulumi.azure.containerapp.EnvironmentArgs;
    import com.pulumi.azure.containerapp.App;
    import com.pulumi.azure.containerapp.AppArgs;
    import com.pulumi.azure.containerapp.inputs.AppTemplateArgs;
    import com.pulumi.azure.containerapp.inputs.AppIngressArgs;
    import com.pulumi.azure.dns.TxtRecord;
    import com.pulumi.azure.dns.TxtRecordArgs;
    import com.pulumi.azure.dns.inputs.TxtRecordRecordArgs;
    import com.pulumi.azure.containerapp.EnvironmentCertificate;
    import com.pulumi.azure.containerapp.EnvironmentCertificateArgs;
    import com.pulumi.azure.containerapp.CustomDomain;
    import com.pulumi.azure.containerapp.CustomDomainArgs;
    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 exampleZone = new Zone("exampleZone", ZoneArgs.builder()        
                .name("contoso.com")
                .resourceGroupName(example.name())
                .build());
    
            var exampleAnalyticsWorkspace = new AnalyticsWorkspace("exampleAnalyticsWorkspace", AnalyticsWorkspaceArgs.builder()        
                .name("example")
                .location(example.location())
                .resourceGroupName(example.name())
                .sku("PerGB2018")
                .retentionInDays(30)
                .build());
    
            var exampleEnvironment = new Environment("exampleEnvironment", EnvironmentArgs.builder()        
                .name("Example-Environment")
                .location(example.location())
                .resourceGroupName(example.name())
                .logAnalyticsWorkspaceId(exampleAnalyticsWorkspace.id())
                .build());
    
            var exampleApp = new App("exampleApp", AppArgs.builder()        
                .name("example-app")
                .containerAppEnvironmentId(exampleEnvironment.id())
                .resourceGroupName(example.name())
                .revisionMode("Single")
                .template(AppTemplateArgs.builder()
                    .containers(AppTemplateContainerArgs.builder()
                        .name("examplecontainerapp")
                        .image("mcr.microsoft.com/azuredocs/containerapps-helloworld:latest")
                        .cpu(0.25)
                        .memory("0.5Gi")
                        .build())
                    .build())
                .ingress(AppIngressArgs.builder()
                    .allowInsecureConnections(false)
                    .externalEnabled(true)
                    .targetPort(5000)
                    .transport("http")
                    .trafficWeights(AppIngressTrafficWeightArgs.builder()
                        .latestRevision(true)
                        .percentage(100)
                        .build())
                    .build())
                .build());
    
            var exampleTxtRecord = new TxtRecord("exampleTxtRecord", TxtRecordArgs.builder()        
                .name("asuid.example")
                .resourceGroupName(exampleZone.resourceGroupName())
                .zoneName(exampleZone.name())
                .ttl(300)
                .records(TxtRecordRecordArgs.builder()
                    .value(exampleApp.customDomainVerificationId())
                    .build())
                .build());
    
            var exampleEnvironmentCertificate = new EnvironmentCertificate("exampleEnvironmentCertificate", EnvironmentCertificateArgs.builder()        
                .name("myfriendlyname")
                .containerAppEnvironmentId(exampleEnvironment.id())
                .certificateBlob(StdFunctions.filebase64(Filebase64Args.builder()
                    .input("path/to/certificate_file.pfx")
                    .build()).result())
                .certificatePassword("$3cretSqu1rreL")
                .build());
    
            var exampleCustomDomain = new CustomDomain("exampleCustomDomain", CustomDomainArgs.builder()        
                .name(StdFunctions.trimprefix().applyValue(invoke -> invoke.result()))
                .containerAppId(exampleApp.id())
                .containerAppEnvironmentCertificateId(exampleEnvironmentCertificate.id())
                .certificateBindingType("SniEnabled")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleZone:
        type: azure:dns:Zone
        name: example
        properties:
          name: contoso.com
          resourceGroupName: ${example.name}
      exampleTxtRecord:
        type: azure:dns:TxtRecord
        name: example
        properties:
          name: asuid.example
          resourceGroupName: ${exampleZone.resourceGroupName}
          zoneName: ${exampleZone.name}
          ttl: 300
          records:
            - value: ${exampleApp.customDomainVerificationId}
      exampleAnalyticsWorkspace:
        type: azure:operationalinsights:AnalyticsWorkspace
        name: example
        properties:
          name: example
          location: ${example.location}
          resourceGroupName: ${example.name}
          sku: PerGB2018
          retentionInDays: 30
      exampleEnvironment:
        type: azure:containerapp:Environment
        name: example
        properties:
          name: Example-Environment
          location: ${example.location}
          resourceGroupName: ${example.name}
          logAnalyticsWorkspaceId: ${exampleAnalyticsWorkspace.id}
      exampleEnvironmentCertificate:
        type: azure:containerapp:EnvironmentCertificate
        name: example
        properties:
          name: myfriendlyname
          containerAppEnvironmentId: ${exampleEnvironment.id}
          certificateBlob:
            fn::invoke:
              Function: std:filebase64
              Arguments:
                input: path/to/certificate_file.pfx
              Return: result
          certificatePassword: $3cretSqu1rreL
      exampleApp:
        type: azure:containerapp:App
        name: example
        properties:
          name: example-app
          containerAppEnvironmentId: ${exampleEnvironment.id}
          resourceGroupName: ${example.name}
          revisionMode: Single
          template:
            containers:
              - name: examplecontainerapp
                image: mcr.microsoft.com/azuredocs/containerapps-helloworld:latest
                cpu: 0.25
                memory: 0.5Gi
          ingress:
            allowInsecureConnections: false
            externalEnabled: true
            targetPort: 5000
            transport: http
            trafficWeights:
              - latestRevision: true
                percentage: 100
      exampleCustomDomain:
        type: azure:containerapp:CustomDomain
        name: example
        properties:
          name:
            fn::invoke:
              Function: std:trimprefix
              Arguments:
                input: ${exampleTxtRecord.fqdn}
                prefix: asuid.
              Return: result
          containerAppId: ${exampleApp.id}
          containerAppEnvironmentCertificateId: ${exampleEnvironmentCertificate.id}
          certificateBindingType: SniEnabled
    

    Create CustomDomain Resource

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

    Constructor syntax

    new CustomDomain(name: string, args: CustomDomainArgs, opts?: CustomResourceOptions);
    @overload
    def CustomDomain(resource_name: str,
                     args: CustomDomainArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def CustomDomain(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     certificate_binding_type: Optional[str] = None,
                     container_app_environment_certificate_id: Optional[str] = None,
                     container_app_id: Optional[str] = None,
                     name: Optional[str] = None)
    func NewCustomDomain(ctx *Context, name string, args CustomDomainArgs, opts ...ResourceOption) (*CustomDomain, error)
    public CustomDomain(string name, CustomDomainArgs args, CustomResourceOptions? opts = null)
    public CustomDomain(String name, CustomDomainArgs args)
    public CustomDomain(String name, CustomDomainArgs args, CustomResourceOptions options)
    
    type: azure:containerapp:CustomDomain
    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 CustomDomainArgs
    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 CustomDomainArgs
    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 CustomDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomDomainArgs
    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 azureCustomDomainResource = new Azure.ContainerApp.CustomDomain("azureCustomDomainResource", new()
    {
        CertificateBindingType = "string",
        ContainerAppEnvironmentCertificateId = "string",
        ContainerAppId = "string",
        Name = "string",
    });
    
    example, err := containerapp.NewCustomDomain(ctx, "azureCustomDomainResource", &containerapp.CustomDomainArgs{
    	CertificateBindingType:               pulumi.String("string"),
    	ContainerAppEnvironmentCertificateId: pulumi.String("string"),
    	ContainerAppId:                       pulumi.String("string"),
    	Name:                                 pulumi.String("string"),
    })
    
    var azureCustomDomainResource = new CustomDomain("azureCustomDomainResource", CustomDomainArgs.builder()        
        .certificateBindingType("string")
        .containerAppEnvironmentCertificateId("string")
        .containerAppId("string")
        .name("string")
        .build());
    
    azure_custom_domain_resource = azure.containerapp.CustomDomain("azureCustomDomainResource",
        certificate_binding_type="string",
        container_app_environment_certificate_id="string",
        container_app_id="string",
        name="string")
    
    const azureCustomDomainResource = new azure.containerapp.CustomDomain("azureCustomDomainResource", {
        certificateBindingType: "string",
        containerAppEnvironmentCertificateId: "string",
        containerAppId: "string",
        name: "string",
    });
    
    type: azure:containerapp:CustomDomain
    properties:
        certificateBindingType: string
        containerAppEnvironmentCertificateId: string
        containerAppId: string
        name: string
    

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

    CertificateBindingType string
    The Certificate Binding type. Possible values include Disabled and SniEnabled. Changing this forces a new resource to be created.
    ContainerAppEnvironmentCertificateId string
    The ID of the Container App Environment Certificate to use. Changing this forces a new resource to be created.
    ContainerAppId string
    The ID of the Container App to which this Custom Domain should be bound. Changing this forces a new resource to be created.
    Name string

    The fully qualified name of the Custom Domain. Must be the CN or a named SAN in the certificate specified by the container_app_environment_certificate_id. Changing this forces a new resource to be created.

    Note: The Custom Domain verification TXT record requires a prefix of asuid., however, this must be trimmed from the name property here. See the official docs for more information.

    CertificateBindingType string
    The Certificate Binding type. Possible values include Disabled and SniEnabled. Changing this forces a new resource to be created.
    ContainerAppEnvironmentCertificateId string
    The ID of the Container App Environment Certificate to use. Changing this forces a new resource to be created.
    ContainerAppId string
    The ID of the Container App to which this Custom Domain should be bound. Changing this forces a new resource to be created.
    Name string

    The fully qualified name of the Custom Domain. Must be the CN or a named SAN in the certificate specified by the container_app_environment_certificate_id. Changing this forces a new resource to be created.

    Note: The Custom Domain verification TXT record requires a prefix of asuid., however, this must be trimmed from the name property here. See the official docs for more information.

    certificateBindingType String
    The Certificate Binding type. Possible values include Disabled and SniEnabled. Changing this forces a new resource to be created.
    containerAppEnvironmentCertificateId String
    The ID of the Container App Environment Certificate to use. Changing this forces a new resource to be created.
    containerAppId String
    The ID of the Container App to which this Custom Domain should be bound. Changing this forces a new resource to be created.
    name String

    The fully qualified name of the Custom Domain. Must be the CN or a named SAN in the certificate specified by the container_app_environment_certificate_id. Changing this forces a new resource to be created.

    Note: The Custom Domain verification TXT record requires a prefix of asuid., however, this must be trimmed from the name property here. See the official docs for more information.

    certificateBindingType string
    The Certificate Binding type. Possible values include Disabled and SniEnabled. Changing this forces a new resource to be created.
    containerAppEnvironmentCertificateId string
    The ID of the Container App Environment Certificate to use. Changing this forces a new resource to be created.
    containerAppId string
    The ID of the Container App to which this Custom Domain should be bound. Changing this forces a new resource to be created.
    name string

    The fully qualified name of the Custom Domain. Must be the CN or a named SAN in the certificate specified by the container_app_environment_certificate_id. Changing this forces a new resource to be created.

    Note: The Custom Domain verification TXT record requires a prefix of asuid., however, this must be trimmed from the name property here. See the official docs for more information.

    certificate_binding_type str
    The Certificate Binding type. Possible values include Disabled and SniEnabled. Changing this forces a new resource to be created.
    container_app_environment_certificate_id str
    The ID of the Container App Environment Certificate to use. Changing this forces a new resource to be created.
    container_app_id str
    The ID of the Container App to which this Custom Domain should be bound. Changing this forces a new resource to be created.
    name str

    The fully qualified name of the Custom Domain. Must be the CN or a named SAN in the certificate specified by the container_app_environment_certificate_id. Changing this forces a new resource to be created.

    Note: The Custom Domain verification TXT record requires a prefix of asuid., however, this must be trimmed from the name property here. See the official docs for more information.

    certificateBindingType String
    The Certificate Binding type. Possible values include Disabled and SniEnabled. Changing this forces a new resource to be created.
    containerAppEnvironmentCertificateId String
    The ID of the Container App Environment Certificate to use. Changing this forces a new resource to be created.
    containerAppId String
    The ID of the Container App to which this Custom Domain should be bound. Changing this forces a new resource to be created.
    name String

    The fully qualified name of the Custom Domain. Must be the CN or a named SAN in the certificate specified by the container_app_environment_certificate_id. Changing this forces a new resource to be created.

    Note: The Custom Domain verification TXT record requires a prefix of asuid., however, this must be trimmed from the name property here. See the official docs for more information.

    Outputs

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

    Get an existing CustomDomain 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?: CustomDomainState, opts?: CustomResourceOptions): CustomDomain
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            certificate_binding_type: Optional[str] = None,
            container_app_environment_certificate_id: Optional[str] = None,
            container_app_id: Optional[str] = None,
            name: Optional[str] = None) -> CustomDomain
    func GetCustomDomain(ctx *Context, name string, id IDInput, state *CustomDomainState, opts ...ResourceOption) (*CustomDomain, error)
    public static CustomDomain Get(string name, Input<string> id, CustomDomainState? state, CustomResourceOptions? opts = null)
    public static CustomDomain get(String name, Output<String> id, CustomDomainState 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:
    CertificateBindingType string
    The Certificate Binding type. Possible values include Disabled and SniEnabled. Changing this forces a new resource to be created.
    ContainerAppEnvironmentCertificateId string
    The ID of the Container App Environment Certificate to use. Changing this forces a new resource to be created.
    ContainerAppId string
    The ID of the Container App to which this Custom Domain should be bound. Changing this forces a new resource to be created.
    Name string

    The fully qualified name of the Custom Domain. Must be the CN or a named SAN in the certificate specified by the container_app_environment_certificate_id. Changing this forces a new resource to be created.

    Note: The Custom Domain verification TXT record requires a prefix of asuid., however, this must be trimmed from the name property here. See the official docs for more information.

    CertificateBindingType string
    The Certificate Binding type. Possible values include Disabled and SniEnabled. Changing this forces a new resource to be created.
    ContainerAppEnvironmentCertificateId string
    The ID of the Container App Environment Certificate to use. Changing this forces a new resource to be created.
    ContainerAppId string
    The ID of the Container App to which this Custom Domain should be bound. Changing this forces a new resource to be created.
    Name string

    The fully qualified name of the Custom Domain. Must be the CN or a named SAN in the certificate specified by the container_app_environment_certificate_id. Changing this forces a new resource to be created.

    Note: The Custom Domain verification TXT record requires a prefix of asuid., however, this must be trimmed from the name property here. See the official docs for more information.

    certificateBindingType String
    The Certificate Binding type. Possible values include Disabled and SniEnabled. Changing this forces a new resource to be created.
    containerAppEnvironmentCertificateId String
    The ID of the Container App Environment Certificate to use. Changing this forces a new resource to be created.
    containerAppId String
    The ID of the Container App to which this Custom Domain should be bound. Changing this forces a new resource to be created.
    name String

    The fully qualified name of the Custom Domain. Must be the CN or a named SAN in the certificate specified by the container_app_environment_certificate_id. Changing this forces a new resource to be created.

    Note: The Custom Domain verification TXT record requires a prefix of asuid., however, this must be trimmed from the name property here. See the official docs for more information.

    certificateBindingType string
    The Certificate Binding type. Possible values include Disabled and SniEnabled. Changing this forces a new resource to be created.
    containerAppEnvironmentCertificateId string
    The ID of the Container App Environment Certificate to use. Changing this forces a new resource to be created.
    containerAppId string
    The ID of the Container App to which this Custom Domain should be bound. Changing this forces a new resource to be created.
    name string

    The fully qualified name of the Custom Domain. Must be the CN or a named SAN in the certificate specified by the container_app_environment_certificate_id. Changing this forces a new resource to be created.

    Note: The Custom Domain verification TXT record requires a prefix of asuid., however, this must be trimmed from the name property here. See the official docs for more information.

    certificate_binding_type str
    The Certificate Binding type. Possible values include Disabled and SniEnabled. Changing this forces a new resource to be created.
    container_app_environment_certificate_id str
    The ID of the Container App Environment Certificate to use. Changing this forces a new resource to be created.
    container_app_id str
    The ID of the Container App to which this Custom Domain should be bound. Changing this forces a new resource to be created.
    name str

    The fully qualified name of the Custom Domain. Must be the CN or a named SAN in the certificate specified by the container_app_environment_certificate_id. Changing this forces a new resource to be created.

    Note: The Custom Domain verification TXT record requires a prefix of asuid., however, this must be trimmed from the name property here. See the official docs for more information.

    certificateBindingType String
    The Certificate Binding type. Possible values include Disabled and SniEnabled. Changing this forces a new resource to be created.
    containerAppEnvironmentCertificateId String
    The ID of the Container App Environment Certificate to use. Changing this forces a new resource to be created.
    containerAppId String
    The ID of the Container App to which this Custom Domain should be bound. Changing this forces a new resource to be created.
    name String

    The fully qualified name of the Custom Domain. Must be the CN or a named SAN in the certificate specified by the container_app_environment_certificate_id. Changing this forces a new resource to be created.

    Note: The Custom Domain verification TXT record requires a prefix of asuid., however, this must be trimmed from the name property here. See the official docs for more information.

    Import

    A Container App Custom Domain can be imported using the resource id, e.g.

    $ pulumi import azure:containerapp/customDomain:CustomDomain example "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.App/containerApps/myContainerApp/customDomainName/mycustomdomain.example.com"
    

    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.72.0 published on Monday, Apr 15, 2024 by Pulumi