Share via

SecurityUserRulesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:security_user_rules> attribute.

Constructor

SecurityUserRulesOperations(*args, **kwargs)

Methods

begin_delete

Deletes a security user rule.
create_or_update

Creates or updates a security user rule.
get

Gets a security user rule.
list

Lists all Security User Rules in a rule collection.

begin_delete

Deletes a security user rule.

begin_delete(resource_group_name: str, network_manager_name: str, configuration_name: str, rule_collection_name: str, rule_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 Security Configuration. Required.
rule_collection_name
Required
str

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

The name of the rule. 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 a security user rule.

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

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 Security Configuration. Required.
rule_collection_name
Required
str

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

The name of the rule. Required.
security_user_rule
Required
SecurityUserRule or IO[bytes]

The security user rule to create or update. Is either a SecurityUserRule type or a IO[bytes] type. Required.

Returns

Type Description
SecurityUserRule

SecurityUserRule or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets a security user rule.

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

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 Security Configuration. Required.
rule_collection_name
Required
str

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

The name of the rule. Required.

Returns

Type Description
SecurityUserRule

SecurityUserRule or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Lists all Security User Rules in a rule collection.

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

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 Security Configuration. Required.
rule_collection_name
Required
str

The name of the network manager security Configuration rule collection. 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[SecurityUserRule]

An iterator like instance of either SecurityUserRule 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.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv169\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>