Partager via


RoutesClient Interface

public interface RoutesClient

An instance of this class provides access to all the operations defined in RoutesClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<RouteInner>,RouteInner> beginCreate(String resourceGroupName, String profileName, String endpointName, String routeName, RouteInner route)

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

abstract SyncPoller<PollResult<RouteInner>,RouteInner> beginCreate(String resourceGroupName, String profileName, String endpointName, String routeName, RouteInner route, Context context)

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

abstract PollerFlux<PollResult<RouteInner>,RouteInner> beginCreateAsync(String resourceGroupName, String profileName, String endpointName, String routeName, RouteInner route)

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

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String profileName, String endpointName, String routeName)

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

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String profileName, String endpointName, String routeName, Context context)

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

abstract PollerFlux<PollResult<Void>,Void> beginDeleteAsync(String resourceGroupName, String profileName, String endpointName, String routeName)

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

abstract SyncPoller<PollResult<RouteInner>,RouteInner> beginUpdate(String resourceGroupName, String profileName, String endpointName, String routeName, RouteUpdateParameters routeUpdateProperties)

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

abstract SyncPoller<PollResult<RouteInner>,RouteInner> beginUpdate(String resourceGroupName, String profileName, String endpointName, String routeName, RouteUpdateParameters routeUpdateProperties, Context context)

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

abstract PollerFlux<PollResult<RouteInner>,RouteInner> beginUpdateAsync(String resourceGroupName, String profileName, String endpointName, String routeName, RouteUpdateParameters routeUpdateProperties)

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

abstract RouteInner create(String resourceGroupName, String profileName, String endpointName, String routeName, RouteInner route)

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

abstract RouteInner create(String resourceGroupName, String profileName, String endpointName, String routeName, RouteInner route, Context context)

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

abstract Mono<RouteInner> createAsync(String resourceGroupName, String profileName, String endpointName, String routeName, RouteInner route)

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

abstract Mono<Response<Flux<ByteBuffer>>> createWithResponseAsync(String resourceGroupName, String profileName, String endpointName, String routeName, RouteInner route)

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

abstract void delete(String resourceGroupName, String profileName, String endpointName, String routeName)

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

abstract void delete(String resourceGroupName, String profileName, String endpointName, String routeName, Context context)

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

abstract Mono<Void> deleteAsync(String resourceGroupName, String profileName, String endpointName, String routeName)

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

abstract Mono<Response<Flux<ByteBuffer>>> deleteWithResponseAsync(String resourceGroupName, String profileName, String endpointName, String routeName)

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

abstract RouteInner get(String resourceGroupName, String profileName, String endpointName, String routeName)

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

abstract Mono<RouteInner> getAsync(String resourceGroupName, String profileName, String endpointName, String routeName)

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

abstract Response<RouteInner> getWithResponse(String resourceGroupName, String profileName, String endpointName, String routeName, Context context)

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

abstract Mono<Response<RouteInner>> getWithResponseAsync(String resourceGroupName, String profileName, String endpointName, String routeName)

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

abstract PagedIterable<RouteInner> listByEndpoint(String resourceGroupName, String profileName, String endpointName)

Lists all of the existing origins within a profile.

abstract PagedIterable<RouteInner> listByEndpoint(String resourceGroupName, String profileName, String endpointName, Context context)

Lists all of the existing origins within a profile.

abstract PagedFlux<RouteInner> listByEndpointAsync(String resourceGroupName, String profileName, String endpointName)

Lists all of the existing origins within a profile.

abstract RouteInner update(String resourceGroupName, String profileName, String endpointName, String routeName, RouteUpdateParameters routeUpdateProperties)

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

abstract RouteInner update(String resourceGroupName, String profileName, String endpointName, String routeName, RouteUpdateParameters routeUpdateProperties, Context context)

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

abstract Mono<RouteInner> updateAsync(String resourceGroupName, String profileName, String endpointName, String routeName, RouteUpdateParameters routeUpdateProperties)

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

abstract Mono<Response<Flux<ByteBuffer>>> updateWithResponseAsync(String resourceGroupName, String profileName, String endpointName, String routeName, RouteUpdateParameters routeUpdateProperties)

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

Method Details

beginCreate

public abstract SyncPoller,RouteInner> beginCreate(String resourceGroupName, String profileName, String endpointName, String routeName, RouteInner route)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.
route - Route properties.

Returns:

the SyncPoller<T,U> for polling of friendly Routes name mapping to the any Routes or secret related information.

beginCreate

public abstract SyncPoller,RouteInner> beginCreate(String resourceGroupName, String profileName, String endpointName, String routeName, RouteInner route, Context context)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.
route - Route properties.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of friendly Routes name mapping to the any Routes or secret related information.

beginCreateAsync

public abstract PollerFlux,RouteInner> beginCreateAsync(String resourceGroupName, String profileName, String endpointName, String routeName, RouteInner route)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.
route - Route properties.

Returns:

the PollerFlux<T,U> for polling of friendly Routes name mapping to the any Routes or secret related information.

beginDelete

public abstract SyncPoller,Void> beginDelete(String resourceGroupName, String profileName, String endpointName, String routeName)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller,Void> beginDelete(String resourceGroupName, String profileName, String endpointName, String routeName, Context context)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDeleteAsync

public abstract PollerFlux,Void> beginDeleteAsync(String resourceGroupName, String profileName, String endpointName, String routeName)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.

Returns:

the PollerFlux<T,U> for polling of long-running operation.

beginUpdate

public abstract SyncPoller,RouteInner> beginUpdate(String resourceGroupName, String profileName, String endpointName, String routeName, RouteUpdateParameters routeUpdateProperties)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.
routeUpdateProperties - Route update properties.

Returns:

the SyncPoller<T,U> for polling of friendly Routes name mapping to the any Routes or secret related information.

beginUpdate

public abstract SyncPoller,RouteInner> beginUpdate(String resourceGroupName, String profileName, String endpointName, String routeName, RouteUpdateParameters routeUpdateProperties, Context context)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.
routeUpdateProperties - Route update properties.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of friendly Routes name mapping to the any Routes or secret related information.

beginUpdateAsync

public abstract PollerFlux,RouteInner> beginUpdateAsync(String resourceGroupName, String profileName, String endpointName, String routeName, RouteUpdateParameters routeUpdateProperties)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.
routeUpdateProperties - Route update properties.

Returns:

the PollerFlux<T,U> for polling of friendly Routes name mapping to the any Routes or secret related information.

create

public abstract RouteInner create(String resourceGroupName, String profileName, String endpointName, String routeName, RouteInner route)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.
route - Route properties.

Returns:

friendly Routes name mapping to the any Routes or secret related information.

create

public abstract RouteInner create(String resourceGroupName, String profileName, String endpointName, String routeName, RouteInner route, Context context)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.
route - Route properties.
context - The context to associate with this operation.

Returns:

friendly Routes name mapping to the any Routes or secret related information.

createAsync

public abstract Mono createAsync(String resourceGroupName, String profileName, String endpointName, String routeName, RouteInner route)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.
route - Route properties.

Returns:

friendly Routes name mapping to the any Routes or secret related information on successful completion of Mono.

createWithResponseAsync

public abstract Mono>> createWithResponseAsync(String resourceGroupName, String profileName, String endpointName, String routeName, RouteInner route)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.
route - Route properties.

Returns:

friendly Routes name mapping to the any Routes or secret related information along with Response<T> on successful completion of Mono.

delete

public abstract void delete(String resourceGroupName, String profileName, String endpointName, String routeName)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.

delete

public abstract void delete(String resourceGroupName, String profileName, String endpointName, String routeName, Context context)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.
context - The context to associate with this operation.

deleteAsync

public abstract Mono deleteAsync(String resourceGroupName, String profileName, String endpointName, String routeName)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.

Returns:

A Mono that completes when a successful response is received.

deleteWithResponseAsync

public abstract Mono>> deleteWithResponseAsync(String resourceGroupName, String profileName, String endpointName, String routeName)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.

Returns:

the Response<T> on successful completion of Mono.

get

public abstract RouteInner get(String resourceGroupName, String profileName, String endpointName, String routeName)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.

Returns:

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

getAsync

public abstract Mono getAsync(String resourceGroupName, String profileName, String endpointName, String routeName)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.

Returns:

an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint on successful completion of Mono.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String profileName, String endpointName, String routeName, Context context)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.
context - The context to associate with this operation.

Returns:

an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint along with Response<T>.

getWithResponseAsync

public abstract Mono> getWithResponseAsync(String resourceGroupName, String profileName, String endpointName, String routeName)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.

Returns:

an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint along with Response<T> on successful completion of Mono.

listByEndpoint

public abstract PagedIterable listByEndpoint(String resourceGroupName, String profileName, String endpointName)

Lists all of the existing origins within a profile.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.

Returns:

result of the request to list routes as paginated response with PagedIterable<T>.

listByEndpoint

public abstract PagedIterable listByEndpoint(String resourceGroupName, String profileName, String endpointName, Context context)

Lists all of the existing origins within a profile.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
context - The context to associate with this operation.

Returns:

result of the request to list routes as paginated response with PagedIterable<T>.

listByEndpointAsync

public abstract PagedFlux listByEndpointAsync(String resourceGroupName, String profileName, String endpointName)

Lists all of the existing origins within a profile.

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.

Returns:

result of the request to list routes as paginated response with PagedFlux<T>.

update

public abstract RouteInner update(String resourceGroupName, String profileName, String endpointName, String routeName, RouteUpdateParameters routeUpdateProperties)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.
routeUpdateProperties - Route update properties.

Returns:

friendly Routes name mapping to the any Routes or secret related information.

update

public abstract RouteInner update(String resourceGroupName, String profileName, String endpointName, String routeName, RouteUpdateParameters routeUpdateProperties, Context context)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.
routeUpdateProperties - Route update properties.
context - The context to associate with this operation.

Returns:

friendly Routes name mapping to the any Routes or secret related information.

updateAsync

public abstract Mono updateAsync(String resourceGroupName, String profileName, String endpointName, String routeName, RouteUpdateParameters routeUpdateProperties)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.
routeUpdateProperties - Route update properties.

Returns:

friendly Routes name mapping to the any Routes or secret related information on successful completion of Mono.

updateWithResponseAsync

public abstract Mono>> updateWithResponseAsync(String resourceGroupName, String profileName, String endpointName, String routeName, RouteUpdateParameters routeUpdateProperties)

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

Parameters:

resourceGroupName - Name of the Resource group within the Azure subscription.
profileName - Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
endpointName - Name of the endpoint under the profile which is unique globally.
routeName - Name of the routing rule.
routeUpdateProperties - Route update properties.

Returns:

friendly Routes name mapping to the any Routes or secret related information along with Response<T> on successful completion of Mono.

Applies to