Partager via


Register-PSResourceRepository

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

Syntaxe

NameParameterSet (Par défaut)

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

PSGalleryParameterSet

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

RepositoriesParameterSet

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 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 PSGallery par défaut. Contrairement à l’exemple précédent, nous ne pouvons pas utiliser les paramètres name et Uri pour inscrire le référentiel . Le dépôt PSGallery 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 le NameParameterSet ou le 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 à extraire d’un coffre-fort SecretManagement enregistré, où SecretStore est le nom du coffre-fort et TestSecret est le nom du secret stocké.

Le module Microsoft.PowerShell.SecretManagement doit être installé, disposer d’un coffre-fort enregistré et d’un secret stocké dans celui-ci. Si elle est correctement configurée, la commande Get-SecretInfo -Name 'TestSecret' renvoie le secret.

Le format du secret doit correspondre aux exigences du référentiel. Dans certains cas, TestSecret il peut être nécessaire de le stocker en tant qu’objet PSCredential avec un nom d’utilisateur et un mot de passe ou un jeton. Dans d’autres, il peut être nécessaire de le stocker en tant que SecureString représentant uniquement le jeton.

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

  • V2 : utilise l’API NuGet V2
  • V3 - utilise l’API NuGet V3
  • ContainerRegistry - utilisé pour Azure Container Registry
  • Local : utilisez-le pour les référentiels basés sur le système de fichiers
  • NugetServer : utilisez-le pour les référentiels NuGet.Server

L’applet de commande Register-PSResourceRepository 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.

Propriétés des paramètres

Type:Microsoft.PowerShell.PSResourceGet.UtilClasses.PSRepositoryInfo+APIVersion
Valeur par défaut:None
Valeurs acceptées:V2, V3, Local, NugetServer, ContainerRegistry
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

NameParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Propriétés des paramètres

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False
Alias:cf

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-CredentialInfo

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

Propriétés des paramètres

Type:Microsoft.PowerShell.PSResourceGet.UtilClasses.PSCredentialInfo
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

NameParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-CredentialProvider

Il s’agit d’un paramètre dynamique qui spécifie le fournisseur d’accréditations à utiliser pour le dépôt. Ce paramètre n’est disponible que lorsque le dépôt enregistré est un flux Azure Artifacts. Les valeurs valides sont les suivantes :

  • None - Aucun fournisseur de crédibilité défini
  • AzArtifacts - Utiliser le fournisseur Azure Artifacts Credential

Si vous n’utilisez pas ce paramètre, la valeur par défaut est None. Si l’URL du dépôt contient pkgs.dev.azure.com ou pkgs.visualstudio.com, la commande enregistre automatiquement le dépôt avec la propriété CredentialProvider définie à AzArtifacts.

Propriétés des paramètres

Type:Microsoft.PowerShell.PSResourceGet.UtilClasses.CredentialProviderType
Valeur par défaut:None
Valeurs acceptées:None, AzArtifacts
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

NameParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Force

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

Propriétés des paramètres

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Name

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

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

NameParameterSet
Position:0
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-PassThru

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

Propriétés des paramètres

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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 dans 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.

Propriétés des paramètres

Type:Int32
Valeur par défaut:50
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

NameParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
PSGalleryParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-PSGallery

En cas de spécification, inscrit référentiel PSGallery.

Propriétés des paramètres

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

PSGalleryParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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 le NameParameterSet ou le PSGalleryParameterSet.

Propriétés des paramètres

Type:

Hashtable[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

RepositoriesParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Trusted

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

Propriétés des paramètres

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

NameParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
PSGalleryParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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://

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

NameParameterSet
Position:1
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.

Propriétés des paramètres

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False
Alias:Wi

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

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.