RoutingRuleCollectionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:routing_rule_collections> attribute.

Inheritance

builtins.object

RoutingRuleCollectionsOperations

Constructor

RoutingRuleCollectionsOperations(*args, **kwargs)

Methods

begin_delete	Deletes an routing rule collection.
create_or_update	Creates or updates a routing rule collection.
get	Gets a network manager routing configuration rule collection.
list	Lists all the rule collections in a routing configuration, in a paginated format.

begin_delete

Deletes an routing rule collection.

begin_delete(resource_group_name: str, network_manager_name: str, configuration_name: str, rule_collection_name: str, *, force: bool | None = None, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
network_manager_name Required	str The name of the network manager. Required.
configuration_name Required	str The name of the network manager Routing Configuration. Required.
rule_collection_name Required	str The name of the network manager routing Configuration rule collection. Required.

Keyword-Only Parameters

Name	Description
force	bool Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete. Default value is None.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update

Creates or updates a routing rule collection.

create_or_update(resource_group_name: str, network_manager_name: str, configuration_name: str, rule_collection_name: str, rule_collection: _models.RoutingRuleCollection, *, content_type: str = 'application/json', **kwargs: Any) -> _models.RoutingRuleCollection

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
network_manager_name Required	str The name of the network manager. Required.
configuration_name Required	str The name of the network manager Routing Configuration. Required.
rule_collection_name Required	str The name of the network manager routing Configuration rule collection. Required.
rule_collection Required	RoutingRuleCollection or IO[bytes] The Rule Collection to create or update. Is either a RoutingRuleCollection type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name	Description
force	bool Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete. Default value is None.

Returns

Type	Description
RoutingRuleCollection	RoutingRuleCollection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a network manager routing configuration rule collection.

get(resource_group_name: str, network_manager_name: str, configuration_name: str, rule_collection_name: str, **kwargs: Any) -> RoutingRuleCollection

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
network_manager_name Required	str The name of the network manager. Required.
configuration_name Required	str The name of the network manager Routing Configuration. Required.
rule_collection_name Required	str The name of the network manager routing Configuration rule collection. Required.

Keyword-Only Parameters

Name	Description
force	bool Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete. Default value is None.

Returns

Type	Description
RoutingRuleCollection	RoutingRuleCollection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Lists all the rule collections in a routing configuration, in a paginated format.

list(resource_group_name: str, network_manager_name: str, configuration_name: str, *, top: int | None = None, skip_token: str | None = None, **kwargs: Any) -> Iterable[RoutingRuleCollection]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
network_manager_name Required	str The name of the network manager. Required.
configuration_name Required	str The name of the network manager Routing Configuration. Required.

Keyword-Only Parameters

Name	Description
top	int An optional query parameter which specifies the maximum number of records to be returned by the server. Default value is None.
skip_token	str SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. Default value is None.

Returns

Type	Description
ItemPaged[RoutingRuleCollection]	An iterator like instance of either RoutingRuleCollection or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>