MQTT データフロー エンドポイントを構成する

1. 操作エクスペリエンスで、[データフロー エンドポイント] を選択します。

2. 既定のエンドポイントを選択して、設定を表示または編集します。

   

既定のエンドポイントを編集するには、次の内容を含む Bicep .bicep ファイルを作成します。 必要に応じて設定を更新し、<AIO_INSTANCE_NAME> などのプレースホルダーの値を独自の値に置き換えます。

param aioInstanceName string = '<AIO_INSTANCE_NAME>'
param customLocationName string = '<CUSTOM_LOCATION_NAME>'

resource aioInstance 'Microsoft.IoTOperations/instances@2024-11-01' existing = {
  name: aioInstanceName
}
resource customLocation 'Microsoft.ExtendedLocation/customLocations@2021-08-31-preview' existing = {
  name: customLocationName
}
resource defaultMqttBrokerDataflowEndpoint 'Microsoft.IoTOperations/instances/dataflowEndpoints@2024-11-01' = {
  parent: aioInstance
  name: 'default'
  extendedLocation: {
    name: customLocation.id
    type: 'CustomLocation'
  }
  properties: {
    endpointType: 'Mqtt'
    mqttSettings: {
      host: 'aio-broker:18883'
      authentication: {
        method: 'ServiceAccountToken'
        serviceAccountTokenSettings: {
          audience: 'aio-internal'
        }
      }
      tls: {
        mode: 'Enabled'
        trustedCaCertificateConfigMapRef: 'azure-iot-operations-aio-ca-trust-bundle'
      }
    }
  }
}

次に、Azure CLI を使用してデプロイします。

az deployment group create --resource-group <RESOURCE_GROUP> --template-file <FILE>.bicep

Kubernetes クラスターでは、既定の MQTT ブローカー エンドポイント設定を表示できます。 設定を表示するには、次のコマンドを使用します。

kubectl get dataflowendpoint default -n azure-iot-operations -o yaml

1. 操作エクスペリエンスで、[データフロー エンドポイント] を選択します。

2. [新しいデータフロー エンドポイントの作成] で、[Azure IoT Operations ローカル MQTT]>[新規] を選びます。

   

   エンドポイントに関する次の設定を入力します。

   設定	内容
   Name	データフロー エンドポイントの名前。
   Host	MQTT ブローカーのホスト名とポート。 <hostname>:<port> という形式を使用します
   認証方法	認証に使用する方式。 サービス アカウント トークンまたは X509 証明書を選択する
   サービス対象ユーザー	サービス アカウント トークンの対象ユーザー。 サービス アカウント トークンを使用する場合に必要です。
   X509 クライアント証明書	認証に使用する X.509 クライアント証明書。 "X509 証明書" を使う場合に必要です。
   X509 クライアント キー	X.509 クライアント証明書に対応する秘密キー。 "X509 証明書" を使う場合に必要です。
   X509 中間証明書	X.509 クライアント証明書チェーンの中間証明書。 "X509 証明書" を使う場合に必要です。

param aioInstanceName string = '<AIO_INSTANCE_NAME>'
param customLocationName string = '<CUSTOM_LOCATION_NAME>'
param endpointName string = '<ENDPOINT_NAME>'
param mqttBrokerHostname string = '<HOSTNAME>:<PORT>'
param trustedCA string = '<TRUST_BUNDLE>'
param serviceAccountAudience string = '<SA_AUDIENCE>'

resource aioInstance 'Microsoft.IoTOperations/instances@2024-11-01' existing = {
  name: aioInstanceName
}
resource customLocation 'Microsoft.ExtendedLocation/customLocations@2021-08-31-preview' existing = {
  name: customLocationName
}
resource MqttBrokerDataflowEndpoint 'Microsoft.IoTOperations/instances/dataflowEndpoints@2024-11-01' = {
  parent: aioInstance
  name: endpointName
  extendedLocation: {
    name: customLocation.id
    type: 'CustomLocation'
  }
  properties: {
    endpointType: 'Mqtt'
    mqttSettings: {
      host: mqttBrokerHostname
      authentication: {
        method: 'ServiceAccountToken'
        serviceAccountTokenSettings: {
          audience: serviceAccountAudience
        }
      }
      tls: {
        mode: 'Enabled'
        trustedCaCertificateConfigMapRef: trustedCA
      }
    }
  }
}

apiVersion: connectivity.iotoperations.azure.com/v1
kind: DataflowEndpoint
metadata:
  name: <ENDPOINT_NAME>
  namespace: azure-iot-operations
spec:
  endpointType: Mqtt
  mqttSettings:
    host: "<HOSTNAME>:<PORT>"
    tls:
      mode: Enabled
      trustedCaCertificateConfigMapRef: <TRUST_BUNDLE>
    authentication:
      method: ServiceAccountToken
      serviceAccountTokenSettings:
        audience: <SA_AUDIENCE>

1. 操作エクスペリエンスで、[データフロー エンドポイント] タブを選択します。

2. [新しいデータフロー エンドポイントの作成] で、[Azure Event Grid MQTT]>[新規] を選びます。

   

   エンドポイントに関する次の設定を入力します。

   設定	内容
   Name	データフロー エンドポイントの名前。
   Host	Event Grid MQTT ブローカーのホスト名とポート。 <NAMESPACE>.<REGION>-1.ts.eventgrid.azure.net:8883 という形式を使用します
   認証方法	認証に使用する方式。 "システム割り当てマネージド ID" または "ユーザー割り当てマネージド ID" を選択することをお勧めします。

3. [適用] を選択してエンドポイントをプロビジョニングします。

次の内容を含む Bicep .bicep ファイルを作成します。

param aioInstanceName string = '<AIO_INSTANCE_NAME>'
param customLocationName string = '<CUSTOM_LOCATION_NAME>'
param endpointName string = '<ENDPOINT_NAME>'
param eventGridHostName string = '<NAMESPACE>.<REGION>-1.ts.eventgrid.azure.net:8883'

resource aioInstance 'Microsoft.IoTOperations/instances@2024-11-01' existing = {
  name: aioInstanceName
}
resource customLocation 'Microsoft.ExtendedLocation/customLocations@2021-08-31-preview' existing = {
  name: customLocationName
}
resource remoteMqttBrokerDataflowEndpoint 'Microsoft.IoTOperations/instances/dataflowEndpoints@2024-11-01' = {
  parent: aioInstance
  name: endpointName
  extendedLocation: {
    name: customLocation.id
    type: 'CustomLocation'
  }
  properties: {
    endpointType: 'Mqtt'
    mqttSettings: {
      host: eventGridHostName
      authentication: {
        // See available authentication methods section for method types
        // method: <METHOD_TYPE>
      }
      tls: {
        mode: 'Enabled'
      }
    }
  }
}

次に、Azure CLI を使用してデプロイします。

az deployment group create --resource-group <RESOURCE_GROUP> --template-file <FILE>.bicep

次の内容を含む Kubernetes マニフェスト .yaml ファイルを作成します。

apiVersion: connectivity.iotoperations.azure.com/v1
kind: DataflowEndpoint
metadata:
  name: <ENDPOINT_NAME>
  namespace: azure-iot-operations
spec:
  endpointType: Mqtt
  mqttSettings:
    host: <NAMESPACE>.<REGION>-1.ts.eventgrid.azure.net:8883
    authentication:
      # See available authentication methods section for method types
      # method: <METHOD_TYPE>
    tls:
      mode: Enabled

次に、このマニフェスト ファイルを Kubernetes クラスターに適用します。

kubectl apply -f <FILE>.yaml

1. 操作エクスペリエンスで、[データフロー エンドポイント] タブを選択します。

2. [新しいデータフロー エンドポイントの作成] で、[カスタム MQTT ブローカー]>[新規] を選びます。

   

3. エンドポイントに関する次の設定を入力します。

   設定	内容
   Name	データフロー エンドポイントの名前
   Host	<hostname>.<port> 形式での MQTT ブローカー エンドポイントのホスト名。
   認証方法	認証に使用する方式。 "サービス アカウント トークン" または "X509 証明書" を選択します。
   サービス対象ユーザー	サービス アカウント トークンの対象ユーザー。 サービス アカウント トークンを使用する場合に必要です。
   X509 クライアント証明書	認証に使用する X.509 クライアント証明書。 "X509 証明書" を使う場合に必要です。
   X509 クライアント キー	X.509 クライアント証明書に対応する秘密キー。 "X509 証明書" を使う場合に必要です。
   X509 中間証明書	X.509 クライアント証明書チェーンの中間証明書。 "X509 証明書" を使う場合に必要です。

4. [適用] を選択してエンドポイントをプロビジョニングします。

mqttSettings: {
  authentication: {
    // See available authentication methods section for method types
    // method: <METHOD_TYPE>
  }
  host: '<HOST>:<PORT>'
  tls: {
    mode: 'Enabled' // or 'Disabled'
    trustedCaCertificateConfigMapRef: '<TRUSTED_CA_CERT_CONFIGMAP>'
  }
}

spec:
  endpointType: Mqtt
  mqttSettings:
    host: <HOST>:<PORT>
    authentication:
      # See available authentication methods section for method types
      # method: <METHOD_TYPE>
    tls:
      mode: Enabled # or Disabled
      trustedCaCertificateConfigMapRef: <TRUSTED_CA_CERT_CONFIGMAP>

操作エクスペリエンスのデータフロー エンドポイント設定ページで、[基本] タブを選択し、[認証方法]>[システム割り当てマネージド ID] を選択します。

mqttSettings: {
  authentication: {
    method: 'SystemAssignedManagedIdentity'
    systemAssignedManagedIdentitySettings: {}
  }
}

mqttSettings:
  authentication:
    method: SystemAssignedManagedIdentity
    systemAssignedManagedIdentitySettings:
      {}

サポートされていません。

mqttSettings: {
  authentication: {
    method: 'SystemAssignedManagedIdentity'
    systemAssignedManagedIdentitySettings: {
      audience: 'https://<AUDIENCE>'
    }
  }
}

mqttSettings:
  authentication:
    method: SystemAssignedManagedIdentity
    systemAssignedManagedIdentitySettings:
      audience: https://<AUDIENCE>

Operations Experience のデータフロー エンドポイント設定ページで、[基本] タブを選択し、[認証方法]>[ユーザー割り当てマネージド ID] を選択します。

mqttSettings: {
  authentication: {
    method: 'UserAssignedManagedIdentity'
    userAssignedManagedIdentitySettings: {
      clientId: '<ID>'
      tenantId: '<ID>'
      // Optional, defaults to 'https://eventgrid.azure.net/.default'
      // scope: 'https://<SCOPE_URL>' 
    }
  }
}

mqttSettings:
  authentication:
    method: UserAssignedManagedIdentity
    userAssignedManagedIdentitySettings:
      clientId: <ID>
      tenantId: <ID>
      # Optional, defaults to 'https://eventgrid.azure.net/.default'
      # scope: https://<SCOPE_URL>

操作エクスペリエンスのデータフロー エンドポイント設定ページで、[基本] タブを選択し、[認証方法]>[サービス アカウント トークン] を選択します。

サービスの対象ユーザーを入力します。

mqttSettings: {
  authentication: {
    method: 'ServiceAccountToken'
    serviceAccountTokenSettings: {
      audience: '<YOUR_SERVICE_ACCOUNT_AUDIENCE>'
    }
  }
}

mqttSettings:
  authentication:
    method: ServiceAccountToken
    serviceAccountTokenSettings:
      audience: <YOUR_SERVICE_ACCOUNT_AUDIENCE>

Operations Experience のデータフロー エンドポイント設定ページで、[基本] タブを選択し、[認証方法]>[X509 証明書] を選択します。

ここで、[同期されたシークレット名] にシークレットの名前を入力します。 この名前は、データフロー エンドポイント設定でシークレットを参照するために使用されるものであり、Kubernetes クラスターに格納されているシークレットの名前です。

次に、[X509 クライアント証明書]、[X509 クライアント キー]、[X509 中間証明書] で、[参照の追加] を選択して証明書、秘密キー、中間証明書を追加します。 次のページで、Azure Key Vault のシークレットを選択し、Azure Key Vault から追加するか、シークレットを新規作成します。

[新規作成] を選択した場合は、次の設定を入力します。

シークレットの詳細については、「Azure IoT Operations でのシークレットの作成と管理」を参照してください。

mqttSettings: {
  authentication: {
    method: 'X509Certificate'
      x509CertificateSettings:
        secretRef: '<X509_SECRET_NAME>'
  }
}

mqttSettings:
  authentication:
    method: X509Certificate
    x509CertificateSettings:
      secretRef: <X509_SECRET_NAME>

Operations Experience のデータフロー エンドポイント設定ページで、[基本] タブを選択し、[認証方法]>[なし] を選択します。

mqttSettings: {
  authentication: {
    method: 'Anonymous'
  }
}

mqttSettings:
  authentication:
    method: Anonymous
    anonymousSettings:
      {}

Operations Experience で、データフロー エンドポイントの [詳細設定] タブを選択します。

// See sections below for explanation of each setting
mqttSettings: {
  qos: 1
  retain: 'Keep'
  sessionExpirySeconds: 3600
  keepAliveSeconds: 60
  maxInflightMessages: 100
  protocol: WebSockets
  clientIdPrefix: 'dataflow'
  cloudEventAttributes : 'Propagate' // or 'CreateOrRemap'
}

# See sections below for explanation of each setting
mqttSettings:
  qos: 1
  retain: Keep
  sessionExpirySeconds: 3600
  keepAliveSeconds: 60
  maxInflightMessages: 100
  protocol: WebSockets
  clientIdPrefix: dataflow
  cloudEventAttributes : Propagate # or CreateOrRemap

Operations Experience のデータフロー エンドポイント設定ページで、[詳細設定] タブを選択し、[TLS モードが有効] の横にあるチェックボックス使用します。

mqttSettings: {
  tls: {
    mode: 'Enabled' // or 'Disabled'
  }
}

mqttSettings:
  tls:
    mode: Enabled # or Disabled

Operations Experience のデータフロー エンドポイント設定ページで、[詳細設定] タブを選択し、[信頼された CA 証明書構成マップ] フィールドを使用して、信頼された CA 証明書を含む ConfigMap を指定します。

mqttSettings: {
  tls: {
    trustedCaCertificateConfigMapRef: '<YOUR_CA_CERTIFICATE>'
  }
}

mqttSettings:
  tls:
    trustedCaCertificateConfigMapRef: <YOUR_CA_CERTIFICATE>

操作エクスペリエンスのデータフロー エンドポイント設定ページで、[詳細設定] タブを選択し、[クライアント ID プレフィックス] フィールドを使用してプレフィクスを指定します。

mqttSettings: {
  clientIdPrefix: '<YOUR_PREFIX>'
}

mqttSettings:
  clientIdPrefix: <YOUR_PREFIX>

操作エクスペリエンスのデータフロー エンドポイント設定ページで、[詳細設定] タブを選択し、[サービスの品質 (QoS)] フィールドを使用して QoS レベルを指定します。

mqttSettings: {
  qos: 1 // Or 0
}

mqttSettings:
  qos: 1 # Or 0

操作エクスペリエンスのデータフロー エンドポイント設定ページで、[詳細設定] タブを選択し、[保持] フィールドを使用して保持設定を指定します。

mqttSettings: {
  retain: Keep // or Never
}

mqttSettings:
  retain: Keep # or Never

操作エクスペリエンスのデータフロー エンドポイント設定ページで、[詳細設定] タブを選択し、[セッションの有効期間] フィールドを使用してセッションの有効期間間隔を指定します。

mqttSettings: {
  sessionExpirySeconds: 600
}

mqttSettings:
  sessionExpirySeconds: 600

操作エクスペリエンスのデータフロー エンドポイント設定ページで、[詳細設定] タブを選択し、[プロトコル] フィールドを使用してプロトコルを指定します。

mqttSettings: {
  protocol: 'WebSockets'
}

mqttSettings:
  protocol: WebSockets

操作エクスペリエンスのデータフロー エンドポイント設定ページで、[詳細設定] タブを選択し、[配信中のメッセージの最大数] フィールドを使用して配信中のメッセージの最大数を指定します。

mqttSettings: {
  maxInflightMessages: 100
}

mqttSettings:
  maxInflightMessages: 100

操作エクスペリエンスのデータフロー エンドポイント設定ページで、[詳細設定] タブを選択し、[キープ アライブ] フィールドを使用してキープ アライブ間隔を指定します。

mqttSettings: {
  keepAliveSeconds: 60
}

mqttSettings:
  keepAliveSeconds: 60

操作エクスペリエンスのデータフロー エンドポイント設定ページで、[詳細設定] タブを選択し、クラウド イベント属性] フィールドを使用して CloudEvents 設定を指定します。

mqttSettings: {
  cloudEventAttributes : 'Propagate' // or 'CreateOrRemap'
}

mqttSettings:
  cloudEventAttributes : Propagate # or CreateOrRemap