az network manager security-admin-config
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 --config --config-name --configuration-name
--manager-name --name --network-manager-name
--resource-group
[--aggregation --network-group-address-space-aggregation-option {Manual, None}]
[--apply-on --apply-on-network-intent-policy]
[--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
Name of the network manager security configuration.
The name of the network manager.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Determine update behavior for changes to network groups referenced within the rules in this configuration.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | Manual, None |
Enum list of network intent policy based services. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Description of the security configuration.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az network manager security-admin-config delete
Delete a network manager security admin configuration.
az network manager security-admin-config delete [--config --config-name --configuration-name]
[--force {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--manager-name --name --network-manager-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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of the network manager security configuration.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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.
Property | Value |
---|---|
Default value: | False |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of the network manager.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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 --manager-name --name --network-manager-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 of the network manager.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property | Value |
---|---|
Parameter group: | Pagination Arguments |
Token to specify where to start paginating. This is the token value from a previously truncated response.
Property | Value |
---|---|
Parameter group: | Pagination Arguments |
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.
Optional query parameter which specifies the maximum number of records to be returned by the server.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az network manager security-admin-config show
Get a network manager security admin configuration.
az network manager security-admin-config show [--config --config-name --configuration-name]
[--ids]
[--manager-name --name --network-manager-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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of the network manager security configuration.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of the network manager.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az network manager security-admin-config update
Update a network manager security admin configuration.
az network manager security-admin-config update [--add]
[--aggregation --network-group-address-space-aggregation-option {Manual, None}]
[--apply-on --apply-on-network-intent-policy]
[--config --config-name --configuration-name]
[--description]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--manager-name --name --network-manager-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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Determine update behavior for changes to network groups referenced within the rules in this configuration.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | Manual, None |
Enum list of network intent policy based services. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name of the network manager security configuration.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Description of the security configuration.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The name of the network manager.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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 [--config --config-name --configuration-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--manager-name --name --network-manager-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of the network manager security configuration.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Wait until created with 'provisioningState' at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Wait until deleted.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Wait until the resource exists.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Polling interval in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 30 |
Name of the network manager.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Maximum wait in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |