Add-BT_Customer

Syntax

Add-BT_Customer -Ticket <Ticket> -PrimaryDomain <string> -CompanyName <string> [-Environment <string>] [-Id <guid>] [-IsDeleted <bool>] [-Created <datetime>] [-Updated <datetime>] [-Version <int>] [-SystemUserId <guid>] [-OrganizationId <guid>] [-CountryName <string>] [-StateProvinceName <string>] [-CityName <string>] [-IndustryType <Industries>] [-CompanySizeBucket <CustomerSizeRange>] [-ShortId <string>] [-IsArchived <bool>] [-CustomerSubscriptionRenewalPolicy <CustomerSubscriptionRenewalPolicy>] [-LastAccessed <datetime>] [-IsDefaultCustomer <bool>] [-IsDemoCustomer <bool>] [-WorkgroupId <guid>] [-AccessLevel <AccessLevel>] [<CommonParameters>]

Add-BT_Customer -Ticket <Ticket> -EndpointUrl <string> -PrimaryDomain <string> -CompanyName <string> [-Id <guid>] [-IsDeleted <bool>] [-Created <datetime>] [-Updated <datetime>] [-Version <int>] [-SystemUserId <guid>] [-OrganizationId <guid>] [-CountryName <string>] [-StateProvinceName <string>] [-CityName <string>] [-IndustryType <Industries>] [-CompanySizeBucket <CustomerSizeRange>] [-ShortId <string>] [-IsArchived <bool>] [-CustomerSubscriptionRenewalPolicy <CustomerSubscriptionRenewalPolicy>] [-LastAccessed <datetime>] [-IsDefaultCustomer <bool>] [-IsDemoCustomer <bool>] [-WorkgroupId <guid>] [-AccessLevel <AccessLevel>] [<CommonParameters>]

Detailed Description

Add-BT_Customer adds a(an) BT_Customer. Represents a partner's customers being sold to in the MSPC platform. Customers are added under workgroups.

Parameters

Total Parameters: 36

CompanyName

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

EndpointUrl

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

PrimaryDomain

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

CityName

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

CompanySizeBucket

Available values are listed below.

Value Description
Unknown Unknown.
Between1And10 Between 1 and 10.
Between11And50 Between 11 and 50.
Between51And200 Between 51 and 200.
Between201And500 Between 201 and 500.
Between501And1000 Between 501 and 1000.
Between1001And5000 Between 1001 and 5000.
Between5001And10000 Between 5001 and 10000.
Over10001 Over 10001.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

CountryName

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Created

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

CustomerSubscriptionRenewalPolicy

Available values are listed below.

Value Description
None None.
AutoRenew Auto renew all subscriptions that are under the customer.
DoNotAutoRenew Do not the auto renew subscriptions under the customer.

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

IndustryType

Available values are listed below.

Value Description
None None.
Education Education.
Government Government.
Healthcare Healthcare.
Legal Legal.
CommunicationAndMedia Communication & media.
FinancialServices Financial services.
ManufacturingAndResources Manufacturing & resources.
RetailConsumerProductsAndServices Retail, consumer products and services.
Other Other.
NoVerticalFocus No vertical focus.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

IsArchived

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

IsDefaultCustomer

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

IsDeleted

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

IsDemoCustomer

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

LastAccessed

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

OrganizationId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ShortId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

StateProvinceName

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

Version

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

WorkgroupId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Outputs

System.Object

Notes

T

Customers are under workgroups, thus this cmdlet requires a ticket scoped to a workgroup id.


Examples

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

# Get a ticket scoped to a workgroup

$cred = Get-Credential

$ticket = Get-BT_Ticket -Credential $cred -ServiceType BitTitan -WorkgroupId 'your-workgroup-id-here'

# Create a new customer

$customer = Add-BT_Customer -Ticket $ticket -CompanyName 'company-name-here' -PrimaryDomain 'company-domain-here'