Remove-SCSPFSetting

  • Reference
Module:
spfadmin

Removes a setting from a database or a portal endpoint.

Syntax

Remove-SCSPFSetting
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-SCSPFSetting
      -SpfSetting <SpfSetting[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-SCSPFSetting cmdlet removes a setting from a database connection string or a portal endpoint connection string.

Examples

Example 1: Remove a setting

PS C:\>$Setting = Get-SCSPFSetting -Name "ContosoSetting" | Remove-SCSPFSetting

This command obtains a setting by name and then passes it to the Remove-SCSPFSetting cmdlet by using the pipeline operator.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:System.Management.Automation.SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SpfSetting

Specifies one or more settings to remove.

Type:Microsoft.SystemCenter.Foundation.SPFData.Types.SpfSetting[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:System.Management.Automation.SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.SystemCenter.Foundation.SPFData.Types.SpfSetting[]

Outputs

System.Object