az network manager security-admin-config rule-collection

  • Reference

Note

This reference is part of the virtual-network-manager extension for the Azure CLI (version 2.51.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

Name Description Type Status
az network manager security-admin-config rule-collection create

Create a network manager security configuration admin rule collection.

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

Delete an admin rule collection.

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

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

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

Manage admin rule with network.

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

Create a network manager security configuration admin rule.

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

Delete an admin rule.

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

List all network manager security configuration admin rules.

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

Get a network manager security configuration admin rule.

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

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

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

Get a network manager security admin configuration rule collection.

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

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

 Extension GA
az network manager security-admin-config rule-collection wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

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]

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

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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]
                                                                [--force {0, 1, f, false, n, no, t, true, y, yes}]
                                                                [--ids]
                                                                [--name]
                                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                                [--resource-group]
                                                                [--rule-collection-name]
                                                                [--subscription]
                                                                [--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"

Optional Parameters

--configuration-name

The name of the network manager Security Configuration.

--force

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.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

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

The name of the network manager.

--no-wait

Do not wait for the long-running operation to finish.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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 network manager security Configuration rule collection.

--subscription

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

--yes -y

Do not prompt for confirmation.

default value: False
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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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 all the rule collections in a security admin configuration, in a paginated format.

az network manager security-admin-config rule-collection list --configuration-name
                                                              --name
                                                              --resource-group
                                                              [--max-items]
                                                              [--next-token]
                                                              [--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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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

Get a network manager security admin configuration rule collection.

az network manager security-admin-config rule-collection show [--configuration-name]
                                                              [--ids]
                                                              [--name]
                                                              [--resource-group]
                                                              [--rule-collection-name]
                                                              [--subscription]

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"

Optional Parameters

--configuration-name

The name of the network manager Security Configuration.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--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 network manager security Configuration rule collection.

--subscription

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

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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 --rule-collection-name
                                                                [--applies-to-groups]
                                                                [--configuration-name]
                                                                [--description]
                                                                [--ids]
                                                                [--name]
                                                                [--resource-group]
                                                                [--subscription]

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"

Required Parameters

--rule-collection-name

The name of the admin rule collection.

Optional Parameters

--applies-to-groups

Groups for configuration.

--configuration-name

The name of the network manager security Configuration.

--description

A description for this rule. Restricted to 140 chars.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

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

--subscription

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

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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 wait

Place the CLI in a waiting state until a condition is met.

az network manager security-admin-config rule-collection wait [--configuration-name]
                                                              [--created]
                                                              [--custom]
                                                              [--deleted]
                                                              [--exists]
                                                              [--ids]
                                                              [--interval]
                                                              [--name]
                                                              [--resource-group]
                                                              [--rule-collection-name]
                                                              [--subscription]
                                                              [--timeout]
                                                              [--updated]

Optional Parameters

--configuration-name

The name of the network manager Security Configuration.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

default value: 30
--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 network manager security Configuration rule collection.

--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False
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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.