az iot ops broker authn method

Note

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

Mqtt ブローカー認証メソッドの操作。

コマンド

名前 説明 状態
az iot ops broker authn method add

Mqtt ブローカー認証リソースに認証方法を追加します。

Extension GA

az iot ops broker authn method add

Mqtt ブローカー認証リソースに認証方法を追加します。

これは add メソッドです。 ターゲット認証リソースが存在しない場合は、コマンドによって作成されます。

az iot ops broker authn method add --authn
                                   --instance
                                   --resource-group
                                   [--acquire-policy-token]
                                   [--broker]
                                   [--change-reference]
                                   [--custom-ca-ref]
                                   [--custom-ep]
                                   [--custom-header]
                                   [--custom-x509-secret-ref]
                                   [--sat-aud]
                                   [--show-config {false, true}]
                                   [--x509-attr]
                                   [--x509-client-ca-ref]

SAT 認証方法を構成し、既存の既定の認証リソースに追加します。

az iot ops broker authn method add --authn default --in myinstance -g myresourcegroup --sat-aud my-audience1 my-audience2

x509 認証方法を構成し、新しく作成した認証リソースに追加します。

az iot ops broker authn method add --authn myauthn --in myinstance -g myresourcegroup --x509-client-ca-ref client-ca --x509-attr root.subject='CN = Contoso Root CA Cert, OU = Engineering, C = US' root.attributes.organization=contoso --x509-attr intermediate.subject='CN = Contoso Intermediate CA' intermediate.attributes.city=seattle intermediate.attributes.foo=bar --x509-attr smartfan.subject='CN = smart-fan' smartfan.attributes.building=17

カスタム認証サービスの認証方法を構成し、新しく作成した認証リソースに追加します。

az iot ops broker authn method add --authn myauthn --in myinstance -g myresourcegroup --custom-ep https://myauthserver --custom-ca-ref myconfigmap --custom-x509-secret-ref mysecret --custom-header a=b c=d

既存の認証リソースに 2 つの個別の認証方法を構成して追加します。

az iot ops broker authn method add --authn myexistingauthn --in myinstance -g myresourcegroup --sat-aud my-audience1 my-audience2 --x509-client-ca-ref client-ca

必須のパラメーター

--authn -n

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

--instance -i

IoT Operations インスタンス名。

--resource-group -g

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

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ
パラメーター グループ: Global Policy Arguments
--broker -b

Mqtt ブローカー名。

プロパティ
規定値: default
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ
パラメーター グループ: Global Policy Arguments
--custom-ca-ref

カスタム認証サーバーの証明書を検証するための CA 証明書を含む configmap の名前。

プロパティ
パラメーター グループ: Custom Arguments
--custom-ep

カスタム認証サービスに使用するエンドポイント。 形式は https://.* です。

プロパティ
パラメーター グループ: Custom Arguments
--custom-header

カスタム認証サーバーに渡す HTTP ヘッダー。 形式はスペース区切りのキーと値のペアです。 1 回以上使用できます。

プロパティ
パラメーター グループ: Custom Arguments
--custom-x509-secret-ref

クライアント証明書を含む Kubernetes シークレットへの参照。

プロパティ
パラメーター グループ: Custom Arguments
--sat-aud

許可対象ユーザーのスペース区切りのリスト。

プロパティ
パラメーター グループ: SAT Arguments
--show-config

API を呼び出す代わりに、生成されたリソース構成を表示します。

プロパティ
指定可能な値: false, true
--x509-attr

証明書のプロパティに基づいてクライアントを承認するための属性を認証リソースで指定します。 これらの属性を持つ x509 証明書を使用して、承認規則をクライアントに適用できます。 書式はスペース区切りのキーと値のペアで、キーは 'a.b.c=value' などのオブジェクトドット表記を使用します。 1 回以上使用できます。

プロパティ
パラメーター グループ: x509 Arguments
--x509-client-ca-ref

信頼されたクライアント ca 証明書リソースを含む configmap の名前。 既定値は 'client-ca' です。

プロパティ
パラメーター グループ: x509 Arguments
グローバル パラメーター
--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