Endpoints interface

Package:

@azure/arm-cdn

Interface representing a Endpoints.

Methods

beginCreate(string, string, string, Endpoint, EndpointsCreateOptionalParams)	Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
beginCreateAndWait(string, string, string, Endpoint, EndpointsCreateOptionalParams)	Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
beginDelete(string, string, string, EndpointsDeleteOptionalParams)	Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
beginDeleteAndWait(string, string, string, EndpointsDeleteOptionalParams)	Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
beginLoadContent(string, string, string, LoadParameters, EndpointsLoadContentOptionalParams)	Pre-loads a content to CDN. Available for Verizon Profiles.
beginLoadContentAndWait(string, string, string, LoadParameters, EndpointsLoadContentOptionalParams)	Pre-loads a content to CDN. Available for Verizon Profiles.
beginPurgeContent(string, string, string, PurgeParameters, EndpointsPurgeContentOptionalParams)	Removes a content from CDN.
beginPurgeContentAndWait(string, string, string, PurgeParameters, EndpointsPurgeContentOptionalParams)	Removes a content from CDN.
beginStart(string, string, string, EndpointsStartOptionalParams)	Starts an existing CDN endpoint that is on a stopped state.
beginStartAndWait(string, string, string, EndpointsStartOptionalParams)	Starts an existing CDN endpoint that is on a stopped state.
beginStop(string, string, string, EndpointsStopOptionalParams)	Stops an existing running CDN endpoint.
beginStopAndWait(string, string, string, EndpointsStopOptionalParams)	Stops an existing running CDN endpoint.
beginUpdate(string, string, string, EndpointUpdateParameters, EndpointsUpdateOptionalParams)	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.
beginUpdateAndWait(string, string, string, EndpointUpdateParameters, EndpointsUpdateOptionalParams)	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.
get(string, string, string, EndpointsGetOptionalParams)	Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
listByProfile(string, string, EndpointsListByProfileOptionalParams)	Lists existing CDN endpoints.
listResourceUsage(string, string, string, EndpointsListResourceUsageOptionalParams)	Checks the quota and usage of geo filters and custom domains under the given endpoint.
validateCustomDomain(string, string, string, ValidateCustomDomainInput, EndpointsValidateCustomDomainOptionalParams)	Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.

Method Details

beginCreate(string, string, string, Endpoint, EndpointsCreateOptionalParams)

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

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

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.

endpointName

string

Name of the endpoint under the profile which is unique globally.

endpoint

Endpoint

Endpoint properties

options

EndpointsCreateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<Endpoint>, Endpoint>>

beginCreateAndWait(string, string, string, Endpoint, EndpointsCreateOptionalParams)

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

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

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.

endpointName

string

Name of the endpoint under the profile which is unique globally.

endpoint

Endpoint

Endpoint properties

options

EndpointsCreateOptionalParams

The options parameters.

Returns

Promise<Endpoint>

beginDelete(string, string, string, EndpointsDeleteOptionalParams)

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

function beginDelete(resourceGroupName: string, profileName: string, endpointName: string, options?: EndpointsDeleteOptionalParams): 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.

endpointName

string

Name of the endpoint under the profile which is unique globally.

options

EndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, EndpointsDeleteOptionalParams)

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

function beginDeleteAndWait(resourceGroupName: string, profileName: string, endpointName: string, options?: EndpointsDeleteOptionalParams): 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.

endpointName

string

Name of the endpoint under the profile which is unique globally.

options

EndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginLoadContent(string, string, string, LoadParameters, EndpointsLoadContentOptionalParams)

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

function beginLoadContent(resourceGroupName: string, profileName: string, endpointName: string, contentFilePaths: LoadParameters, options?: EndpointsLoadContentOptionalParams): 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.

endpointName

string

Name of the endpoint under the profile which is unique globally.

contentFilePaths

LoadParameters

The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictures/city.png' which loads a single file

options

EndpointsLoadContentOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginLoadContentAndWait(string, string, string, LoadParameters, EndpointsLoadContentOptionalParams)

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

function beginLoadContentAndWait(resourceGroupName: string, profileName: string, endpointName: string, contentFilePaths: LoadParameters, options?: EndpointsLoadContentOptionalParams): 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.

endpointName

string

Name of the endpoint under the profile which is unique globally.

contentFilePaths

LoadParameters

The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictures/city.png' which loads a single file

options

EndpointsLoadContentOptionalParams

The options parameters.

Returns

Promise<void>

beginPurgeContent(string, string, string, PurgeParameters, EndpointsPurgeContentOptionalParams)

Removes a content from CDN.

function beginPurgeContent(resourceGroupName: string, profileName: string, endpointName: string, contentFilePaths: PurgeParameters, options?: EndpointsPurgeContentOptionalParams): 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.

endpointName

string

Name of the endpoint under the profile which is unique globally.

contentFilePaths

PurgeParameters

The path to the content to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.

options

EndpointsPurgeContentOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginPurgeContentAndWait(string, string, string, PurgeParameters, EndpointsPurgeContentOptionalParams)

Removes a content from CDN.

function beginPurgeContentAndWait(resourceGroupName: string, profileName: string, endpointName: string, contentFilePaths: PurgeParameters, options?: EndpointsPurgeContentOptionalParams): 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.

endpointName

string

Name of the endpoint under the profile which is unique globally.

contentFilePaths

PurgeParameters

The path to the content to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.

options

EndpointsPurgeContentOptionalParams

The options parameters.

Returns

Promise<void>

beginStart(string, string, string, EndpointsStartOptionalParams)

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

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

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.

endpointName

string

Name of the endpoint under the profile which is unique globally.

options

EndpointsStartOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<Endpoint>, Endpoint>>

beginStartAndWait(string, string, string, EndpointsStartOptionalParams)

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

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

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.

endpointName

string

Name of the endpoint under the profile which is unique globally.

options

EndpointsStartOptionalParams

The options parameters.

Returns

Promise<Endpoint>

beginStop(string, string, string, EndpointsStopOptionalParams)

Stops an existing running CDN endpoint.

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

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.

endpointName

string

Name of the endpoint under the profile which is unique globally.

options

EndpointsStopOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<Endpoint>, Endpoint>>

beginStopAndWait(string, string, string, EndpointsStopOptionalParams)

Stops an existing running CDN endpoint.

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

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.

endpointName

string

Name of the endpoint under the profile which is unique globally.

options

EndpointsStopOptionalParams

The options parameters.

Returns

Promise<Endpoint>

beginUpdate(string, string, string, EndpointUpdateParameters, EndpointsUpdateOptionalParams)

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.

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

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.

endpointName

string

Name of the endpoint under the profile which is unique globally.

endpointUpdateProperties

EndpointUpdateParameters

Endpoint update properties

options

EndpointsUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<Endpoint>, Endpoint>>

beginUpdateAndWait(string, string, string, EndpointUpdateParameters, EndpointsUpdateOptionalParams)

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.

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

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.

endpointName

string

Name of the endpoint under the profile which is unique globally.

endpointUpdateProperties

EndpointUpdateParameters

Endpoint update properties

options

EndpointsUpdateOptionalParams

The options parameters.

Returns

Promise<Endpoint>

get(string, string, string, EndpointsGetOptionalParams)

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

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

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.

endpointName

string

Name of the endpoint under the profile which is unique globally.

options

EndpointsGetOptionalParams

The options parameters.

Returns

Promise<Endpoint>

listByProfile(string, string, EndpointsListByProfileOptionalParams)

Lists existing CDN endpoints.

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

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.

options

EndpointsListByProfileOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Endpoint, Endpoint[], PageSettings>

listResourceUsage(string, string, string, EndpointsListResourceUsageOptionalParams)

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

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

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.

endpointName

string

Name of the endpoint under the profile which is unique globally.

options

EndpointsListResourceUsageOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ResourceUsage, ResourceUsage[], PageSettings>

validateCustomDomain(string, string, string, ValidateCustomDomainInput, EndpointsValidateCustomDomainOptionalParams)

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

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

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.

endpointName

string

Name of the endpoint under the profile which is unique globally.

customDomainProperties

ValidateCustomDomainInput

Custom domain to be validated.

options

EndpointsValidateCustomDomainOptionalParams

The options parameters.

Returns

Promise<ValidateCustomDomainOutput>