Share via

az network perimeter logging-configuration

Note

This reference is part of the nsp extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az network perimeter logging-configuration command. Learn more about extensions.

Manage Network Security Perimeter Logging Configurations.

Commands

Name Description Type Status
az network perimeter logging-configuration create

Create a network security perimeter logging configuration.

 Extension GA
az network perimeter logging-configuration delete

Delete a network security perimeter logging configuration.

 Extension GA
az network perimeter logging-configuration list

List all network security perimeter logging configurations.

 Extension GA
az network perimeter logging-configuration show

Get a network security perimeter logging configuration.

 Extension GA
az network perimeter logging-configuration update

Cerate or update a network security perimeter logging configuration.

 Extension GA

az network perimeter logging-configuration create

Create a network security perimeter logging configuration.

az network perimeter logging-configuration create --perimeter-name
                                                  --resource-group
                                                  [--enabled-log-categories]
                                                  [--logging-configuration-name --name]
                                                  [--version]

Examples

Create a network security perimeter logging configuration

az network perimeter logging-configuration create --perimeter-name nsp1 --resource-group rg1 --enabled-log-categories "[NspPublicInboundPerimeterRulesDenied,NspPublicOutboundPerimeterRulesDenied]"

Required Parameters

--perimeter-name

The name of the network security perimeter.

--resource-group -g

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.

--enabled-log-categories

The log categories to enable in the NSP logging configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--logging-configuration-name --name -n

The name of the NSP logging configuration. Accepts 'instance' as name.

Property Value
Default value: instance
--version

The version of the NSP logging configuration.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network perimeter logging-configuration delete

Delete a network security perimeter logging configuration.

az network perimeter logging-configuration delete [--ids]
                                                  [--logging-configuration-name --name]
                                                  [--perimeter-name]
                                                  [--resource-group]
                                                  [--subscription]
                                                  [--yes]

Examples

Delete a network security perimeter logging configuration

az network perimeter logging-configuration delete --resource-group rg1 --perimeter-name nsp1

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Resource Id Arguments
--logging-configuration-name --name -n

The name of the NSP logging configuration. Accepts 'instance' as name.

Property Value
Parameter group: Resource Id Arguments
Default value: instance
--perimeter-name

The name of the network security perimeter.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network perimeter logging-configuration list

List all network security perimeter logging configurations.

az network perimeter logging-configuration list --perimeter-name
                                                --resource-group
                                                [--max-items]
                                                [--next-token]

Required Parameters

--perimeter-name

The name of the network security perimeter.

--resource-group -g

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.

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

Property Value
Parameter group: Pagination Arguments
--next-token

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

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network perimeter logging-configuration show

Get a network security perimeter logging configuration.

az network perimeter logging-configuration show [--ids]
                                                [--logging-configuration-name --name]
                                                [--perimeter-name]
                                                [--resource-group]
                                                [--subscription]

Examples

Get a network security perimeter logging configuration

az network perimeter logging-configuration show --resource-group rg1 --perimeter-name nsp1

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Resource Id Arguments
--logging-configuration-name --name -n

The name of the NSP logging configuration. Accepts 'instance' as name.

Property Value
Parameter group: Resource Id Arguments
Default value: instance
--perimeter-name

The name of the network security perimeter.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network perimeter logging-configuration update

Cerate or update a network security perimeter logging configuration.

az network perimeter logging-configuration update [--add]
                                                  [--enabled-log-categories]
                                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--ids]
                                                  [--logging-configuration-name --name]
                                                  [--perimeter-name]
                                                  [--remove]
                                                  [--resource-group]
                                                  [--set]
                                                  [--subscription]
                                                  [--version]

Examples

Update a network security perimeter logging configuration

az network perimeter logging-configuration update --perimeter-name nsp1 --resource-group rg1 --enabled-log-categories "[NspPublicInboundPerimeterRulesDenied,NspPublicOutboundPerimeterRulesDenied]"

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

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
--enabled-log-categories

The log categories to enable in the NSP logging configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--force-string

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

Property Value
Parameter group: Resource Id Arguments
--logging-configuration-name --name -n

The name of the NSP logging configuration. Accepts 'instance' as name.

Property Value
Parameter group: Resource Id Arguments
--perimeter-name

The name of the network security perimeter.

Property Value
Parameter group: Resource Id Arguments
--remove

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

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--subscription

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

The version of the NSP logging configuration.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False