Register-PSResourceRepository

Register-PSResourceRepository
    [-Name] <String>
    [-Uri] <String>
    [-Trusted]
    [-Priority <Int32>]
    [-ApiVersion <APIVersion>]
    [-CredentialInfo <PSCredentialInfo>]
    [-PassThru]
    [-Force]
    [-CredentialProvider <CredentialProvider>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Register-PSResourceRepository
    [-PSGallery]
    [-Trusted]
    [-Priority <Int32>]
    [-PassThru]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Register-PSResourceRepository
    -Repository <Hashtable[]>
    [-PassThru]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

The cmdlet registers a NuGet repository containing PowerShell resources.

This example registers the repository with the Name of PoshTestGallery.

Register-PSResourceRepository -Name PoshTestGallery -Uri 'https://www.poshtestgallery.com/api/v2'
Get-PSResourceRepository -Name PoshTestGallery

Name             Uri                                          Trusted   Priority
----             ---                                          -------   --------
PoshTestGallery  https://www.poshtestgallery.com/api/v2         False         50

This example registers the default PSGallery repository. Unlike the previous example, we can't use the Name and Uri parameters to register the PSGallery repository. The PSGallery repository is registered by default but can be removed. Use this command to restore the default registration.

Register-PSResourceRepository -PSGallery
Get-PSResourceRepository -Name 'PSGallery'

Name             Uri                                          Trusted   Priority
----             ---                                          -------   --------
PSGallery        https://www.powershellgallery.com/api/v2       False         50

This example registers multiple repositories at once. To do so, we use the Repository parameter and provide an array of hashtables. Each hashtable can only have keys associated with parameters for the NameParameterSet or the PSGalleryParameterSet.

$arrayOfHashtables = @{
        Name = 'Local'
        Uri = 'D:/PSRepoLocal/'
        Trusted = $true
        Priority = 20
    },
    @{
        Name = 'PSGv3'
        Uri = 'https://www.powershellgallery.com/api/v3'
        Trusted = $true
        Priority = 50
    },
    @{
        PSGallery = $true
        Trusted = $true
        Priority = 10
    }
Register-PSResourceRepository -Repository $arrayOfHashtables
Get-PSResourceRepository

Name      Uri                                      Trusted Priority
----      ---                                      ------- --------
PSGallery https://www.powershellgallery.com/api/v2 True    10
Local     file:///D:/PSRepoLocal/                  True    20
PSGv3     https://www.powershellgallery.com/api/v3 True    50

This example registers a repository with credential information to be retrieved from a registered SecretManagement vault, where SecretStore is the name of the vault and TestSecret is the name of the stored secret.

You must have the Microsoft.PowerShell.SecretManagement module installed, have a registered vault, and stored a secret within it. If setup correctly, the command Get-SecretInfo -Name 'TestSecret' would return the secret.

The format of the secret must match the requirements of the repository. In some instances, TestSecret might need storing as a PSCredential object with a username and password or token. In others it may need storing as a SecureString representing just the token.

$parameters = @{
  Name = 'PSGv3'
  Uri = 'https://www.powershellgallery.com/api/v3'
  Trusted = $true
  Priority = 50
  CredentialInfo = [Microsoft.PowerShell.PSResourceGet.UtilClasses.PSCredentialInfo]::new(
    'SecretStore', 'TestSecret')
}
Register-PSResourceRepository @parameters
Get-PSResourceRepository | Select-Object * -ExpandProperty CredentialInfo

Name           : PSGv3
Uri            : https://www.powershellgallery.com/api/v3
Trusted        : True
Priority       : 50
CredentialInfo : Microsoft.PowerShell.PSResourceGet.UtilClasses.PSCredentialInfo
VaultName      : SecretStore
SecretName     : TestSecret
Credential     :

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.

By default, the cmdlet produces no output. When you use the PassThru parameter, the cmdlet returns a PSRepositoryInfo object.

Repositories are unique by Name. Attempting to register a repository with same name results in an error.