AFDEndpointsOperations interface

Package:

@azure/arm-cdn

Interface representing a AFDEndpoints operations.

Properties

beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
beginPurgeContent
beginPurgeContentAndWait
beginUpdate
beginUpdateAndWait
create	Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
delete	Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
get	Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
listByProfile	Lists existing AzureFrontDoor endpoints.
listResourceUsage	Checks the quota and actual usage of endpoints under the given Azure Front Door profile.
purgeContent	Removes a content from AzureFrontDoor.
update	Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update domains, use the Update Custom Domain operation.
validateCustomDomain	Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.

Property Details

beginCreate

Warning

This API is now deprecated.

use create instead

beginCreate: (resourceGroupName: string, profileName: string, endpointName: string, endpointParam: AFDEndpoint, options?: AFDEndpointsCreateOptionalParams) => Promise<SimplePollerLike<OperationState<AFDEndpoint>, AFDEndpoint>>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, endpointParam: AFDEndpoint, options?: AFDEndpointsCreateOptionalParams) => Promise<SimplePollerLike<OperationState<AFDEndpoint>, AFDEndpoint>>

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

beginCreateAndWait: (resourceGroupName: string, profileName: string, endpointName: string, endpointParam: AFDEndpoint, options?: AFDEndpointsCreateOptionalParams) => Promise<AFDEndpoint>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, endpointParam: AFDEndpoint, options?: AFDEndpointsCreateOptionalParams) => Promise<AFDEndpoint>

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginPurgeContent

Warning

This API is now deprecated.

use purgeContent instead

beginPurgeContent: (resourceGroupName: string, profileName: string, endpointName: string, contents: AfdPurgeParameters, options?: AFDEndpointsPurgeContentOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, contents: AfdPurgeParameters, options?: AFDEndpointsPurgeContentOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginPurgeContentAndWait

Warning

This API is now deprecated.

use purgeContent instead

beginPurgeContentAndWait: (resourceGroupName: string, profileName: string, endpointName: string, contents: AfdPurgeParameters, options?: AFDEndpointsPurgeContentOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, contents: AfdPurgeParameters, options?: AFDEndpointsPurgeContentOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, profileName: string, endpointName: string, endpointUpdateProperties: AFDEndpointUpdateParameters, options?: AFDEndpointsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<AFDEndpoint>, AFDEndpoint>>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, endpointUpdateProperties: AFDEndpointUpdateParameters, options?: AFDEndpointsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<AFDEndpoint>, AFDEndpoint>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, profileName: string, endpointName: string, endpointUpdateProperties: AFDEndpointUpdateParameters, options?: AFDEndpointsUpdateOptionalParams) => Promise<AFDEndpoint>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, endpointUpdateProperties: AFDEndpointUpdateParameters, options?: AFDEndpointsUpdateOptionalParams) => Promise<AFDEndpoint>

create

Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.

create: (resourceGroupName: string, profileName: string, endpointName: string, endpointParam: AFDEndpoint, options?: AFDEndpointsCreateOptionalParams) => PollerLike<OperationState<AFDEndpoint>, AFDEndpoint>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, endpointParam: AFDEndpoint, options?: AFDEndpointsCreateOptionalParams) => PollerLike<OperationState<AFDEndpoint>, AFDEndpoint>

delete

Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.

delete: (resourceGroupName: string, profileName: string, endpointName: string, options?: AFDEndpointsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

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

get

Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.

get: (resourceGroupName: string, profileName: string, endpointName: string, options?: AFDEndpointsGetOptionalParams) => Promise<AFDEndpoint>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, options?: AFDEndpointsGetOptionalParams) => Promise<AFDEndpoint>

listByProfile

Lists existing AzureFrontDoor endpoints.

listByProfile: (resourceGroupName: string, profileName: string, options?: AFDEndpointsListByProfileOptionalParams) => PagedAsyncIterableIterator<AFDEndpoint, AFDEndpoint[], PageSettings>

Property Value

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

listResourceUsage

Checks the quota and actual usage of endpoints under the given Azure Front Door profile.

listResourceUsage: (resourceGroupName: string, profileName: string, endpointName: string, options?: AFDEndpointsListResourceUsageOptionalParams) => PagedAsyncIterableIterator<Usage, Usage[], PageSettings>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, options?: AFDEndpointsListResourceUsageOptionalParams) => PagedAsyncIterableIterator<Usage, Usage[], PageSettings>

purgeContent

Removes a content from AzureFrontDoor.

purgeContent: (resourceGroupName: string, profileName: string, endpointName: string, contents: AfdPurgeParameters, options?: AFDEndpointsPurgeContentOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, contents: AfdPurgeParameters, options?: AFDEndpointsPurgeContentOptionalParams) => PollerLike<OperationState<void>, void>

update

Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update domains, use the Update Custom Domain operation.

update: (resourceGroupName: string, profileName: string, endpointName: string, endpointUpdateProperties: AFDEndpointUpdateParameters, options?: AFDEndpointsUpdateOptionalParams) => PollerLike<OperationState<AFDEndpoint>, AFDEndpoint>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, endpointUpdateProperties: AFDEndpointUpdateParameters, options?: AFDEndpointsUpdateOptionalParams) => PollerLike<OperationState<AFDEndpoint>, AFDEndpoint>

validateCustomDomain

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

validateCustomDomain: (resourceGroupName: string, profileName: string, endpointName: string, customDomainProperties: ValidateCustomDomainInput, options?: AFDEndpointsValidateCustomDomainOptionalParams) => Promise<ValidateCustomDomainOutput>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, customDomainProperties: ValidateCustomDomainInput, options?: AFDEndpointsValidateCustomDomainOptionalParams) => Promise<ValidateCustomDomainOutput>