azure-native.cdn.getCustomDomain
Explore with Pulumi AI
Gets an existing custom domain within an endpoint. Azure REST API version: 2023-05-01.
Other available API versions: 2016-10-02, 2023-07-01-preview.
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:
- Custom
Domain stringName Name of the custom domain within an endpoint.
- Endpoint
Name string Name of the endpoint under the profile which is unique globally.
- Profile
Name string Name of the CDN profile which is unique within the resource group.
- Resource
Group stringName Name of the Resource group within the Azure subscription.
- Custom
Domain stringName Name of the custom domain within an endpoint.
- Endpoint
Name string Name of the endpoint under the profile which is unique globally.
- Profile
Name string Name of the CDN profile which is unique within the resource group.
- Resource
Group stringName Name of the Resource group within the Azure subscription.
- custom
Domain StringName Name of the custom domain within an endpoint.
- endpoint
Name String Name of the endpoint under the profile which is unique globally.
- profile
Name String Name of the CDN profile which is unique within the resource group.
- resource
Group StringName Name of the Resource group within the Azure subscription.
- custom
Domain stringName Name of the custom domain within an endpoint.
- endpoint
Name string Name of the endpoint under the profile which is unique globally.
- profile
Name string Name of the CDN profile which is unique within the resource group.
- resource
Group stringName Name of the Resource group within the Azure subscription.
- custom_
domain_ strname 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_ strname Name of the Resource group within the Azure subscription.
- custom
Domain StringName Name of the custom domain within an endpoint.
- endpoint
Name String Name of the endpoint under the profile which is unique globally.
- profile
Name String Name of the CDN profile which is unique within the resource group.
- resource
Group StringName Name of the Resource group within the Azure subscription.
getCustomDomain Result
The following output properties are available:
- 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.
- Host
Name string The host name of the custom domain. Must be a domain name.
- Id string
Resource ID.
- 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.
- 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.
- Host
Name string The host name of the custom domain. Must be a domain name.
- Id string
Resource ID.
- 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.
- 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.
- host
Name String The host name of the custom domain. Must be a domain name.
- id String
Resource ID.
- 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.
- 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.
- host
Name string The host name of the custom domain. Must be a domain name.
- id string
Resource ID.
- 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.
- 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.
- 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 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.
- 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.
- host
Name String The host name of the custom domain. Must be a domain name.
- id String
Resource ID.
- 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
- Certificate
Type string Type of certificate used
- Type
Name string
- Certificate
Type string Type of certificate used
- Type
Name string
- certificate
Type String Type of certificate used
- type
Name String
- certificate
Type string Type of certificate used
- type
Name string
- certificate_
type str Type of certificate used
- type_
name str
- certificate
Type String Type of certificate used
- type
Name String
CdnManagedHttpsParametersResponse
- Certificate
Source Pulumi.Parameters Azure Native. Cdn. Inputs. Cdn Certificate Source Parameters Response Defines the certificate source parameters using CDN managed certificate for enabling SSL.
- Protocol
Type 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 CdnParameters Certificate Source Parameters Response Defines the certificate source parameters using CDN managed certificate for enabling SSL.
- Protocol
Type 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 CdnParameters Certificate Source Parameters Response Defines the certificate source parameters using CDN managed certificate for enabling SSL.
- protocol
Type 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 CdnParameters Certificate Source Parameters Response Defines the certificate source parameters using CDN managed certificate for enabling SSL.
- protocol
Type 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_ Cdnparameters Certificate Source Parameters Response 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_ strversion TLS protocol version that will be used for Https
- certificate
Source Property MapParameters Defines the certificate source parameters using CDN managed certificate for enabling SSL.
- protocol
Type 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
- Delete
Rule string Describes the action that shall be taken when the certificate is removed from Key Vault.
- Resource
Group stringName Resource group of the user's Key Vault containing the SSL certificate
- Secret
Name string The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.
- Subscription
Id string Subscription Id of the user's Key Vault containing the SSL certificate
- Type
Name string - Update
Rule string Describes the action that shall be taken when the certificate is updated in Key Vault.
- Vault
Name 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 string Describes the action that shall be taken when the certificate is removed from Key Vault.
- Resource
Group stringName Resource group of the user's Key Vault containing the SSL certificate
- Secret
Name string The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.
- Subscription
Id string Subscription Id of the user's Key Vault containing the SSL certificate
- Type
Name string - Update
Rule string Describes the action that shall be taken when the certificate is updated in Key Vault.
- Vault
Name 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 String Describes the action that shall be taken when the certificate is removed from Key Vault.
- resource
Group StringName Resource group of the user's Key Vault containing the SSL certificate
- secret
Name String The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.
- subscription
Id String Subscription Id of the user's Key Vault containing the SSL certificate
- type
Name String - update
Rule String Describes the action that shall be taken when the certificate is updated in Key Vault.
- vault
Name 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 string Describes the action that shall be taken when the certificate is removed from Key Vault.
- resource
Group stringName Resource group of the user's Key Vault containing the SSL certificate
- secret
Name string The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.
- subscription
Id string Subscription Id of the user's Key Vault containing the SSL certificate
- type
Name string - update
Rule string Describes the action that shall be taken when the certificate is updated in Key Vault.
- vault
Name 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 str Describes the action that shall be taken when the certificate is removed from Key Vault.
- resource_
group_ strname 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.
- delete
Rule String Describes the action that shall be taken when the certificate is removed from Key Vault.
- resource
Group StringName Resource group of the user's Key Vault containing the SSL certificate
- secret
Name String The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.
- subscription
Id String Subscription Id of the user's Key Vault containing the SSL certificate
- type
Name String - update
Rule String Describes the action that shall be taken when the certificate is updated in Key Vault.
- vault
Name 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
- 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
- Certificate
Source Pulumi.Parameters 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 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 KeyParameters Vault Certificate Source Parameters Response Defines the certificate source parameters using user's keyvault certificate for enabling SSL.
- Protocol
Type 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 KeyParameters Vault Certificate Source Parameters Response Defines the certificate source parameters using user's keyvault certificate for enabling SSL.
- protocol
Type 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 KeyParameters Vault Certificate Source Parameters Response Defines the certificate source parameters using user's keyvault certificate for enabling SSL.
- protocol
Type 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_ Keyparameters Vault Certificate Source Parameters Response 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_ strversion TLS protocol version that will be used for Https
- certificate
Source Property MapParameters Defines the certificate source parameters using user's keyvault certificate for enabling SSL.
- protocol
Type String Defines the TLS extension protocol that is used for secure delivery.
- minimum
Tls StringVersion TLS protocol version that will be used for Https
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0