Interface INetworksMqttBrokers

Namespace

Meraki.Api.Interfaces.General.Networks

Assembly

Meraki.Api.dll

Admins interface

public interface INetworksMqttBrokers

Methods

CreateNetworkMqttBrokerAsync(string, MqttBrokerCreateUpdateRequest, CancellationToken)

Add an MQTT broker

[Post("/networks/{networkId}/mqttBrokers")]
Task<MqttBroker> CreateNetworkMqttBrokerAsync(string networkId, MqttBrokerCreateUpdateRequest createNetworkMqttBroker, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

createNetworkMqttBroker MqttBrokerCreateUpdateRequest

Body for adding an MQTT broker

cancellationToken CancellationToken

Returns

Task<MqttBroker>

Exceptions

ApiException

Thrown when fails to make API call

DeleteNetworkMqttBrokerAsync(string, string, CancellationToken)

Delete an MQTT broker

[Delete("/networks/{networkId}/mqttBrokers/{mqttBrokerId}")]
Task DeleteNetworkMqttBrokerAsync(string networkId, string mqttBrokerId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

mqttBrokerId string

The MQTT broker id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkMqttBrokerAsync(string, string, CancellationToken)

Return an MQTT broker

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

Parameters

networkId string

The network id

mqttBrokerId string

The MQTT broker id

cancellationToken CancellationToken

Returns

Task<MqttBroker>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkMqttBrokersAsync(string, CancellationToken)

List the MQTT brokers for this network

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

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task<List<MqttBroker>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkMqttBrokerAsync(string, string, MqttBrokerCreateUpdateRequest, CancellationToken)

Update an MQTT broker

[Put("/networks/{networkId}/mqttBrokers/{mqttBrokerId}")]
Task<MqttBroker> UpdateNetworkMqttBrokerAsync(string networkId, string mqttBrokerId, MqttBrokerCreateUpdateRequest updateNetworkMqttBroker, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

mqttBrokerId string

The MQTT broker id

updateNetworkMqttBroker MqttBrokerCreateUpdateRequest

Body for updating an MQTT broker

cancellationToken CancellationToken

Returns

Task<MqttBroker>

Exceptions

ApiException

Thrown when fails to make API call