EndpointsOperations interface

Package:

@azure/arm-cdn

Interface representing a Endpoints operations.

Properties

beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
beginLoadContent
beginLoadContentAndWait
beginPurgeContent
beginPurgeContentAndWait
beginStart
beginStartAndWait
beginStop
beginStopAndWait
beginUpdate
beginUpdateAndWait
create	Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
delete	Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
get	Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
listByProfile	Lists existing CDN endpoints.
listResourceUsage	Checks the quota and usage of geo filters and custom domains under the given endpoint.
loadContent	Pre-loads a content to CDN. Available for Verizon Profiles.
purgeContent	Removes a content from CDN.
start	Starts an existing CDN endpoint that is on a stopped state.
stop	Stops an existing running CDN endpoint.
update	Updates an existing CDN 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 custom domains, use the Update Custom Domain operation.
validateCustomDomain	Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.

Property Details

beginCreate

Warning

This API is now deprecated.

use create instead

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

Property Value

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

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

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

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, endpointParam: Endpoint, options?: EndpointsCreateOptionalParams) => Promise<Endpoint>

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginLoadContent

Warning

This API is now deprecated.

use loadContent instead

beginLoadContent: (resourceGroupName: string, profileName: string, endpointName: string, contentFilePaths: LoadParameters, options?: EndpointsLoadContentOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

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

beginLoadContentAndWait

Warning

This API is now deprecated.

use loadContent instead

beginLoadContentAndWait: (resourceGroupName: string, profileName: string, endpointName: string, contentFilePaths: LoadParameters, options?: EndpointsLoadContentOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, contentFilePaths: LoadParameters, options?: EndpointsLoadContentOptionalParams) => Promise<void>

beginPurgeContent

Warning

This API is now deprecated.

use purgeContent instead

beginPurgeContent: (resourceGroupName: string, profileName: string, endpointName: string, contentFilePaths: PurgeParameters, options?: EndpointsPurgeContentOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

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

beginPurgeContentAndWait

Warning

This API is now deprecated.

use purgeContent instead

beginPurgeContentAndWait: (resourceGroupName: string, profileName: string, endpointName: string, contentFilePaths: PurgeParameters, options?: EndpointsPurgeContentOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, contentFilePaths: PurgeParameters, options?: EndpointsPurgeContentOptionalParams) => Promise<void>

beginStart

Warning

This API is now deprecated.

use start instead

beginStart: (resourceGroupName: string, profileName: string, endpointName: string, options?: EndpointsStartOptionalParams) => Promise<SimplePollerLike<OperationState<Endpoint>, Endpoint>>

Property Value

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

beginStartAndWait

Warning

This API is now deprecated.

use start instead

beginStartAndWait: (resourceGroupName: string, profileName: string, endpointName: string, options?: EndpointsStartOptionalParams) => Promise<Endpoint>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, options?: EndpointsStartOptionalParams) => Promise<Endpoint>

beginStop

Warning

This API is now deprecated.

use stop instead

beginStop: (resourceGroupName: string, profileName: string, endpointName: string, options?: EndpointsStopOptionalParams) => Promise<SimplePollerLike<OperationState<Endpoint>, Endpoint>>

Property Value

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

beginStopAndWait

Warning

This API is now deprecated.

use stop instead

beginStopAndWait: (resourceGroupName: string, profileName: string, endpointName: string, options?: EndpointsStopOptionalParams) => Promise<Endpoint>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, options?: EndpointsStopOptionalParams) => Promise<Endpoint>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, profileName: string, endpointName: string, endpointUpdateProperties: EndpointUpdateParameters, options?: EndpointsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Endpoint>, Endpoint>>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, endpointUpdateProperties: EndpointUpdateParameters, options?: EndpointsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Endpoint>, Endpoint>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, profileName: string, endpointName: string, endpointUpdateProperties: EndpointUpdateParameters, options?: EndpointsUpdateOptionalParams) => Promise<Endpoint>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, endpointUpdateProperties: EndpointUpdateParameters, options?: EndpointsUpdateOptionalParams) => Promise<Endpoint>

create

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

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

Property Value

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

delete

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

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

Property Value

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

get

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

get: (resourceGroupName: string, profileName: string, endpointName: string, options?: EndpointsGetOptionalParams) => Promise<Endpoint>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, options?: EndpointsGetOptionalParams) => Promise<Endpoint>

listByProfile

Lists existing CDN endpoints.

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

Property Value

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

listResourceUsage

Checks the quota and usage of geo filters and custom domains under the given endpoint.

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

Property Value

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

loadContent

Pre-loads a content to CDN. Available for Verizon Profiles.

loadContent: (resourceGroupName: string, profileName: string, endpointName: string, contentFilePaths: LoadParameters, options?: EndpointsLoadContentOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

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

purgeContent

Removes a content from CDN.

purgeContent: (resourceGroupName: string, profileName: string, endpointName: string, contentFilePaths: PurgeParameters, options?: EndpointsPurgeContentOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

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

start

Starts an existing CDN endpoint that is on a stopped state.

start: (resourceGroupName: string, profileName: string, endpointName: string, options?: EndpointsStartOptionalParams) => PollerLike<OperationState<Endpoint>, Endpoint>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, options?: EndpointsStartOptionalParams) => PollerLike<OperationState<Endpoint>, Endpoint>

stop

Stops an existing running CDN endpoint.

stop: (resourceGroupName: string, profileName: string, endpointName: string, options?: EndpointsStopOptionalParams) => PollerLike<OperationState<Endpoint>, Endpoint>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, options?: EndpointsStopOptionalParams) => PollerLike<OperationState<Endpoint>, Endpoint>

update

Updates an existing CDN 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 custom domains, use the Update Custom Domain operation.

update: (resourceGroupName: string, profileName: string, endpointName: string, endpointUpdateProperties: EndpointUpdateParameters, options?: EndpointsUpdateOptionalParams) => PollerLike<OperationState<Endpoint>, Endpoint>

Property Value

(resourceGroupName: string, profileName: string, endpointName: string, endpointUpdateProperties: EndpointUpdateParameters, options?: EndpointsUpdateOptionalParams) => PollerLike<OperationState<Endpoint>, Endpoint>

validateCustomDomain

Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.

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

Property Value

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