Add-BT_Workgroup

Syntax

Add-BT_Workgroup -Ticket <Ticket> [-Environment <string>] [-Id <guid>] [-IsDeleted <bool>] [-Created <datetime>] [-Updated <datetime>] [-Version <int>] [-CreatedBySystemUserId <guid>] [-WorkgroupOrganizationId <guid>] [-Name <string>] [-DefaultPaymentProfileId <guid>] [-HasHadPaymentProfile <bool>] [-ExchangeRateId <guid>] [-CouponReedemingStatus <DistributorCouponReedemingStatus>] [-HasOptOutDistributorSuggestion <bool>] [-CreditLimit <decimal>] [-NetTermsPaymentDays <int>] [-PlanType <WorkgroupPlanType>] [-SkipChargesUntil <datetime>] [-BillingStatus <WorkgroupBillingStatus>] [-TrialPlanType <WorkgroupPlanType>] [-TrialPlanEndDate <datetime>] [-BillingGracePeriodEndDate <datetime>] [-AccessLevel <AccessLevel>] [<CommonParameters>]

Add-BT_Workgroup -Ticket <Ticket> -EndpointUrl <string> [-Id <guid>] [-IsDeleted <bool>] [-Created <datetime>] [-Updated <datetime>] [-Version <int>] [-CreatedBySystemUserId <guid>] [-WorkgroupOrganizationId <guid>] [-Name <string>] [-DefaultPaymentProfileId <guid>] [-HasHadPaymentProfile <bool>] [-ExchangeRateId <guid>] [-CouponReedemingStatus <DistributorCouponReedemingStatus>] [-HasOptOutDistributorSuggestion <bool>] [-CreditLimit <decimal>] [-NetTermsPaymentDays <int>] [-PlanType <WorkgroupPlanType>] [-SkipChargesUntil <datetime>] [-BillingStatus <WorkgroupBillingStatus>] [-TrialPlanType <WorkgroupPlanType>] [-TrialPlanEndDate <datetime>] [-BillingGracePeriodEndDate <datetime>] [-AccessLevel <AccessLevel>] [<CommonParameters>]

Detailed Description

Add-BT_Workgroup adds a(an) BT_Workgroup. A workgroup is managing a list of customers. A workgroup may be associated with a payment profile. It also has a Plan Type which defines the level of features enabled in MSPC. Each master system user has access to one workgroup at least. A system user can invite somebody to manage his/her workgroup. A workgroup represents an environment containing sets of customers, end users, teams, and member information.

Parameters

Total Parameters: 36

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

BillingGracePeriodEndDate

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

BillingStatus

Available values are listed below.

Value Description
Unknown Unknown - default value for backward compatibility.
Okay Everything is fine, all dues invoices are paid.
LateOnPayment LateOnPayment, some due invoices are yet to be paid.
FailureToPay FailureToPay, some due invoices haven't been paid for a while.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

CouponReedemingStatus

Available values are listed below.

Value Description
Never Never.
Yes Yes.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Created

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

CreatedBySystemUserId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

CreditLimit

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DefaultPaymentProfileId

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

ExchangeRateId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

HasHadPaymentProfile

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

HasOptOutDistributorSuggestion

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Id

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

IsDeleted

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Name

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

NetTermsPaymentDays

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

PlanType

Available values are listed below.

Value Description
Unknown Unknown - default value for backward compatibility.
GetOrganized Get organized.
GetOptimized Get optimized.
GetAutomated Get automated.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SkipChargesUntil

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

TrialPlanEndDate

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

TrialPlanType

Available values are listed below.

Value Description
Unknown Unknown - default value for backward compatibility.
GetOrganized Get organized.
GetOptimized Get optimized.
GetAutomated Get automated.

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

WorkgroupOrganizationId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Outputs

System.Object

Notes

Examples

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

$workgroup = Add-BT_Workgroup -Ticket $btTicket -Name "My new workgroup" -CreatedBySystemUserId $btTicket.SystemUserId


0 Comments