Skip to content

Latest commit

 

History

History
136 lines (92 loc) · 3.54 KB

File metadata and controls

136 lines (92 loc) · 3.54 KB
external help file Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
Module Name Microsoft.Online.SharePoint.PowerShell
online version https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/remove-spocontainertype
applicable SharePoint Online
title Remove-SPOContainerType
schema 2.0.0
author ShreyasSar26
ms.author shsaravanan
ms.reviewer

Remove-SPOContainerType

SYNOPSIS

This cmdlet removes the container type specified from the tenant.

SYNTAX

Remove-SPOContainerType -ContainerTypeId <Guid> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This cmdlet deletes only the trial container type in the tenant. To delete a container type in trial status, you must remove all containers of the container type first, including from the deleted container collection. To remove containers, refer to Remove-SPOContainer. Once all the containers are deleted, trial container type can be deleted using this cmdlet.

You must be a SharePoint Embedded Administrator to run this cmdlet.

EXAMPLES

Example 1

Remove-SPOContainerType -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604a8

In Example 1, the cmdlet asks for a confirmation on the remove action and on confirmation, deletes the trial container type.

Example 1 places the container with the given ID into the recycle bin. The container will be permanently deleted from the recycle bin after 93 days unless the deleted container is restored before permanent deletion.

PARAMETERS

-ContainerTypeId

Applicable: SharePoint Online

This parameter specifies the ID of the container type corresponding to the SharePoint Embedded application. Use the Get-SPOContainertype command to retrieve the ID.

Type: System.Guid
Parameter Sets: (All)
Aliases:

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

-Force

Applicable: SharePoint Online

Whether to remove the container type without prompting for confirmation.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
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.

Type: System.Management.Automation.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, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object

NOTES

RELATED LINKS

Getting started with SharePoint Online Management Shell

New-SPOContainerType

Set-SPOContainerType

Remove-SPOContainerType