Add-BT_CustomerEndUser

Syntax

Add-BT_CustomerEndUser -Ticket <Ticket> [-Environment <string>] [-Id <guid>] [-IsDeleted <bool>] [-Created <datetime>] [-Updated <datetime>] [-Version <int>] [-SystemUserId <guid>] [-OrganizationId <guid>] [-PrimaryIdentity <string>] [-PrimaryEmailAddress <string>] [-ExternalId <string>] [-FirstName <string>] [-LastName <string>] [-FullName <string>] [-DisplayName <string>] [-EmailAddress <string>] [-UserPrincipalName <string>] [-GeneratedIdentity <string>] [-ShortId <string>] [-AgentSendStatus <AgentSendStatus>] [-IsArchived <bool>] [-ResourceId <guid>] [-AccessLevel <AccessLevel>] [-ActiveSubscriptionId <guid>] [-SubscriptionId <guid>] [<CommonParameters>]

Add-BT_CustomerEndUser -Ticket <Ticket> -EndpointUrl <string> [-Id <guid>] [-IsDeleted <bool>] [-Created <datetime>] [-Updated <datetime>] [-Version <int>] [-SystemUserId <guid>] [-OrganizationId <guid>] [-PrimaryIdentity <string>] [-PrimaryEmailAddress <string>] [-ExternalId <string>] [-FirstName <string>] [-LastName <string>] [-FullName <string>] [-DisplayName <string>] [-EmailAddress <string>] [-UserPrincipalName <string>] [-GeneratedIdentity <string>] [-ShortId <string>] [-AgentSendStatus <AgentSendStatus>] [-IsArchived <bool>] [-ResourceId <guid>] [-AccessLevel <AccessLevel>] [-ActiveSubscriptionId <guid>] [-SubscriptionId <guid>] [<CommonParameters>]

Detailed Description

Add-BT_CustomerEndUser adds a(an) BT_CustomerEndUser. Represents an MSPC customer end user.

Parameters

Total Parameters: 38

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

ActiveSubscriptionId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

AgentSendStatus

Available values are listed below.

Value Description
NotSent Not sent.
Pending Pending.
Sent Sent.
FailedToBeSent Failed to be sent.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Created

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DisplayName

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

EmailAddress

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

ExternalId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

FirstName

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

FullName

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

GeneratedIdentity

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Id

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

IsArchived

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

IsDeleted

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

LastName

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

OrganizationId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

PrimaryEmailAddress

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

PrimaryIdentity

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ResourceId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ShortId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SystemUserId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Updated

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

UserPrincipalName

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Version

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Outputs

System.Object

Notes

Ticket requirement

Customer end users are under customers, thus this cmdlet requires a ticket scoped to a customer's organization Id.


Primary email address

Primary emaill address must be provided.


Examples

-------------------------- Example 1 -------------------------

# Retrieve a ticket scoped with a customer's organization id

$customerTicket = Get-BT_Ticket -Ticket $btTicket -OrganizationId $customers.OrganizationId

# Add a customer end user

$endUser = Add-BT_CustomerEndUser -Ticket $customerTicket -PrimaryEmailAddress "user@domain.com" -FirstName "John" -LastName "Smith"


0 Comments