az network manager security-admin-config rule-collection rule

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Note

This reference is part of the virtual-network-manager extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az network manager security-admin-config rule-collection rule command. Learn more about extensions.

Manage adminrule with network.

Commands

az network manager security-admin-config rule-collection rule create	Create a network manager security configuration admin rule.
az network manager security-admin-config rule-collection rule delete	Deletes an admin rule.
az network manager security-admin-config rule-collection rule list	Retrieves a network manager security configuration admin rule.
az network manager security-admin-config rule-collection rule show	Gets a network manager security configuration admin rule in a subscription.
az network manager security-admin-config rule-collection rule update	Update a network manager security configuration admin rule in a subscription.

az network manager security-admin-config rule-collection rule create

Create a network manager security configuration admin rule.

az network manager security-admin-config rule-collection rule create --access {Allow, AlwaysAllow, Deny}
                                                                     --configuration-name
                                                                     --direction {Inbound, Outbound}
                                                                     --kind {Custom, Default}
                                                                     --name
                                                                     --priority
                                                                     --protocol {Ah, Any, Esp, Icmp, Tcp, Udp}
                                                                     --resource-group
                                                                     --rule-collection-name
                                                                     --rule-name
                                                                     [--description]
                                                                     [--dest-port-ranges]
                                                                     [--destinations]
                                                                     [--display-name]
                                                                     [--flag]
                                                                     [--source-port-ranges]
                                                                     [--sources]

Examples

Create security admin rules

az network manager security-admin-config rule-collection rule create --configuration-name "myTestSecurityConfig" --network-manager-name "testNetworkManager" --resource-group "rg1" --rule-collection-name "myTestCollection" --rule-name "SampleAdminRule" --kind "Custom" --protocol "Tcp" --access "Allow" --priority 32 --direction "Inbound" --destinations address-prefix="*" address-prefix-type="IPPrefix"  --dest-port-ranges 22

Required Parameters

--access

Indicates the access allowed for this particular rule.

accepted values: Allow, AlwaysAllow, Deny

--configuration-name

The name of the network manager security Configuration.

--direction

Indicates if the traffic matched against the rule in inbound or outbound.

accepted values: Inbound, Outbound

--kind

Required. Whether the rule is custom or default.Constant filled by server.

accepted values: Custom, Default

--name --network-manager-name -n

The name of the network manager.

--priority

The priority of the rule.

--protocol

Network protocol this rule applies to.

accepted values: Ah, Any, Esp, Icmp, Tcp, Udp

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--rule-collection-name

The name of the admin rule collection.

--rule-name

The name of the rule.

Optional Parameters

--description

A description for this rule. Restricted to 140 chars.

--dest-port-ranges

The destination port ranges.

--destinations

The destination address prefixes. CIDR or destination IP ranges.

--display-name

A friendly name for the rule.

--flag

Default rule flag.

--source-port-ranges

The source port ranges.

--sources

The CIDR or source IP ranges.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network manager security-admin-config rule-collection rule delete

Deletes an admin rule.

az network manager security-admin-config rule-collection rule delete --configuration-name
                                                                     --name
                                                                     --resource-group
                                                                     --rule-collection-name
                                                                     --rule-name
                                                                     [--yes]

Examples

Deletes an admin rule.

az network manager security-admin-config rule-collection rule delete --configuration-name "myTestSecurityConfig" --network-manager-name "testNetworkManager" --resource-group "rg1" --rule-collection-name "myTestCollection" --rule-name "SampleAdminRule"

Required Parameters

--configuration-name

The name of the network manager security Configuration.

--name --network-manager-name -n

The name of the network manager.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--rule-collection-name

The name of the admin rule collection.

--rule-name

The name of the rule.

Optional Parameters

--yes -y

Do not prompt for confirmation.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network manager security-admin-config rule-collection rule list

Retrieves a network manager security configuration admin rule.

az network manager security-admin-config rule-collection rule list --configuration-name
                                                                   --name
                                                                   --resource-group
                                                                   --rule-collection-name
                                                                   [--skip-token]
                                                                   [--top]

Examples

List security admin rules

az network manager security-admin-config rule-collection rule list --configuration-name "myTestSecurityConfig" --network-manager-name "testNetworkManager" --resource-group "rg1" --rule-collection-name "myTestCollection"

Required Parameters

--configuration-name

The name of the network manager security Configuration.

--name --network-manager-name -n

The name of the network manager.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--rule-collection-name

The name of the admin rule collection.

Optional Parameters

--skip-token

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.

--top

An optional query parameter which specifies the maximum number of records to be returned by the server.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network manager security-admin-config rule-collection rule show

Gets a network manager security configuration admin rule in a subscription.

az network manager security-admin-config rule-collection rule show --configuration-name
                                                                   --name
                                                                   --resource-group
                                                                   --rule-collection-name
                                                                   --rule-name

Examples

Gets security admin rule

az network manager security-admin-config rule-collection rule show --configuration-name "myTestSecurityConfig" --network-manager-name "testNetworkManager" --resource-group "rg1" --rule-collection-name "myTestCollection" --rule-name "SampleAdminRule"

Required Parameters

--configuration-name

The name of the network manager security Configuration.

--name --network-manager-name -n

The name of the network manager.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--rule-collection-name

The name of the admin rule collection.

--rule-name

The name of the rule.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network manager security-admin-config rule-collection rule update

Update a network manager security configuration admin rule in a subscription.

az network manager security-admin-config rule-collection rule update --configuration-name
                                                                     --name
                                                                     --resource-group
                                                                     --rule-collection-name
                                                                     --rule-name
                                                                     [--access {Allow, AlwaysAllow, Deny}]
                                                                     [--add]
                                                                     [--description]
                                                                     [--dest-port-ranges]
                                                                     [--destinations]
                                                                     [--direction {Inbound, Outbound}]
                                                                     [--display-name]
                                                                     [--flag]
                                                                     [--force-string]
                                                                     [--kind {Custom, Default}]
                                                                     [--priority]
                                                                     [--protocol {Ah, Any, Esp, Icmp, Tcp, Udp}]
                                                                     [--remove]
                                                                     [--set]
                                                                     [--source-port-ranges]
                                                                     [--sources]

Examples

Update security admin rule

az network manager security-admin-config rule-collection rule update --configuration-name "myTestSecurityConfig" --network-manager-name "testNetworkManager" --resource-group "rg1" --rule-collection-name "myTestCollection" --rule-name "SampleAdminRule" --access "Deny"

Required Parameters

--configuration-name

The name of the network manager security Configuration.

--name --network-manager-name -n

The name of the network manager.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--rule-collection-name

The name of the admin rule collection.

--rule-name

The name of the rule.

Optional Parameters

--access

Indicates the access allowed for this particular rule.

accepted values: Allow, AlwaysAllow, Deny

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--description

A description for this rule. Restricted to 140 chars.

--dest-port-ranges

The destination port ranges.

--destinations

The destination address prefixes. CIDR or destination IP ranges.

--direction

Indicates if the traffic matched against the rule in inbound or outbound.

accepted values: Inbound, Outbound

--display-name

A friendly name for the rule.

--flag

Default rule flag.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--kind

Required. Whether the rule is custom or default.Constant filled by server.

accepted values: Custom, Default

--priority

The priority of the rule.

--protocol

Network protocol this rule applies to.

accepted values: Ah, Any, Esp, Icmp, Tcp, Udp

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--source-port-ranges

The source port ranges.

--sources

The CIDR or source IP ranges.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.