Interface ISecureConnectDeploymentsNetworkDevices

Namespace

Meraki.Api.Interfaces.SecureConnect.Deployments

Assembly

Meraki.Api.dll

Defines a contract for managing network devices within Secure Connect deployments.

public interface ISecureConnectDeploymentsNetworkDevices

Remarks

This interface provides methods for performing CRUD operations on network devices, as well as retrieving associated policies. Each method interacts with the Secure Connect API and requires an organization ID to scope the operations.

Methods

CreateNetworkDeviceAsync(long, SecureConnectNetworkDeviceCreateRequest, CancellationToken)

Create a network device.

[Post("/organizations/{organizationId}/networkDevices")]
Task<SecureConnectNetworkDevice> CreateNetworkDeviceAsync(long organizationId, SecureConnectNetworkDeviceCreateRequest secureConnectNetworkDeviceCreateRequest, CancellationToken cancellationToken = default)

Parameters

organizationId long

Organization ID associated with this resource.

secureConnectNetworkDeviceCreateRequest SecureConnectNetworkDeviceCreateRequest

The device creation request

cancellationToken CancellationToken

Cancellation token

Returns

Task<SecureConnectNetworkDevice>

Exceptions

ApiException

Thrown when fails to make API call

DeleteNetworkDeviceAsync(long, long, CancellationToken)

Remove a network device.

[Delete("/organizations/{organizationId}/networkDevices/{originId}")]
Task DeleteNetworkDeviceAsync(long organizationId, long originId, CancellationToken cancellationToken = default)

Parameters

organizationId long

Organization ID associated with this resource.

originId long

The origin ID of the network device. minimum = 1

cancellationToken CancellationToken

Cancellation token

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetAllNetworkDevicesAsync(long, CancellationToken)

List the network devices.

[Get("/organizations/{organizationId}/networkDevices")]
Task<List<SecureConnectNetworkDevice>> GetAllNetworkDevicesAsync(long organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId long

Organization ID associated with this resource.

cancellationToken CancellationToken

Cancellation token

Returns

Task<List<SecureConnectNetworkDevice>>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkDeviceAsync(long, long, CancellationToken)

Get a network device.

[Get("/organizations/{organizationId}/networkDevices/{originId}")]
Task<SecureConnectNetworkDevice> GetNetworkDeviceAsync(long organizationId, long originId, CancellationToken cancellationToken = default)

Parameters

organizationId long

Organization ID associated with this resource.

originId long

The origin ID of the network device. minimum = 1

cancellationToken CancellationToken

Cancellation token

Returns

Task<SecureConnectNetworkDevice>

Exceptions

ApiException

Thrown when fails to make API call

ListNetworkDevicePoliciesAsync(long, long, CancellationToken)

List the Umbrella policies associated with a network device. If no filters are supplied, Umbrella returns the DNS policies.

[Get("/organizations/{organizationId}/networkDevices/{originId}/policies")]
Task<List<SecureConnectDevicePolicy>> ListNetworkDevicePoliciesAsync(long organizationId, long originId, CancellationToken cancellationToken = default)

Parameters

organizationId long

Organization ID associated with this resource.

originId long

The origin ID of the network device. minimum = 1

cancellationToken CancellationToken

Cancellation token

Returns

Task<List<SecureConnectDevicePolicy>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkDeviceAsync(long, long, SecureConnectNetworkDeviceUpdateRequest, CancellationToken)

Update a network device.

[Patch("/organizations/{organizationId}/networkDevices/{originId}")]
Task<SecureConnectNetworkDevice> UpdateNetworkDeviceAsync(long organizationId, long originId, SecureConnectNetworkDeviceUpdateRequest secureConnectNetworkDeviceUpdateRequest, CancellationToken cancellationToken = default)

Parameters

organizationId long

Organization ID associated with this resource.

originId long

The origin ID of the network device. minimum = 1

secureConnectNetworkDeviceUpdateRequest SecureConnectNetworkDeviceUpdateRequest

The device creation request

cancellationToken CancellationToken

Cancellation token

Returns

Task<SecureConnectNetworkDevice>

Exceptions

ApiException

Thrown when fails to make API call