Get-BT_OfferingInstance

Syntax

Get-BT_OfferingInstance -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] [-Name <Object[]>] [-SortBy_Name_Ascending] [-SortBy_Name_Descending] [-SystemUserId <Object[]>] [-OrganizationId <Object[]>] [-OfferingMetadataId <Object[]>] [-KeyName <Object[]>] [-SortBy_KeyName_Ascending] [-SortBy_KeyName_Descending] [-Status <string[]>] [-CallbackStatus <string[]>] [-ReleaseMode <string[]>] [-Vendor <Object[]>] [-SortBy_Vendor_Ascending] [-SortBy_Vendor_Descending] [-GeneratedByInformation <Object[]>] [-SortBy_GeneratedByInformation_Ascending] [-SortBy_GeneratedByInformation_Descending] [-AssignedToUserId <Object[]>] [-AssignedToTeamId <Object[]>] [-CompletedAt <string[]>] [-SortBy_CompletedAt_Ascending] [-SortBy_CompletedAt_Descending] [-DueBy <string[]>] [-SortBy_DueBy_Ascending] [-SortBy_DueBy_Descending] [-Description <Object[]>] [-SortBy_Description_Ascending] [-SortBy_Description_Descending] [-Visibility <string[]>] [-OfferingMetadataCreated <string[]>] [-OfferingMetadataUpdated <string[]>] [-OfferingMetadataVersion <Object[]>] [-OfferingMetadataEditVersion <Object[]>] [-OfferingMetadataWorkgroupOrganizationId <Object[]>] [-OfferingMetadataCallbackHandlerName <Object[]>] [-OfferingMetadataAdditionalCallbackHandlerNames <Object[]>] [-OfferingMetadataName <Object[]>] [-OfferingMetadataSystemUserId <Object[]>] [-OfferingMetadataKeyName <Object[]>] [-OfferingMetadataDurationInMinutes <Object[]>] [-OfferingMetadataVendor <Object[]>] [-OfferingMetadataDefaultAssignedToUserId <Object[]>] [-OfferingMetadataDefaultAssignedToTeamId <Object[]>] [-OfferingMetadataDefaultDueBy <string[]>] [-OfferingMetadataDescription <Object[]>] [-OfferingMetadataIsSystemAdded <string>] [-OfferingMetadataVisibility <string[]>] [-OfferingMetadataReleaseMode <string[]>] [-OfferingMetadataOriginalMetadataId <Object[]>] [-CustomerCreated <string[]>] [-CustomerUpdated <string[]>] [-CustomerSystemUserId <Object[]>] [-CustomerOrganizationId <Object[]>] [-CustomerPrimaryDomain <Object[]>] [-CustomerCompanyName <Object[]>] [-CustomerCountryName <Object[]>] [-CustomerStateProvinceName <Object[]>] [-CustomerCityName <Object[]>] [-CustomerIndustryType <string[]>] [-CustomerCompanySizeBucket <string[]>] [-CustomerShortId <Object[]>] [-CustomerIsArchived <string>] [-CustomerCustomerSubscriptionRenewalPolicy <string[]>] [-CustomerLastAccessed <string[]>] [-CustomerIsDefaultCustomer <string>] [-CustomerIsDemoCustomer <string>] [-CustomerWorkgroupId <Object[]>] [-CustomerProjectStatsCreated <string[]>] [-CustomerProjectStatsUpdated <string[]>] [-CustomerProjectStatsSystemUserId <Object[]>] [-CustomerProjectStatsOrganizationId <Object[]>] [-CustomerProjectStatsName <Object[]>] [-CustomerProjectStatsStatus <string[]>] [-CustomerProjectStatsApplicationServiceId <Object[]>] [-CustomerProjectStatsIsNotGenerated <string>] [-CustomerProjectStatsApplicationServiceType <string[]>] [-CustomerProjectStatsExternalProjectId <Object[]>] [-CustomerProjectStatsOfferingInstanceId <Object[]>] [-CustomerExtendedPropertyCreated <string[]>] [-CustomerExtendedPropertyUpdated <string[]>] [-CustomerExtendedPropertySystemUserId <Object[]>] [-CustomerExtendedPropertyReferenceEntityType <Object[]>] [-CustomerExtendedPropertyReferenceEntityId <Object[]>] [-CustomerExtendedPropertyName <Object[]>] [-CustomerExtendedPropertyIsEncrypted <string>] [-CustomerExtendedPropertyWorkgroupOrganizationId <Object[]>] [<CommonParameters>]

Get-BT_OfferingInstance -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] [-Name <Object[]>] [-SortBy_Name_Ascending] [-SortBy_Name_Descending] [-SystemUserId <Object[]>] [-OrganizationId <Object[]>] [-OfferingMetadataId <Object[]>] [-KeyName <Object[]>] [-SortBy_KeyName_Ascending] [-SortBy_KeyName_Descending] [-Status <string[]>] [-CallbackStatus <string[]>] [-ReleaseMode <string[]>] [-Vendor <Object[]>] [-SortBy_Vendor_Ascending] [-SortBy_Vendor_Descending] [-GeneratedByInformation <Object[]>] [-SortBy_GeneratedByInformation_Ascending] [-SortBy_GeneratedByInformation_Descending] [-AssignedToUserId <Object[]>] [-AssignedToTeamId <Object[]>] [-CompletedAt <string[]>] [-SortBy_CompletedAt_Ascending] [-SortBy_CompletedAt_Descending] [-DueBy <string[]>] [-SortBy_DueBy_Ascending] [-SortBy_DueBy_Descending] [-Description <Object[]>] [-SortBy_Description_Ascending] [-SortBy_Description_Descending] [-Visibility <string[]>] [-OfferingMetadataCreated <string[]>] [-OfferingMetadataUpdated <string[]>] [-OfferingMetadataVersion <Object[]>] [-OfferingMetadataEditVersion <Object[]>] [-OfferingMetadataWorkgroupOrganizationId <Object[]>] [-OfferingMetadataCallbackHandlerName <Object[]>] [-OfferingMetadataAdditionalCallbackHandlerNames <Object[]>] [-OfferingMetadataName <Object[]>] [-OfferingMetadataSystemUserId <Object[]>] [-OfferingMetadataKeyName <Object[]>] [-OfferingMetadataDurationInMinutes <Object[]>] [-OfferingMetadataVendor <Object[]>] [-OfferingMetadataDefaultAssignedToUserId <Object[]>] [-OfferingMetadataDefaultAssignedToTeamId <Object[]>] [-OfferingMetadataDefaultDueBy <string[]>] [-OfferingMetadataDescription <Object[]>] [-OfferingMetadataIsSystemAdded <string>] [-OfferingMetadataVisibility <string[]>] [-OfferingMetadataReleaseMode <string[]>] [-OfferingMetadataOriginalMetadataId <Object[]>] [-CustomerCreated <string[]>] [-CustomerUpdated <string[]>] [-CustomerSystemUserId <Object[]>] [-CustomerOrganizationId <Object[]>] [-CustomerPrimaryDomain <Object[]>] [-CustomerCompanyName <Object[]>] [-CustomerCountryName <Object[]>] [-CustomerStateProvinceName <Object[]>] [-CustomerCityName <Object[]>] [-CustomerIndustryType <string[]>] [-CustomerCompanySizeBucket <string[]>] [-CustomerShortId <Object[]>] [-CustomerIsArchived <string>] [-CustomerCustomerSubscriptionRenewalPolicy <string[]>] [-CustomerLastAccessed <string[]>] [-CustomerIsDefaultCustomer <string>] [-CustomerIsDemoCustomer <string>] [-CustomerWorkgroupId <Object[]>] [-CustomerProjectStatsCreated <string[]>] [-CustomerProjectStatsUpdated <string[]>] [-CustomerProjectStatsSystemUserId <Object[]>] [-CustomerProjectStatsOrganizationId <Object[]>] [-CustomerProjectStatsName <Object[]>] [-CustomerProjectStatsStatus <string[]>] [-CustomerProjectStatsApplicationServiceId <Object[]>] [-CustomerProjectStatsIsNotGenerated <string>] [-CustomerProjectStatsApplicationServiceType <string[]>] [-CustomerProjectStatsExternalProjectId <Object[]>] [-CustomerProjectStatsOfferingInstanceId <Object[]>] [-CustomerExtendedPropertyCreated <string[]>] [-CustomerExtendedPropertyUpdated <string[]>] [-CustomerExtendedPropertySystemUserId <Object[]>] [-CustomerExtendedPropertyReferenceEntityType <Object[]>] [-CustomerExtendedPropertyReferenceEntityId <Object[]>] [-CustomerExtendedPropertyName <Object[]>] [-CustomerExtendedPropertyIsEncrypted <string>] [-CustomerExtendedPropertyWorkgroupOrganizationId <Object[]>] [<CommonParameters>]

Detailed Description

Get-BT_OfferingInstance gets 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.

Parameters

Total Parameters: 116

EndpointUrl

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Ticket

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

AssignedToTeamId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

AssignedToUserId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

CallbackStatus

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

Name

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

OfferingMetadataId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

OrganizationId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

PageOffset

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

PageSize

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ReleaseMode

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

RetrieveAll

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ShouldUnmaskProperties

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_CompletedAt_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_CompletedAt_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Created_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Created_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Description_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Description_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_DueBy_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_DueBy_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_GeneratedByInformation_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_GeneratedByInformation_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_KeyName_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_KeyName_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Name_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Name_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Updated_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Updated_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Vendor_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Vendor_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Version_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Version_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Status

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

Vendor

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Version

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Visibility

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


Customer scope

Offering instances belong to customers, thus a ticket scoped to a customer will only return the offering instances belonging to this customer.


Workgroup scope

Offering instances belong to workgroups, thus a ticket scoped to a workgroup will only return the offering instances belonging to this workgroup.


Examples

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

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

$offeringInstances = Get-BT_OfferingInstance -Ticket $btTicket -OfferingMetadataId $offeringMetadata.Id