Manage Azure CDN with PowerShell
PowerShell provides one of the most flexible methods to manage your Azure CDN profiles and endpoints. You can use PowerShell interactively or by writing scripts to automate management tasks. This tutorial demonstrates several of the most common tasks you can accomplish with PowerShell to manage your Azure CDN profiles and endpoints.
Prerequisites
Note
This article has been updated to use the Azure Az PowerShell module. The Az PowerShell module is the recommended PowerShell module for interacting with Azure. To get started with the Az PowerShell module, see Install Azure PowerShell. To learn how to migrate to the Az PowerShell module, see Migrate Azure PowerShell from AzureRM to Az.
To use PowerShell to manage your Azure CDN profiles and endpoints, you must have the Azure PowerShell module installed. To learn how to install Azure PowerShell and connect to Azure using the Connect-AzAccount cmdlet, see How to install and configure Azure PowerShell.
Important
You must log in with Connect-AzAccount before you can execute Azure PowerShell cmdlets.
Listing the Azure CDN cmdlets
You can list all the Azure CDN cmdlets using the Get-Command cmdlet.
PS C:\> Get-Command -Module Az.Cdn
CommandType Name Version Source
----------- ---- ------- ------
Cmdlet Confirm-AzCdnEndpointProbeURL 1.4.0 Az.Cdn
Cmdlet Disable-AzCdnCustomDomain 1.4.0 Az.Cdn
Cmdlet Disable-AzCdnCustomDomainHttps 1.4.0 Az.Cdn
Cmdlet Enable-AzCdnCustomDomain 1.4.0 Az.Cdn
Cmdlet Enable-AzCdnCustomDomainHttps 1.4.0 Az.Cdn
Cmdlet Get-AzCdnCustomDomain 1.4.0 Az.Cdn
Cmdlet Get-AzCdnEdgeNode 1.4.0 Az.Cdn
Cmdlet Get-AzCdnEndpoint 1.4.0 Az.Cdn
Cmdlet Get-AzCdnEndpointNameAvailability 1.4.0 Az.Cdn
Cmdlet Get-AzCdnEndpointResourceUsage 1.4.0 Az.Cdn
Cmdlet Get-AzCdnOrigin 1.4.0 Az.Cdn
Cmdlet Get-AzCdnProfile 1.4.0 Az.Cdn
Cmdlet Get-AzCdnProfileResourceUsage 1.4.0 Az.Cdn
Cmdlet Get-AzCdnProfileSsoUrl 1.4.0 Az.Cdn
Cmdlet Get-AzCdnProfileSupportedOptimizationType 1.4.0 Az.Cdn
Cmdlet Get-AzCdnSubscriptionResourceUsage 1.4.0 Az.Cdn
Cmdlet New-AzCdnCustomDomain 1.4.0 Az.Cdn
Cmdlet New-AzCdnDeliveryPolicy 1.4.0 Az.Cdn
Cmdlet New-AzCdnDeliveryRule 1.4.0 Az.Cdn
Cmdlet New-AzCdnDeliveryRuleAction 1.4.0 Az.Cdn
Cmdlet New-AzCdnDeliveryRuleCondition 1.4.0 Az.Cdn
Cmdlet New-AzCdnEndpoint 1.4.0 Az.Cdn
Cmdlet New-AzCdnProfile 1.4.0 Az.Cdn
Cmdlet Publish-AzCdnEndpointContent 1.4.0 Az.Cdn
Cmdlet Remove-AzCdnCustomDomain 1.4.0 Az.Cdn
Cmdlet Remove-AzCdnEndpoint 1.4.0 Az.Cdn
Cmdlet Remove-AzCdnProfile 1.4.0 Az.Cdn
Cmdlet Set-AzCdnEndpoint 1.4.0 Az.Cdn
Cmdlet Set-AzCdnOrigin 1.4.0 Az.Cdn
Cmdlet Set-AzCdnProfile 1.4.0 Az.Cdn
Cmdlet Start-AzCdnEndpoint 1.4.0 Az.Cdn
Cmdlet Stop-AzCdnEndpoint 1.4.0 Az.Cdn
Cmdlet Test-AzCdnCustomDomain 1.4.0 Az.Cdn
Cmdlet Unpublish-AzCdnEndpointContent 1.4.0 Az.Cdn
Getting help
You can get help with any of these cmdlets using the Get-Help cmdlet. Get-Help provides usage and syntax, and optionally shows examples.
PS C:\> Get-Help Get-AzCdnProfile
NAME
Get-AzCdnProfile
SYNOPSIS
Gets an Azure CDN profile.
SYNTAX
Get-AzCdnProfile [-ProfileName <String>] [-ResourceGroupName <String>] [-InformationAction
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
DESCRIPTION
Gets an Azure CDN profile and all related information.
RELATED LINKS
REMARKS
To see the examples, type: "get-help Get-AzCdnProfile -examples".
For more information, type: "get-help Get-AzCdnProfile -detailed".
For technical information, type: "get-help Get-AzCdnProfile -full".
Listing existing Azure CDN profiles
The Get-AzCdnProfile cmdlet without any parameters retrieves all your existing CDN profiles.
Get-AzCdnProfile
This output can be piped to cmdlets for enumeration.
# Output the name of all profiles on this subscription.
Get-AzCdnProfile | ForEach-Object { Write-Host $_.Name }
# Return only **Azure CDN from Verizon** profiles.
Get-AzCdnProfile | Where-Object { $_.Sku.Name -eq "Standard_Verizon" }
You can also return a single profile by specifying the profile name and resource group.
Get-AzCdnProfile -ProfileName CdnDemo -ResourceGroupName CdnDemoRG
Tip
It is possible to have multiple CDN profiles with the same name, so long as they are in different resource groups. Omitting the ResourceGroupName parameter returns all profiles with a matching name.
Listing existing CDN endpoints
Get-AzCdnEndpoint can retrieve an individual endpoint or all the endpoints on a profile.
# Get a single endpoint.
Get-AzCdnEndpoint -ProfileName CdnDemo -ResourceGroupName CdnDemoRG -EndpointName cdndocdemo
# Get all of the endpoints on a given profile.
Get-AzCdnEndpoint -ProfileName CdnDemo -ResourceGroupName CdnDemoRG
# Return all of the endpoints on all of the profiles.
Get-AzCdnProfile | Get-AzCdnEndpoint
# Return all of the endpoints in this subscription that are currently running.
Get-AzCdnProfile | Get-AzCdnEndpoint | Where-Object { $_.ResourceState -eq "Running" }
Creating CDN profiles and endpoints
New-AzCdnProfile and New-AzCdnEndpoint are used to create CDN profiles and endpoints. The following SKUs are supported:
- Standard_Verizon
- Premium_Verizon
- Custom_Verizon
- Standard_Akamai
- Standard_Microsoft
- Standard_ChinaCdn
# Create a new profile
New-AzCdnProfile -ProfileName CdnPoshDemo -ResourceGroupName CdnDemoRG -Sku Standard_Akamai -Location "Central US"
# Create a new endpoint
New-AzCdnEndpoint -ProfileName CdnPoshDemo -ResourceGroupName CdnDemoRG -Location "Central US" -EndpointName cdnposhdoc -OriginName "Contoso" -OriginHostName "www.contoso.com"
# Create a new profile and endpoint (same as above) in one line
New-AzCdnProfile -ProfileName CdnPoshDemo -ResourceGroupName CdnDemoRG -Sku Standard_Akamai -Location "Central US" | New-AzCdnEndpoint -EndpointName cdnposhdoc -OriginName "Contoso" -OriginHostName "www.contoso.com"
Checking endpoint name availability
Get-AzCdnEndpointNameAvailability returns an object indicating if an endpoint name is available.
# Retrieve availability
$availability = Get-AzCdnEndpointNameAvailability -EndpointName "cdnposhdoc"
# If available, write a message to the console.
If($availability.NameAvailable) { Write-Host "Yes, that endpoint name is available." }
Else { Write-Host "No, that endpoint name is not available." }
Adding a custom domain
New-AzCdnCustomDomain adds a custom domain name to an existing endpoint.
Important
You must set up the CNAME with your DNS provider as described in How to map Custom Domain to Content Delivery Network (CDN) endpoint. You can test the mapping before modifying your endpoint using Test-AzCdnCustomDomain.
# Get an existing endpoint
$endpoint = Get-AzCdnEndpoint -ProfileName CdnPoshDemo -ResourceGroupName CdnDemoRG -EndpointName cdnposhdoc
# Check the mapping
$result = Test-AzCdnCustomDomain -CdnEndpoint $endpoint -CustomDomainHostName "cdn.contoso.com"
# Create the custom domain on the endpoint
If($result.CustomDomainValidated){ New-AzCdnCustomDomain -CustomDomainName Contoso -HostName "cdn.contoso.com" -CdnEndpoint $endpoint }
Modifying an endpoint
Set-AzCdnEndpoint modifies an existing endpoint.
# Get an existing endpoint
$endpoint = Get-AzCdnEndpoint -ProfileName CdnPoshDemo -ResourceGroupName CdnDemoRG -EndpointName cdnposhdoc
# Set up content compression
$endpoint.IsCompressionEnabled = $true
$endpoint.ContentTypesToCompress = "text/javascript","text/css","application/json"
# Save the changed endpoint and apply the changes
Set-AzCdnEndpoint -CdnEndpoint $endpoint
Purging/Pre-loading CDN assets
Unpublish-AzCdnEndpointContent purges cached assets, while Publish-AzCdnEndpointContent pre-loads assets on supported endpoints.
# Purge some assets.
Unpublish-AzCdnEndpointContent -ProfileName CdnDemo -ResourceGroupName CdnDemoRG -EndpointName cdndocdemo -PurgeContent "/images/kitten.png","/video/rickroll.mp4"
# Pre-load some assets.
Publish-AzCdnEndpointContent -ProfileName CdnDemo -ResourceGroupName CdnDemoRG -EndpointName cdndocdemo -LoadContent "/images/kitten.png","/video/rickroll.mp4"
# Purge everything in /images/ on all endpoints.
Get-AzCdnProfile | Get-AzCdnEndpoint | Unpublish-AzCdnEndpointContent -PurgeContent "/images/*"
Starting/Stopping CDN endpoints
Start-AzCdnEndpoint and Stop-AzCdnEndpoint can be used to start and stop individual endpoints or groups of endpoints.
# Stop the cdndocdemo endpoint
Stop-AzCdnEndpoint -ProfileName CdnDemo -ResourceGroupName CdnDemoRG -EndpointName cdndocdemo
# Stop all endpoints
Get-AzCdnProfile | Get-AzCdnEndpoint | Stop-AzCdnEndpoint
# Start all endpoints
Get-AzCdnProfile | Get-AzCdnEndpoint | Start-AzCdnEndpoint
Creating Standard Rules engine policy and applying to an existing CDN endpoint
New-AzCdnDeliveryRule, New=AzCdnDeliveryRuleCondition, and New-AzCdnDeliveryRuleAction can be used to configure the Azure CDN Standard Rules engine on Azure CDN from Microsoft profiles.
# Create a new http to https redirect rule
$Condition=New-AzCdnDeliveryRuleCondition -MatchVariable RequestProtocol -Operator Equal -MatchValue HTTP
$Action=New-AzCdnDeliveryRuleAction -RedirectType Found -DestinationProtocol HTTPS
$HttpToHttpsRedirectRule=New-AzCdnDeliveryRule -Name "HttpToHttpsRedirectRule" -Order 2 -Condition $Condition -Action $Action
# Create a path based Response header modification rule.
$Cond1=New-AzCdnDeliveryRuleCondition -MatchVariable UrlPath -Operator BeginsWith -MatchValue "/images/"
$Action1=New-AzCdnDeliveryRuleAction -HeaderActionType ModifyResponseHeader -Action Overwrite -HeaderName "Access-Control-Allow-Origin" -Value "*"
$PathBasedCacheOverrideRule=New-AzCdnDeliveryRule -Name "PathBasedCacheOverride" -Order 1 -Condition $Cond1 -Action $action1
# Create a delivery policy with above deliveryRules.
$Policy = New-AzCdnDeliveryPolicy -Description "DeliveryPolicy" -Rule $HttpToHttpsRedirectRule,$UrlRewriteRule
# Update existing endpoint with created delivery policy
$ep = Get-AzCdnEndpoint -EndpointName cdndocdemo -ProfileName CdnDemo -ResourceGroupName CdnDemoRG
$ep.DeliveryPolicy = $Policy
Set-AzCdnEndpoint -CdnEndpoint $ep
Deleting CDN resources
Remove-AzCdnProfile and Remove-AzCdnEndpoint can be used to remove profiles and endpoints.
# Remove a single endpoint
Remove-AzCdnEndpoint -ProfileName CdnPoshDemo -ResourceGroupName CdnDemoRG -EndpointName cdnposhdoc
# Remove all the endpoints on a profile and skip confirmation (-Force)
Get-AzCdnProfile -ProfileName CdnPoshDemo -ResourceGroupName CdnDemoRG | Get-AzCdnEndpoint | Remove-AzCdnEndpoint -Force
# Remove a single profile
Remove-AzCdnProfile -ProfileName CdnPoshDemo -ResourceGroupName CdnDemoRG
Next Steps
Learn how to automate Azure CDN with .NET or Node.js.
To learn about CDN features, see CDN Overview.