Get-BT_OfferingMetadata

Syntax

Get-BT_OfferingMetadata -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] [-EditVersion <Object[]>] [-SortBy_EditVersion_Ascending] [-SortBy_EditVersion_Descending] [-WorkgroupOrganizationId <Object[]>] [-CallbackHandlerName <Object[]>] [-SortBy_CallbackHandlerName_Ascending] [-SortBy_CallbackHandlerName_Descending] [-AdditionalCallbackHandlerNames <Object[]>] [-SortBy_AdditionalCallbackHandlerNames_Ascending] [-SortBy_AdditionalCallbackHandlerNames_Descending] [-Name <Object[]>] [-SortBy_Name_Ascending] [-SortBy_Name_Descending] [-SystemUserId <Object[]>] [-KeyName <Object[]>] [-SortBy_KeyName_Ascending] [-SortBy_KeyName_Descending] [-DurationInMinutes <Object[]>] [-SortBy_DurationInMinutes_Ascending] [-SortBy_DurationInMinutes_Descending] [-Vendor <Object[]>] [-SortBy_Vendor_Ascending] [-SortBy_Vendor_Descending] [-DefaultAssignedToUserId <Object[]>] [-DefaultAssignedToTeamId <Object[]>] [-DefaultDueBy <string[]>] [-SortBy_DefaultDueBy_Ascending] [-SortBy_DefaultDueBy_Descending] [-Description <Object[]>] [-SortBy_Description_Ascending] [-SortBy_Description_Descending] [-IsSystemAdded <string>] [-Visibility <string[]>] [-ReleaseMode <string[]>] [-OriginalMetadataId <Object[]>] [<CommonParameters>]

Get-BT_OfferingMetadata -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] [-EditVersion <Object[]>] [-SortBy_EditVersion_Ascending] [-SortBy_EditVersion_Descending] [-WorkgroupOrganizationId <Object[]>] [-CallbackHandlerName <Object[]>] [-SortBy_CallbackHandlerName_Ascending] [-SortBy_CallbackHandlerName_Descending] [-AdditionalCallbackHandlerNames <Object[]>] [-SortBy_AdditionalCallbackHandlerNames_Ascending] [-SortBy_AdditionalCallbackHandlerNames_Descending] [-Name <Object[]>] [-SortBy_Name_Ascending] [-SortBy_Name_Descending] [-SystemUserId <Object[]>] [-KeyName <Object[]>] [-SortBy_KeyName_Ascending] [-SortBy_KeyName_Descending] [-DurationInMinutes <Object[]>] [-SortBy_DurationInMinutes_Ascending] [-SortBy_DurationInMinutes_Descending] [-Vendor <Object[]>] [-SortBy_Vendor_Ascending] [-SortBy_Vendor_Descending] [-DefaultAssignedToUserId <Object[]>] [-DefaultAssignedToTeamId <Object[]>] [-DefaultDueBy <string[]>] [-SortBy_DefaultDueBy_Ascending] [-SortBy_DefaultDueBy_Descending] [-Description <Object[]>] [-SortBy_Description_Ascending] [-SortBy_Description_Descending] [-IsSystemAdded <string>] [-Visibility <string[]>] [-ReleaseMode <string[]>] [-OriginalMetadataId <Object[]>] [<CommonParameters>]

Detailed Description

Get-BT_OfferingMetadata gets a(an) BT_OfferingMetadata. Represents an item in the catalog, or a customization of an item in the catalog. An offering metadata contains information about an MSPComplete service, such as the vendor and the keywords.

Parameters

Total Parameters: 64

EndpointUrl

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Ticket

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

AdditionalCallbackHandlerNames

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

CallbackHandlerName

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Created

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DefaultAssignedToTeamId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DefaultAssignedToUserId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DefaultDueBy

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Description

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

DurationInMinutes

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

EditVersion

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

Id

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

IsDeleted

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

IsSystemAdded

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

OriginalMetadataId

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_AdditionalCallbackHandlerNames_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_AdditionalCallbackHandlerNames_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_CallbackHandlerName_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_CallbackHandlerName_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_DefaultDueBy_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_DefaultDueBy_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_DurationInMinutes_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_DurationInMinutes_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_EditVersion_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_EditVersion_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

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

WorkgroupOrganizationId

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


Public and private MSPComplete services

With MSPC, you can create your own custom services. While MSPComplete services offered by BitTitan do not belong to any workgroup, your private services belong to your workgroups.


Examples

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

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