Share via

AdminRuleCollectionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:admin_rule_collections> attribute.

Constructor

AdminRuleCollectionsOperations(*args, **kwargs)

Methods

begin_delete

Deletes an admin rule collection.
create_or_update

Creates or updates an admin rule collection.
get

Gets a network manager security admin configuration rule collection.
list

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

begin_delete

Deletes an admin 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. Required.
network_manager_name
Required
str

The name of the network manager. Required.
configuration_name
Required
str

The name of the network manager Security Configuration. Required.
rule_collection_name
Required
str

The name of the network manager security 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.

Default value: 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 an admin rule collection.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
network_manager_name
Required
str

The name of the network manager. Required.
configuration_name
Required
str

The name of the network manager Security Configuration. Required.
rule_collection_name
Required
str

The name of the network manager security Configuration rule collection. Required.
rule_collection
Required
AdminRuleCollection or IO[bytes]

The Rule Collection to create or update. Is either a AdminRuleCollection type or a IO[bytes] type. Required.

Returns

Type Description
AdminRuleCollection

AdminRuleCollection or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets a network manager security admin configuration rule collection.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
network_manager_name
Required
str

The name of the network manager. Required.
configuration_name
Required
str

The name of the network manager Security Configuration. Required.
rule_collection_name
Required
str

The name of the network manager security Configuration rule collection. Required.

Returns

Type Description
AdminRuleCollection

AdminRuleCollection or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Lists all the rule collections in a security admin 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[AdminRuleCollection]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
network_manager_name
Required
str

The name of the network manager. Required.
configuration_name
Required
str

The name of the network manager Security 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.

Default value: 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.

Default value: None

Returns

Type Description
ItemPaged[AdminRuleCollection]

An iterator like instance of either AdminRuleCollection or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.network.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv177\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>