Share via

az network manager security-admin-config

  • Reference

Note

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

Manage security admin configuration with network.

Commands

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

Create a network manager security admin configuration.

 Extension GA
az network manager security-admin-config delete

Delete a network manager security admin configuration.

 Extension GA
az network manager security-admin-config list

List all the network manager security admin configurations in a network manager, in a paginated format.

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

Manage admin rule collection with network.

 Extension GA
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 show

Get a network manager security admin configuration.

 Extension GA
az network manager security-admin-config update

Update a network manager security admin configuration.

 Extension GA
az network manager security-admin-config wait

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

 Extension GA

az network manager security-admin-config create

Create a network manager security admin configuration.

az network manager security-admin-config create --configuration-name
                                                --name
                                                --resource-group
                                                [--aggregation {Manual, None}]
                                                [--apply-on]
                                                [--description]

Examples

Create a network manager security admin configuration.

az network manager security-admin-config create --configuration-name "myTestSecurityConfig" --network-manager-name "TestNetworkManager" --resource-group "rg1" --description "A sample policy" --apply-on None

Required Parameters

--configuration-name

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

--aggregation --network-group-address-space-aggregation-option

Determine update behavior for changes to network groups referenced within the rules in this configuration.

Accepted values: Manual, None
--apply-on --apply-on-network-intent-policy

Enum list of network intent policy based services. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--description

Description of the security configuration.

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 delete

Delete a network manager security admin configuration.

az network manager security-admin-config 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]
                                                [--subscription]
                                                [--yes]

Examples

Delete a network manager security admin configuration.

az network manager security-admin-config delete --configuration-name "myTestSecurityConfig" --network-manager-name "testNetworkManager" --resource-group "rg1" --force n

Optional Parameters

--configuration-name

Name of the network manager security configuration.

--force

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

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

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

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

List all the network manager security admin configurations in a network manager, in a paginated format.

az network manager security-admin-config list --name
                                              --resource-group
                                              [--max-items]
                                              [--next-token]
                                              [--skip-token]
                                              [--top]

Examples

List security admin configurations in a network manager.

az network manager security-admin-config list --network-manager-name "testNetworkManager" --resource-group "rg1"

Required Parameters

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

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

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

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 show

Get a network manager security admin configuration.

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

Examples

Get a security admin configuration.

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

Optional Parameters

--configuration-name

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

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 update

Update a network manager security admin configuration.

az network manager security-admin-config update [--add]
                                                [--aggregation {Manual, None}]
                                                [--apply-on]
                                                [--configuration-name]
                                                [--description]
                                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--ids]
                                                [--name]
                                                [--remove]
                                                [--resource-group]
                                                [--set]
                                                [--subscription]

Examples

Update a network manager security admin configuration.

az network manager security-admin-config update --configuration-name "myTestSecurityConfig" --network-manager-name "TestNetworkManager" --resource-group "rg1" --description "A sample policy" --apply-on None

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

--aggregation --network-group-address-space-aggregation-option

Determine update behavior for changes to network groups referenced within the rules in this configuration.

Accepted values: Manual, None
--apply-on --apply-on-network-intent-policy

Enum list of network intent policy based services. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--configuration-name

Name of the network manager security configuration.

--description

Description of the security configuration.

--force-string

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

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.

--remove

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

--resource-group -g

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

--set

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

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

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

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

Optional Parameters

--configuration-name

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

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.

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