New-AzureRmCdnEndpoint

Creates a CDN 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

New-AzureRmCdnEndpoint
   -EndpointName <String>
   -ProfileName <String>
   -ResourceGroupName <String>
   -Location <String>
   [-OriginHostHeader <String>]
   [-OriginPath <String>]
   [-ContentTypesToCompress <String[]>]
   [-IsCompressionEnabled <Boolean>]
   [-IsHttpAllowed <Boolean>]
   [-IsHttpsAllowed <Boolean>]
   [-QueryStringCachingBehavior <PSQueryStringCachingBehavior>]
   -OriginName <String>
   -OriginHostName <String>
   [-HttpPort <Int32>]
   [-HttpsPort <Int32>]
   [-OptimizationType <String>]
   [-ProbePath <String>]
   [-GeoFilters <PSGeoFilter[]>]
   [-DeliveryPolicy <PSDeliveryPolicy>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmCdnEndpoint
   -EndpointName <String>
   -CdnProfile <PSProfile>
   [-OriginHostHeader <String>]
   [-OriginPath <String>]
   [-ContentTypesToCompress <String[]>]
   [-IsCompressionEnabled <Boolean>]
   [-IsHttpAllowed <Boolean>]
   [-IsHttpsAllowed <Boolean>]
   [-QueryStringCachingBehavior <PSQueryStringCachingBehavior>]
   -OriginName <String>
   -OriginHostName <String>
   [-HttpPort <Int32>]
   [-HttpsPort <Int32>]
   [-OptimizationType <String>]
   [-ProbePath <String>]
   [-GeoFilters <PSGeoFilter[]>]
   [-DeliveryPolicy <PSDeliveryPolicy>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzureRmCdnEndpoint cmdlet creates an Azure Content Delivery Network (CDN) endpoint.

Parameters

-CdnProfile

Specifies the CDN profile object to which the endpoint is added.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContentTypesToCompress

Specifies an array of content types to compress from the edge node to the client.

Type:String[]
Position:Named
Default value:None
Required:False
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

-DeliveryPolicy

The delivery policy for this endpoint.

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

-EndpointName

Specifies the name of the endpoint.

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

-GeoFilters

The list of geo filters that applies to this endpoint.

Type:PSGeoFilter[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HttpPort

Specifies the HTTP port number on the origin server.

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HttpsPort

Specifies the HTTPS port number on the origin server.

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IsCompressionEnabled

Indicates whether compression is enabled for the endpoint.

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IsHttpAllowed

Indicates whether the endpoint enables HTTP traffic.

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IsHttpsAllowed

Indicates whether the endpoint enables HTTPS traffic.

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

Specifies the resource location of the endpoint.

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

-OptimizationType

Specifies any optimization this endpoint has.

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

-OriginHostHeader

Specifies the origin host head of the endpoint.

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

-OriginHostName

Specifies the host name of the origin server.

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

-OriginName

Specifies the resource name of the origin server.

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

-OriginPath

Specifies the path of the origin server.

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

-ProbePath

Specifies the probe path for Dynamic Site Acceleration

Type:String
Position:Named
Default value:None
Required:False
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

-QueryStringCachingBehavior

Specifies the behavior of CDN endpoint when a query string is in the request URL.

Type:Nullable<T>[PSQueryStringCachingBehavior]
Accepted values:IgnoreQueryString, BypassCaching, UseQueryString, NotSet
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of the resource group to which this endpoint belongs.

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

-Tag

The tags to associate with the Azure CDN endpoint.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSProfile

Parameters: CdnProfile (ByValue)

Outputs

PSEndpoint