Compartilhar via

Register-PSResourceRepository

  • Referência
Módulo:
Microsoft.PowerShell.PSResourceGet

Registra um repositório para recursos do PowerShell.

Syntax

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

Description

O cmdlet registra um repositório NuGet que contém recursos do PowerShell.

Exemplos

Exemplo 1

Este exemplo registra o repositório com o Nome de 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

Exemplo 2

Este exemplo registra o repositório padrão PSGallery . Ao contrário do exemplo anterior, não podemos usar os parâmetros Name e Uri para registrar o PSGallery repositório. O PSGallery repositório é registrado por padrão, mas pode ser removido. Use este comando para restaurar o registro padrão.

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

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

Exemplo 3

Este exemplo registra vários repositórios de uma só vez. Para fazer isso, usamos o parâmetro Repository e fornecemos uma matriz de hashtables. Cada hashtable só pode ter chaves associadas a parâmetros para NameParameterSet ou 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

Exemplo 4

Este exemplo registra um repositório com informações de credenciais a serem recuperadas de um cofre SecretManagement registrado. Você deve ter o módulo Microsoft.PowerShell.SecretManagement instalado e ter um cofre registrado contendo o segredo armazenado. O formato do segredo deve corresponder aos requisitos do repositório.

$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     :

Parâmetros

-ApiVersion

Especifica a versão da API usada pelo repositório. Os valores válidos são:

  • v2 - usa a API NuGet V2
  • v3 - usa a API NuGet V3
  • local - use isso para repositórios baseados em sistema de arquivos
  • nugetServer - use isso para repositórios baseados em NuGet.Server

O Register-PSResourceRepository cmdlet deve detectar automaticamente a versão da API. Esse parâmetro permite que você altere a versão da API depois de registrar um repositório.

Type:Microsoft.PowerShell.PSResourceGet.UtilClasses.PSRepositoryInfo+APIVersion
Accepted values:unknown, v2, v3, local, nugetServer
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

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

-CredentialInfo

Um objeto PSCredentialInfo que inclui o nome de um cofre e um segredo armazenado em um repositório Microsoft.PowerShell.SecretManagement .

Type:Microsoft.PowerShell.PSResourceGet.UtilClasses.PSCredentialInfo
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Substitui um repositório se ele já existir.

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

-Name

Nome do repositório a ser registrado. Não pode ser PSGallery.

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

-PassThru

Quando especificado, exibe o repositório registrado com êxito e suas informações.

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

-Priority

Especifica a classificação de prioridade do repositório. Os valores de prioridade válidos variam de 0 a 100. Valores mais baixos têm uma classificação de prioridade mais alta. O valor padrão é 50.

Os repositórios são classificados por prioridade e depois por nome. Ao procurar recursos em vários repositórios, os cmdlets PSResourceGet pesquisam os repositórios usando essa ordem de classificação e retornam a primeira correspondência encontrada.

Type:Int32
Position:Named
Default value:50
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PSGallery

Quando especificado, registra o repositório PSGallery .

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

-Repository

Especifica uma matriz de hashtables que contêm informações do repositório. Use esse parâmetro para registrar vários repositórios de uma só vez. Cada hashtable só pode ter chaves associadas a parâmetros para NameParameterSet ou PSGalleryParameterSet.

Type:Hashtable[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Trusted

Especifica se o repositório deve ser confiável.

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

-Uri

Especifica o local do repositório a ser registrado. O valor deve usar um dos seguintes esquemas de URI:

  • https://
  • http://
  • ftp://
  • file://
Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

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

Entradas

None

Saídas

Microsoft.PowerShell.PSResourceGet.UtilClasses.PSRepositoryInfo

Por padrão, o cmdlet não produz nenhuma saída. Quando você usa o parâmetro PassThru , o cmdlet retorna um objeto PSRepositoryInfo .

Observações

Os repositórios são exclusivos por Nome. A tentativa de registrar um repositório com o mesmo nome resulta em um erro.