Skip to content

Changes to Set-SPOContainerType cmdlet #882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
May 13, 2025
132 changes: 91 additions & 41 deletions sharepoint/sharepoint-ps/sharepoint-online/Set-SPOContainerType.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,34 +11,44 @@ ms.reviewer:
---

# Set-SPOContainerType

## SYNOPSIS
Sets or updates one or more property values of a trial or standard container type.

Sets or updates one or more property values of a trial, standard or a direct to customer billed container type.

## SYNTAX

### ParamSet1

```powershell
Set-SPOContainerType -ContainerTypeId <ContainerTypeId> -OwningApplicationId <OwningApplicationId> -ContainerTypeName <ContainerTypeName>

### ContainerTypeName
```
### ParamSet2
```powershell
Set-SPOContainerType -ContainerTypeId <ContainerTypeId> -AzureSubscriptionId <AzureSubscriptionId> -ResourceGroup <ResourceGroup>
Set-SPOContainerType -ContainerTypeId <Guid> [-ContainerTypeName] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
```


### AzureSubscriptionId
```
Set-SPOContainerType -ContainerTypeId <Guid> [[-AzureSubscriptionId] <Guid>] [-ResourceGroup] <String>
[-WhatIf] [-Confirm] [<CommonParameters>]
```

### ApplicationRedirectUrl
```
Set-SPOContainerType -ContainerTypeId <Guid> [-ApplicationRedirectUrl] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
```

## DESCRIPTION
This cmdlet is used to reset the parameters associated with a container type - both trial and standard. The cmdlet can be used to change the basic information of a container type such as container type name, owning application ID or the billing information of the container type.

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 change 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.
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](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell).


## EXAMPLES

### Example 1

```powershell
Expand All @@ -64,78 +74,117 @@ Set-SPOContainerType -ContainerTypeId 01f62754-0873-4ec6-ab4a-3eed48ba8be7 -Owni
In Example 3, the trial container type name is updated as 'Blue Container Type'



## PARAMETERS


### -ContainerTypeName

This parameter names your container type for your SharePoint Embedded application.
### -ApplicationRedirectUrl
This parameter sets the application redirect Url for the container type.

```yaml
Type: String
Parameter Sets: (All)
Parameter Sets: ApplicationRedirectUrl
Aliases:
Applicable: SharePoint Online

Required: True
Position: Named
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -OwningApplicationId

This parameter specifies the ID of the SharePoint Embedded application.
### -AzureSubscriptionId
Use this parameter to set the Azure billing subscription ID you wish to attach to the container type.

```yaml
Type: String
Parameter Sets:
Type: Guid
Parameter Sets: AzureSubscriptionId
Aliases:
Applicable: SharePoint Online

Required: True
Position: Named
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -AzureSubscriptionId
### -Confirm
Prompts you for confirmation before running the cmdlet.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

This parameter describes the Azure subscription ID to which the container type needs to be associated.
### -ContainerTypeId
Use this parameter to enter the container type ID

```yaml
Type: String
Type: Guid
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

Required: False
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ContainerTypeName
Use this parameter to pass the conatiner type name you intend to use for the container type

### -ResourceGroup
```yaml
Type: String
Parameter Sets: ContainerTypeName
Aliases:

This parameter describes the resource group to be used for the associated container type.
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: 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.

```yaml
Type: String
Parameter Sets:
Parameter Sets: AzureSubscriptionId
Aliases:
Applicable: SharePoint Online

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).

## RELATED LINKS

[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
Expand All @@ -145,3 +194,4 @@ Accept wildcard characters: False
[Get-SPOContainerType](./Get-SPOContainerType.md)

[Remove-SPOContainerType](./Remove-SPOContainerType.md)