ProfilesOperations interface

Package:

@azure/arm-cdn

Interface representing a Profiles operations.

Properties

beginCanMigrate
beginCanMigrateAndWait
beginCdnCanMigrateToAfd
beginCdnCanMigrateToAfdAndWait
beginCdnMigrateToAfd
beginCdnMigrateToAfdAndWait
beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
beginMigrate
beginMigrateAndWait
beginMigrationAbort
beginMigrationAbortAndWait
beginMigrationCommit
beginMigrationCommitAndWait
beginUpdate
beginUpdateAndWait
canMigrate	Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.
cdnCanMigrateToAfd	Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.
cdnMigrateToAfd	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.
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.
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.
generateSsoUri	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	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	Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within an Azure subscription.
listByResourceGroup	Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within a resource group.
listResourceUsage	Checks the quota and actual usage of endpoints under the given Azure Front Door Standard or Azure Front Door Premium or CDN profile.
listSupportedOptimizationTypes	Gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values.
migrate	Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this.
migrationAbort	Abort the migration to Azure Frontdoor Premium/Standard.
migrationCommit	Commit the migrated Azure Frontdoor(Standard/Premium) profile.
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.

Property Details

beginCanMigrate

Warning

This API is now deprecated.

use canMigrate instead

beginCanMigrate: (resourceGroupName: string, canMigrateParameters: CanMigrateParameters, options?: ProfilesCanMigrateOptionalParams) => Promise<SimplePollerLike<OperationState<CanMigrateResult>, CanMigrateResult>>

Property Value

(resourceGroupName: string, canMigrateParameters: CanMigrateParameters, options?: ProfilesCanMigrateOptionalParams) => Promise<SimplePollerLike<OperationState<CanMigrateResult>, CanMigrateResult>>

beginCanMigrateAndWait

Warning

This API is now deprecated.

use canMigrate instead

beginCanMigrateAndWait: (resourceGroupName: string, canMigrateParameters: CanMigrateParameters, options?: ProfilesCanMigrateOptionalParams) => Promise<CanMigrateResult>

Property Value

(resourceGroupName: string, canMigrateParameters: CanMigrateParameters, options?: ProfilesCanMigrateOptionalParams) => Promise<CanMigrateResult>

beginCdnCanMigrateToAfd

Warning

This API is now deprecated.

use cdnCanMigrateToAfd instead

beginCdnCanMigrateToAfd: (resourceGroupName: string, profileName: string, options?: ProfilesCdnCanMigrateToAfdOptionalParams) => Promise<SimplePollerLike<OperationState<CanMigrateResult>, CanMigrateResult>>

Property Value

(resourceGroupName: string, profileName: string, options?: ProfilesCdnCanMigrateToAfdOptionalParams) => Promise<SimplePollerLike<OperationState<CanMigrateResult>, CanMigrateResult>>

beginCdnCanMigrateToAfdAndWait

Warning

This API is now deprecated.

use cdnCanMigrateToAfd instead

beginCdnCanMigrateToAfdAndWait: (resourceGroupName: string, profileName: string, options?: ProfilesCdnCanMigrateToAfdOptionalParams) => Promise<CanMigrateResult>

Property Value

(resourceGroupName: string, profileName: string, options?: ProfilesCdnCanMigrateToAfdOptionalParams) => Promise<CanMigrateResult>

beginCdnMigrateToAfd

Warning

This API is now deprecated.

use cdnMigrateToAfd instead

beginCdnMigrateToAfd: (resourceGroupName: string, profileName: string, migrationParameters: CdnMigrationToAfdParameters, options?: ProfilesCdnMigrateToAfdOptionalParams) => Promise<SimplePollerLike<OperationState<MigrateResult>, MigrateResult>>

Property Value

(resourceGroupName: string, profileName: string, migrationParameters: CdnMigrationToAfdParameters, options?: ProfilesCdnMigrateToAfdOptionalParams) => Promise<SimplePollerLike<OperationState<MigrateResult>, MigrateResult>>

beginCdnMigrateToAfdAndWait

Warning

This API is now deprecated.

use cdnMigrateToAfd instead

beginCdnMigrateToAfdAndWait: (resourceGroupName: string, profileName: string, migrationParameters: CdnMigrationToAfdParameters, options?: ProfilesCdnMigrateToAfdOptionalParams) => Promise<MigrateResult>

Property Value

(resourceGroupName: string, profileName: string, migrationParameters: CdnMigrationToAfdParameters, options?: ProfilesCdnMigrateToAfdOptionalParams) => Promise<MigrateResult>

beginCreate

Warning

This API is now deprecated.

use create instead

beginCreate: (resourceGroupName: string, profileName: string, profile: Profile, options?: ProfilesCreateOptionalParams) => Promise<SimplePollerLike<OperationState<Profile>, Profile>>

Property Value

(resourceGroupName: string, profileName: string, profile: Profile, options?: ProfilesCreateOptionalParams) => Promise<SimplePollerLike<OperationState<Profile>, Profile>>

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

beginCreateAndWait: (resourceGroupName: string, profileName: string, profile: Profile, options?: ProfilesCreateOptionalParams) => Promise<Profile>

Property Value

(resourceGroupName: string, profileName: string, profile: Profile, options?: ProfilesCreateOptionalParams) => Promise<Profile>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, profileName: string, options?: ProfilesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, profileName: string, options?: ProfilesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, profileName: string, options?: ProfilesDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, profileName: string, options?: ProfilesDeleteOptionalParams) => Promise<void>

beginMigrate

Warning

This API is now deprecated.

use migrate instead

beginMigrate: (resourceGroupName: string, migrationParameters: MigrationParameters, options?: ProfilesMigrateOptionalParams) => Promise<SimplePollerLike<OperationState<MigrateResult>, MigrateResult>>

Property Value

(resourceGroupName: string, migrationParameters: MigrationParameters, options?: ProfilesMigrateOptionalParams) => Promise<SimplePollerLike<OperationState<MigrateResult>, MigrateResult>>

beginMigrateAndWait

Warning

This API is now deprecated.

use migrate instead

beginMigrateAndWait: (resourceGroupName: string, migrationParameters: MigrationParameters, options?: ProfilesMigrateOptionalParams) => Promise<MigrateResult>

Property Value

(resourceGroupName: string, migrationParameters: MigrationParameters, options?: ProfilesMigrateOptionalParams) => Promise<MigrateResult>

beginMigrationAbort

Warning

This API is now deprecated.

use migrationAbort instead

beginMigrationAbort: (resourceGroupName: string, profileName: string, options?: ProfilesMigrationAbortOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, profileName: string, options?: ProfilesMigrationAbortOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginMigrationAbortAndWait

Warning

This API is now deprecated.

use migrationAbort instead

beginMigrationAbortAndWait: (resourceGroupName: string, profileName: string, options?: ProfilesMigrationAbortOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, profileName: string, options?: ProfilesMigrationAbortOptionalParams) => Promise<void>

beginMigrationCommit

Warning

This API is now deprecated.

use migrationCommit instead

beginMigrationCommit: (resourceGroupName: string, profileName: string, options?: ProfilesMigrationCommitOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, profileName: string, options?: ProfilesMigrationCommitOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginMigrationCommitAndWait

Warning

This API is now deprecated.

use migrationCommit instead

beginMigrationCommitAndWait: (resourceGroupName: string, profileName: string, options?: ProfilesMigrationCommitOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, profileName: string, options?: ProfilesMigrationCommitOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, profileName: string, profileUpdateParameters: ProfileUpdateParameters, options?: ProfilesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Profile>, Profile>>

Property Value

(resourceGroupName: string, profileName: string, profileUpdateParameters: ProfileUpdateParameters, options?: ProfilesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Profile>, Profile>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, profileName: string, profileUpdateParameters: ProfileUpdateParameters, options?: ProfilesUpdateOptionalParams) => Promise<Profile>

Property Value

(resourceGroupName: string, profileName: string, profileUpdateParameters: ProfileUpdateParameters, options?: ProfilesUpdateOptionalParams) => Promise<Profile>

canMigrate

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

canMigrate: (resourceGroupName: string, canMigrateParameters: CanMigrateParameters, options?: ProfilesCanMigrateOptionalParams) => PollerLike<OperationState<CanMigrateResult>, CanMigrateResult>

Property Value

(resourceGroupName: string, canMigrateParameters: CanMigrateParameters, options?: ProfilesCanMigrateOptionalParams) => PollerLike<OperationState<CanMigrateResult>, CanMigrateResult>

cdnCanMigrateToAfd

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

cdnCanMigrateToAfd: (resourceGroupName: string, profileName: string, options?: ProfilesCdnCanMigrateToAfdOptionalParams) => PollerLike<OperationState<CanMigrateResult>, CanMigrateResult>

Property Value

(resourceGroupName: string, profileName: string, options?: ProfilesCdnCanMigrateToAfdOptionalParams) => PollerLike<OperationState<CanMigrateResult>, CanMigrateResult>

cdnMigrateToAfd

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.

cdnMigrateToAfd: (resourceGroupName: string, profileName: string, migrationParameters: CdnMigrationToAfdParameters, options?: ProfilesCdnMigrateToAfdOptionalParams) => PollerLike<OperationState<MigrateResult>, MigrateResult>

Property Value

(resourceGroupName: string, profileName: string, migrationParameters: CdnMigrationToAfdParameters, options?: ProfilesCdnMigrateToAfdOptionalParams) => PollerLike<OperationState<MigrateResult>, MigrateResult>

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.

create: (resourceGroupName: string, profileName: string, profile: Profile, options?: ProfilesCreateOptionalParams) => PollerLike<OperationState<Profile>, Profile>

Property Value

(resourceGroupName: string, profileName: string, profile: Profile, options?: ProfilesCreateOptionalParams) => PollerLike<OperationState<Profile>, Profile>

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: (resourceGroupName: string, profileName: string, options?: ProfilesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, profileName: string, options?: ProfilesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

generateSsoUri

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.

generateSsoUri: (resourceGroupName: string, profileName: string, options?: ProfilesGenerateSsoUriOptionalParams) => Promise<SsoUri>

Property Value

(resourceGroupName: string, profileName: string, options?: ProfilesGenerateSsoUriOptionalParams) => Promise<SsoUri>

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.

get: (resourceGroupName: string, profileName: string, options?: ProfilesGetOptionalParams) => Promise<Profile>

Property Value

(resourceGroupName: string, profileName: string, options?: ProfilesGetOptionalParams) => Promise<Profile>

list

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

list: (options?: ProfilesListOptionalParams) => PagedAsyncIterableIterator<Profile, Profile[], PageSettings>

Property Value

(options?: ProfilesListOptionalParams) => PagedAsyncIterableIterator<Profile, Profile[], PageSettings>

listByResourceGroup

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

listByResourceGroup: (resourceGroupName: string, options?: ProfilesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Profile, Profile[], PageSettings>

Property Value

(resourceGroupName: string, options?: ProfilesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Profile, Profile[], PageSettings>

listResourceUsage

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

listResourceUsage: (resourceGroupName: string, profileName: string, options?: ProfilesListResourceUsageOptionalParams) => PagedAsyncIterableIterator<ResourceUsage, ResourceUsage[], PageSettings>

Property Value

(resourceGroupName: string, profileName: string, options?: ProfilesListResourceUsageOptionalParams) => PagedAsyncIterableIterator<ResourceUsage, ResourceUsage[], PageSettings>

listSupportedOptimizationTypes

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

listSupportedOptimizationTypes: (resourceGroupName: string, profileName: string, options?: ProfilesListSupportedOptimizationTypesOptionalParams) => Promise<SupportedOptimizationTypesListResult>

Property Value

(resourceGroupName: string, profileName: string, options?: ProfilesListSupportedOptimizationTypesOptionalParams) => Promise<SupportedOptimizationTypesListResult>

migrate

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

migrate: (resourceGroupName: string, migrationParameters: MigrationParameters, options?: ProfilesMigrateOptionalParams) => PollerLike<OperationState<MigrateResult>, MigrateResult>

Property Value

(resourceGroupName: string, migrationParameters: MigrationParameters, options?: ProfilesMigrateOptionalParams) => PollerLike<OperationState<MigrateResult>, MigrateResult>

migrationAbort

Abort the migration to Azure Frontdoor Premium/Standard.

migrationAbort: (resourceGroupName: string, profileName: string, options?: ProfilesMigrationAbortOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, profileName: string, options?: ProfilesMigrationAbortOptionalParams) => PollerLike<OperationState<void>, void>

migrationCommit

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

migrationCommit: (resourceGroupName: string, profileName: string, options?: ProfilesMigrationCommitOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, profileName: string, options?: ProfilesMigrationCommitOptionalParams) => PollerLike<OperationState<void>, void>

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: (resourceGroupName: string, profileName: string, profileUpdateParameters: ProfileUpdateParameters, options?: ProfilesUpdateOptionalParams) => PollerLike<OperationState<Profile>, Profile>

Property Value

(resourceGroupName: string, profileName: string, profileUpdateParameters: ProfileUpdateParameters, options?: ProfilesUpdateOptionalParams) => PollerLike<OperationState<Profile>, Profile>