Get-BT_Customer

Syntax

Get-BT_Customer -Ticket <Ticket> [-Environment <string>] [-PageOffset <int>] [-PageSize <int>] [-RetrieveAll] [-ShouldUnmaskProperties <bool>] [-Id <Object[]>] [-IsDeleted <string>] [-Created <string[]>] [-SortBy_Created_Ascending] [-SortBy_Created_Descending] [-Updated <string[]>] [-SortBy_Updated_Ascending] [-SortBy_Updated_Descending] [-Version <Object[]>] [-SortBy_Version_Ascending] [-SortBy_Version_Descending] [-SystemUserId <Object[]>] [-OrganizationId <Object[]>] [-PrimaryDomain <Object[]>] [-SortBy_PrimaryDomain_Ascending] [-SortBy_PrimaryDomain_Descending] [-CompanyName <Object[]>] [-SortBy_CompanyName_Ascending] [-SortBy_CompanyName_Descending] [-CountryName <Object[]>] [-SortBy_CountryName_Ascending] [-SortBy_CountryName_Descending] [-StateProvinceName <Object[]>] [-SortBy_StateProvinceName_Ascending] [-SortBy_StateProvinceName_Descending] [-CityName <Object[]>] [-SortBy_CityName_Ascending] [-SortBy_CityName_Descending] [-IndustryType <string[]>] [-CompanySizeBucket <string[]>] [-ShortId <Object[]>] [-SortBy_ShortId_Ascending] [-SortBy_ShortId_Descending] [-IsArchived <string>] [-CustomerSubscriptionRenewalPolicy <string[]>] [-LastAccessed <string[]>] [-SortBy_LastAccessed_Ascending] [-SortBy_LastAccessed_Descending] [-IsDefaultCustomer <string>] [-IsDemoCustomer <string>] [-WorkgroupId <Object[]>] [-ProjectStatsCreated <string[]>] [-ProjectStatsUpdated <string[]>] [-ProjectStatsSystemUserId <Object[]>] [-ProjectStatsOrganizationId <Object[]>] [-ProjectStatsName <Object[]>] [-ProjectStatsStatus <string[]>] [-ProjectStatsApplicationServiceId <Object[]>] [-ProjectStatsIsNotGenerated <string>] [-ProjectStatsApplicationServiceType <string[]>] [-ProjectStatsExternalProjectId <Object[]>] [-ProjectStatsOfferingInstanceId <Object[]>] [-ExtendedPropertyCreated <string[]>] [-ExtendedPropertyUpdated <string[]>] [-ExtendedPropertySystemUserId <Object[]>] [-ExtendedPropertyReferenceEntityType <Object[]>] [-ExtendedPropertyReferenceEntityId <Object[]>] [-ExtendedPropertyName <Object[]>] [-ExtendedPropertyIsEncrypted <string>] [-ExtendedPropertyWorkgroupOrganizationId <Object[]>] [<CommonParameters>]

Get-BT_Customer -Ticket <Ticket> -EndpointUrl <string> [-PageOffset <int>] [-PageSize <int>] [-RetrieveAll] [-ShouldUnmaskProperties <bool>] [-Id <Object[]>] [-IsDeleted <string>] [-Created <string[]>] [-SortBy_Created_Ascending] [-SortBy_Created_Descending] [-Updated <string[]>] [-SortBy_Updated_Ascending] [-SortBy_Updated_Descending] [-Version <Object[]>] [-SortBy_Version_Ascending] [-SortBy_Version_Descending] [-SystemUserId <Object[]>] [-OrganizationId <Object[]>] [-PrimaryDomain <Object[]>] [-SortBy_PrimaryDomain_Ascending] [-SortBy_PrimaryDomain_Descending] [-CompanyName <Object[]>] [-SortBy_CompanyName_Ascending] [-SortBy_CompanyName_Descending] [-CountryName <Object[]>] [-SortBy_CountryName_Ascending] [-SortBy_CountryName_Descending] [-StateProvinceName <Object[]>] [-SortBy_StateProvinceName_Ascending] [-SortBy_StateProvinceName_Descending] [-CityName <Object[]>] [-SortBy_CityName_Ascending] [-SortBy_CityName_Descending] [-IndustryType <string[]>] [-CompanySizeBucket <string[]>] [-ShortId <Object[]>] [-SortBy_ShortId_Ascending] [-SortBy_ShortId_Descending] [-IsArchived <string>] [-CustomerSubscriptionRenewalPolicy <string[]>] [-LastAccessed <string[]>] [-SortBy_LastAccessed_Ascending] [-SortBy_LastAccessed_Descending] [-IsDefaultCustomer <string>] [-IsDemoCustomer <string>] [-WorkgroupId <Object[]>] [-ProjectStatsCreated <string[]>] [-ProjectStatsUpdated <string[]>] [-ProjectStatsSystemUserId <Object[]>] [-ProjectStatsOrganizationId <Object[]>] [-ProjectStatsName <Object[]>] [-ProjectStatsStatus <string[]>] [-ProjectStatsApplicationServiceId <Object[]>] [-ProjectStatsIsNotGenerated <string>] [-ProjectStatsApplicationServiceType <string[]>] [-ProjectStatsExternalProjectId <Object[]>] [-ProjectStatsOfferingInstanceId <Object[]>] [-ExtendedPropertyCreated <string[]>] [-ExtendedPropertyUpdated <string[]>] [-ExtendedPropertySystemUserId <Object[]>] [-ExtendedPropertyReferenceEntityType <Object[]>] [-ExtendedPropertyReferenceEntityId <Object[]>] [-ExtendedPropertyName <Object[]>] [-ExtendedPropertyIsEncrypted <string>] [-ExtendedPropertyWorkgroupOrganizationId <Object[]>] [<CommonParameters>]

Detailed Description

Get-BT_Customer gets a(an) BT_Customer. Represents a partner's customers being sold to in the MSPC platform.

Parameters

Total Parameters: 78

EndpointUrl

Paremeter specs:

Ticket

Paremeter specs:

CityName

Paremeter specs:

CompanyName

Paremeter specs:

CompanySizeBucket

Paremeter specs:

CountryName

Paremeter specs:

Created

Paremeter specs:

CustomerSubscriptionRenewalPolicy

Paremeter specs:

Environment

Available values are listed below.

Paremeter specs:

Id

Paremeter specs:

IndustryType

Paremeter specs:

IsArchived

Paremeter specs:

IsDefaultCustomer

Paremeter specs:

IsDeleted

Paremeter specs:

IsDemoCustomer

Paremeter specs:

LastAccessed

Paremeter specs:

OrganizationId

Paremeter specs:

PageOffset

Paremeter specs:

PageSize

Paremeter specs:

PrimaryDomain

Paremeter specs:

RetrieveAll

Paremeter specs:

ShortId

Paremeter specs:

ShouldUnmaskProperties

Paremeter specs:

SortBy_CityName_Ascending

Paremeter specs:

SortBy_CityName_Descending

Paremeter specs:

SortBy_CompanyName_Ascending

Paremeter specs:

SortBy_CompanyName_Descending

Paremeter specs:

SortBy_CountryName_Ascending

Paremeter specs:

SortBy_CountryName_Descending

Paremeter specs:

SortBy_Created_Ascending

Paremeter specs:

SortBy_Created_Descending

Paremeter specs:

SortBy_LastAccessed_Ascending

Paremeter specs:

SortBy_LastAccessed_Descending

Paremeter specs:

SortBy_PrimaryDomain_Ascending

Paremeter specs:

SortBy_PrimaryDomain_Descending

Paremeter specs:

SortBy_ShortId_Ascending

Paremeter specs:

SortBy_ShortId_Descending

Paremeter specs:

SortBy_StateProvinceName_Ascending

Paremeter specs:

SortBy_StateProvinceName_Descending

Paremeter specs:

SortBy_Updated_Ascending

Paremeter specs:

SortBy_Updated_Descending

Paremeter specs:

SortBy_Version_Ascending

Paremeter specs:

SortBy_Version_Descending

Paremeter specs:

StateProvinceName

Paremeter specs:

SystemUserId

Paremeter specs:

Updated

Paremeter specs:

Version

Paremeter specs:

WorkgroupId

Paremeter specs:

Outputs

System.Object

Notes

Workgroup scope

Customers belong to workgroups, thus a ticket scoped to a workgroup will only return the customers belonging to this workgroup.

Default customer

Every BitTitan workgroup has a the default customer. The company name of the default customer is "Default" and you can retrieve it with the following parameter: -FilterBy_String_CompanyName "Default".

Examples

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

Get-BT_Customer -Ticket $btTicket -CompanyName "Default"