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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
extendedProperties	object	Key-Value pair representing additional properties for profiles.
frontDoorId	string	The Id of the frontdoor.
identity	object	The managed service identities assigned to this resource.
kind	string	Kind of the profile. Used by portal to differentiate traditional CDN profile and new AFD profile.
location	string	The geo-location where the resource lives. Required.
logScrubbing	object	Defines rules that scrub sensitive fields in the Azure Front Door profile logs.
originResponseTimeoutSeconds	integer	Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.
provisioningState	string	Provisioning status of the profile. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
resourceState	string	Resource status of the profile. Known values are: "Creating", "Active", "Deleting", "Disabled", "Migrating", "Migrated", "PendingMigrationCommit", "CommittingMigration", and "AbortingMigration". (Creating, Active, Deleting, Disabled, Migrating, Migrated, PendingMigrationCommit, CommittingMigration, AbortingMigration)
sku	object	The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
extendedProperties	object	Key-Value pair representing additional properties for profiles.
frontDoorId	string	The Id of the frontdoor.
identity	object	The managed service identities assigned to this resource.
kind	string	Kind of the profile. Used by portal to differentiate traditional CDN profile and new AFD profile.
location	string	The geo-location where the resource lives. Required.
logScrubbing	object	Defines rules that scrub sensitive fields in the Azure Front Door profile logs.
originResponseTimeoutSeconds	integer	Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.
provisioningState	string	Provisioning status of the profile. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
resourceState	string	Resource status of the profile. Known values are: "Creating", "Active", "Deleting", "Disabled", "Migrating", "Migrated", "PendingMigrationCommit", "CommittingMigration", and "AbortingMigration". (Creating, Active, Deleting, Disabled, Migrating, Migrated, PendingMigrationCommit, CommittingMigration, AbortingMigration)
sku	object	The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
extendedProperties	object	Key-Value pair representing additional properties for profiles.
frontDoorId	string	The Id of the frontdoor.
identity	object	The managed service identities assigned to this resource.
kind	string	Kind of the profile. Used by portal to differentiate traditional CDN profile and new AFD profile.
location	string	The geo-location where the resource lives. Required.
logScrubbing	object	Defines rules that scrub sensitive fields in the Azure Front Door profile logs.
originResponseTimeoutSeconds	integer	Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.
provisioningState	string	Provisioning status of the profile. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
resourceState	string	Resource status of the profile. Known values are: "Creating", "Active", "Deleting", "Disabled", "Migrating", "Migrated", "PendingMigrationCommit", "CommittingMigration", and "AbortingMigration". (Creating, Active, Deleting, Disabled, Migrating, Migrated, PendingMigrationCommit, CommittingMigration, AbortingMigration)
sku	object	The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, profile_name, subscription_id		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	resource_group_name, subscription_id		Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within a resource group.
list	select	subscription_id		Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within an Azure subscription.
create	insert	resource_group_name, profile_name, subscription_id, location, 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	resource_group_name, profile_name, subscription_id		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	resource_group_name, profile_name, subscription_id		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.
list_supported_optimization_types	exec	resource_group_name, profile_name, subscription_id		Gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values.
list_resource_usage	exec	resource_group_name, profile_name, subscription_id		Checks the quota and actual usage of endpoints under the given Azure Front Door Standard or Azure Front Door Premium or CDN profile.
migration_commit	exec	resource_group_name, profile_name, subscription_id		Commit the migrated Azure Frontdoor(Standard/Premium) profile.
generate_sso_uri	exec	resource_group_name, profile_name, subscription_id		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.
cdn_can_migrate_to_afd	exec	resource_group_name, profile_name, subscription_id		Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.
cdn_migrate_to_afd	exec	resource_group_name, profile_name, subscription_id, sku		Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. This step prepares the profile for migration and will be followed by Commit to finalize the migration.
migration_abort	exec	resource_group_name, profile_name, subscription_id		Abort the migration to Azure Frontdoor Premium/Standard.
can_migrate	exec	resource_group_name, subscription_id, classicResourceReference		Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.
migrate	exec	resource_group_name, subscription_id, sku, classicResourceReference, profileName		Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this.

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
profile_name	string	Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

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
id,
name,
extendedProperties,
frontDoorId,
identity,
kind,
location,
logScrubbing,
originResponseTimeoutSeconds,
provisioningState,
resourceState,
sku,
systemData,
tags,
type
FROM azure.cdn.profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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
id,
name,
extendedProperties,
frontDoorId,
identity,
kind,
location,
logScrubbing,
originResponseTimeoutSeconds,
provisioningState,
resourceState,
sku,
systemData,
tags,
type
FROM azure.cdn.profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
id,
name,
extendedProperties,
frontDoorId,
identity,
kind,
location,
logScrubbing,
originResponseTimeoutSeconds,
provisioningState,
resourceState,
sku,
systemData,
tags,
type
FROM azure.cdn.profiles
WHERE subscription_id = '{{ subscription_id }}' -- 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 (
tags,
location,
properties,
sku,
identity,
resource_group_name,
profile_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ sku }}' /* required */,
'{{ identity }}',
'{{ resource_group_name }}',
'{{ profile_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: profiles
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the profiles resource.
  - name: profile_name
    value: "{{ profile_name }}"
    description: Required parameter for the profiles resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the profiles resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The JSON object that contains the properties required to create a profile.
    value:
      resourceState: "{{ resourceState }}"
      provisioningState: "{{ provisioningState }}"
      extendedProperties: "{{ extendedProperties }}"
      frontDoorId: "{{ frontDoorId }}"
      originResponseTimeoutSeconds: {{ originResponseTimeoutSeconds }}
      logScrubbing:
        state: "{{ state }}"
        scrubbingRules:
          - matchVariable: "{{ matchVariable }}"
            selectorMatchOperator: "{{ selectorMatchOperator }}"
            selector: "{{ selector }}"
            state: "{{ state }}"
  - name: sku
    description: |
      The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile. Required.
    value:
      name: "{{ name }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

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 
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type;

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 resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_supported_optimization_types

Gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values.

EXEC azure.cdn.profiles.list_supported_optimization_types 
@resource_group_name='{{ resource_group_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_resource_usage

Checks the quota and actual usage of endpoints under the given Azure Front Door Standard or Azure Front Door Premium or CDN profile.

EXEC azure.cdn.profiles.list_resource_usage 
@resource_group_name='{{ resource_group_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

migration_commit

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

EXEC azure.cdn.profiles.migration_commit 
@resource_group_name='{{ resource_group_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@subscription_id='{{ subscription_id }}' --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 
@resource_group_name='{{ resource_group_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

cdn_can_migrate_to_afd

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

EXEC azure.cdn.profiles.cdn_can_migrate_to_afd 
@resource_group_name='{{ resource_group_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

cdn_migrate_to_afd

Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. This step prepares the profile for migration and will be followed by Commit to finalize the migration.

EXEC azure.cdn.profiles.cdn_migrate_to_afd 
@resource_group_name='{{ resource_group_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"sku": "{{ sku }}", 
"migrationEndpointMappings": "{{ migrationEndpointMappings }}"
}'
;

migration_abort

Abort the migration to Azure Frontdoor Premium/Standard.

EXEC azure.cdn.profiles.migration_abort 
@resource_group_name='{{ resource_group_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

can_migrate

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

EXEC azure.cdn.profiles.can_migrate 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --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 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"sku": "{{ sku }}", 
"classicResourceReference": "{{ classicResourceReference }}", 
"profileName": "{{ profileName }}", 
"migrationWebApplicationFirewallMappings": "{{ migrationWebApplicationFirewallMappings }}"
}'
;