az neuroshield
Note
This reference is part of the neuroshield extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az neuroshield command. Learn more about extensions.
Manage Neuro Shield.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az neuroshield create |
Create a NeuroShield resource. |
Extension | GA |
| az neuroshield delete |
Delete a NeuroShield resource. |
Extension | GA |
| az neuroshield finding |
Manage Finding. |
Extension | GA |
| az neuroshield finding list |
List findings across all protected resources under a NeuroShield resource. |
Extension | GA |
| az neuroshield list |
List all NeuroShield resources in a subscription. |
Extension | GA |
| az neuroshield mitigation |
Manage Mitigation. |
Extension | GA |
| az neuroshield mitigation list |
List mitigations across all protected resources under a NeuroShield resource. |
Extension | GA |
| az neuroshield operation-status |
Manage Neuro Shield Operation Status. |
Extension | GA |
| az neuroshield operation-status show |
Get the status of an asynchronous NeuroShield operation. |
Extension | GA |
| az neuroshield protected-resource |
Manage Protected Resource. |
Extension | GA |
| az neuroshield protected-resource create |
Create a protected resource under a NeuroShield resource. |
Extension | GA |
| az neuroshield protected-resource delete |
Delete a protected resource under a NeuroShield resource. |
Extension | GA |
| az neuroshield protected-resource finding |
Manage Finding. |
Extension | GA |
| az neuroshield protected-resource finding list |
List findings under a protected resource. |
Extension | GA |
| az neuroshield protected-resource finding mitigate |
Triggers mitigation for all awaiting-approval mitigations under a finding. |
Extension | GA |
| az neuroshield protected-resource finding rollback |
Rolls back succeeded rollbackable mitigations under a finding. |
Extension | GA |
| az neuroshield protected-resource finding show |
Get a finding under a protected resource. |
Extension | GA |
| az neuroshield protected-resource list |
List all protected resources under a NeuroShield resource. |
Extension | GA |
| az neuroshield protected-resource mitigation |
Manage Mitigation. |
Extension | GA |
| az neuroshield protected-resource mitigation execute |
Approves and queues a mitigation for execution. |
Extension | GA |
| az neuroshield protected-resource mitigation list |
List mitigations under a protected resource. |
Extension | GA |
| az neuroshield protected-resource mitigation rollback |
Rolls back a mitigation when rollback is available. |
Extension | GA |
| az neuroshield protected-resource mitigation show |
Get a mitigation under a protected resource. |
Extension | GA |
| az neuroshield protected-resource show |
Get a protected resource under a NeuroShield resource. |
Extension | GA |
| az neuroshield protected-resource trigger-inventory-upload |
Requests a fresh inventory upload from the Neuron agents associated with a protected resource. |
Extension | GA |
| az neuroshield protected-resource wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az neuroshield show |
Get a NeuroShield resource. |
Extension | GA |
| az neuroshield summary |
Manage Summary. |
Extension | GA |
| az neuroshield summary list |
List the aggregate fleet overview singleton for a NeuroShield resource. |
Extension | GA |
| az neuroshield summary show |
Get the aggregate fleet overview singleton for a NeuroShield resource. |
Extension | GA |
| az neuroshield update |
Update a NeuroShield resource. |
Extension | GA |
az neuroshield create
Create a NeuroShield resource.
az neuroshield create --name --neuroshield-name
--resource-group
--response-mode {Auto, Manual}
[--acquire-policy-token]
[--change-reference]
[--description]
[--if-match]
[--location]
[--severity-threshold {Critical, High, Low, Medium}]
[--tags]
Examples
Create or update NeuroShield resource
az neuroshield create --resource-group myResourceGroup --neuroshield-name myNeuroShield --location eastus2 --tags "{env:test}" --response-mode Manual --severity-threshold Medium --description Test NeuroShield resource
Create or update NeuroShield with omitted optional properties
az neuroshield create --resource-group myResourceGroup --neuroshield-name myNeuroShield --location eastus2 --response-mode Manual
Required Parameters
The name of the NeuroShield resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Response mode that controls mitigation serving behavior. A full create or update (PUT) request must specify Auto or Manual; there is no default. Omitting responseMode from a PATCH request preserves the existing mode.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Auto, Manual |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Human-readable description of the NeuroShield resource. Omission in a full PUT request resolves to an empty string. Control characters other than tab, line feed, and carriage return are not allowed.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The entity tag that makes the request conditional.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
| Property | Value |
|---|---|
| Parameter group: | Resource Arguments |
Minimum severity level for mitigation generation. Omission in a full PUT request resolves to Low; omission in PATCH preserves the value.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Critical, High, Low, Medium |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Resource 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.
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 neuroshield delete
Delete a NeuroShield resource.
az neuroshield delete [--acquire-policy-token]
[--change-reference]
[--ids]
[--name --neuroshield-name]
[--resource-group]
[--subscription]
[--yes]
Examples
Delete NeuroShield resource
az neuroshield delete --resource-group myResourceGroup --neuroshield-name myNeuroShield
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy 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 |
The name of the NeuroShield resource.
| 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 |
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 neuroshield list
List all NeuroShield resources in a subscription.
az neuroshield list [--max-items]
[--next-token]
[--resource-group]
[--skip-token]
[--top]
Examples
List NeuroShield resources by subscription
az neuroshield list
List NeuroShield resources by resource group
az neuroshield list --resource-group myResourceGroup
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 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The continuation token used to retrieve the next page.
The maximum number of items to return.
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 neuroshield show
Get a NeuroShield resource.
az neuroshield show [--ids]
[--name --neuroshield-name]
[--resource-group]
[--subscription]
Examples
Get NeuroShield resource
az neuroshield show --resource-group myResourceGroup --neuroshield-name myNeuroShield
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 NeuroShield resource.
| 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 neuroshield update
Update a NeuroShield resource.
az neuroshield update [--acquire-policy-token]
[--add]
[--change-reference]
[--description]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--if-match]
[--name --neuroshield-name]
[--remove]
[--resource-group]
[--response-mode {Auto, Manual}]
[--set]
[--severity-threshold {Critical, High, Low, Medium}]
[--subscription]
[--tags]
Examples
Update the response mode and severity threshold of a NeuroShield
az neuroshield update -g myResourceGroup -n myNeuroShield --response-mode Manual --severity-threshold Medium
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
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 |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Human-readable description of the NeuroShield resource. Omission in a full PUT request resolves to an empty string. Control characters other than tab, line feed, and carriage return are not allowed.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
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 entity tag that makes the request conditional.
The name of the NeuroShield resource.
| 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 |
Response mode that controls mitigation serving behavior. A full create or update (PUT) request must specify Auto or Manual; there is no default. Omitting responseMode from a PATCH request preserves the existing mode.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Auto, Manual |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.
| Property | Value |
|---|---|
| Parameter group: | Generic Update Arguments |
Minimum severity level for mitigation generation. Omission in a full PUT request resolves to Low; omission in PATCH preserves the value.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Critical, High, Low, Medium |
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 |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Resource 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 |