Edit

Share via

Unregister-PackageSource

  • Reference
Module:
PackageManagement

Removes a registered package source.

Syntax

Unregister-PackageSource
          [[-Source] <String>]
          [-Location <String>]
          [-Credential <PSCredential>]
          [-Force]
          [-ForceBootstrap]
          [-WhatIf]
          [-Confirm]
          [-ProviderName <String>]
          [<CommonParameters>]
Unregister-PackageSource
          -InputObject <PackageSource[]>
          [-Credential <PSCredential>]
          [-Force]
          [-ForceBootstrap]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]
Unregister-PackageSource
          [-Credential <PSCredential>]
          [-Force]
          [-ForceBootstrap]
          [-WhatIf]
          [-Confirm]
          [-ConfigFile <String>]
          [-SkipValidate]
          [<CommonParameters>]
Unregister-PackageSource
          [-Credential <PSCredential>]
          [-Force]
          [-ForceBootstrap]
          [-WhatIf]
          [-Confirm]
          [-ConfigFile <String>]
          [-SkipValidate]
          [<CommonParameters>]
Unregister-PackageSource
          [-Credential <PSCredential>]
          [-Force]
          [-ForceBootstrap]
          [-WhatIf]
          [-Confirm]
          [-PackageManagementProvider <String>]
          [-PublishLocation <String>]
          [-ScriptSourceLocation <String>]
          [-ScriptPublishLocation <String>]
          [<CommonParameters>]
Unregister-PackageSource
          [-Credential <PSCredential>]
          [-Force]
          [-ForceBootstrap]
          [-WhatIf]
          [-Confirm]
          [-PackageManagementProvider <String>]
          [-PublishLocation <String>]
          [-ScriptSourceLocation <String>]
          [-ScriptPublishLocation <String>]
          [<CommonParameters>]

Description

The Unregister-PackageSource cmdlet removes a registered package source. Package sources are always managed by a package provider. To find package sources, use the Get-PackageSource cmdlet.

Examples

Example 1: Unregister a package source for the NuGet provider

The Unregister-PackageSource cmdlet unregisters a package source from the local computer. The Location and Provider parameters can be used to further specify the source to remove.

PS> Unregister-PackageSource -Source MyNuGet

The Unregister-PackageSource cmdlet uses the Source parameter to specify which source to remove.

Example 2: Use a PackageSource object to unregister a package

This example uses the Get-PackageSource and Unregister-PackageSource to unregister a package source. The PackageSource object is stored in a variable.

PS> $pkgsource = Get-PackageSource -Name MyNuGet
PS> Unregister-PackageSource -InputObject $pkgsource

The $pkgsource variable stores the PackageSource created by the Get-PackageSource cmdlet. Unregister-PackageSource uses the $pkgsource as input to the InputObject parameter.

As an alternative, the Unregister-PackageSource cmdlet can specify a value for the InputObject parameter:

Unregister-PackageSource -InputObject ( Get-PackageSource -Name MyNuGet )

Parameters

-ConfigFile

Specifies a configuration file.

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

-Confirm

Prompts you for confirmation before Unregister-PackageSource is run.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Specifies a user account that has permission to access the computer and run commands. Type a user name, such as User01, Domain01\User01, or enter a PSCredential object, generated by the Get-Credential cmdlet. If you type a user name, you're prompted for a password.

When the Credential parameter isn't specified, the current user account is used.

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

-Force

Forces the command to run without asking for user confirmation. Overrides restrictions that prevent Unregister-PackageSource from succeeding, with the exception of security.

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

-ForceBootstrap

Indicates that Unregister-PackageSource forces PackageManagement to automatically uninstall the package provider for the specified package source.

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

-InputObject

Accepts pipeline input that specifies the PackageSource object from the Get-PackageSource cmdlet. InputObject accepts the PackageSource object as a Get-PackageSource value or a variable that contains the object.

Type:Microsoft.PackageManagement.Packaging.PackageSource[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Location

Specifies the location to which a package source points. The value of this parameter can be a URI, a file path, or any other destination format that is supported by the package provider.

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

-PackageManagementProvider

Specifies the PackageManagement provider.

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

-ProviderName

Specifies the provider name.

Type:String
Aliases:Provider
Accepted values:Bootstrap, NuGet, PowerShellGet
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-PublishLocation

Specifies the publish location.

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

-ScriptPublishLocation

Specifies the script publish location.

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

-ScriptSourceLocation

Specifies the script source location.

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

-SkipValidate

Switch that skips validating the credentials of a package source.

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

-Source

Specifies the friendly name of the package source.

Type:String
Aliases:Name
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if Unregister-PackageSource cmdlet is run. The cmdlet isn't run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.PackageManagement.Packaging.PackageSource

You can pipe a PackageSource object to this cmdlet

Outputs

None

This cmdlet returns no output.

Notes

Including a package provider in a command can make dynamic parameters available to a cmdlet. Dynamic parameters are specific to a package provider. The Get-Help cmdlet lists a cmdlet's parameter sets and includes the provider's parameter set.