profiles

Creates, updates, deletes, gets or lists a profiles resource.

Overview

Name	profiles
Type	Resource
Id	azure.cdn.profiles

Fields

The following fields are returned by SELECT queries:

get

OK. The request has succeeded.

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities).
kind	string	Kind of the profile. Used by portal to differentiate traditional CDN profile and new AFD profile.
location	string	Resource location.
properties	object	The JSON object that contains the properties required to create a profile.
sku	object	The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile.
tags	object	Resource tags.

list_by_resource_group

OK. The request has succeeded.

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities).
kind	string	Kind of the profile. Used by portal to differentiate traditional CDN profile and new AFD profile.
location	string	Resource location.
properties	object	The JSON object that contains the properties required to create a profile.
sku	object	The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile.
tags	object	Resource tags.

list

OK. The request has succeeded.

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities).
kind	string	Kind of the profile. Used by portal to differentiate traditional CDN profile and new AFD profile.
location	string	Resource location.
properties	object	The JSON object that contains the properties required to create a profile.
sku	object	The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, profileName, subscriptionId		Gets an Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.
list_by_resource_group	select	resourceGroupName, subscriptionId		Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within a resource group.
list	select	subscriptionId		Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within an Azure subscription.
create	insert	resourceGroupName, profileName, subscriptionId, data__sku		Creates a new Azure Front Door Standard or Azure Front Door Premium or CDN profile with a profile name under the specified subscription and resource group.
update	update	resourceGroupName, profileName, subscriptionId		Updates an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.
delete	delete	resourceGroupName, profileName, subscriptionId		Deletes an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified parameters. Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains.
can_migrate	exec	resourceGroupName, subscriptionId, classicResourceReference		Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.
migrate	exec	resourceGroupName, subscriptionId, classicResourceReference, sku, profileName		Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this.
migration_commit	exec	resourceGroupName, profileName, subscriptionId		Commit the migrated Azure Frontdoor(Standard/Premium) profile.
generate_sso_uri	exec	resourceGroupName, profileName, subscriptionId		Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemental portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
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.
subscriptionId	string	Azure Subscription ID.

SELECT examples

get

Gets an Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.

SELECT
identity,
kind,
location,
properties,
sku,
tags
FROM azure.cdn.profiles
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND profileName = '{{ profileName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within a resource group.

SELECT
identity,
kind,
location,
properties,
sku,
tags
FROM azure.cdn.profiles
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within an Azure subscription.

SELECT
identity,
kind,
location,
properties,
sku,
tags
FROM azure.cdn.profiles
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a new Azure Front Door Standard or Azure Front Door Premium or CDN profile with a profile name under the specified subscription and resource group.

INSERT INTO azure.cdn.profiles (
data__location,
data__tags,
data__sku,
data__identity,
data__properties,
resourceGroupName,
profileName,
subscriptionId
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ sku }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ profileName }}',
'{{ subscriptionId }}'
RETURNING
identity,
kind,
location,
properties,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: profiles
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the profiles resource.
    - name: profileName
      value: string
      description: Required parameter for the profiles resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the profiles resource.
    - name: location
      value: string
      description: |
        Resource location.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: sku
      value: object
      description: |
        The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile.
    - name: identity
      value: object
      description: |
        Managed service identity (system assigned and/or user assigned identities).
    - name: properties
      value: object
      description: |
        The JSON object that contains the properties required to create a profile.

UPDATE examples

update

Updates an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.

UPDATE azure.cdn.profiles
SET 
data__tags = '{{ tags }}',
data__identity = '{{ identity }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND profileName = '{{ profileName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
identity,
kind,
location,
properties,
sku,
tags;

DELETE examples

delete

Deletes an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified parameters. Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains.

DELETE FROM azure.cdn.profiles
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND profileName = '{{ profileName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

can_migrate

Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.

EXEC azure.cdn.profiles.can_migrate 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"classicResourceReference": "{{ classicResourceReference }}"
}'
;

migrate

Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this.

EXEC azure.cdn.profiles.migrate 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"sku": "{{ sku }}", 
"classicResourceReference": "{{ classicResourceReference }}", 
"profileName": "{{ profileName }}", 
"migrationWebApplicationFirewallMappings": "{{ migrationWebApplicationFirewallMappings }}"
}'
;

migration_commit

Commit the migrated Azure Frontdoor(Standard/Premium) profile.

EXEC azure.cdn.profiles.migration_commit 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@profileName='{{ profileName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

generate_sso_uri

Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemental portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.

EXEC azure.cdn.profiles.generate_sso_uri 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@profileName='{{ profileName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;