Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Routes

Package version

Class representing a Routes.

Hierarchy

  • Routes

Index

Constructors

constructor

Methods

beginCreateOrUpdate

  • beginCreateOrUpdate(resourceGroupName: string, routeTableName: string, routeName: string, routeParameters: Route, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>
  • Creates or updates a route in the specified route table.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • routeTableName: string

      The name of the route table.

    • routeName: string

      The name of the route.

    • routeParameters: Route

      Parameters supplied to the create or update route operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

  • beginDeleteMethod(resourceGroupName: string, routeTableName: string, routeName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>
  • Deletes the specified route from a route table.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • routeTableName: string

      The name of the route table.

    • routeName: string

      The name of the route.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrUpdate

  • createOrUpdate(resourceGroupName: string, routeTableName: string, routeName: string, routeParameters: Route, options?: msRest.RequestOptionsBase): Promise<Models.RoutesCreateOrUpdateResponse>
  • Creates or updates a route in the specified route table.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • routeTableName: string

      The name of the route table.

    • routeName: string

      The name of the route.

    • routeParameters: Route

      Parameters supplied to the create or update route operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.RoutesCreateOrUpdateResponse>

    Promise<Models.RoutesCreateOrUpdateResponse>

deleteMethod

  • deleteMethod(resourceGroupName: string, routeTableName: string, routeName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • Deletes the specified route from a route table.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • routeTableName: string

      The name of the route table.

    • routeName: string

      The name of the route.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

get

  • get(resourceGroupName: string, routeTableName: string, routeName: string, options?: msRest.RequestOptionsBase): Promise<Models.RoutesGetResponse>
  • get(resourceGroupName: string, routeTableName: string, routeName: string, callback: msRest.ServiceCallback<Route>): void
  • get(resourceGroupName: string, routeTableName: string, routeName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Route>): void
  • Gets the specified route from a route table.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • routeTableName: string

      The name of the route table.

    • routeName: string

      The name of the route.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.RoutesGetResponse>

    Promise<Models.RoutesGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • routeTableName: string

      The name of the route table.

    • routeName: string

      The name of the route.

    • callback: msRest.ServiceCallback<Route>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • routeTableName: string

      The name of the route table.

    • routeName: string

      The name of the route.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Route>

      The callback

    Returns void

list

  • list(resourceGroupName: string, routeTableName: string, options?: msRest.RequestOptionsBase): Promise<Models.RoutesListResponse>
  • list(resourceGroupName: string, routeTableName: string, callback: msRest.ServiceCallback<RouteListResult>): void
  • list(resourceGroupName: string, routeTableName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RouteListResult>): void
  • Gets all routes in a route table.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • routeTableName: string

      The name of the route table.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.RoutesListResponse>

    Promise<Models.RoutesListResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • routeTableName: string

      The name of the route table.

    • callback: msRest.ServiceCallback<RouteListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • routeTableName: string

      The name of the route table.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RouteListResult>

      The callback

    Returns void

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.RoutesListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<RouteListResult>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RouteListResult>): void
  • Gets all routes in a route table.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.RoutesListNextResponse>

    Promise<Models.RoutesListNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<RouteListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RouteListResult>

      The callback

    Returns void

Generated using TypeDoc