Remove-PnPStorageEntity

Tip

We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Remove-PnPStorageEntity.md to change this file.

Remove Storage Entities / Farm Properties from either the tenant scoped app catalog or the current site collection if the site has a site collection scoped app catalog

Syntax

Remove-PnPStorageEntity
      -Key <String>
      [-Scope <StorageEntityScope>]
      [-Connection <PnPConnection>]  
      [<CommonParameters>]

Examples

EXAMPLE 1

Remove-PnPStorageEntity -Key MyKey

Removes an existing storage entity / farm property

EXAMPLE 2

Remove-PnPStorageEntity -Key MyKey -Scope Site

Removes an existing storage entity from the current site collection

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type:PnPConnection
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Key

The key of the value to remove.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Scope

Defines the scope of the storage entity. Defaults to Tenant.

Type:StorageEntityScope
Accepted values:Site, Tenant
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:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False