Set-BT_CustomerDeviceUserModule

Syntax

Set-BT_CustomerDeviceUserModule -Ticket <Ticket> -customerdeviceusermodule <CustomerDeviceUserModuleDTO[]> [-Environment <string>] [-Id <guid>] [-IsDeleted <bool>] [-Created <datetime>] [-Updated <datetime>] [-Version <int>] [-SystemUserId <guid>] [-OrganizationId <guid>] [-ModuleName <string>] [-ModuleVersion <string>] [-EndUserId <guid>] [-DeviceId <guid>] [-State <ModuleState>] [-StatusMessage <string>] [-InstallationDate <datetime>] [-LastUpdatedDate <datetime>] [-UninstallationDate <datetime>] [-DeviceSettings <ModuleSettings>] [-Results <string>] [-ScheduledStartDate <datetime>] [-DesiredState <ModuleDesiredState>] [-LatestOutcome <ModuleOutcome>] [-LatestOutcomeMessage <string>] [-AccessLevel <AccessLevel>] [<CommonParameters>]

Set-BT_CustomerDeviceUserModule -Ticket <Ticket> -EndpointUrl <string> -customerdeviceusermodule <CustomerDeviceUserModuleDTO[]> [-Id <guid>] [-IsDeleted <bool>] [-Created <datetime>] [-Updated <datetime>] [-Version <int>] [-SystemUserId <guid>] [-OrganizationId <guid>] [-ModuleName <string>] [-ModuleVersion <string>] [-EndUserId <guid>] [-DeviceId <guid>] [-State <ModuleState>] [-StatusMessage <string>] [-InstallationDate <datetime>] [-LastUpdatedDate <datetime>] [-UninstallationDate <datetime>] [-DeviceSettings <ModuleSettings>] [-Results <string>] [-ScheduledStartDate <datetime>] [-DesiredState <ModuleDesiredState>] [-LatestOutcome <ModuleOutcome>] [-LatestOutcomeMessage <string>] [-AccessLevel <AccessLevel>] [<CommonParameters>]

Detailed Description

Set-BT_CustomerDeviceUserModule sets a(an) BT_CustomerDeviceUserModule. Represents the module settings, status and results for a given user on a given device.

Parameters

Total Parameters: 38

customerdeviceusermodule

Paremeter specs:

Required True
ValueFromPipeline True
ValueFromPipelineByPropertyName True

EndpointUrl

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Ticket

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

AccessLevel

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Created

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DesiredState

Available values are listed below.

Value Description
None None.
Installed Installed.
NotInstalled Not installed.
Uninstalled Uninstalled.
Disabled Disabled.
Enabled Enabled.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DeviceId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DeviceSettings

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

EndUserId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Environment

Available values are listed below.

Value Description
BT Represents BT
Beta Represents Beta
Develop Represents Develop
Release Represents Release
Test Represents Test
China Represents China
Germany Represents Germany
Alpha Represents Alpha
Today Represents Today
Sandbox-02 Represents Sandbox-02
Sandbox-03 Represents Sandbox-03

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Id

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

InstallationDate

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

IsDeleted

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

LastUpdatedDate

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

LatestOutcome

Available values are listed below.

Value Description
Unknown Unknown.
Success Success.
Failure Failure.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

LatestOutcomeMessage

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ModuleName

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ModuleVersion

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

OrganizationId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Results

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ScheduledStartDate

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

State

Available values are listed below.

Value Description
NotInstalled Not installed.
Installing Installing.
Installed Installed.
Running Running.
Failed Failed.
Enabling Enabling.
Enabled Enabled.
Disabling Disabling.
Disabled Disabled.
Uninstalling Uninstalling.
Uninstalled Uninstalled.
Complete Complete.
Waiting Waiting for the next heartbeat or the scheduled time.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

StatusMessage

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SystemUserId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

UninstallationDate

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Updated

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Version

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Outputs

System.Object

Notes

Examples