az network manager security-admin-config rule-collection

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 command. Learn more about extensions.

Manage admin rule collection with network.

Commands

az network manager security-admin-config rule-collection create	Create a network manager security configuration admin rule collection.
az network manager security-admin-config rule-collection delete	Delete an admin rule collection.
az network manager security-admin-config rule-collection list	List network manager security configuration admin rule collections.
az network manager security-admin-config rule-collection rule	Manage adminrule with network.
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 show	Gets a network manager security configuration admin rule collection in a subscription.
az network manager security-admin-config rule-collection update	Update a network manager security configuration admin rule collection in a subscription.

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

Create a network manager security configuration admin rule collection.

az network manager security-admin-config rule-collection create --applies-to-groups
                                                                --configuration-name
                                                                --name
                                                                --resource-group
                                                                --rule-collection-name
                                                                [--description]
                                                                [--display-name]

Examples

Create security admin rule collections

az network manager security-admin-config rule-collection create --configuration-name "myTestSecurityConfig" --network-manager-name "testNetworkManager"  -g "rg1" --rule-collection-name "myTestCollection" --description "A sample description" --display-name "ASampleCollection" --applies-to-groups  network-group-id="/subscriptions/sub_id/resourceGroups/rgid/providers/Microsoft.Network/networkManagers/TestNetworkManager/networkGroups/TestNetworkGroup"

Required Parameters

--applies-to-groups

Groups for configuration.

--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

--description

A description for this rule. Restricted to 140 chars.

--display-name

A friendly name for 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 delete

Delete an admin rule collection.

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

Examples

Delete an admin rule collection.

az network manager security-admin-config rule-collection delete --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

--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 list

List network manager security configuration admin rule collections.

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

Examples

List security admin rule collections

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

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>.

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 show

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

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

Examples

Gets security admin rule collection

az network manager security-admin-config rule-collection show --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.

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 update

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

az network manager security-admin-config rule-collection update --configuration-name
                                                                --name
                                                                --resource-group
                                                                --rule-collection-name
                                                                [--add]
                                                                [--applies-to-groups]
                                                                [--description]
                                                                [--display-name]
                                                                [--force-string]
                                                                [--remove]
                                                                [--set]

Examples

Update security admin rule collection

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

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

--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>.

--applies-to-groups

Groups for configuration.

--description

A description for this rule. Restricted to 140 chars.

--display-name

A friendly name for the rule.

--force-string

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

--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=.

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.