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:

Ticket

Paremeter specs:

AssignedToTeamId

Paremeter specs:

AssignedToUserId

Paremeter specs:

CallbackStatus

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:

Name

Paremeter specs:

OfferingMetadataId

Paremeter specs:

OrganizationId

Paremeter specs:

PageOffset

Paremeter specs:

PageSize

Paremeter specs:

ReleaseMode

Paremeter specs:

RetrieveAll

Paremeter specs:

ShouldUnmaskProperties

Paremeter specs:

SortBy_CompletedAt_Ascending

Paremeter specs:

SortBy_CompletedAt_Descending

Paremeter specs:

SortBy_Created_Ascending

Paremeter specs:

SortBy_Created_Descending

Paremeter specs:

SortBy_Description_Ascending

Paremeter specs:

SortBy_Description_Descending

Paremeter specs:

SortBy_DueBy_Ascending

Paremeter specs:

SortBy_DueBy_Descending

Paremeter specs:

SortBy_GeneratedByInformation_Ascending

Paremeter specs:

SortBy_GeneratedByInformation_Descending

Paremeter specs:

SortBy_KeyName_Ascending

Paremeter specs:

SortBy_KeyName_Descending

Paremeter specs:

SortBy_Name_Ascending

Paremeter specs:

SortBy_Name_Descending

Paremeter specs:

SortBy_Updated_Ascending

Paremeter specs:

SortBy_Updated_Descending

Paremeter specs:

SortBy_Vendor_Ascending

Paremeter specs:

SortBy_Vendor_Descending

Paremeter specs:

SortBy_Version_Ascending

Paremeter specs:

SortBy_Version_Descending

Paremeter specs:

Status

Paremeter specs:

SystemUserId

Paremeter specs:

Updated

Paremeter specs:

Vendor

Paremeter specs:

Version

Paremeter specs:

Visibility

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

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