RoutePolicies interface

Package:

@azure/arm-managednetworkfabric

Interface representing a RoutePolicies.

Methods

beginCommitConfiguration(string, string, RoutePoliciesCommitConfigurationOptionalParams)	Commits the configuration of the given resources.
beginCommitConfigurationAndWait(string, string, RoutePoliciesCommitConfigurationOptionalParams)	Commits the configuration of the given resources.
beginCreate(string, string, RoutePolicy, RoutePoliciesCreateOptionalParams)	Implements Route Policy PUT method.
beginCreateAndWait(string, string, RoutePolicy, RoutePoliciesCreateOptionalParams)	Implements Route Policy PUT method.
beginDelete(string, string, RoutePoliciesDeleteOptionalParams)	Implements Route Policy DELETE method.
beginDeleteAndWait(string, string, RoutePoliciesDeleteOptionalParams)	Implements Route Policy DELETE method.
beginUpdate(string, string, RoutePolicyPatch, RoutePoliciesUpdateOptionalParams)	API to update certain properties of the Route Policy resource.
beginUpdateAdministrativeState(string, string, UpdateAdministrativeState, RoutePoliciesUpdateAdministrativeStateOptionalParams)	Updated the admin state for this Route Policy.
beginUpdateAdministrativeStateAndWait(string, string, UpdateAdministrativeState, RoutePoliciesUpdateAdministrativeStateOptionalParams)	Updated the admin state for this Route Policy.
beginUpdateAndWait(string, string, RoutePolicyPatch, RoutePoliciesUpdateOptionalParams)	API to update certain properties of the Route Policy resource.
beginValidateConfiguration(string, string, RoutePoliciesValidateConfigurationOptionalParams)	Validates the configuration of the resources.
beginValidateConfigurationAndWait(string, string, RoutePoliciesValidateConfigurationOptionalParams)	Validates the configuration of the resources.
get(string, string, RoutePoliciesGetOptionalParams)	Implements Route Policy GET method.
listByResourceGroup(string, RoutePoliciesListByResourceGroupOptionalParams)	Implements RoutePolicies list by resource group GET method.
listBySubscription(RoutePoliciesListBySubscriptionOptionalParams)	Implements RoutePolicies list by subscription GET method.

Method Details

beginCommitConfiguration(string, string, RoutePoliciesCommitConfigurationOptionalParams)

Commits the configuration of the given resources.

function beginCommitConfiguration(resourceGroupName: string, routePolicyName: string, options?: RoutePoliciesCommitConfigurationOptionalParams): Promise<SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

routePolicyName

string

Name of the Route Policy.

options

RoutePoliciesCommitConfigurationOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

beginCommitConfigurationAndWait(string, string, RoutePoliciesCommitConfigurationOptionalParams)

Commits the configuration of the given resources.

function beginCommitConfigurationAndWait(resourceGroupName: string, routePolicyName: string, options?: RoutePoliciesCommitConfigurationOptionalParams): Promise<CommonPostActionResponseForStateUpdate>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

routePolicyName

string

Name of the Route Policy.

options

RoutePoliciesCommitConfigurationOptionalParams

The options parameters.

Returns

Promise<CommonPostActionResponseForStateUpdate>

beginCreate(string, string, RoutePolicy, RoutePoliciesCreateOptionalParams)

Implements Route Policy PUT method.

function beginCreate(resourceGroupName: string, routePolicyName: string, body: RoutePolicy, options?: RoutePoliciesCreateOptionalParams): Promise<SimplePollerLike<OperationState<RoutePolicy>, RoutePolicy>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

routePolicyName

string

Name of the Route Policy.

body

RoutePolicy

Request payload.

options

RoutePoliciesCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<RoutePolicy>, RoutePolicy>>

beginCreateAndWait(string, string, RoutePolicy, RoutePoliciesCreateOptionalParams)

Implements Route Policy PUT method.

function beginCreateAndWait(resourceGroupName: string, routePolicyName: string, body: RoutePolicy, options?: RoutePoliciesCreateOptionalParams): Promise<RoutePolicy>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

routePolicyName

string

Name of the Route Policy.

body

RoutePolicy

Request payload.

options

RoutePoliciesCreateOptionalParams

The options parameters.

Returns

Promise<RoutePolicy>

beginDelete(string, string, RoutePoliciesDeleteOptionalParams)

Implements Route Policy DELETE method.

function beginDelete(resourceGroupName: string, routePolicyName: string, options?: RoutePoliciesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

routePolicyName

string

Name of the Route Policy.

options

RoutePoliciesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, RoutePoliciesDeleteOptionalParams)

Implements Route Policy DELETE method.

function beginDeleteAndWait(resourceGroupName: string, routePolicyName: string, options?: RoutePoliciesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

routePolicyName

string

Name of the Route Policy.

options

RoutePoliciesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, RoutePolicyPatch, RoutePoliciesUpdateOptionalParams)

API to update certain properties of the Route Policy resource.

function beginUpdate(resourceGroupName: string, routePolicyName: string, body: RoutePolicyPatch, options?: RoutePoliciesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<RoutePolicy>, RoutePolicy>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

routePolicyName

string

Name of the Route Policy.

body

RoutePolicyPatch

Route Policy properties to update.

options

RoutePoliciesUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<RoutePolicy>, RoutePolicy>>

beginUpdateAdministrativeState(string, string, UpdateAdministrativeState, RoutePoliciesUpdateAdministrativeStateOptionalParams)

Updated the admin state for this Route Policy.

function beginUpdateAdministrativeState(resourceGroupName: string, routePolicyName: string, body: UpdateAdministrativeState, options?: RoutePoliciesUpdateAdministrativeStateOptionalParams): Promise<SimplePollerLike<OperationState<CommonPostActionResponseForDeviceUpdate>, CommonPostActionResponseForDeviceUpdate>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

routePolicyName

string

Name of the Route Policy.

body

UpdateAdministrativeState

Request payload.

options

RoutePoliciesUpdateAdministrativeStateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<CommonPostActionResponseForDeviceUpdate>, CommonPostActionResponseForDeviceUpdate>>

beginUpdateAdministrativeStateAndWait(string, string, UpdateAdministrativeState, RoutePoliciesUpdateAdministrativeStateOptionalParams)

Updated the admin state for this Route Policy.

function beginUpdateAdministrativeStateAndWait(resourceGroupName: string, routePolicyName: string, body: UpdateAdministrativeState, options?: RoutePoliciesUpdateAdministrativeStateOptionalParams): Promise<CommonPostActionResponseForDeviceUpdate>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

routePolicyName

string

Name of the Route Policy.

body

UpdateAdministrativeState

Request payload.

options

RoutePoliciesUpdateAdministrativeStateOptionalParams

The options parameters.

Returns

Promise<CommonPostActionResponseForDeviceUpdate>

beginUpdateAndWait(string, string, RoutePolicyPatch, RoutePoliciesUpdateOptionalParams)

API to update certain properties of the Route Policy resource.

function beginUpdateAndWait(resourceGroupName: string, routePolicyName: string, body: RoutePolicyPatch, options?: RoutePoliciesUpdateOptionalParams): Promise<RoutePolicy>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

routePolicyName

string

Name of the Route Policy.

body

RoutePolicyPatch

Route Policy properties to update.

options

RoutePoliciesUpdateOptionalParams

The options parameters.

Returns

Promise<RoutePolicy>

beginValidateConfiguration(string, string, RoutePoliciesValidateConfigurationOptionalParams)

Validates the configuration of the resources.

function beginValidateConfiguration(resourceGroupName: string, routePolicyName: string, options?: RoutePoliciesValidateConfigurationOptionalParams): Promise<SimplePollerLike<OperationState<ValidateConfigurationResponse>, ValidateConfigurationResponse>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

routePolicyName

string

Name of the Route Policy.

options

RoutePoliciesValidateConfigurationOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ValidateConfigurationResponse>, ValidateConfigurationResponse>>

beginValidateConfigurationAndWait(string, string, RoutePoliciesValidateConfigurationOptionalParams)

Validates the configuration of the resources.

function beginValidateConfigurationAndWait(resourceGroupName: string, routePolicyName: string, options?: RoutePoliciesValidateConfigurationOptionalParams): Promise<ValidateConfigurationResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

routePolicyName

string

Name of the Route Policy.

options

RoutePoliciesValidateConfigurationOptionalParams

The options parameters.

Returns

Promise<ValidateConfigurationResponse>

get(string, string, RoutePoliciesGetOptionalParams)

Implements Route Policy GET method.

function get(resourceGroupName: string, routePolicyName: string, options?: RoutePoliciesGetOptionalParams): Promise<RoutePolicy>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

routePolicyName

string

Name of the Route Policy.

options

RoutePoliciesGetOptionalParams

The options parameters.

Returns

Promise<RoutePolicy>

listByResourceGroup(string, RoutePoliciesListByResourceGroupOptionalParams)

Implements RoutePolicies list by resource group GET method.

function listByResourceGroup(resourceGroupName: string, options?: RoutePoliciesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<RoutePolicy, RoutePolicy[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

RoutePoliciesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RoutePolicy, RoutePolicy[], PageSettings>

listBySubscription(RoutePoliciesListBySubscriptionOptionalParams)

Implements RoutePolicies list by subscription GET method.

function listBySubscription(options?: RoutePoliciesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<RoutePolicy, RoutePolicy[], PageSettings>

Parameters

options

RoutePoliciesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RoutePolicy, RoutePolicy[], PageSettings>