Add-BT_OfferingInstance

Syntax

Add-BT_OfferingInstance -Ticket <Ticket> -OfferingMetadataId <guid> [-Environment <string>] [-Id <guid>] [-IsDeleted <bool>] [-Created <datetime>] [-Updated <datetime>] [-Version <int>] [-Name <string>] [-SystemUserId <guid>] [-OrganizationId <guid>] [-OfferingMetadata <OfferingMetadata>] [-KeyName <string>] [-Status <OfferingStatus>] [-CallbackStatus <CallbackStatus>] [-ReleaseMode <ReleaseMode>] [-Vendor <string>] [-Keywords <string[]>] [-Notes <string>] [-GeneratedByInformation <string>] [-AssignedToUserId <guid>] [-AssignedToTeamId <guid>] [-CompletedAt <datetime>] [-DueBy <datetime>] [-Description <string>] [-AdvancedSettings <OfferingAdvancedSettings>] [-Visibility <MetadataVisibility>] [-TaskInstances <TaskInstance[]>] [-AccessLevel <AccessLevel>] [<CommonParameters>]

Add-BT_OfferingInstance -Ticket <Ticket> -EndpointUrl <string> -OfferingMetadataId <guid> [-Id <guid>] [-IsDeleted <bool>] [-Created <datetime>] [-Updated <datetime>] [-Version <int>] [-Name <string>] [-SystemUserId <guid>] [-OrganizationId <guid>] [-OfferingMetadata <OfferingMetadata>] [-KeyName <string>] [-Status <OfferingStatus>] [-CallbackStatus <CallbackStatus>] [-ReleaseMode <ReleaseMode>] [-Vendor <string>] [-Keywords <string[]>] [-Notes <string>] [-GeneratedByInformation <string>] [-AssignedToUserId <guid>] [-AssignedToTeamId <guid>] [-CompletedAt <datetime>] [-DueBy <datetime>] [-Description <string>] [-AdvancedSettings <OfferingAdvancedSettings>] [-Visibility <MetadataVisibility>] [-TaskInstances <TaskInstance[]>] [-AccessLevel <AccessLevel>] [<CommonParameters>]

Detailed Description

Add-BT_OfferingInstance adds a(an) BT_OfferingInstance. Represents a deployment of an to a customer. An offering instance contains information about one of your executions of the service, such as the execution status and the customer organization id. The metadata of the service can be found in the associated offering metadata object. You can use this cmdlet to start an MSPComplete service and it will also create the associated TaskInstance and TaskTarget entities.

Parameters

Total Parameters: 41

EndpointUrl

Paremeter specs:

OfferingMetadataId

Paremeter specs:

Ticket

Paremeter specs:

AccessLevel

Paremeter specs:

AdvancedSettings

Paremeter specs:

AssignedToTeamId

Paremeter specs:

AssignedToUserId

Paremeter specs:

CallbackStatus

Available values are listed below.

Paremeter specs:

CompletedAt

Paremeter specs:

Created

Paremeter specs:

Description

Paremeter specs:

DueBy

Paremeter specs:

Environment

Available values are listed below.

Paremeter specs:

GeneratedByInformation

Paremeter specs:

Id

Paremeter specs:

IsDeleted

Paremeter specs:

KeyName

Paremeter specs:

Keywords

Paremeter specs:

Name

Paremeter specs:

Notes

Paremeter specs:

OfferingMetadata

Paremeter specs:

OrganizationId

Paremeter specs:

ReleaseMode

Available values are listed below.

Paremeter specs:

Status

Available values are listed below.

Paremeter specs:

SystemUserId

Paremeter specs:

TaskInstances

Paremeter specs:

Updated

Paremeter specs:

Vendor

Paremeter specs:

Version

Paremeter specs:

Visibility

Available values are listed below.

Paremeter specs:

Outputs

System.Object

Notes

Offering metadata and offering instance

There are two different types of entities for services:

the metadata, called OfferingMetadata, which contains information about the service, such as the vendor and the keywords

the instance, called OfferingInstance, which contains information about one of your executions of the service, such as the execution status and the customer organization id

Ticket requirement

Offering instances are under customers, thus a ticket scoped to a customer is required.

Examples

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

$customers = Get-BT_Customer -Ticket $btTicket

$customerTicket = Get-BT_Ticket -Ticket $btTicket -OrganizationId $customers[0].OrganizationId

$offeringMetadata = Get-BT_OfferingMetadata -Ticket $btTicket -KeyName "AddProxyOffice365"

$offeringInstance = Add-BT_OfferingInstance -Ticket $customerTicket -OfferingMetadataId $offeringMetadata[0].Id