az network manager security-user-config

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

Manage securityuserconfiguration with network.

Commands

az network manager security-user-config create	Create a network manager security user Configuration.
az network manager security-user-config delete	Deletes a network manager security user Configuration.
az network manager security-user-config list	Lists all the network manager security user configurations in a network manager, in a paginated format.
az network manager security-user-config show	Retrieves a network manager security user Configuration.
az network manager security-user-config update	Update a network manager security user Configuration.

az network manager security-user-config create

Create a network manager security user Configuration.

az network manager security-user-config create --configuration-name
                                               --name
                                               --resource-group
                                               [--delete-existing-ns-gs {false, true}]
                                               [--description]
                                               [--display-name]

Examples

Create network manager security user Configuration

az network manager security-user-config create --configuration-name "myTestSecurityConfig" --network-manager-name "testNetworkManager" --resource-group "rg1" --description "A sample policy" --delete-existing-ns-gs true

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

--delete-existing-ns-gs

Flag if need to delete existing network security groups.

accepted values: false, true

--description

A description of the security Configuration.

--display-name

A display name 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.

--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-user-config delete

Deletes a network manager security user Configuration.

az network manager security-user-config delete --configuration-name
                                               --name
                                               --resource-group
                                               [--yes]

Examples

Delete network manager security user Configuration

az network manager security-user-config delete --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

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

Lists all the network manager security user configurations in a network manager, in a paginated format.

az network manager security-user-config list --name
                                             --resource-group
                                             [--skip-token]
                                             [--top]

Examples

List security user configurations in a network manager

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

Required Parameters

--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-user-config show

Retrieves a network manager security user Configuration.

az network manager security-user-config show --configuration-name
                                             --name
                                             --resource-group

Examples

Get security user configurations

az network manager security-user-config show --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>.

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-user-config update

Update a network manager security user Configuration.

az network manager security-user-config update --configuration-name
                                               --name
                                               --resource-group
                                               [--add]
                                               [--delete-existing-ns-gs {false, true}]
                                               [--description]
                                               [--display-name]
                                               [--force-string]
                                               [--remove]
                                               [--security-type {AdminPolicy, UserPolicy}]
                                               [--set]

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

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

--delete-existing-ns-gs

Flag if need to delete existing network security groups.

accepted values: false, true

--description

A description of the security Configuration.

--display-name

A display name of the security Configuration.

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

--security-type

Security Type.

accepted values: AdminPolicy, UserPolicy

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