Profiles interface
Interface representing a Profiles.
Methods
| begin |
Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile. |
| begin |
Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile. |
| begin |
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. |
| begin |
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. |
| begin |
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. |
| begin |
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. |
| begin |
Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this. |
| begin |
Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this. |
| begin |
Commit the migrated Azure Frontdoor(Standard/Premium) profile. |
| begin |
Commit the migrated Azure Frontdoor(Standard/Premium) profile. |
| begin |
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. |
| begin |
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. |
| generate |
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. |
| get(string, string, Profiles |
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(Profiles |
Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within an Azure subscription. |
| list |
Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within a resource group. |
| list |
Checks the quota and actual usage of endpoints under the given Azure Front Door Standard or Azure Front Door Premium or CDN profile. |
| list |
Gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values. |
Method Details
beginCanMigrate(string, CanMigrateParameters, ProfilesCanMigrateOptionalParams)
Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.
function beginCanMigrate(resourceGroupName: string, canMigrateParameters: CanMigrateParameters, options?: ProfilesCanMigrateOptionalParams): Promise<SimplePollerLike<OperationState<CanMigrateResult>, CanMigrateResult>>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- canMigrateParameters
- CanMigrateParameters
Properties needed to check if cdn profile or classic frontdoor can be migrated.
- options
- ProfilesCanMigrateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CanMigrateResult>, CanMigrateResult>>
beginCanMigrateAndWait(string, CanMigrateParameters, ProfilesCanMigrateOptionalParams)
Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.
function beginCanMigrateAndWait(resourceGroupName: string, canMigrateParameters: CanMigrateParameters, options?: ProfilesCanMigrateOptionalParams): Promise<CanMigrateResult>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- canMigrateParameters
- CanMigrateParameters
Properties needed to check if cdn profile or classic frontdoor can be migrated.
- options
- ProfilesCanMigrateOptionalParams
The options parameters.
Returns
Promise<CanMigrateResult>
beginCreate(string, string, Profile, ProfilesCreateOptionalParams)
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.
function beginCreate(resourceGroupName: string, profileName: string, profile: Profile, options?: ProfilesCreateOptionalParams): Promise<SimplePollerLike<OperationState<Profile>, Profile>>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- profileName
-
string
Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- profile
- Profile
Profile properties needed to create a new profile.
- options
- ProfilesCreateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Profile>, Profile>>
beginCreateAndWait(string, string, Profile, ProfilesCreateOptionalParams)
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.
function beginCreateAndWait(resourceGroupName: string, profileName: string, profile: Profile, options?: ProfilesCreateOptionalParams): Promise<Profile>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- profileName
-
string
Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- profile
- Profile
Profile properties needed to create a new profile.
- options
- ProfilesCreateOptionalParams
The options parameters.
Returns
Promise<Profile>
beginDelete(string, string, ProfilesDeleteOptionalParams)
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.
function beginDelete(resourceGroupName: string, profileName: string, options?: ProfilesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- profileName
-
string
Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- options
- ProfilesDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, ProfilesDeleteOptionalParams)
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.
function beginDeleteAndWait(resourceGroupName: string, profileName: string, options?: ProfilesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- profileName
-
string
Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- options
- ProfilesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginMigrate(string, MigrationParameters, ProfilesMigrateOptionalParams)
Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this.
function beginMigrate(resourceGroupName: string, migrationParameters: MigrationParameters, options?: ProfilesMigrateOptionalParams): Promise<SimplePollerLike<OperationState<MigrateResult>, MigrateResult>>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- migrationParameters
- MigrationParameters
Properties needed to migrate the profile.
- options
- ProfilesMigrateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<MigrateResult>, MigrateResult>>
beginMigrateAndWait(string, MigrationParameters, ProfilesMigrateOptionalParams)
Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this.
function beginMigrateAndWait(resourceGroupName: string, migrationParameters: MigrationParameters, options?: ProfilesMigrateOptionalParams): Promise<MigrateResult>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- migrationParameters
- MigrationParameters
Properties needed to migrate the profile.
- options
- ProfilesMigrateOptionalParams
The options parameters.
Returns
Promise<MigrateResult>
beginMigrationCommit(string, string, ProfilesMigrationCommitOptionalParams)
Commit the migrated Azure Frontdoor(Standard/Premium) profile.
function beginMigrationCommit(resourceGroupName: string, profileName: string, options?: ProfilesMigrationCommitOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- profileName
-
string
Name of the CDN profile which is unique within the resource group.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginMigrationCommitAndWait(string, string, ProfilesMigrationCommitOptionalParams)
Commit the migrated Azure Frontdoor(Standard/Premium) profile.
function beginMigrationCommitAndWait(resourceGroupName: string, profileName: string, options?: ProfilesMigrationCommitOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- profileName
-
string
Name of the CDN profile which is unique within the resource group.
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, ProfileUpdateParameters, ProfilesUpdateOptionalParams)
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.
function beginUpdate(resourceGroupName: string, profileName: string, profileUpdateParameters: ProfileUpdateParameters, options?: ProfilesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Profile>, Profile>>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- profileName
-
string
Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- profileUpdateParameters
- ProfileUpdateParameters
Profile properties needed to update an existing profile.
- options
- ProfilesUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Profile>, Profile>>
beginUpdateAndWait(string, string, ProfileUpdateParameters, ProfilesUpdateOptionalParams)
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.
function beginUpdateAndWait(resourceGroupName: string, profileName: string, profileUpdateParameters: ProfileUpdateParameters, options?: ProfilesUpdateOptionalParams): Promise<Profile>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- profileName
-
string
Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- profileUpdateParameters
- ProfileUpdateParameters
Profile properties needed to update an existing profile.
- options
- ProfilesUpdateOptionalParams
The options parameters.
Returns
Promise<Profile>
generateSsoUri(string, string, ProfilesGenerateSsoUriOptionalParams)
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.
function generateSsoUri(resourceGroupName: string, profileName: string, options?: ProfilesGenerateSsoUriOptionalParams): Promise<SsoUri>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- profileName
-
string
Name of the CDN profile which is unique within the resource group.
The options parameters.
Returns
Promise<SsoUri>
get(string, string, ProfilesGetOptionalParams)
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.
function get(resourceGroupName: string, profileName: string, options?: ProfilesGetOptionalParams): Promise<Profile>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- profileName
-
string
Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- options
- ProfilesGetOptionalParams
The options parameters.
Returns
Promise<Profile>
list(ProfilesListOptionalParams)
Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within an Azure subscription.
function list(options?: ProfilesListOptionalParams): PagedAsyncIterableIterator<Profile, Profile[], PageSettings>Parameters
- options
- ProfilesListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, ProfilesListByResourceGroupOptionalParams)
Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within a resource group.
function listByResourceGroup(resourceGroupName: string, options?: ProfilesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Profile, Profile[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
The options parameters.
Returns
listResourceUsage(string, string, ProfilesListResourceUsageOptionalParams)
Checks the quota and actual usage of endpoints under the given Azure Front Door Standard or Azure Front Door Premium or CDN profile.
function listResourceUsage(resourceGroupName: string, profileName: string, options?: ProfilesListResourceUsageOptionalParams): PagedAsyncIterableIterator<ResourceUsage, ResourceUsage[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- profileName
-
string
Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
The options parameters.
Returns
listSupportedOptimizationTypes(string, string, ProfilesListSupportedOptimizationTypesOptionalParams)
Gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values.
function listSupportedOptimizationTypes(resourceGroupName: string, profileName: string, options?: ProfilesListSupportedOptimizationTypesOptionalParams): Promise<SupportedOptimizationTypesListResult>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- profileName
-
string
Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
The options parameters.
Returns
Promise<SupportedOptimizationTypesListResult>