az network-analytics data-product

Note

このリファレンスは、Azure CLI (バージョン 2.51.0 以降) のネットワーク分析拡張機能の一部です。 拡張機能は、az network-analytics data-product コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

Azure Operator インサイト Data Product 操作。

コマンド

名前	説明	型	Status
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 の種類: User、Group、または ServicePrincipal。

--role

ユーザーに割り当てられるデータ製品ロール。

承認された値: Reader, SensitiveReader

--role-id

組み込みロールのロール ID。

--user-name

ユーザー名。

省略可能のパラメーター

--data-product-name

データ製品リソース名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource 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

このリソースに割り当てられているマネージド サービス ID。 短縮構文、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

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource 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

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource 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 の種類: User、Group、または ServicePrincipal。

--role

ユーザーに割り当てられるデータ製品ロール。

承認された値: Reader, SensitiveReader

--role-assignment-id

ロールの割り当て要求の ID。

--role-id

組み込みロールのロール ID。

--user-name

ユーザー名。

省略可能のパラメーター

--data-product-name

データ製品リソース名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource 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

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource 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

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

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

データ製品リソース名。

--deleted

削除されるまで待ちます。

既定値: False

--exists

リソースが存在するまで待ちます。

既定値: False

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource 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 を使います。