1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. AppServiceEnvironmentAseCustomDnsSuffixConfiguration
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.web.AppServiceEnvironmentAseCustomDnsSuffixConfiguration

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Full view of the custom domain suffix configuration for ASEv3. Azure REST API version: 2022-09-01. Prior API version in Azure Native 1.x: 2022-03-01.

    Other available API versions: 2023-01-01, 2023-12-01, 2024-04-01.

    Example Usage

    Update ASE custom DNS suffix configuration

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var appServiceEnvironmentAseCustomDnsSuffixConfiguration = new AzureNative.Web.AppServiceEnvironmentAseCustomDnsSuffixConfiguration("appServiceEnvironmentAseCustomDnsSuffixConfiguration", new()
        {
            CertificateUrl = "https://test-kv.vault.azure.net/secrets/contosocert",
            DnsSuffix = "contoso.com",
            KeyVaultReferenceIdentity = "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi",
            Name = "test-ase",
            ResourceGroupName = "test-rg",
        });
    
    });
    
    package main
    
    import (
    	web "github.com/pulumi/pulumi-azure-native-sdk/web/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := web.NewAppServiceEnvironmentAseCustomDnsSuffixConfiguration(ctx, "appServiceEnvironmentAseCustomDnsSuffixConfiguration", &web.AppServiceEnvironmentAseCustomDnsSuffixConfigurationArgs{
    			CertificateUrl:            pulumi.String("https://test-kv.vault.azure.net/secrets/contosocert"),
    			DnsSuffix:                 pulumi.String("contoso.com"),
    			KeyVaultReferenceIdentity: pulumi.String("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi"),
    			Name:                      pulumi.String("test-ase"),
    			ResourceGroupName:         pulumi.String("test-rg"),
    		})
    		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.azurenative.web.AppServiceEnvironmentAseCustomDnsSuffixConfiguration;
    import com.pulumi.azurenative.web.AppServiceEnvironmentAseCustomDnsSuffixConfigurationArgs;
    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 appServiceEnvironmentAseCustomDnsSuffixConfiguration = new AppServiceEnvironmentAseCustomDnsSuffixConfiguration("appServiceEnvironmentAseCustomDnsSuffixConfiguration", AppServiceEnvironmentAseCustomDnsSuffixConfigurationArgs.builder()
                .certificateUrl("https://test-kv.vault.azure.net/secrets/contosocert")
                .dnsSuffix("contoso.com")
                .keyVaultReferenceIdentity("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi")
                .name("test-ase")
                .resourceGroupName("test-rg")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    app_service_environment_ase_custom_dns_suffix_configuration = azure_native.web.AppServiceEnvironmentAseCustomDnsSuffixConfiguration("appServiceEnvironmentAseCustomDnsSuffixConfiguration",
        certificate_url="https://test-kv.vault.azure.net/secrets/contosocert",
        dns_suffix="contoso.com",
        key_vault_reference_identity="/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi",
        name="test-ase",
        resource_group_name="test-rg")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const appServiceEnvironmentAseCustomDnsSuffixConfiguration = new azure_native.web.AppServiceEnvironmentAseCustomDnsSuffixConfiguration("appServiceEnvironmentAseCustomDnsSuffixConfiguration", {
        certificateUrl: "https://test-kv.vault.azure.net/secrets/contosocert",
        dnsSuffix: "contoso.com",
        keyVaultReferenceIdentity: "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi",
        name: "test-ase",
        resourceGroupName: "test-rg",
    });
    
    resources:
      appServiceEnvironmentAseCustomDnsSuffixConfiguration:
        type: azure-native:web:AppServiceEnvironmentAseCustomDnsSuffixConfiguration
        properties:
          certificateUrl: https://test-kv.vault.azure.net/secrets/contosocert
          dnsSuffix: contoso.com
          keyVaultReferenceIdentity: /subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi
          name: test-ase
          resourceGroupName: test-rg
    

    Create AppServiceEnvironmentAseCustomDnsSuffixConfiguration Resource

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

    Constructor syntax

    new AppServiceEnvironmentAseCustomDnsSuffixConfiguration(name: string, args: AppServiceEnvironmentAseCustomDnsSuffixConfigurationArgs, opts?: CustomResourceOptions);
    @overload
    def AppServiceEnvironmentAseCustomDnsSuffixConfiguration(resource_name: str,
                                                             args: AppServiceEnvironmentAseCustomDnsSuffixConfigurationArgs,
                                                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def AppServiceEnvironmentAseCustomDnsSuffixConfiguration(resource_name: str,
                                                             opts: Optional[ResourceOptions] = None,
                                                             name: Optional[str] = None,
                                                             resource_group_name: Optional[str] = None,
                                                             certificate_url: Optional[str] = None,
                                                             dns_suffix: Optional[str] = None,
                                                             key_vault_reference_identity: Optional[str] = None,
                                                             kind: Optional[str] = None)
    func NewAppServiceEnvironmentAseCustomDnsSuffixConfiguration(ctx *Context, name string, args AppServiceEnvironmentAseCustomDnsSuffixConfigurationArgs, opts ...ResourceOption) (*AppServiceEnvironmentAseCustomDnsSuffixConfiguration, error)
    public AppServiceEnvironmentAseCustomDnsSuffixConfiguration(string name, AppServiceEnvironmentAseCustomDnsSuffixConfigurationArgs args, CustomResourceOptions? opts = null)
    public AppServiceEnvironmentAseCustomDnsSuffixConfiguration(String name, AppServiceEnvironmentAseCustomDnsSuffixConfigurationArgs args)
    public AppServiceEnvironmentAseCustomDnsSuffixConfiguration(String name, AppServiceEnvironmentAseCustomDnsSuffixConfigurationArgs args, CustomResourceOptions options)
    
    type: azure-native:web:AppServiceEnvironmentAseCustomDnsSuffixConfiguration
    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 AppServiceEnvironmentAseCustomDnsSuffixConfigurationArgs
    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 AppServiceEnvironmentAseCustomDnsSuffixConfigurationArgs
    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 AppServiceEnvironmentAseCustomDnsSuffixConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppServiceEnvironmentAseCustomDnsSuffixConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppServiceEnvironmentAseCustomDnsSuffixConfigurationArgs
    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 appServiceEnvironmentAseCustomDnsSuffixConfigurationResource = new AzureNative.Web.AppServiceEnvironmentAseCustomDnsSuffixConfiguration("appServiceEnvironmentAseCustomDnsSuffixConfigurationResource", new()
    {
        Name = "string",
        ResourceGroupName = "string",
        CertificateUrl = "string",
        DnsSuffix = "string",
        KeyVaultReferenceIdentity = "string",
        Kind = "string",
    });
    
    example, err := web.NewAppServiceEnvironmentAseCustomDnsSuffixConfiguration(ctx, "appServiceEnvironmentAseCustomDnsSuffixConfigurationResource", &web.AppServiceEnvironmentAseCustomDnsSuffixConfigurationArgs{
    	Name:                      pulumi.String("string"),
    	ResourceGroupName:         pulumi.String("string"),
    	CertificateUrl:            pulumi.String("string"),
    	DnsSuffix:                 pulumi.String("string"),
    	KeyVaultReferenceIdentity: pulumi.String("string"),
    	Kind:                      pulumi.String("string"),
    })
    
    var appServiceEnvironmentAseCustomDnsSuffixConfigurationResource = new AppServiceEnvironmentAseCustomDnsSuffixConfiguration("appServiceEnvironmentAseCustomDnsSuffixConfigurationResource", AppServiceEnvironmentAseCustomDnsSuffixConfigurationArgs.builder()
        .name("string")
        .resourceGroupName("string")
        .certificateUrl("string")
        .dnsSuffix("string")
        .keyVaultReferenceIdentity("string")
        .kind("string")
        .build());
    
    app_service_environment_ase_custom_dns_suffix_configuration_resource = azure_native.web.AppServiceEnvironmentAseCustomDnsSuffixConfiguration("appServiceEnvironmentAseCustomDnsSuffixConfigurationResource",
        name="string",
        resource_group_name="string",
        certificate_url="string",
        dns_suffix="string",
        key_vault_reference_identity="string",
        kind="string")
    
    const appServiceEnvironmentAseCustomDnsSuffixConfigurationResource = new azure_native.web.AppServiceEnvironmentAseCustomDnsSuffixConfiguration("appServiceEnvironmentAseCustomDnsSuffixConfigurationResource", {
        name: "string",
        resourceGroupName: "string",
        certificateUrl: "string",
        dnsSuffix: "string",
        keyVaultReferenceIdentity: "string",
        kind: "string",
    });
    
    type: azure-native:web:AppServiceEnvironmentAseCustomDnsSuffixConfiguration
    properties:
        certificateUrl: string
        dnsSuffix: string
        keyVaultReferenceIdentity: string
        kind: string
        name: string
        resourceGroupName: string
    

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

    Name string
    Name of the App Service Environment.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    CertificateUrl string
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    DnsSuffix string
    The default custom domain suffix to use for all sites deployed on the ASE.
    KeyVaultReferenceIdentity string
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    Kind string
    Kind of resource.
    Name string
    Name of the App Service Environment.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    CertificateUrl string
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    DnsSuffix string
    The default custom domain suffix to use for all sites deployed on the ASE.
    KeyVaultReferenceIdentity string
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    Kind string
    Kind of resource.
    name String
    Name of the App Service Environment.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    certificateUrl String
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    dnsSuffix String
    The default custom domain suffix to use for all sites deployed on the ASE.
    keyVaultReferenceIdentity String
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    kind String
    Kind of resource.
    name string
    Name of the App Service Environment.
    resourceGroupName string
    Name of the resource group to which the resource belongs.
    certificateUrl string
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    dnsSuffix string
    The default custom domain suffix to use for all sites deployed on the ASE.
    keyVaultReferenceIdentity string
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    kind string
    Kind of resource.
    name str
    Name of the App Service Environment.
    resource_group_name str
    Name of the resource group to which the resource belongs.
    certificate_url str
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    dns_suffix str
    The default custom domain suffix to use for all sites deployed on the ASE.
    key_vault_reference_identity str
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    kind str
    Kind of resource.
    name String
    Name of the App Service Environment.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    certificateUrl String
    The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
    dnsSuffix String
    The default custom domain suffix to use for all sites deployed on the ASE.
    keyVaultReferenceIdentity String
    The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
    kind String
    Kind of resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ProvisioningDetails string
    ProvisioningState string
    Type string
    Resource type.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProvisioningDetails string
    ProvisioningState string
    Type string
    Resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    provisioningDetails String
    provisioningState String
    type String
    Resource type.
    id string
    The provider-assigned unique ID for this managed resource.
    provisioningDetails string
    provisioningState string
    type string
    Resource type.
    id str
    The provider-assigned unique ID for this managed resource.
    provisioning_details str
    provisioning_state str
    type str
    Resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    provisioningDetails String
    provisioningState String
    type String
    Resource type.

    Import

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

    $ pulumi import azure-native:web:AppServiceEnvironmentAseCustomDnsSuffixConfiguration customDnsSuffix /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi