Azure Classic v5.52.0, Oct 2 23

We recommend using Azure Native.

Azure Classic v5.52.0 published on Monday, Oct 2, 2023 by Pulumi

pulumi/pulumi-azure

azure.frontdoor.CustomHttpsConfiguration

Explore with Pulumi AI

We recommend using Azure Native.

Azure Classic v5.52.0 published on Monday, Oct 2, 2023 by Pulumi

pulumi/pulumi-azure

Import

Front Door Custom HTTPS Configurations can be imported using the resource id of the Front Door Custom HTTPS Configuration, e.g.

 $ pulumi import azure:frontdoor/customHttpsConfiguration:CustomHttpsConfiguration example_custom_https_1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/frontDoors/frontdoor1/customHttpsConfiguration/endpoint1

Create CustomHttpsConfiguration Resource

new CustomHttpsConfiguration(name: string, args: CustomHttpsConfigurationArgs, opts?: CustomResourceOptions);

@overload
def CustomHttpsConfiguration(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             custom_https_configuration: Optional[CustomHttpsConfigurationCustomHttpsConfigurationArgs] = None,
                             custom_https_provisioning_enabled: Optional[bool] = None,
                             frontend_endpoint_id: Optional[str] = None)
@overload
def CustomHttpsConfiguration(resource_name: str,
                             args: CustomHttpsConfigurationArgs,
                             opts: Optional[ResourceOptions] = None)

func NewCustomHttpsConfiguration(ctx *Context, name string, args CustomHttpsConfigurationArgs, opts ...ResourceOption) (*CustomHttpsConfiguration, error)

public CustomHttpsConfiguration(string name, CustomHttpsConfigurationArgs args, CustomResourceOptions? opts = null)

public CustomHttpsConfiguration(String name, CustomHttpsConfigurationArgs args)
public CustomHttpsConfiguration(String name, CustomHttpsConfigurationArgs args, CustomResourceOptions options)

type: azure:frontdoor:CustomHttpsConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CustomHttpsConfigurationArgs: 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 CustomHttpsConfigurationArgs: 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 CustomHttpsConfigurationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CustomHttpsConfigurationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args CustomHttpsConfigurationArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

CustomHttpsProvisioningEnabled bool: Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
FrontendEndpointId string: The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.
CustomHttpsConfigurationConfig CustomHttpsConfigurationCustomHttpsConfiguration: A custom_https_configuration block as defined above.

CustomHttpsProvisioningEnabled bool: Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
FrontendEndpointId string: The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.
CustomHttpsConfiguration CustomHttpsConfigurationCustomHttpsConfigurationArgs: A custom_https_configuration block as defined above.

customHttpsProvisioningEnabled Boolean: Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
frontendEndpointId String: The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.
customHttpsConfiguration CustomHttpsConfigurationCustomHttpsConfiguration: A custom_https_configuration block as defined above.

customHttpsProvisioningEnabled boolean: Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
frontendEndpointId string: The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.
customHttpsConfiguration CustomHttpsConfigurationCustomHttpsConfiguration: A custom_https_configuration block as defined above.

custom_https_provisioning_enabled bool: Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
frontend_endpoint_id str: The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.
custom_https_configuration CustomHttpsConfigurationCustomHttpsConfigurationArgs: A custom_https_configuration block as defined above.

customHttpsProvisioningEnabled Boolean: Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
frontendEndpointId String: The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.
customHttpsConfiguration Property Map: A custom_https_configuration block as defined above.

Outputs

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

Get an existing CustomHttpsConfiguration 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?: CustomHttpsConfigurationState, opts?: CustomResourceOptions): CustomHttpsConfiguration

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        custom_https_configuration: Optional[CustomHttpsConfigurationCustomHttpsConfigurationArgs] = None,
        custom_https_provisioning_enabled: Optional[bool] = None,
        frontend_endpoint_id: Optional[str] = None) -> CustomHttpsConfiguration

func GetCustomHttpsConfiguration(ctx *Context, name string, id IDInput, state *CustomHttpsConfigurationState, opts ...ResourceOption) (*CustomHttpsConfiguration, error)

public static CustomHttpsConfiguration Get(string name, Input<string> id, CustomHttpsConfigurationState? state, CustomResourceOptions? opts = null)

public static CustomHttpsConfiguration get(String name, Output<String> id, CustomHttpsConfigurationState 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:

CustomHttpsConfigurationConfig CustomHttpsConfigurationCustomHttpsConfiguration: A custom_https_configuration block as defined above.
CustomHttpsProvisioningEnabled bool: Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
FrontendEndpointId string: The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.

CustomHttpsConfiguration CustomHttpsConfigurationCustomHttpsConfigurationArgs: A custom_https_configuration block as defined above.
CustomHttpsProvisioningEnabled bool: Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
FrontendEndpointId string: The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.

customHttpsConfiguration CustomHttpsConfigurationCustomHttpsConfiguration: A custom_https_configuration block as defined above.
customHttpsProvisioningEnabled Boolean: Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
frontendEndpointId String: The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.

customHttpsConfiguration CustomHttpsConfigurationCustomHttpsConfiguration: A custom_https_configuration block as defined above.
customHttpsProvisioningEnabled boolean: Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
frontendEndpointId string: The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.

custom_https_configuration CustomHttpsConfigurationCustomHttpsConfigurationArgs: A custom_https_configuration block as defined above.
custom_https_provisioning_enabled bool: Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
frontend_endpoint_id str: The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.

customHttpsConfiguration Property Map: A custom_https_configuration block as defined above.
customHttpsProvisioningEnabled Boolean: Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
frontendEndpointId String: The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.

Supporting Types

CustomHttpsConfigurationCustomHttpsConfiguration, CustomHttpsConfigurationCustomHttpsConfigurationArgs

AzureKeyVaultCertificateSecretName string

The name of the Key Vault secret representing the full certificate PFX.

AzureKeyVaultCertificateSecretVersion string

The version of the Key Vault secret representing the full certificate PFX.

Note: In order to enable the use of your own custom HTTPS certificate you must grant Azure Front Door Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation.

AzureKeyVaultCertificateVaultId string

The ID of the Key Vault containing the SSL certificate.

CertificateSource string

Certificate source to encrypted HTTPS traffic with. Allowed values are FrontDoor or AzureKeyVault. Defaults to FrontDoor.

The following attributes are only valid if certificate_source is set to AzureKeyVault:

MinimumTlsVersion string

Minimum client TLS version supported.

ProvisioningState string

ProvisioningSubstate string

AzureKeyVaultCertificateSecretName string

The name of the Key Vault secret representing the full certificate PFX.

AzureKeyVaultCertificateSecretVersion string

The version of the Key Vault secret representing the full certificate PFX.

Note: In order to enable the use of your own custom HTTPS certificate you must grant Azure Front Door Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation.

AzureKeyVaultCertificateVaultId string

The ID of the Key Vault containing the SSL certificate.

CertificateSource string

Certificate source to encrypted HTTPS traffic with. Allowed values are FrontDoor or AzureKeyVault. Defaults to FrontDoor.

The following attributes are only valid if certificate_source is set to AzureKeyVault:

MinimumTlsVersion string

Minimum client TLS version supported.

ProvisioningState string

ProvisioningSubstate string

azureKeyVaultCertificateSecretName String

The name of the Key Vault secret representing the full certificate PFX.

azureKeyVaultCertificateSecretVersion String

The version of the Key Vault secret representing the full certificate PFX.

Note: In order to enable the use of your own custom HTTPS certificate you must grant Azure Front Door Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation.

azureKeyVaultCertificateVaultId String

The ID of the Key Vault containing the SSL certificate.

certificateSource String

Certificate source to encrypted HTTPS traffic with. Allowed values are FrontDoor or AzureKeyVault. Defaults to FrontDoor.

The following attributes are only valid if certificate_source is set to AzureKeyVault:

minimumTlsVersion String

Minimum client TLS version supported.

provisioningState String

provisioningSubstate String

azureKeyVaultCertificateSecretName string

The name of the Key Vault secret representing the full certificate PFX.

azureKeyVaultCertificateSecretVersion string

The version of the Key Vault secret representing the full certificate PFX.

Note: In order to enable the use of your own custom HTTPS certificate you must grant Azure Front Door Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation.

azureKeyVaultCertificateVaultId string

The ID of the Key Vault containing the SSL certificate.

certificateSource string

Certificate source to encrypted HTTPS traffic with. Allowed values are FrontDoor or AzureKeyVault. Defaults to FrontDoor.

The following attributes are only valid if certificate_source is set to AzureKeyVault:

minimumTlsVersion string

Minimum client TLS version supported.

provisioningState string

provisioningSubstate string

azure_key_vault_certificate_secret_name str

The name of the Key Vault secret representing the full certificate PFX.

azure_key_vault_certificate_secret_version str

The version of the Key Vault secret representing the full certificate PFX.

Note: In order to enable the use of your own custom HTTPS certificate you must grant Azure Front Door Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation.

azure_key_vault_certificate_vault_id str

The ID of the Key Vault containing the SSL certificate.

certificate_source str

Certificate source to encrypted HTTPS traffic with. Allowed values are FrontDoor or AzureKeyVault. Defaults to FrontDoor.

The following attributes are only valid if certificate_source is set to AzureKeyVault:

minimum_tls_version str

Minimum client TLS version supported.

provisioning_state str

provisioning_substate str

azureKeyVaultCertificateSecretName String

The name of the Key Vault secret representing the full certificate PFX.

azureKeyVaultCertificateSecretVersion String

The version of the Key Vault secret representing the full certificate PFX.

Note: In order to enable the use of your own custom HTTPS certificate you must grant Azure Front Door Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation.

azureKeyVaultCertificateVaultId String