afd_profiles

Creates, updates, deletes, gets or lists an afd_profiles resource.

Overview

Name	afd_profiles
Type	Resource
Id	azure.cdn.afd_profiles

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
check_endpoint_name_availability	exec	subscriptionId, resourceGroupName, profileName, name, type		Check the availability of an afdx endpoint name, and return the globally unique endpoint host name.
check_host_name_availability	exec	resourceGroupName, profileName, subscriptionId, hostName		Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.
validate_secret	exec	resourceGroupName, profileName, subscriptionId, secretSource, secretType		Validate a Secret in the profile.
upgrade	exec	resourceGroupName, profileName, subscriptionId, wafMappingList		Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor.

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 Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.
resourceGroupName	string	Name of the Resource group within the Azure subscription.
subscriptionId	string	Azure Subscription ID.

Lifecycle Methods

check_endpoint_name_availability

Check the availability of an afdx endpoint name, and return the globally unique endpoint host name.

EXEC azure.cdn.afd_profiles.check_endpoint_name_availability 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@profileName='{{ profileName }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}", 
"autoGeneratedDomainNameLabelScope": "{{ autoGeneratedDomainNameLabelScope }}"
}'
;

check_host_name_availability

Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.

EXEC azure.cdn.afd_profiles.check_host_name_availability 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@profileName='{{ profileName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"hostName": "{{ hostName }}"
}'
;

validate_secret

Validate a Secret in the profile.

EXEC azure.cdn.afd_profiles.validate_secret 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@profileName='{{ profileName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"secretType": "{{ secretType }}", 
"secretSource": "{{ secretSource }}", 
"secretVersion": "{{ secretVersion }}"
}'
;

upgrade

Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor.

EXEC azure.cdn.afd_profiles.upgrade 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@profileName='{{ profileName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"wafMappingList": "{{ wafMappingList }}"
}'
;