Public/Get-DwImportDeviceFeed.ps1
|
#requires -Version 7 function Get-DwImportDeviceFeed { <# .SYNOPSIS Gets device imports. .DESCRIPTION Gets one or more device feeds. Use ImportId to get a specific feed or omit for all feeds. .PARAMETER Instance Dashworks instance. For example, myinstance.dashworks.app .PARAMETER Port Dashworks API port number. Default = 8443 .PARAMETER APIKey Dashworks API Key. .PARAMETER ImportId Optional. The id for the device feed. Omit to get all device feeds. .PARAMETER FeedName Optional. Name of device feed to find. Can only be used when ImportId is not specified. .EXAMPLE PS> Get-DwImportDeviceFeed -ImportId 1 -Instance "myinstance.dashworks.app" -APIKey "xxxxx" #> [CmdletBinding()] param ( [Parameter(Mandatory=$true)] [string]$Instance, [Parameter(Mandatory=$false)] [int]$Port = 8443, [Parameter(Mandatory=$true)] [string]$APIKey, [parameter(Mandatory=$false)] [int]$ImportId, [parameter(Mandatory=$false)] [string]$FeedName ) if ($ImportId -and $FeedName) { throw "Cannot specify both ImportId and FeedName."} $uri = "https://{0}:{1}/apiv2/imports/devices" -f $Instance, $Port if ($ImportId) { $uri += "/{0}" -f $ImportId } if ($FeedName) { $uri += "?filter=eq(name,'{0}')" -f $FeedName} $headers = @{'x-api-key' = $APIKey} try { $result = Invoke-RestMethod -Uri $uri -Method GET -Headers $headers return $result } catch { Write-Error $_ } } |