Set-SPOContainerType
Sets or updates one or more property values of a trial, standard or a direct to customer billed container type.
Syntax
ContainerTypeName
Set-SPOContainerType
[-ContainerTypeName] <String>
-ContainerTypeId <Guid>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
OwningApplicationId
Set-SPOContainerType
[-OwningApplicationId] <Guid>
-ContainerTypeId <Guid>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
AzureSubscriptionId
Set-SPOContainerType
[[-AzureSubscriptionId] <Guid>]
[-ResourceGroup] <String>
-ContainerTypeId <Guid>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ApplicationRedirectUrl
Set-SPOContainerType
[-ApplicationRedirectUrl] <String>
-ContainerTypeId <Guid>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
This cmdlet updates the existing property of a container type with the new value provided. The cmdlet can be used to change the basic information of a container type such as container type name or the billing information of the container type.
You must be a SharePoint Embedded Administrator to run the cmdlet.
While you only need to be a SharePoint Embedded Administrator to set the basic information of a container type, you need owner or contributor access on the existing billing subscription associated with the container type and also on the new billing subscription, to change the billing information of the container type. List of parameters that cannot be updated includes container type ID and owning application ID.
For permissions and the most current information about Windows PowerShell for SharePoint Embedded Containers, see the documentation at Intro to SharePoint Embedded Containers Management Shell.
Examples
Example 1
Set-SPOContainerType -ContainerTypeId da1d89b3-b4cf-4c0a-8e1c-0d131c57544f -OwningApplicationId 12a9d93c-18d7-46a0-b43e-28d20addd56a - ContainerTypeName 'Red Container Type'
Example 1 sets the container type name as 'Red Container Type'
Example 2
Set-SPOContainerType -ContainerTypeId da1d89b3-b4cf-4c0a-8e1c-0d131c57544f –Azure Subscription 12a9d93c-18d7-46a0-b43e-28d20addd56a -ResourceGroup RG200
In Example 2, the billing profile of the container type is updated.
Example 3
Set-SPOContainerType -ContainerTypeId 01f62754-0873-4ec6-ab4a-3eed48ba8be7 -OwningApplicationId 994b9586-253e-4a77-b51 - ContainerTypeName 'Blue Container Type'
In Example 3, the trial container type name is updated as 'Blue Container Type'
Parameters
-ApplicationRedirectUrl
This parameter sets the application redirect Url for the container type.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ApplicationRedirectUrl
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AzureSubscriptionId
Use this parameter to set the Azure billing subscription ID you wish to attach to the container type.
Parameter properties
| Type: | System.Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
AzureSubscriptionId
| Position: | 1 |
| 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 |
-ContainerTypeId
Use this parameter to enter the container type ID
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 |
-ContainerTypeName
Use this parameter to pass the conatiner type name you intend to use for the container type
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ContainerTypeName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceGroup
Use this parameter to set the Azure resource group of the associated Azure billing subscription you intend to attach to the container type.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
AzureSubscriptionId
| Position: | 0 |
| Mandatory: | True |
| 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.