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:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

OfferingMetadataId

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

AdvancedSettings

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

AssignedToTeamId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

AssignedToUserId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

CallbackStatus

Available values are listed below.

Value Description
None None.
WaitingForInstantiationCallback Waiting for instantiation callback.
WaitingForExecutionCallback Waiting for execution callback.
CallbackFailed Callback failed.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

CompletedAt

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Created

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Description

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DueBy

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

GeneratedByInformation

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

KeyName

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Keywords

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Name

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Notes

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

OfferingMetadata

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

OrganizationId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ReleaseMode

Available values are listed below.

Value Description
Released Indicates that this is a released OfferingInstance / TaskInstance.
Design Indicates that this is a design mode OfferingInstance / TaskInstance.
Estimate Indicates that this is an estimate mode OfferingInstance / TaskInstance.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Status

Available values are listed below.

Value Description
NeedParameters Need parameters, offering is a draft.
Deployed Deployed.
DeploymentInProgress Deployment in progress.
FailedToDeploy Deployment of offering failed.
InProgress The offering service is in progress (the underlying tasks are in progress).
Completed The offering service completed (all underlying tasks have completed).
Cancelled The offering service has been cancelled.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SystemUserId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

TaskInstances

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Updated

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Vendor

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Version

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Visibility

Available values are listed below.

Value Description
Hidden Hidden.
Public Entire workgroup.
OnlyMe Owner only.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

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