azure-native.cdn.getCustomDomain

Explore with Pulumi AI

Gets an existing custom domain within an endpoint. API Version: 2020-09-01.

Using getCustomDomain

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCustomDomain(args: GetCustomDomainArgs, opts?: InvokeOptions): Promise<GetCustomDomainResult>
function getCustomDomainOutput(args: GetCustomDomainOutputArgs, opts?: InvokeOptions): Output<GetCustomDomainResult>
def get_custom_domain(custom_domain_name: Optional[str] = None,
                      endpoint_name: Optional[str] = None,
                      profile_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCustomDomainResult
def get_custom_domain_output(custom_domain_name: Optional[pulumi.Input[str]] = None,
                      endpoint_name: Optional[pulumi.Input[str]] = None,
                      profile_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCustomDomainResult]
func LookupCustomDomain(ctx *Context, args *LookupCustomDomainArgs, opts ...InvokeOption) (*LookupCustomDomainResult, error)
func LookupCustomDomainOutput(ctx *Context, args *LookupCustomDomainOutputArgs, opts ...InvokeOption) LookupCustomDomainResultOutput

> Note: This function is named LookupCustomDomain in the Go SDK.

public static class GetCustomDomain 
{
    public static Task<GetCustomDomainResult> InvokeAsync(GetCustomDomainArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomDomainResult> Invoke(GetCustomDomainInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCustomDomainResult> getCustomDomain(GetCustomDomainArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure-native:cdn:getCustomDomain
  arguments:
    # arguments dictionary

The following arguments are supported:

CustomDomainName string

Name of the custom domain within an endpoint.

EndpointName string

Name of the endpoint under the profile which is unique globally.

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.

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.

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.

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.

custom_domain_name str

Name of the custom domain within an endpoint.

endpoint_name str

Name of the endpoint under the profile which is unique globally.

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.

customDomainName String

Name of the custom domain within an endpoint.

endpointName String

Name of the endpoint under the profile which is unique globally.

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.

getCustomDomain Result

The following output properties are available:

CustomHttpsProvisioningState string

Provisioning status of Custom Https of the custom domain.

CustomHttpsProvisioningSubstate string

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.

HostName string

The host name of the custom domain. Must be a domain name.

Id string

Resource ID.

Name string

Resource name.

ProvisioningState string

Provisioning status 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 Custom Https of the custom domain.

CustomHttpsProvisioningSubstate string

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.

HostName string

The host name of the custom domain. Must be a domain name.

Id string

Resource ID.

Name string

Resource name.

ProvisioningState string

Provisioning status 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 Custom Https of the custom domain.

customHttpsProvisioningSubstate String

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.

hostName String

The host name of the custom domain. Must be a domain name.

id String

Resource ID.

name String

Resource name.

provisioningState String

Provisioning status 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 Custom Https of the custom domain.

customHttpsProvisioningSubstate string

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.

hostName string

The host name of the custom domain. Must be a domain name.

id string

Resource ID.

name string

Resource name.

provisioningState string

Provisioning status 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 Custom Https of the custom domain.

custom_https_provisioning_substate str

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.

host_name str

The host name of the custom domain. Must be a domain name.

id str

Resource ID.

name str

Resource name.

provisioning_state str

Provisioning status 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 Custom Https of the custom domain.

customHttpsProvisioningSubstate String

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.

hostName String

The host name of the custom domain. Must be a domain name.

id String

Resource ID.

name String

Resource name.

provisioningState String

Provisioning status 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

CertificateType string

Type of certificate used

OdataType string
CertificateType string

Type of certificate used

OdataType string
certificateType String

Type of certificate used

odataType String
certificateType string

Type of certificate used

odataType string
certificate_type str

Type of certificate used

odata_type str
certificateType String

Type of certificate used

odataType String

CdnManagedHttpsParametersResponse

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

DeleteRule string

Describes the action that shall be taken when the certificate is removed from Key Vault.

OdataType string
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

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.

OdataType string
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

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.

odataType String
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

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.

odataType string
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

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.

odata_type str
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

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.

odataType String
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

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

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

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

Package Details

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