次の方法で共有

az iot ops broker authz

Note

このリファレンスは、Azure CLI (バージョン 2.67.0 以降) の azure-iot-ops 拡張機能の一部です。 拡張機能は、 az iot ops broker authz コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

Mqtt ブローカーの承認管理。

コマンド

名前 説明 型 状態
az iot ops broker authz apply

mqtt ブローカー承認リソースを作成または置き換えます。

 Extension GA
az iot ops broker authz delete

Mqtt ブローカー承認リソースを削除します。

 Extension GA
az iot ops broker authz list

ブローカーに関連付けられている mqtt ブローカー承認リソースを一覧表示します。

 Extension GA
az iot ops broker authz show

Mqtt ブローカー承認リソースの詳細を表示します。

 Extension GA

az iot ops broker authz apply

mqtt ブローカー承認リソースを作成または置き換えます。

構成ファイル形式の例を次に示します。

{
    "authorizationPolicies": {
        "cache": "Enabled",
        "rules": [
            {
                "principals": {
                    "clientIds": [
                        "temperature-sensor",
                        "humidity-sensor"
                    ],
                    "attributes": [
                        {
                            "city": "seattle",
                            "organization": "contoso"
                        }
                    ]
                },
                "brokerResources": [
                    {
                        "method": "Connect"
                    },
                    {
                        "method": "Publish",
                        "topics": [
                            "/telemetry/{principal.clientId}",
                            "/telemetry/{principal.attributes.organization}"
                        ]
                    },
                    {
                        "method": "Subscribe",
                        "topics": [
                            "/commands/{principal.attributes.organization}"
                        ]
                    }
                ]
            }
        ]
    }
}

上記のコンテンツを適用して使用すると、単一の認証規則で構成されたターゲット承認リソースが作成または置き換えられます。

az iot ops broker authz apply --config-file
                              --instance
                              --name
                              --resource-group
                              [--broker]

例

構成ファイルを使用して、既定のブローカーの承認リソースを作成または置換します。

az iot ops broker authz apply -n authz --in myinstance -g myresourcegroup --config-file /path/to/authz/config.json

必須のパラメーター

--config-file

json 形式のリソース プロパティを含む構成ファイルへのパス。 構成ファイルには、リソースの ARM 表現と互換性のあるプロパティを持つオブジェクトが含まれている必要があります。 このオブジェクトは、ARM リソースの 'properties:{}' と直接関連付けられます。

プロパティ 値
Parameter group: Config Arguments
--instance -i

IoT Operations インスタンス名。

--name -n

Mqtt ブローカー承認リソース名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--broker -b

Mqtt ブローカー名。

プロパティ 値
規定値: default
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az iot ops broker authz delete

Mqtt ブローカー承認リソースを削除します。

az iot ops broker authz delete --instance
                               --name
                               --resource-group
                               [--broker]
                               [--yes {false, true}]

例

既定のブローカーに関連付けられている "authz" という mqtt ブローカー承認リソースを削除します。

az iot ops broker authz delete -n authz --in myinstance -g myresourcegroup

前の例と同じですが、確認プロンプトをスキップします。

az iot ops broker authz delete -n authz --in myinstance -g myresourcegroup -y

必須のパラメーター

--instance -i

IoT Operations インスタンス名。

--name -n

Mqtt ブローカー承認リソース名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--broker -b

Mqtt ブローカー名。

プロパティ 値
規定値: default
--yes -y

プロンプトなしで [y] es を確認します。 CI と自動化のシナリオに役立ちます。

プロパティ 値
指定可能な値: false, true
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az iot ops broker authz list

ブローカーに関連付けられている mqtt ブローカー承認リソースを一覧表示します。

az iot ops broker authz list --instance
                             --resource-group
                             [--broker]

例

既定のブローカーに関連付けられているすべての mqtt ブローカー承認リソースを列挙します。

az iot ops broker authz list --in myinstance -g myresourcegroup

必須のパラメーター

--instance -i

IoT Operations インスタンス名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--broker -b

Mqtt ブローカー名。

プロパティ 値
規定値: default
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az iot ops broker authz show

Mqtt ブローカー承認リソースの詳細を表示します。

az iot ops broker authz show --instance
                             --name
                             --resource-group
                             [--broker]

例

既定のブローカーに関連付けられている既定の承認リソースの詳細を表示します。

az iot ops broker authz show -n authz --in myinstance -g myresourcegroup

必須のパラメーター

--instance -i

IoT Operations インスタンス名。

--name -n

Mqtt ブローカー承認リソース名。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--broker -b

Mqtt ブローカー名。

プロパティ 値
規定値: default
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False