Get-SCSPFOffer
Get-SCSPFOffer
Gets one or more offer objects.
Syntax
Parameter Set: FromOfferIdParameterSetName
Get-SCSPFOffer -ID <Guid[]> [ <CommonParameters>]
Parameter Set: FromOfferNameParameterSetName
Get-SCSPFOffer -Name <String[]> [ <CommonParameters>]
Parameter Set: FromOfferStampParameterSetName
Get-SCSPFOffer -Stamp <Stamp> [ <CommonParameters>]
Parameter Set: FromOfferTenantParameterSetName
Get-SCSPFOffer -Tenant <Tenant> [ <CommonParameters>]
Detailed Description
The Get-SCSPFOffer cmdlet gets one or more offer objects in Service Provider Foundation. To create a new offer, use the New-SCSPFOffer cmdlet.
Parameters
-ID<Guid[]>
Specifies one or more identifiers (as a GUID) for a specific object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies the name of one or more offers.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Stamp<Stamp>
Specifies a stamp for which this cmdlet will return associated offers. To obtain a stamp, use the Get-SCSPFStamp cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Tenant<Tenant>
Specifies a tenant for which this cmdlet will return associated offers. To obtain a tenant, use the Get-SCSPFTenant cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
1: Get all offers.
This command lists all the existing offers.
PS C:\> Get-SCSPFOffer
2: Get an offer by its ID.
This command gets an offer by its ID.
PS C:\> $offr = Get-SCSPFOffer -ID aeea340e-abe4-478b-af3c-e2c95ccb7a1e
3: Get an offer by its name.
This command gets an offer by its name.
PS C:\> $offr = Get-SCSPFOffer -Name "Beginner"
4: Get an offer that is associated to a particular stamp.
The first command gets a stamp.
The second command gets an offer from the stamp.
PS C:\> $stmp = Get-SCSPFStamp -Name "Silver"
PS C:\> $offr = Get-SCSPFOffer -Stamp $stmp
5: Get an offer that is associated to a particular tenant.
The first command gets a tenant.
The second command gets an offer from the tenant.
PS C:\> $tnnt = Get-SCSPFTenant -Name "Contoso"
PS C:\> $offr = Get-SCSPFOffer -Tenant $tnnt