Remove-SCSPFSetting
Removes a setting from a database or a portal endpoint.
Syntax
Empty (Default)
Remove-SCSPFSetting
[-WhatIf]
[-Confirm]
[<CommonParameters>]
FromSettingParameterSetName
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.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SpfSetting
Specifies one or more settings to remove.
Parameter properties
| Type: | Microsoft.SystemCenter.Foundation.SPFData.Types.SpfSetting[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromSettingParameterSetName
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.