az network-analytics data-product
Note
This reference is part of the network-analytics extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az network-analytics data-product command. Learn more about extensions.
Azure Operator Insights Data Product operations.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az network-analytics data-product add-user-role |
Assign role to the data product. |
Extension | GA |
| az network-analytics data-product create |
Create data product resource. |
Extension | GA |
| az network-analytics data-product delete |
Delete data product resource. |
Extension | GA |
| az network-analytics data-product list |
List data products by resource group. |
Extension | GA |
| az network-analytics data-product list-roles-assignment |
List user roles associated with the data product. |
Extension | GA |
| az network-analytics data-product remove-user-role |
Remove role from the data product. |
Extension | GA |
| az network-analytics data-product show |
Get data product resource. |
Extension | GA |
| az network-analytics data-product wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az network-analytics data-product add-user-role
Assign role to the data product.
az network-analytics data-product add-user-role --data-type-scope
--principal-id
--principal-type
--role {Reader, SensitiveReader}
--role-id
--user-name
[--data-product-name]
[--ids]
[--resource-group]
[--subscription]Examples
Add User Role
az network-analytics data-product add-user-role --data-product-name <dpname> --resource-group <rgname> --data-type-scope " " --principal-id <userid> --principal-type user --role reader --role-id " " --user-name " "Required Parameters
Data Type Scope at which the role assignment is created. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Object ID of the AAD principal or security-group.
Type of the principal Id: User, Group or ServicePrincipal.
Data Product role to be assigned to a user.
Role Id of the Built-In Role.
User name.
Optional Parameters
The data product resource name.
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 of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az network-analytics data-product create
Create data product resource.
az network-analytics data-product create --data-product-name
--resource-group
[--encryption-key]
[--identity]
[--key-encryption-enable {Disabled, Enabled}]
[--location]
[--major-version]
[--managed-rg]
[--networkacls]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--owners]
[--private-links-enabled {Disabled, Enabled}]
[--product]
[--public-network-access {Disabled, Enabled}]
[--publisher]
[--purview-account]
[--purview-collection]
[--redundancy {Disabled, Enabled}]
[--tags]Examples
Create data product with all parameter
az network-analytics data-product create --name dpname --resource-group rgname --location westcentralus --publisher Microsoft --product MCC --major-version 2.0.0 --owners xyz@email --customer-managed-key-encryption-enabled Enabled --key-encryption-enable Enabled --encryption-key '{"keyVaultUri":"<vaulturi>","keyName":"<keyname>","keyVersion":"<version>"}' --managed-rg '{"location":"westcentralus","name":"<mrgname>"}' --networkacls '{"virtualNetworkRule":[{"id":"<ruleid>","action":"<action>","state":"<state>"}],"ipRules":[{"value":"<value>","action":"<action>"}],"allowedQueryIpRangeList":["1.2.3.4-1.2.3.10"],"defaultAction":"Allow"}' --private-links-enabled Enabled --public-network-access Enabled --purview-account perviewaccount --purview-collection collection --redundancy Enabled --identity '{"type":"userAssigned","userAssignedIdentities":{"/subscriptions/<subid>/resourceGroups/<rgname>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<idname>"}}' --tags '{"key1":"value1","key2":"value2"}'Required Parameters
The data product resource name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Customer managed encryption key details for data product. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The managed service identities assigned to this resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Flag to enable customer managed key encryption for data product.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Major version of data product.
Managed resource group configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Network rule set for data product. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
List of name or email associated with data product resource deployment. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Flag to enable or disable private link for data product resource.
Product name of data product.
Flag to enable or disable public access of data product resource.
Data product publisher name.
Purview account url for data product to connect to.
Purview collection url for data product to connect to.
Flag to enable or disable redundancy for data product.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az network-analytics data-product delete
Delete data product resource.
az network-analytics data-product delete [--data-product-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]Examples
Delete DP
az network-analytics data-product delete --name <dpname> --resource-group <rg>Optional Parameters
The data product resource name.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az network-analytics data-product list
List data products by resource group.
az network-analytics data-product list [--max-items]
[--next-token]
[--resource-group]Examples
List all DP
az network-analytics data-product listList DP in RG
az network-analytics data-product list --resource-group <rg>Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az network-analytics data-product list-roles-assignment
List user roles associated with the data product.
az network-analytics data-product list-roles-assignment [--data-product-name]
[--ids]
[--resource-group]
[--subscription]Examples
List roles
az network-analytics data-product list-roles-assignment --data-product-name <dpname> --resource-group <rg>Optional Parameters
The data product resource name.
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 of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az network-analytics data-product remove-user-role
Remove role from the data product.
az network-analytics data-product remove-user-role --data-type-scope
--principal-id
--principal-type
--role {Reader, SensitiveReader}
--role-assignment-id
--role-id
--user-name
[--data-product-name]
[--ids]
[--resource-group]
[--subscription]Examples
remove user role
az network-analytics data-product remove-user-role --data-product-name <dpname> --resource-group <rg> --data-type-scope " " --principal-id <userid> --principal-type user --role reader --role-id " " --user-name " " --role-assignment-id " "Required Parameters
Data Type Scope at which the role assignment is created. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Object ID of the AAD principal or security-group.
Type of the principal Id: User, Group or ServicePrincipal.
Data Product role to be assigned to a user.
Id of role assignment request.
Role Id of the Built-In Role.
User name.
Optional Parameters
The data product resource name.
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 of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az network-analytics data-product show
Get data product resource.
az network-analytics data-product show [--data-product-name]
[--ids]
[--resource-group]
[--subscription]Examples
Get DP
az network-analytics data-product show --name <dpname> --resource-group <rg>Optional Parameters
The data product resource name.
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 of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
az network-analytics data-product wait
Place the CLI in a waiting state until a condition is met.
az network-analytics data-product wait [--created]
[--custom]
[--data-product-name]
[--deleted]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
The data product resource name.
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
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.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for