Get-PSProvider.md

external help file	Microsoft.PowerShell.Commands.Management.dll-Help.xml
Locale	en-US
Module Name	Microsoft.PowerShell.Management
ms.date	12/12/2022
online version	https://learn.microsoft.com/powershell/module/microsoft.powershell.management/get-psprovider?view=powershell-7.6&WT.mc_id=ps-gethelp
schema	2.0.0
title	Get-PSProvider

Get-PSProvider

SYNOPSIS

Gets information about the specified PowerShell provider.

SYNTAX

Get-PSProvider [[-PSProvider] <String[]>] [<CommonParameters>]

DESCRIPTION

The Get-PSProvider cmdlet gets the PowerShell providers in the current session. You can get a particular drive or all drives in the session.

PowerShell providers let you access a variety of data stores as though they were file system drives. For information about PowerShell providers, see about_Providers.

EXAMPLES

Example 1: Display a list of all available providers

Get-PSProvider

This command displays a list of all available PowerShell providers.

Example 2: Display a list of all PowerShell providers that begin with specified letters

Get-PSProvider F*, R* | Format-List

This command displays a list of all PowerShell providers with names that begin with the letter F or R.

Example 3: Find snap-ins or module that added providers to your session

Get-PSProvider | Format-Table Name, Module, PSSnapIn -AutoSize

Name        Module                        PSSnapIn
----        ------                        --------
Registry                                  Microsoft.PowerShell.Core
Alias                                     Microsoft.PowerShell.Core
Environment                               Microsoft.PowerShell.Core
FileSystem                                Microsoft.PowerShell.Core
Function                                  Microsoft.PowerShell.Core
Variable                                  Microsoft.PowerShell.Core
Certificate Microsoft.PowerShell.Security
WSMan       Microsoft.WSMan.Management

Get-PSProvider | where {$_.ModuleName -eq "Microsoft.PowerShell.Security"}

Name            Capabilities      Drives
----            ------------      ------
Certificate     ShouldProcess     {cert}

These commands find the PowerShell snap-ins or modules that added providers to your session. All PowerShell elements, including providers, originate in a snap-in or in a module.

These commands use the PSSnapin and Module properties of the ProviderInfo object that Get-PSProvider returns. The values of these properties contain the name of the snap-in or module that adds the provider.

The first command gets all of the providers in the session and formats them in a table with the values of their Name, Module, and PSSnapin properties.

The second command uses the Where-Object cmdlet to get the providers that come from the Microsoft.PowerShell.Security snap-in.

Example 4: Resolve the path of the Home property of the FileSystem provider

C:\> Resolve-Path ~

Path
----
C:\Users\User01

PS C:\> (Get-PSProvider FileSystem).Home

C:\Users\User01

This example shows that the tilde symbol (~) represents the value of the Home property of the FileSystem provider. The Home property value is optional, but for the FileSystem provider, it is defined as $Env:HOMEDRIVE\$Env:HOMEPATH or $HOME.

PARAMETERS

-PSProvider

Specifies the name or names of the PowerShell providers about which this cmdlet gets information.

Type: System.String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
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

System.String

You can pipe one or more provider name strings to this cmdlet.

OUTPUTS

System.Management.Automation.ProviderInfo

This cmdlet returns objects that represent the PowerShell providers in the session.

NOTES

RELATED LINKS