azure-native.cdn.CustomDomain
Explore with Pulumi AI
Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.
Uses Azure REST API version 2024-09-01. In version 2.x of the Azure Native provider, it used API version 2023-05-01.
Other available API versions: 2023-05-01, 2023-07-01-preview, 2024-02-01, 2024-05-01-preview, 2024-06-01-preview, 2025-04-15. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cdn [ApiVersion]
. See the version guide for details.
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,
endpoint_name: Optional[str] = None,
host_name: Optional[str] = None,
profile_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
custom_domain_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-native:cdn:CustomDomain
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. CustomDomainArgs - 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. 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
This property is required. string - The unique name of the resource.
- args
This property is required. CustomDomainArgs - 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. CustomDomainArgs - 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. CustomDomainArgs - 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 azure_nativeCustomDomainResource = new AzureNative.Cdn.CustomDomain("azure-nativeCustomDomainResource", new()
{
EndpointName = "string",
HostName = "string",
ProfileName = "string",
ResourceGroupName = "string",
CustomDomainName = "string",
});
example, err := cdn.NewCustomDomain(ctx, "azure-nativeCustomDomainResource", &cdn.CustomDomainArgs{
EndpointName: pulumi.String("string"),
HostName: pulumi.String("string"),
ProfileName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
CustomDomainName: pulumi.String("string"),
})
var azure_nativeCustomDomainResource = new CustomDomain("azure-nativeCustomDomainResource", CustomDomainArgs.builder()
.endpointName("string")
.hostName("string")
.profileName("string")
.resourceGroupName("string")
.customDomainName("string")
.build());
azure_native_custom_domain_resource = azure_native.cdn.CustomDomain("azure-nativeCustomDomainResource",
endpoint_name="string",
host_name="string",
profile_name="string",
resource_group_name="string",
custom_domain_name="string")
const azure_nativeCustomDomainResource = new azure_native.cdn.CustomDomain("azure-nativeCustomDomainResource", {
endpointName: "string",
hostName: "string",
profileName: "string",
resourceGroupName: "string",
customDomainName: "string",
});
type: azure-native:cdn:CustomDomain
properties:
customDomainName: string
endpointName: string
hostName: string
profileName: string
resourceGroupName: 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CustomDomain resource accepts the following input properties:
- Endpoint
Name This property is required. Changes to this property will trigger replacement.
- Name of the endpoint under the profile which is unique globally.
- Host
Name This property is required. string - The host name of the custom domain. Must be a domain name.
- Profile
Name This property is required. Changes to this property will trigger replacement.
- Name of the CDN profile which is unique within the resource group.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the Resource group within the Azure subscription.
- Custom
Domain Name Changes to this property will trigger replacement.
- Name of the custom domain within an endpoint.
- Endpoint
Name This property is required. Changes to this property will trigger replacement.
- Name of the endpoint under the profile which is unique globally.
- Host
Name This property is required. string - The host name of the custom domain. Must be a domain name.
- Profile
Name This property is required. Changes to this property will trigger replacement.
- Name of the CDN profile which is unique within the resource group.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the Resource group within the Azure subscription.
- Custom
Domain Name Changes to this property will trigger replacement.
- Name of the custom domain within an endpoint.
- endpoint
Name This property is required. Changes to this property will trigger replacement.
- Name of the endpoint under the profile which is unique globally.
- host
Name This property is required. String - The host name of the custom domain. Must be a domain name.
- profile
Name This property is required. Changes to this property will trigger replacement.
- Name of the CDN profile which is unique within the resource group.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the Resource group within the Azure subscription.
- custom
Domain Name Changes to this property will trigger replacement.
- Name of the custom domain within an endpoint.
- endpoint
Name This property is required. Changes to this property will trigger replacement.
- Name of the endpoint under the profile which is unique globally.
- host
Name This property is required. string - The host name of the custom domain. Must be a domain name.
- profile
Name This property is required. Changes to this property will trigger replacement.
- Name of the CDN profile which is unique within the resource group.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the Resource group within the Azure subscription.
- custom
Domain Name Changes to this property will trigger replacement.
- Name of the custom domain within an endpoint.
- endpoint_
name This property is required. Changes to this property will trigger replacement.
- Name of the endpoint under the profile which is unique globally.
- host_
name This property is required. str - The host name of the custom domain. Must be a domain name.
- profile_
name This property is required. Changes to this property will trigger replacement.
- Name of the CDN profile which is unique within the resource group.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- Name of the Resource group within the Azure subscription.
- custom_
domain_ name Changes to this property will trigger replacement.
- Name of the custom domain within an endpoint.
- endpoint
Name This property is required. Changes to this property will trigger replacement.
- Name of the endpoint under the profile which is unique globally.
- host
Name This property is required. String - The host name of the custom domain. Must be a domain name.
- profile
Name This property is required. Changes to this property will trigger replacement.
- Name of the CDN profile which is unique within the resource group.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the Resource group within the Azure subscription.
- custom
Domain Name Changes to this property will trigger replacement.
- 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:
- Azure
Api stringVersion - The Azure API version of the resource.
- Custom
Https stringProvisioning State - Provisioning status of the custom domain.
- Custom
Https stringProvisioning Substate - 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.
- Provisioning
State string - Provisioning status of Custom Https of the custom domain.
- Resource
State string - Resource status of the custom domain.
- System
Data Pulumi.Azure Native. Cdn. Outputs. System Data Response - Read only system data
- Type string
- Resource type.
- Custom
Https Pulumi.Parameters Azure | Pulumi.Native. Cdn. Outputs. Cdn Managed Https Parameters Response Azure Native. Cdn. Outputs. User Managed Https Parameters Response - Certificate parameters for securing custom HTTPS
- Validation
Data 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.
- Azure
Api stringVersion - The Azure API version of the resource.
- Custom
Https stringProvisioning State - Provisioning status of the custom domain.
- Custom
Https stringProvisioning Substate - 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.
- Provisioning
State string - Provisioning status of Custom Https of the custom domain.
- Resource
State string - Resource status of the custom domain.
- System
Data SystemData Response - Read only system data
- Type string
- Resource type.
- Custom
Https CdnParameters Managed | UserHttps Parameters Response Managed Https Parameters Response - Certificate parameters for securing custom HTTPS
- Validation
Data 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.
- azure
Api StringVersion - The Azure API version of the resource.
- custom
Https StringProvisioning State - Provisioning status of the custom domain.
- custom
Https StringProvisioning Substate - 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.
- provisioning
State String - Provisioning status of Custom Https of the custom domain.
- resource
State String - Resource status of the custom domain.
- system
Data SystemData Response - Read only system data
- type String
- Resource type.
- custom
Https CdnParameters Managed | UserHttps Parameters Response Managed Https Parameters Response - Certificate parameters for securing custom HTTPS
- validation
Data 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.
- azure
Api stringVersion - The Azure API version of the resource.
- custom
Https stringProvisioning State - Provisioning status of the custom domain.
- custom
Https stringProvisioning Substate - 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.
- provisioning
State string - Provisioning status of Custom Https of the custom domain.
- resource
State string - Resource status of the custom domain.
- system
Data SystemData Response - Read only system data
- type string
- Resource type.
- custom
Https CdnParameters Managed | UserHttps Parameters Response Managed Https Parameters Response - Certificate parameters for securing custom HTTPS
- validation
Data 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.
- azure_
api_ strversion - The Azure API version of the resource.
- custom_
https_ strprovisioning_ state - Provisioning status of the custom domain.
- custom_
https_ strprovisioning_ substate - 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 SystemData Response - Read only system data
- type str
- Resource type.
- custom_
https_ Cdnparameters Managed | UserHttps Parameters Response Managed Https Parameters Response - 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.
- azure
Api StringVersion - The Azure API version of the resource.
- custom
Https StringProvisioning State - Provisioning status of the custom domain.
- custom
Https StringProvisioning Substate - 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.
- provisioning
State String - Provisioning status of Custom Https of the custom domain.
- resource
State String - Resource status of the custom domain.
- system
Data Property Map - Read only system data
- type String
- Resource type.
- custom
Https Property Map | Property MapParameters - Certificate parameters for securing custom HTTPS
- validation
Data 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
- Certificate
Type This property is required. string - Type of certificate used
- Certificate
Type This property is required. string - Type of certificate used
- certificate
Type This property is required. String - Type of certificate used
- certificate
Type This property is required. string - Type of certificate used
- certificate_
type This property is required. str - Type of certificate used
- certificate
Type This property is required. String - Type of certificate used
CdnManagedHttpsParametersResponse, CdnManagedHttpsParametersResponseArgs
- Certificate
Source Parameters This property is required. Pulumi.Azure Native. Cdn. Inputs. Cdn Certificate Source Parameters Response - Defines the certificate source parameters using CDN managed certificate for enabling SSL.
- Protocol
Type This property is required. string - Defines the TLS extension protocol that is used for secure delivery.
- Minimum
Tls stringVersion - TLS protocol version that will be used for Https
- Certificate
Source Parameters This property is required. CdnCertificate Source Parameters Response - Defines the certificate source parameters using CDN managed certificate for enabling SSL.
- Protocol
Type This property is required. string - Defines the TLS extension protocol that is used for secure delivery.
- Minimum
Tls stringVersion - TLS protocol version that will be used for Https
- certificate
Source Parameters This property is required. CdnCertificate Source Parameters Response - Defines the certificate source parameters using CDN managed certificate for enabling SSL.
- protocol
Type This property is required. String - Defines the TLS extension protocol that is used for secure delivery.
- minimum
Tls StringVersion - TLS protocol version that will be used for Https
- certificate
Source Parameters This property is required. CdnCertificate Source Parameters Response - Defines the certificate source parameters using CDN managed certificate for enabling SSL.
- protocol
Type This property is required. string - Defines the TLS extension protocol that is used for secure delivery.
- minimum
Tls stringVersion - TLS protocol version that will be used for Https
- certificate_
source_ parameters This property is required. CdnCertificate Source Parameters Response - Defines the certificate source parameters using CDN managed certificate for enabling SSL.
- protocol_
type This property is required. str - Defines the TLS extension protocol that is used for secure delivery.
- minimum_
tls_ strversion - TLS protocol version that will be used for Https
- certificate
Source Parameters This property is required. Property Map - Defines the certificate source parameters using CDN managed certificate for enabling SSL.
- protocol
Type This property is required. String - Defines the TLS extension protocol that is used for secure delivery.
- minimum
Tls StringVersion - TLS protocol version that will be used for Https
KeyVaultCertificateSourceParametersResponse, KeyVaultCertificateSourceParametersResponseArgs
- Delete
Rule This property is required. string - Describes the action that shall be taken when the certificate is removed from Key Vault.
- Resource
Group Name This property is required. string - Resource group of the user's Key Vault containing the SSL certificate
- Secret
Name This property is required. string - The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.
- Subscription
Id This property is required. string - Subscription Id of the user's Key Vault containing the SSL certificate
- Update
Rule This property is required. string - Describes the action that shall be taken when the certificate is updated in Key Vault.
- Vault
Name This property is required. string - The name of the user's Key Vault containing the SSL certificate
- Secret
Version string - The version(GUID) of Key Vault Secret in Key Vault.
- Delete
Rule This property is required. string - Describes the action that shall be taken when the certificate is removed from Key Vault.
- Resource
Group Name This property is required. string - Resource group of the user's Key Vault containing the SSL certificate
- Secret
Name This property is required. string - The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.
- Subscription
Id This property is required. string - Subscription Id of the user's Key Vault containing the SSL certificate
- Update
Rule This property is required. string - Describes the action that shall be taken when the certificate is updated in Key Vault.
- Vault
Name This property is required. string - The name of the user's Key Vault containing the SSL certificate
- Secret
Version string - The version(GUID) of Key Vault Secret in Key Vault.
- delete
Rule This property is required. String - Describes the action that shall be taken when the certificate is removed from Key Vault.
- resource
Group Name This property is required. String - Resource group of the user's Key Vault containing the SSL certificate
- secret
Name This property is required. String - The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.
- subscription
Id This property is required. String - Subscription Id of the user's Key Vault containing the SSL certificate
- update
Rule This property is required. String - Describes the action that shall be taken when the certificate is updated in Key Vault.
- vault
Name This property is required. String - The name of the user's Key Vault containing the SSL certificate
- secret
Version String - The version(GUID) of Key Vault Secret in Key Vault.
- delete
Rule This property is required. string - Describes the action that shall be taken when the certificate is removed from Key Vault.
- resource
Group Name This property is required. string - Resource group of the user's Key Vault containing the SSL certificate
- secret
Name This property is required. string - The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.
- subscription
Id This property is required. string - Subscription Id of the user's Key Vault containing the SSL certificate
- update
Rule This property is required. string - Describes the action that shall be taken when the certificate is updated in Key Vault.
- vault
Name This property is required. string - The name of the user's Key Vault containing the SSL certificate
- secret
Version string - The version(GUID) of Key Vault Secret in Key Vault.
- delete_
rule This property is required. str - Describes the action that shall be taken when the certificate is removed from Key Vault.
- resource_
group_ name This property is required. str - Resource group of the user's Key Vault containing the SSL certificate
- secret_
name This property is required. str - The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.
- subscription_
id This property is required. str - Subscription Id of the user's Key Vault containing the SSL certificate
- update_
rule This property is required. str - Describes the action that shall be taken when the certificate is updated in Key Vault.
- vault_
name This property is required. 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.
- delete
Rule This property is required. String - Describes the action that shall be taken when the certificate is removed from Key Vault.
- resource
Group Name This property is required. String - Resource group of the user's Key Vault containing the SSL certificate
- secret
Name This property is required. String - The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.
- subscription
Id This property is required. String - Subscription Id of the user's Key Vault containing the SSL certificate
- update
Rule This property is required. String - Describes the action that shall be taken when the certificate is updated in Key Vault.
- vault
Name This property is required. String - The name of the user's Key Vault containing the SSL certificate
- secret
Version String - The version(GUID) of Key Vault Secret in Key Vault.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC)
- Created
By string - An identifier for the identity that created the resource
- Created
By stringType - The type of identity that created the resource
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - An identifier for the identity that last modified the resource
- Last
Modified stringBy Type - The type of identity that last modified the resource
- Created
At string - The timestamp of resource creation (UTC)
- Created
By string - An identifier for the identity that created the resource
- Created
By stringType - The type of identity that created the resource
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - An identifier for the identity that last modified the resource
- Last
Modified stringBy Type - The type of identity that last modified the resource
- created
At String - The timestamp of resource creation (UTC)
- created
By String - An identifier for the identity that created the resource
- created
By StringType - The type of identity that created the resource
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - An identifier for the identity that last modified the resource
- last
Modified StringBy Type - The type of identity that last modified the resource
- created
At string - The timestamp of resource creation (UTC)
- created
By string - An identifier for the identity that created the resource
- created
By stringType - The type of identity that created the resource
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - An identifier for the identity that last modified the resource
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - An identifier for the identity that last modified the resource
- last_
modified_ strby_ type - The type of identity that last modified the resource
- created
At String - The timestamp of resource creation (UTC)
- created
By String - An identifier for the identity that created the resource
- created
By StringType - The type of identity that created the resource
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - An identifier for the identity that last modified the resource
- last
Modified StringBy Type - The type of identity that last modified the resource
UserManagedHttpsParametersResponse, UserManagedHttpsParametersResponseArgs
- Certificate
Source Parameters This property is required. Pulumi.Azure Native. Cdn. Inputs. Key Vault Certificate Source Parameters Response - Defines the certificate source parameters using user's keyvault certificate for enabling SSL.
- Protocol
Type This property is required. string - Defines the TLS extension protocol that is used for secure delivery.
- Minimum
Tls stringVersion - TLS protocol version that will be used for Https
- Certificate
Source Parameters This property is required. KeyVault Certificate Source Parameters Response - Defines the certificate source parameters using user's keyvault certificate for enabling SSL.
- Protocol
Type This property is required. string - Defines the TLS extension protocol that is used for secure delivery.
- Minimum
Tls stringVersion - TLS protocol version that will be used for Https
- certificate
Source Parameters This property is required. KeyVault Certificate Source Parameters Response - Defines the certificate source parameters using user's keyvault certificate for enabling SSL.
- protocol
Type This property is required. String - Defines the TLS extension protocol that is used for secure delivery.
- minimum
Tls StringVersion - TLS protocol version that will be used for Https
- certificate
Source Parameters This property is required. KeyVault Certificate Source Parameters Response - Defines the certificate source parameters using user's keyvault certificate for enabling SSL.
- protocol
Type This property is required. string - Defines the TLS extension protocol that is used for secure delivery.
- minimum
Tls stringVersion - TLS protocol version that will be used for Https
- certificate_
source_ parameters This property is required. KeyVault Certificate Source Parameters Response - Defines the certificate source parameters using user's keyvault certificate for enabling SSL.
- protocol_
type This property is required. str - Defines the TLS extension protocol that is used for secure delivery.
- minimum_
tls_ strversion - TLS protocol version that will be used for Https
- certificate
Source Parameters This property is required. Property Map - Defines the certificate source parameters using user's keyvault certificate for enabling SSL.
- protocol
Type This property is required. String - Defines the TLS extension protocol that is used for secure delivery.
- minimum
Tls StringVersion - 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}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0