Share via

Get-SCSMSubscription

Module:
System.Center.Service.Manager Module

Retrieves subscriptions that are configured in Service Manager.

Syntax

Default (Default) 

Get-SCSMSubscription
    [-Description <String>]
    [[-DisplayName] <String>]
    [-ManagementPack <ManagementPack>]
    [-SCSession <Connection[]>]
    [-ComputerName <String[]>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Description

The Get-SCSMSubscription cmdlet retrieves subscriptions that are configured in Service Manager.

Examples

Example 1: Get all available subscriptions

PS C:\>Get-SCSMSubscription | Format-List
TargetClass          : System.WorkItem.Incident
ManagementPack       : [Microsoft.EnterpriseManagement.ServiceManager.Default]
Groups               : {}
Condition            : Updated
Enabled              : False
DisplayName          : Subscription1
Description          :
Template             :
Microsoft.EnterpriseManagement.ServiceManager.Sdk.Notifications.EmailTemplate
RecipientUsers       : {Contoso.administrator}
SubscriptionCriteria :
ManagementPackName   : Microsoft.EnterpriseManagement.ServiceManager.Default

This command retrieves available subscriptions, and displays them as a list by using the Format-List cmdlet.

Parameters

-ComputerName

Specifies the name of the computer on which the System Center Data Access service runs. The user account that is specified in the Credential parameter must have access rights to the specified computer.

Parameter properties

Type:

System.String[]

Default value:Localhost
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Credential

Specifies the credentials that this cmdlet uses to connect to the server on which the System Center Data Access service runs. The specified user account must have access rights to that server.

Parameter properties

Type:System.Management.Automation.PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Specifies the description of the subscription to retrieve.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisplayName

Specifies the name of the subscription to retrieve. You can specify a regular expression.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ManagementPack

Specifies the management pack in which the subscription to retrieve is defined.

Parameter properties

Type:Microsoft.EnterpriseManagement.Configuration.ManagementPack
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SCSession

Specifies an object that represents the session to a Service Manager management server.

Parameter properties

Type:

Microsoft.SystemCenter.Core.Connection.Connection[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None.

You cannot pipe input to this cmdlet.

Outputs

Microsoft.EnterpriseManagement.ServiceManager.Sdk.Notifications.Subscriptions.Subscription

This cmdlet retrieves subscriptions that are configured in Service Manager.