Skip to content

Set-VerkadaCameraLicensePlateOfInterest.md

Latest commit

 

History

History
155 lines (119 loc) · 4 KB

Set-VerkadaCameraLicensePlateOfInterest.md

File metadata and controls

155 lines (119 loc) · 4 KB
external help file verkadaModule-help.xml
Module Name verkadaModule
online version https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Set-VerkadaCameraLicensePlateOfInterest.md
schema 2.0.0

Set-VerkadaCameraLicensePlateOfInterest

SYNOPSIS

Updates a License Plate of Interest for an organization using https://apidocs.verkada.com/reference/patchlicenseplateofinterestviewv1

SYNTAX

Set-VerkadaCameraLicensePlateOfInterest [-license_plate] <String> [-description] <String>
 [-x_verkada_auth_api <String>] [-region <String>] [-errorsToFile] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

Updates a license plate description from License Plates of Interest using a specified license plate number. The reqired token can be directly submitted as a parameter, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands.

EXAMPLES

EXAMPLE 1

Set-VerkadaCameraLicensePlateOfInterest -license_plate 'ABC123' -description 'New License Plate Descriptionv2'
The token will be populated from the cache created by Connect-Verkada.

EXAMPLE 2

Set-VerkadaLPoI 'ABC123' 'New License Plate Descriptionv2'
The token will be populated from the cache created by Connect-Verkada.

EXAMPLE 3

Import-CSV ./file_ofLicenses_and_Descriptions.csv | Set-VerkadaLPoI
The token will be populated from the cache created by Connect-Verkada.

EXAMPLE 4

Set-VerkadaCameraLicensePlateOfInterest -license_plate 'ABC123' -description 'New License Plate Descriptionv2' -x_verkada_auth_api 'v2_sd78d9verkada-token'
The token is submitted as a parameter in the call.

PARAMETERS

-license_plate

The license plate number of the License Plate of Interest

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-description

The description for the License Plate of Interest

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-x_verkada_auth_api

The public API token obatined via the Login endpoint to be used for calls that hit the public API gateway

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $Global:verkadaConnection.x_verkada_auth_api
Accept pipeline input: False
Accept wildcard characters: False

-region

The region of the public API to be used

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Api
Accept pipeline input: False
Accept wildcard characters: False

-errorsToFile

Switch to write errors to file

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Set-VerkadaCameraLicensePlateOfInterest.md