Edit

Share via

Test-AzureRmCdnCustomDomain

  • Reference
Module:
AzureRM.Cdn

Checks whether a custom domain can be added to an endpoint.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Test-AzureRmCdnCustomDomain
    -EndpointName <String>
    -ProfileName <String>
    -ResourceGroupName <String>
    -CustomDomainHostName <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzureRmCdnCustomDomain
    -CdnEndpoint <PSEndpoint>
    -CustomDomainHostName <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Test-AzureRmCdnCustomDomain cmdlet checks whether a custom domain can be added to an endpoint by validating the CName mapping.

Parameters

-CdnEndpoint

Specifies the endpoint to which you want to add the custom domain.

Type:PSEndpoint
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-CustomDomainHostName

Specifies the host name of the custom domain.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EndpointName

Specifies the name of the endpoint to which you want to add the custom domain.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ProfileName

Specifies the name of the profile.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of the resource group.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSEndpoint

Parameters: CdnEndpoint (ByValue)

Outputs

PSValidateCustomDomainOutput