New-SPOContainerType
This cmdlet creates a new container type of standard or trial status. The standard container type can be created with the regular billing structure or direct to customer billing structure.
Syntax
Default (Default)
New-SPOContainerType
[-ContainerTypeName] <String>
-OwningApplicationId <Guid>
[-ApplicationRedirectUrl <String>]
[-TrialContainerType]
[-IsPassThroughBilling]
[-IsGovernableByAdmin <Boolean>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
This cmdlet creates a new standard or trial container type. A standard container type, by definition, has a billing profile associated with it and can be either regular billed or direct to consumer billed. A trial container type does not have a billing profile. In case of regular billing, the next step after creation is the addition of a billing profile using the Add-SPOContainerTypeBilling cmdlet. With the use of -IsPassThroughBilling
, you can create a direct to customer billed container type. There is no need to attach a billing profile in case this case. –TrialContainerType
when used creates a trial container type that has a validity of 30 days.
You must be a SharePoint Embedded Administrator to run this cmdlet.
Examples
Example 1
New-SPOContainerType -ContainerTypeName ContosoLegal -OwningApplicationId a735e4af
In Example 1, the cmdlet creates a new regular billed container type ContosoLegal.
Example 2
New-SPOContainerType –IsPassThroughBilling –ContainerTypeName ContosoLegal -OwningApplicationId a735e4af
In Example 2, the cmdlet creates a direct to customer billed container type ContosoLegal.
Example 3
New-SPOContainerType –TrialContainerType -ContainerTypeName ContosoLegal -OwningApplicationId a735e4af
In Example 3, the cmdlet creates a trial container type, ContosoLegal, valid for 30 days.
Example 4
New-SPOContainerType -ContainerTypeName ContosoLegal -OwningApplicationId a735e4af -GovernableByAdmin $false
In Example 4, the cmdlet creates a standard container type, ContosoLegal that has opted out of management through Microsoft-enabled administrator platforms.
Parameters
-ApplicationRedirectUrl
Applicable: SharePoint Online
This parameter specifies the url of that the application should be redirected to.
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 |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: | System.Management.Automation.SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | cf |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-ContainerTypeName
Applicable: SharePoint Online
This parameter names your container type for your SharePoint Embedded application.
Parameter properties
Type: | System.String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | 0 |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-IsGovernableByAdmin
Applicable: SharePoint Online
Using -GovernableByAdmin
, you can decide whether consuming tenant administrators of the application should be provided management capabilities on Microsoft-enabled administrator support, through SharePoint admin center and PowerShell. When not passed, the value is set to True. When set to False, the consuming tenant administrator can perform only read-only actions on containers of the container type, in both SharePoint admin center and PowerShell.
Parameter properties
Type: | System.Boolean |
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 |
-IsPassThroughBilling
Applicable: SharePoint Online
This parameter is used to create a direct to customer billed container type.
Parameter properties
Type: | SwitchParameter |
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 |
-OwningApplicationId
Applicable: SharePoint Online
This parameter specifies the ID of the SharePoint Embedded application.
Parameter properties
Type: | System.Guid |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-TrialContainerType
Applicable: SharePoint Online
This parameter is used to specify that the cmdlet is used to create a trial container type and thereby the billing profile need not be provided.
Parameter properties
Type: | System.Management.Automation.SwitchParameter |
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 |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
Type: | System.Management.Automation.SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | wi |
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.