Register-PSResourceRepository

リファレンス

モジュール:: Microsoft.PowerShell.PSResourceGet

PowerShell リソースのリポジトリを登録します。

構文

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>]

説明

このコマンドレットは、PowerShell リソースを含む NuGet リポジトリを登録します。

例

例 1

次の例では、リポジトリを [名前]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

例 2

この例では、既定 PSGallery のリポジトリを登録します。前の例とは異なり、Name パラメーターと Uri パラメーターを使用してリポジトリをPSGallery登録することはできません。リポジトリは PSGallery 既定で登録されていますが、削除できます。このコマンドを使用して、既定の登録を復元します。

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

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

例 3

この例では、複数のリポジトリを一度に登録します。これを行うには、Repository パラメーターを使用し、ハッシュテーブルの配列を提供します。各ハッシュテーブルには、NameParameterSet または 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

例 4

この例では、登録済みの SecretManagement コンテナーから取得する資格情報を持つリポジトリを登録します。 Microsoft.PowerShell.SecretManagement モジュールをインストールし、保存されているシークレットを含む登録済みコンテナーを持っている必要があります。シークレットの形式は、リポジトリの要件と一致している必要があります。

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

パラメーター

-ApiVersion

リポジトリで使用される API バージョンを指定します。有効な値は次の通りです。

v2 - NuGet V2 API を使用する
v3 - NuGet V3 API を使用します
local - ファイルシステムベースのリポジトリに使用します
nugetServer - これは NuGet.Server ベースのリポジトリに使用します

このコマンドレットは Register-PSResourceRepository 、API のバージョンを自動的に検出します。このパラメーターを使用すると、リポジトリを登録した後で API のバージョンを変更できます。

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

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

-CredentialInfo

コンテナーの名前と、Microsoft.PowerShell.SecretManagement ストアに格納されているシークレットを含む PSCredentialInfo オブジェクト。

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

-Force

リポジトリが既に存在する場合は上書きします。

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

-Name

登録するリポジトリの名前。 PSGallery にすることはあり得ません。

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

-PassThru

指定すると、正常に登録されたリポジトリとその情報が表示されます。

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

-Priority

リポジトリの優先順位のランク付けを指定します。有効な優先順位の値の範囲は 0 から 100 です。値を小さくすると、優先順位が高くなります。既定値は 50 です。

リポジトリは優先度で並べ替えられた後、名前で並べ替えられます。複数のリポジトリ間でリソースを検索する場合、 PSResourceGet コマンドレットは、この並べ替え順序を使用してリポジトリを検索し、最初に見つかった一致を返します。

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

-PSGallery

指定すると、PSGallery リポジトリが登録されます。

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

-Repository

リポジトリ情報を含むハッシュテーブルの配列を指定します。複数のリポジトリを一度に登録するには、このパラメーターを使用します。各ハッシュテーブルには、NameParameterSet または PSGalleryParameterSet のパラメーターにのみキーを関連付けることができます。

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

-Trusted

リポジトリを信頼するかどうかを指定します。

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

-Uri

登録するリポジトリの場所を指定します。値には、次のいずれかの URI スキーマを使用する必要があります。

https://
http://
ftp://
file://

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。コマンドレットは実行されません。

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

入力

None

出力

Microsoft.PowerShell.PSResourceGet.UtilClasses.PSRepositoryInfo

既定では、コマンドレットは出力を生成しません。 PassThru パラメーターを使用すると、コマンドレットは PSRepositoryInfo オブジェクトを返します。

メモ

リポジトリは名前によって一意です。同じ名前のリポジトリを登録しようとすると、エラーが発生します。

Microsoft.PowerShell.SecretManagement

次の方法で共有

Register-PSResourceRepository

構文

説明

例

例 1

例 2

例 3

例 4

パラメーター

-ApiVersion

-Confirm

-CredentialInfo

-Force

-Name

-PassThru

-Priority

-PSGallery

-Repository

-Trusted

-Uri

-WhatIf

入力

出力

メモ

フィードバック

その他のリソース

次の方法で共有

Register-PSResourceRepository

構文

説明

例

例 1

例 2

例 3

例 4

パラメーター

-ApiVersion

-Confirm

-CredentialInfo

-Force

-Name

-PassThru

-Priority

-PSGallery

-Repository

-Trusted

-Uri

-WhatIf

入力

出力

メモ

関連リンク

フィードバック

その他のリソース