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
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ This example sets the host URLs for the application with Id 423poi45.

### -CopilotEmbeddedChatHosts

This parameter is used to add host URLs allowed to use the SharePoint Embedded application's declarative agent experience.
This parameter is used to add host URLs allowed to use the SharePoint Embedded application's declarative agent experience. This will always be a subset of permissible URLs set by the application's developer. To check the list of permissible URLs, use the `Get-SPOApplication` cmdlet.

```yaml
Type: System.Collections.Generic.List`1[System.String]
Expand Down
48 changes: 43 additions & 5 deletions sharepoint/sharepoint-ps/sharepoint-online/Set-SPOContainerType.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,31 @@ ms.reviewer:

## 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>
Set-SPOContainerType -ContainerTypeId <Guid> [-ContainerTypeName] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
### ParamSet2
```powershell
Set-SPOContainerType -ContainerTypeId <ContainerTypeId> -AzureSubscriptionId <AzureSubscriptionId> -ResourceGroup <ResourceGroup>
Set-SPOContainerType -ContainerTypeId <Guid> [[-AzureSubscriptionId] <Guid>] [-ResourceGroup] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
```
### ParamSet3
```powershell
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).

Expand Down Expand Up @@ -67,6 +72,35 @@ 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.

```yaml
Type: String
Parameter Sets: ApplicationRedirectUrl
Aliases:

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

### -ContainerTypeId
Use this parameter to enter the container type ID

```yaml
Type: Guid
Parameter Sets: (All)
Aliases:

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

### -ContainerTypeName

Expand Down Expand Up @@ -136,6 +170,10 @@ 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 Down