Share via


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

Data Type Scope at which the role assignment is created. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--principal-id

Object ID of the AAD principal or security-group.

--principal-type

Type of the principal Id: User, Group or ServicePrincipal.

--role

Data Product role to be assigned to a user.

Accepted values: Reader, SensitiveReader
--role-id

Role Id of the Built-In Role.

--user-name

User name.

Optional Parameters

--data-product-name

The data product resource name.

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

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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.

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

--data-product-name --name -n

The data product resource name.

--resource-group -g

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

Optional Parameters

--encryption-key

Customer managed encryption key details for data product. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--identity

The managed service identities assigned to this resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--key-encryption-enable

Flag to enable customer managed key encryption for data product.

Accepted values: Disabled, Enabled
--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--major-version

Major version of data product.

--managed-rg

Managed resource group configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--networkacls

Network rule set for data product. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--owners

List of name or email associated with data product resource deployment. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--private-links-enabled

Flag to enable or disable private link for data product resource.

Accepted values: Disabled, Enabled
--product

Product name of data product.

--public-network-access

Flag to enable or disable public access of data product resource.

Accepted values: Disabled, Enabled
--publisher

Data product publisher name.

--purview-account

Purview account url for data product to connect to.

--purview-collection

Purview collection url for data product to connect to.

--redundancy

Flag to enable or disable redundancy for data product.

Accepted values: Disabled, Enabled
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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.

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

--data-product-name --name -n

The data product resource name.

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

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False
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.

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

List DP in RG

az network-analytics data-product list --resource-group <rg>

Optional Parameters

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

--next-token

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

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

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

--data-product-name

The data product resource name.

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

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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.

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

Data Type Scope at which the role assignment is created. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--principal-id

Object ID of the AAD principal or security-group.

--principal-type

Type of the principal Id: User, Group or ServicePrincipal.

--role

Data Product role to be assigned to a user.

Accepted values: Reader, SensitiveReader
--role-assignment-id

Id of role assignment request.

--role-id

Role Id of the Built-In Role.

--user-name

User name.

Optional Parameters

--data-product-name

The data product resource name.

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

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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.

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

--data-product-name --name -n

The data product resource name.

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

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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.

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--data-product-name --name -n

The data product resource name.

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--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.

--interval

Polling interval in seconds.

Default value: 30
--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
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.

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