你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az network-analytics data-product

参考

注意

此参考是 Azure CLI（版本 2.51.0 或更高版本）的网络分析扩展的一部分。该扩展将在首次运行 az network-analytics data-product 命令时自动安装。详细了解扩展。

Azure Operator Insights 数据产品操作。

命令

名称	说明	类型	状态
az network-analytics data-product add-user-role	向数据产品分配角色。	扩展	GA
az network-analytics data-product create	创建数据产品资源。	扩展	GA
az network-analytics data-product delete	删除数据产品资源。	扩展	GA
az network-analytics data-product list	按资源组列出数据产品。	扩展	GA
az network-analytics data-product list-roles-assignment	列出与数据产品关联的用户角色。	扩展	GA
az network-analytics data-product remove-user-role	从数据产品中删除角色。	扩展	GA
az network-analytics data-product show	获取数据产品资源。	扩展	GA
az network-analytics data-product wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA

az network-analytics data-product add-user-role

向数据产品分配角色。

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]

示例

添加用户角色

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

必需参数

--data-type-scope

创建角色分配的数据类型范围。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--principal-id

AAD 主体或安全组的对象 ID。

--principal-type

主体 ID 的类型：用户、组或 ServicePrincipal。

--role

要分配给用户的数据产品角色。

接受的值: Reader, SensitiveReader

--role-id

内置角色的角色 ID。

--user-name

用户名。

可选参数

--data-product-name

数据产品资源名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az network-analytics data-product create

创建数据产品资源。

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]

示例

使用所有参数创建数据产品

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"}'

必需参数

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

数据产品资源名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--encryption-key

数据产品的客户管理的加密密钥详细信息。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--identity

分配给此资源的托管服务标识。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--key-encryption-enable

为数据产品启用客户管理的密钥加密的标志。

接受的值: Disabled, Enabled

--location -l

未指定资源所在的地理位置，将使用资源组的位置。

--major-version

数据产品的主要版本。

--managed-rg

托管资源组配置。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--networkacls

数据产品的网络规则集。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--owners

与数据产品资源部署关联的名称或电子邮件列表。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--private-links-enabled

用于启用或禁用数据产品资源的专用链接的标志。

接受的值: Disabled, Enabled

--product

数据产品的产品名称。

--public-network-access

用于启用或禁用数据产品资源的公开访问的标志。

接受的值: Disabled, Enabled

--publisher

数据产品发布者名称。

--purview-account

要连接到的数据产品的 Purview 帐户 URL。

--purview-collection

要连接到的数据产品的 Purview 收集 URL。

--redundancy

用于启用或禁用数据产品的冗余的标志。

接受的值: Disabled, Enabled

--tags

资源标记。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az network-analytics data-product delete

删除数据产品资源。

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]

示例

删除 DP

az network-analytics data-product delete --name <dpname> --resource-group <rg>

可选参数

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

数据产品资源名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--yes -y

不提示确认。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az network-analytics data-product list

按资源组列出数据产品。

az network-analytics data-product list [--max-items]
                                       [--next-token]
                                       [--resource-group]

示例

列出所有 DP

az network-analytics data-product list

列出 RG 中的 DP

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

可选参数

--max-items

命令输出中要返回的项总数。如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。若要恢复分页，请在后续命令的参数中 --next-token 提供令牌值。

--next-token

用于指定开始分页的位置的令牌。这是先前截断的响应中的令牌值。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az network-analytics data-product list-roles-assignment

列出与数据产品关联的用户角色。

az network-analytics data-product list-roles-assignment [--data-product-name]
                                                        [--ids]
                                                        [--resource-group]
                                                        [--subscription]

示例

列出角色

az network-analytics data-product list-roles-assignment --data-product-name <dpname> --resource-group <rg>

可选参数

--data-product-name

数据产品资源名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az network-analytics data-product remove-user-role

从数据产品中删除角色。

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]

示例

删除用户角色

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

必需参数

--data-type-scope

创建角色分配的数据类型范围。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--principal-id

AAD 主体或安全组的对象 ID。

--principal-type

主体 ID 的类型：用户、组或 ServicePrincipal。

--role

要分配给用户的数据产品角色。

接受的值: Reader, SensitiveReader

--role-assignment-id

角色分配请求的 ID。

--role-id

内置角色的角色 ID。

--user-name

用户名。

可选参数

--data-product-name

数据产品资源名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az network-analytics data-product show

获取数据产品资源。

az network-analytics data-product show [--data-product-name]
                                       [--ids]
                                       [--resource-group]
                                       [--subscription]

示例

获取 DP

az network-analytics data-product show --name <dpname> --resource-group <rg>

可选参数

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

数据产品资源名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az network-analytics data-product wait

将 CLI 置于等待状态，直到满足条件。

az network-analytics data-product wait [--created]
                                       [--custom]
                                       [--data-product-name]
                                       [--deleted]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--resource-group]
                                       [--subscription]
                                       [--timeout]
                                       [--updated]

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

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

数据产品资源名称。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--interval

轮询间隔（以秒为单位）。

默认值: 30

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

通过

az network-analytics data-product

命令

az network-analytics data-product add-user-role

示例

必需参数

可选参数

az network-analytics data-product create

示例

必需参数

可选参数

az network-analytics data-product delete

示例

可选参数

az network-analytics data-product list

示例

可选参数

az network-analytics data-product list-roles-assignment

示例

可选参数

az network-analytics data-product remove-user-role

示例

必需参数

可选参数

az network-analytics data-product show

示例

可选参数

az network-analytics data-product wait

可选参数

其他资源