az iot ops broker authn

Note

This reference is part of the azure-iot-ops extension for the Azure CLI (version 2.62.0 or higher). 拡張機能は、 az iot ops broker authn コマンドを初めて実行するときに自動的にインストールされます。 Learn more about extensions.

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

コマンド

名前	説明	型	状態
az iot ops broker authn apply	Mqtt ブローカー認証リソースを作成または置き換えます。	Extension	GA
az iot ops broker authn delete	Mqtt ブローカー認証リソースを削除します。	Extension	GA
az iot ops broker authn list	ブローカーに関連付けられている mqtt ブローカー認証リソースを一覧表示します。	Extension	GA
az iot ops broker authn method	Mqtt ブローカー認証メソッドの操作。	Extension	GA
az iot ops broker authn method add	Mqtt ブローカー認証リソースに認証方法を追加します。	Extension	GA
az iot ops broker authn show	Mqtt ブローカー認証リソースの詳細を表示します。	Extension	GA

az iot ops broker authn apply

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

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

{
    "authenticationMethods": [
        {
            "method": "Custom",
            "customSettings": {
                "endpoint": "https://auth-server-template",
                "caCertConfigMap": "custom-auth-ca",
                "auth": {
                    "x509": {
                        "secretRef": "custom-auth-client-cert"
                    }
                },
                "headers": {
                    "header_key": "header_value"
                }
            }
        },
        {
            "method": "ServiceAccountToken",
            "serviceAccountTokenSettings": {
                "audiences": [
                    "aio-internal",
                    "my-audience"
                ]
            }
        },
        {
            "method": "X509",
            "x509Settings": {
                "trustedClientCaCert": "client-ca",
                "authorizationAttributes": {
                    "root": {
                        "attributes": {
                            "organization": "contoso"
                        },
                        "subject": "CN = Contoso Root CA Cert, OU = Engineering, C = US"
                    },
                    "intermediate": {
                        "attributes": {
                            "city": "seattle",
                            "foo": "bar"
                        },
                        "subject": "CN = Contoso Intermediate CA"
                    },
                    "smartfan": {
                        "attributes": {
                            "building": "17"
                        },
                        "subject": "CN = smart-fan"
                    }
                }
            }
        }
    ]
}

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

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

例

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

az iot ops broker authn apply -n authn --in myinstance -g myresourcegroup --config-file /path/to/authn/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

Output format.

プロパティ	値
規定値:	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 authn delete

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

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

例

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

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

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

az iot ops broker authn delete -n authn --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

Output format.

プロパティ	値
規定値:	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 authn list

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

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

例

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

az iot ops broker authn 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

Output format.

プロパティ	値
規定値:	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 authn show

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

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

例

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

az iot ops broker authn show -n authn --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

Output format.

プロパティ	値
規定値:	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