Interface IOrganizationSensorMqttBrokers

Namespace

Meraki.Api.Interfaces.Products.Sensor

Assembly

Meraki.Api.dll

public interface IOrganizationSensorMqttBrokers

Methods

GetNetworkSensorMqttBrokerAsync(string, string, CancellationToken)

Return the sensor settings of an MQTT broker

[Get("/networks/{networkId}/sensor/mqttBrokers/{mqttBrokerId}")]
Task<SensorMqttBroker> GetNetworkSensorMqttBrokerAsync(string networkId, string mqttBrokerId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

mqttBrokerId string

The broker id

cancellationToken CancellationToken

Returns

Task<SensorMqttBroker>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkSensorMqttBrokersAsync(string, CancellationToken)

List the sensor settings of all MQTT brokers for this network.

[Get("/networks/{networkId}/sensor/mqttBrokers")]
Task<List<SensorMqttBroker>> GetNetworkSensorMqttBrokersAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task<List<SensorMqttBroker>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkSensorMqttBrokerAsync(string, string, SensorMqttBrokerUpdate, CancellationToken)

Update the sensor settings of an MQTT broker.

[Put("/networks/{networkId}/sensor/mqttBrokers/{mqttBrokerId}")]
Task<SensorMqttBroker> UpdateNetworkSensorMqttBrokerAsync(string networkId, string mqttBrokerId, SensorMqttBrokerUpdate sensorMqttUpdate, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

mqttBrokerId string

The broker id

sensorMqttUpdate SensorMqttBrokerUpdate

Body for updating a SensorMqttBroker

cancellationToken CancellationToken

Returns

Task<SensorMqttBroker>

Exceptions

ApiException

Thrown when fails to make API call