Register-PSResourceRepository

Inscrit un référentiel pour les ressources PowerShell.

Syntaxe

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

L’applet de commande inscrit un référentiel NuGet contenant des ressources PowerShell.

Exemples

Exemple 1

Cet exemple enregistre le référentiel avec le nom 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

Exemple 2

Cet exemple enregistre le référentiel par défaut PSGallery . Contrairement à l’exemple précédent, nous ne pouvons pas utiliser les paramètres Name et Uri pour inscrire le PSGallery référentiel. Le PSGallery référentiel est inscrit par défaut, mais peut être supprimé. Utilisez cette commande pour restaurer l’inscription par défaut.

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

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

Exemple 3

Cet exemple enregistre plusieurs référentiels à la fois. Pour ce faire, nous utilisons le paramètre Référentiel et fournissons un tableau de tables de hachage. Chaque table de hachage ne peut avoir que des clés associées à des paramètres pour 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

Exemple 4

Cet exemple enregistre un référentiel avec des informations d’identification à récupérer à partir d’un coffre SecretManagement inscrit. Le module Microsoft.PowerShell.SecretManagement doit être installé et disposer d’un coffre inscrit contenant le secret stocké. Le format du secret doit correspondre aux exigences du référentiel.

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

Paramètres

-ApiVersion

Spécifie la version de l’API utilisée par le référentiel. Les valeurs valides sont :

  • v2 - utilise l’API NuGet V2
  • v3 - utilise l’API NuGet V3
  • local - utilisez-la pour les référentiels basés sur le système de fichiers
  • nugetServer - utilisez-la pour les référentiels NuGet.Server

L’applet Register-PSResourceRepository de commande doit détecter automatiquement la version de l’API. Ce paramètre vous permet de modifier la version de l’API après avoir inscrit un référentiel.

Type:Microsoft.PowerShell.PSResourceGet.UtilClasses.PSRepositoryInfo+APIVersion
Valeurs acceptées:unknown, v2, v3, local, nugetServer
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-CredentialInfo

Objet PSCredentialInfo qui inclut le nom d’un coffre et un secret stockés dans un magasin Microsoft.PowerShell.SecretManagement .

Type:Microsoft.PowerShell.PSResourceGet.UtilClasses.PSCredentialInfo
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Force

Remplace un référentiel s’il existe déjà.

Type:SwitchParameter
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Name

Nom du référentiel à inscrire. Ne peut pas être PSGallery.

Type:String
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-PassThru

Une fois spécifié, affiche le référentiel enregistré avec succès et ses informations.

Type:SwitchParameter
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Priority

Spécifie le classement de priorité du référentiel. Les valeurs de priorité valides vont de 0 à 100. Les valeurs inférieures ont un classement de priorité plus élevé. La valeur par défaut est 50.

Les référentiels sont triés par priorité, puis par nom. Lorsque vous recherchez des ressources sur plusieurs référentiels, les applets de commande PSResourceGet recherchent les référentiels à l’aide de cet ordre de tri et retournent la première correspondance trouvée.

Type:Int32
Position:Named
Valeur par défaut:50
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-PSGallery

Lorsqu’il est spécifié, inscrit le référentiel PSGallery .

Type:SwitchParameter
Position:Named
Valeur par défaut:False
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Repository

Spécifie un tableau de tables de hachage qui contiennent des informations de référentiel. Utilisez ce paramètre pour inscrire plusieurs référentiels à la fois. Chaque table de hachage ne peut avoir que des clés associées à des paramètres pour NameParameterSet ou PSGalleryParameterSet.

Type:Hashtable[]
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Trusted

Spécifie si le référentiel doit être approuvé.

Type:SwitchParameter
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Uri

Spécifie l’emplacement du référentiel à inscrire. La valeur doit utiliser l’un des schémas d’URI suivants :

  • https://
  • http://
  • ftp://
  • file://
Type:String
Position:1
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

None

Sorties

Microsoft.PowerShell.PSResourceGet.UtilClasses.PSRepositoryInfo

Par défaut, l’applet de commande ne produit aucune sortie. Lorsque vous utilisez le paramètre PassThru , l’applet de commande retourne un objet PSRepositoryInfo .

Notes

Les référentiels sont uniques par nom. La tentative d’inscription d’un référentiel portant le même nom entraîne une erreur.