Azure Native v2.21.0, Dec 5 23

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.21.0 published on Tuesday, Dec 5, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.cdn.CustomDomain

Explore with Pulumi AI

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.21.0 published on Tuesday, Dec 5, 2023 by Pulumi

pulumi/pulumi-azure-native

Example Usage

CustomDomains_Create

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

return await Deployment.RunAsync(() => 
{
    var customDomain = new AzureNative.Cdn.CustomDomain("customDomain", new()
    {
        CustomDomainName = "www-someDomain-net",
        EndpointName = "endpoint1",
        HostName = "www.someDomain.net",
        ProfileName = "profile1",
        ResourceGroupName = "RG",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cdn.NewCustomDomain(ctx, "customDomain", &cdn.CustomDomainArgs{
			CustomDomainName:  pulumi.String("www-someDomain-net"),
			EndpointName:      pulumi.String("endpoint1"),
			HostName:          pulumi.String("www.someDomain.net"),
			ProfileName:       pulumi.String("profile1"),
			ResourceGroupName: pulumi.String("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.cdn.CustomDomain;
import com.pulumi.azurenative.cdn.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 customDomain = new CustomDomain("customDomain", CustomDomainArgs.builder()        
            .customDomainName("www-someDomain-net")
            .endpointName("endpoint1")
            .hostName("www.someDomain.net")
            .profileName("profile1")
            .resourceGroupName("RG")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

custom_domain = azure_native.cdn.CustomDomain("customDomain",
    custom_domain_name="www-someDomain-net",
    endpoint_name="endpoint1",
    host_name="www.someDomain.net",
    profile_name="profile1",
    resource_group_name="RG")

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

const customDomain = new azure_native.cdn.CustomDomain("customDomain", {
    customDomainName: "www-someDomain-net",
    endpointName: "endpoint1",
    hostName: "www.someDomain.net",
    profileName: "profile1",
    resourceGroupName: "RG",
});

resources:
  customDomain:
    type: azure-native:cdn:CustomDomain
    properties:
      customDomainName: www-someDomain-net
      endpointName: endpoint1
      hostName: www.someDomain.net
      profileName: profile1
      resourceGroupName: RG

Create CustomDomain Resource

new CustomDomain(name: string, args: CustomDomainArgs, opts?: CustomResourceOptions);

@overload
def CustomDomain(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 custom_domain_name: Optional[str] = None,
                 endpoint_name: Optional[str] = None,
                 host_name: Optional[str] = None,
                 profile_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None)
@overload
def CustomDomain(resource_name: str,
                 args: CustomDomainArgs,
                 opts: Optional[ResourceOptions] = 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-native:cdn:CustomDomain
properties: # The arguments to resource properties.
options: # 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.

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.

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:

EndpointName string: Name of the endpoint under the profile which is unique globally.
HostName string: The host name of the custom domain. Must be a domain name.
ProfileName string: Name of the CDN profile which is unique within the resource group.
ResourceGroupName string: Name of the Resource group within the Azure subscription.
CustomDomainName string: Name of the custom domain within an endpoint.

EndpointName string: Name of the endpoint under the profile which is unique globally.
HostName string: The host name of the custom domain. Must be a domain name.
ProfileName string: Name of the CDN profile which is unique within the resource group.
ResourceGroupName string: Name of the Resource group within the Azure subscription.
CustomDomainName string: Name of the custom domain within an endpoint.

endpointName String: Name of the endpoint under the profile which is unique globally.
hostName String: The host name of the custom domain. Must be a domain name.
profileName String: Name of the CDN profile which is unique within the resource group.
resourceGroupName String: Name of the Resource group within the Azure subscription.
customDomainName String: Name of the custom domain within an endpoint.

endpointName string: Name of the endpoint under the profile which is unique globally.
hostName string: The host name of the custom domain. Must be a domain name.
profileName string: Name of the CDN profile which is unique within the resource group.
resourceGroupName string: Name of the Resource group within the Azure subscription.
customDomainName string: Name of the custom domain within an endpoint.

endpoint_name str: Name of the endpoint under the profile which is unique globally.
host_name str: The host name of the custom domain. Must be a domain name.
profile_name str: Name of the CDN profile which is unique within the resource group.
resource_group_name str: Name of the Resource group within the Azure subscription.
custom_domain_name str: Name of the custom domain within an endpoint.

endpointName String: Name of the endpoint under the profile which is unique globally.
hostName String: The host name of the custom domain. Must be a domain name.
profileName String: Name of the CDN profile which is unique within the resource group.
resourceGroupName String: Name of the Resource group within the Azure subscription.
customDomainName String: Name of the custom domain within an endpoint.

Outputs

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

CustomHttpsProvisioningState string: Provisioning status of the custom domain.
CustomHttpsProvisioningSubstate string: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name.
ProvisioningState string: Provisioning status of Custom Https of the custom domain.
ResourceState string: Resource status of the custom domain.
SystemData Pulumi.AzureNative.Cdn.Outputs.SystemDataResponse: Read only system data
Type string: Resource type.
CustomHttpsParameters Pulumi.AzureNative.Cdn.Outputs.CdnManagedHttpsParametersResponse | Pulumi.AzureNative.Cdn.Outputs.UserManagedHttpsParametersResponse: Certificate parameters for securing custom HTTPS
ValidationData string: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.

CustomHttpsProvisioningState string: Provisioning status of the custom domain.
CustomHttpsProvisioningSubstate string: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name.
ProvisioningState string: Provisioning status of Custom Https of the custom domain.
ResourceState string: Resource status of the custom domain.
SystemData SystemDataResponse: Read only system data
Type string: Resource type.
CustomHttpsParameters CdnManagedHttpsParametersResponse | UserManagedHttpsParametersResponse: Certificate parameters for securing custom HTTPS
ValidationData string: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.

customHttpsProvisioningState String: Provisioning status of the custom domain.
customHttpsProvisioningSubstate String: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.
id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.
provisioningState String: Provisioning status of Custom Https of the custom domain.
resourceState String: Resource status of the custom domain.
systemData SystemDataResponse: Read only system data
type String: Resource type.
customHttpsParameters CdnManagedHttpsParametersResponse | UserManagedHttpsParametersResponse: Certificate parameters for securing custom HTTPS
validationData String: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.

customHttpsProvisioningState string: Provisioning status of the custom domain.
customHttpsProvisioningSubstate string: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.
id string: The provider-assigned unique ID for this managed resource.
name string: Resource name.
provisioningState string: Provisioning status of Custom Https of the custom domain.
resourceState string: Resource status of the custom domain.
systemData SystemDataResponse: Read only system data
type string: Resource type.
customHttpsParameters CdnManagedHttpsParametersResponse | UserManagedHttpsParametersResponse: Certificate parameters for securing custom HTTPS
validationData string: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.

custom_https_provisioning_state str: Provisioning status of the custom domain.
custom_https_provisioning_substate str: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.
id str: The provider-assigned unique ID for this managed resource.
name str: Resource name.
provisioning_state str: Provisioning status of Custom Https of the custom domain.
resource_state str: Resource status of the custom domain.
system_data SystemDataResponse: Read only system data
type str: Resource type.
custom_https_parameters CdnManagedHttpsParametersResponse | UserManagedHttpsParametersResponse: Certificate parameters for securing custom HTTPS
validation_data str: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.

customHttpsProvisioningState String: Provisioning status of the custom domain.
customHttpsProvisioningSubstate String: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.
id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.
provisioningState String: Provisioning status of Custom Https of the custom domain.
resourceState String: Resource status of the custom domain.
systemData Property Map: Read only system data
type String: Resource type.
customHttpsParameters Property Map | Property Map: Certificate parameters for securing custom HTTPS
validationData String: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.

Supporting Types

CdnCertificateSourceParametersResponse, CdnCertificateSourceParametersResponseArgs

CertificateType string: Type of certificate used
TypeName string

CertificateType string: Type of certificate used
TypeName string

certificateType String: Type of certificate used
typeName String

certificateType string: Type of certificate used
typeName string

certificate_type str: Type of certificate used
type_name str

certificateType String: Type of certificate used
typeName String

CdnManagedHttpsParametersResponse, CdnManagedHttpsParametersResponseArgs

CertificateSourceParameters Pulumi.AzureNative.Cdn.Inputs.CdnCertificateSourceParametersResponse: Defines the certificate source parameters using CDN managed certificate for enabling SSL.
ProtocolType string: Defines the TLS extension protocol that is used for secure delivery.
MinimumTlsVersion string: TLS protocol version that will be used for Https

CertificateSourceParameters CdnCertificateSourceParametersResponse: Defines the certificate source parameters using CDN managed certificate for enabling SSL.
ProtocolType string: Defines the TLS extension protocol that is used for secure delivery.
MinimumTlsVersion string: TLS protocol version that will be used for Https

certificateSourceParameters CdnCertificateSourceParametersResponse: Defines the certificate source parameters using CDN managed certificate for enabling SSL.
protocolType String: Defines the TLS extension protocol that is used for secure delivery.
minimumTlsVersion String: TLS protocol version that will be used for Https

certificateSourceParameters CdnCertificateSourceParametersResponse: Defines the certificate source parameters using CDN managed certificate for enabling SSL.
protocolType string: Defines the TLS extension protocol that is used for secure delivery.
minimumTlsVersion string: TLS protocol version that will be used for Https

certificate_source_parameters CdnCertificateSourceParametersResponse: Defines the certificate source parameters using CDN managed certificate for enabling SSL.
protocol_type str: Defines the TLS extension protocol that is used for secure delivery.
minimum_tls_version str: TLS protocol version that will be used for Https

certificateSourceParameters Property Map: Defines the certificate source parameters using CDN managed certificate for enabling SSL.
protocolType String: Defines the TLS extension protocol that is used for secure delivery.
minimumTlsVersion String: TLS protocol version that will be used for Https

KeyVaultCertificateSourceParametersResponse, KeyVaultCertificateSourceParametersResponseArgs

DeleteRule string: Describes the action that shall be taken when the certificate is removed from Key Vault.
ResourceGroupName string: Resource group of the user's Key Vault containing the SSL certificate
SecretName string: The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.
SubscriptionId string: Subscription Id of the user's Key Vault containing the SSL certificate
TypeName string
UpdateRule string: Describes the action that shall be taken when the certificate is updated in Key Vault.
VaultName string: The name of the user's Key Vault containing the SSL certificate
SecretVersion string: The version(GUID) of Key Vault Secret in Key Vault.

DeleteRule string: Describes the action that shall be taken when the certificate is removed from Key Vault.
ResourceGroupName string: Resource group of the user's Key Vault containing the SSL certificate
SecretName string: The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.
SubscriptionId string: Subscription Id of the user's Key Vault containing the SSL certificate
TypeName string
UpdateRule string: Describes the action that shall be taken when the certificate is updated in Key Vault.
VaultName string: The name of the user's Key Vault containing the SSL certificate
SecretVersion string: The version(GUID) of Key Vault Secret in Key Vault.

deleteRule String: Describes the action that shall be taken when the certificate is removed from Key Vault.
resourceGroupName String: Resource group of the user's Key Vault containing the SSL certificate
secretName String: The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.
subscriptionId String: Subscription Id of the user's Key Vault containing the SSL certificate
typeName String
updateRule String: Describes the action that shall be taken when the certificate is updated in Key Vault.
vaultName String: The name of the user's Key Vault containing the SSL certificate
secretVersion String: The version(GUID) of Key Vault Secret in Key Vault.

deleteRule string: Describes the action that shall be taken when the certificate is removed from Key Vault.
resourceGroupName string: Resource group of the user's Key Vault containing the SSL certificate
secretName string: The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.
subscriptionId string: Subscription Id of the user's Key Vault containing the SSL certificate
typeName string
updateRule string: Describes the action that shall be taken when the certificate is updated in Key Vault.
vaultName string: The name of the user's Key Vault containing the SSL certificate
secretVersion string: The version(GUID) of Key Vault Secret in Key Vault.

delete_rule str: Describes the action that shall be taken when the certificate is removed from Key Vault.
resource_group_name str: Resource group of the user's Key Vault containing the SSL certificate
secret_name str: The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.
subscription_id str: Subscription Id of the user's Key Vault containing the SSL certificate
type_name str
update_rule str: Describes the action that shall be taken when the certificate is updated in Key Vault.
vault_name str: The name of the user's Key Vault containing the SSL certificate
secret_version str: The version(GUID) of Key Vault Secret in Key Vault.

deleteRule String: Describes the action that shall be taken when the certificate is removed from Key Vault.
resourceGroupName String: Resource group of the user's Key Vault containing the SSL certificate
secretName String: The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.
subscriptionId String: Subscription Id of the user's Key Vault containing the SSL certificate
typeName String
updateRule String: Describes the action that shall be taken when the certificate is updated in Key Vault.
vaultName String: The name of the user's Key Vault containing the SSL certificate
secretVersion String: The version(GUID) of Key Vault Secret in Key Vault.

SystemDataResponse, SystemDataResponseArgs

CreatedAt string: The timestamp of resource creation (UTC)
CreatedBy string: An identifier for the identity that created the resource
CreatedByType string: The type of identity that created the resource
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: An identifier for 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: An identifier for the identity that created the resource
CreatedByType string: The type of identity that created the resource
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: An identifier for 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: An identifier for the identity that created the resource
createdByType String: The type of identity that created the resource
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: An identifier for 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: An identifier for the identity that created the resource
createdByType string: The type of identity that created the resource
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: An identifier for 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: An identifier for 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 last modification (UTC)
last_modified_by str: An identifier for 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: An identifier for the identity that created the resource
createdByType String: The type of identity that created the resource
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: An identifier for the identity that last modified the resource
lastModifiedByType String: The type of identity that last modified the resource

UserManagedHttpsParametersResponse, UserManagedHttpsParametersResponseArgs

CertificateSourceParameters Pulumi.AzureNative.Cdn.Inputs.KeyVaultCertificateSourceParametersResponse: Defines the certificate source parameters using user's keyvault certificate for enabling SSL.
ProtocolType string: Defines the TLS extension protocol that is used for secure delivery.
MinimumTlsVersion string: TLS protocol version that will be used for Https

CertificateSourceParameters KeyVaultCertificateSourceParametersResponse: Defines the certificate source parameters using user's keyvault certificate for enabling SSL.
ProtocolType string: Defines the TLS extension protocol that is used for secure delivery.
MinimumTlsVersion string: TLS protocol version that will be used for Https

certificateSourceParameters KeyVaultCertificateSourceParametersResponse: Defines the certificate source parameters using user's keyvault certificate for enabling SSL.
protocolType String: Defines the TLS extension protocol that is used for secure delivery.
minimumTlsVersion String: TLS protocol version that will be used for Https

certificateSourceParameters KeyVaultCertificateSourceParametersResponse: Defines the certificate source parameters using user's keyvault certificate for enabling SSL.
protocolType string: Defines the TLS extension protocol that is used for secure delivery.
minimumTlsVersion string: TLS protocol version that will be used for Https

certificate_source_parameters KeyVaultCertificateSourceParametersResponse: Defines the certificate source parameters using user's keyvault certificate for enabling SSL.
protocol_type str: Defines the TLS extension protocol that is used for secure delivery.
minimum_tls_version str: TLS protocol version that will be used for Https

certificateSourceParameters Property Map: Defines the certificate source parameters using user's keyvault certificate for enabling SSL.
protocolType String: Defines the TLS extension protocol that is used for secure delivery.
minimumTlsVersion String: TLS protocol version that will be used for Https

Import

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

$ pulumi import azure-native:cdn:CustomDomain www-someDomain-net /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

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.21.0 published on Tuesday, Dec 5, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.cdn.CustomDomain

On this page

On this page

Example Usage

CustomDomains_Create

Create CustomDomain Resource

CustomDomain Resource Properties

Inputs

Outputs

Supporting Types

CdnCertificateSourceParametersResponse, CdnCertificateSourceParametersResponseArgs

CdnManagedHttpsParametersResponse, CdnManagedHttpsParametersResponseArgs

KeyVaultCertificateSourceParametersResponse, KeyVaultCertificateSourceParametersResponseArgs

SystemDataResponse, SystemDataResponseArgs

UserManagedHttpsParametersResponse, UserManagedHttpsParametersResponseArgs

Import

Package Details

On this page

On this page