Routes interface

Package:

@azure/arm-cdn

Interface representing a Routes.

Methods

beginCreate(string, string, string, string, Route, RoutesCreateOptionalParams)	Creates a new route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
beginCreateAndWait(string, string, string, string, Route, RoutesCreateOptionalParams)	Creates a new route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
beginDelete(string, string, string, string, RoutesDeleteOptionalParams)	Deletes an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
beginDeleteAndWait(string, string, string, string, RoutesDeleteOptionalParams)	Deletes an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
beginUpdate(string, string, string, string, RouteUpdateParameters, RoutesUpdateOptionalParams)	Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
beginUpdateAndWait(string, string, string, string, RouteUpdateParameters, RoutesUpdateOptionalParams)	Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
get(string, string, string, string, RoutesGetOptionalParams)	Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
listByEndpoint(string, string, string, RoutesListByEndpointOptionalParams)	Lists all of the existing origins within a profile.

Method Details

beginCreate(string, string, string, string, Route, RoutesCreateOptionalParams)

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

function beginCreate(resourceGroupName: string, profileName: string, endpointName: string, routeName: string, route: Route, options?: RoutesCreateOptionalParams): Promise<SimplePollerLike<OperationState<Route>, Route>>

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 profile which is unique within the resource group.

endpointName

string

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

routeName

string

Name of the routing rule.

route

Route

Route properties

options

RoutesCreateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<Route>, Route>>

beginCreateAndWait(string, string, string, string, Route, RoutesCreateOptionalParams)

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

function beginCreateAndWait(resourceGroupName: string, profileName: string, endpointName: string, routeName: string, route: Route, options?: RoutesCreateOptionalParams): Promise<Route>

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 profile which is unique within the resource group.

endpointName

string

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

routeName

string

Name of the routing rule.

route

Route

Route properties

options

RoutesCreateOptionalParams

The options parameters.

Returns

Promise<Route>

beginDelete(string, string, string, string, RoutesDeleteOptionalParams)

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

function beginDelete(resourceGroupName: string, profileName: string, endpointName: string, routeName: string, options?: RoutesDeleteOptionalParams): 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 profile which is unique within the resource group.

endpointName

string

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

routeName

string

Name of the routing rule.

options

RoutesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, string, RoutesDeleteOptionalParams)

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

function beginDeleteAndWait(resourceGroupName: string, profileName: string, endpointName: string, routeName: string, options?: RoutesDeleteOptionalParams): 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 profile which is unique within the resource group.

endpointName

string

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

routeName

string

Name of the routing rule.

options

RoutesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, string, RouteUpdateParameters, RoutesUpdateOptionalParams)

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

function beginUpdate(resourceGroupName: string, profileName: string, endpointName: string, routeName: string, routeUpdateProperties: RouteUpdateParameters, options?: RoutesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Route>, Route>>

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 profile which is unique within the resource group.

endpointName

string

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

routeName

string

Name of the routing rule.

routeUpdateProperties

RouteUpdateParameters

Route update properties

options

RoutesUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<Route>, Route>>

beginUpdateAndWait(string, string, string, string, RouteUpdateParameters, RoutesUpdateOptionalParams)

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

function beginUpdateAndWait(resourceGroupName: string, profileName: string, endpointName: string, routeName: string, routeUpdateProperties: RouteUpdateParameters, options?: RoutesUpdateOptionalParams): Promise<Route>

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 profile which is unique within the resource group.

endpointName

string

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

routeName

string

Name of the routing rule.

routeUpdateProperties

RouteUpdateParameters

Route update properties

options

RoutesUpdateOptionalParams

The options parameters.

Returns

Promise<Route>

get(string, string, string, string, RoutesGetOptionalParams)

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

function get(resourceGroupName: string, profileName: string, endpointName: string, routeName: string, options?: RoutesGetOptionalParams): Promise<Route>

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 profile which is unique within the resource group.

endpointName

string

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

routeName

string

Name of the routing rule.

options

RoutesGetOptionalParams

The options parameters.

Returns

Promise<Route>

listByEndpoint(string, string, string, RoutesListByEndpointOptionalParams)

Lists all of the existing origins within a profile.

function listByEndpoint(resourceGroupName: string, profileName: string, endpointName: string, options?: RoutesListByEndpointOptionalParams): PagedAsyncIterableIterator<Route, Route[], 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 profile which is unique within the resource group.

endpointName

string

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

options

RoutesListByEndpointOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Route, Route[], PageSettings>