nuget.config 参照

NuGet のビヘイビアーは、NuGet.Config に記載されているように nuget.configまたはの異なるファイルでの設定によって制御されます。

nuget.config は、最上位の <configuration> ノードを含む XML ファイルであり、このトピックで説明するセクション要素が含まれます。 各セクションにゼロ 個以上の項目を含む。 「examples config file」 (構成ファイルの例) を参照してください。 名前の設定には大文字と小文字の区別があり、値には環境変数を使用することができます。

config セクション

nuget config コマンドを使用して設定できる、さまざまな構成設定が含まれます。

注: dependencyVersion とrepositoryPath については、packages.config を使用するプロジェクトのみに適用されます。 globalPackagesFolder は PackageReference 形式を使用するプロジェクトのみに適用されます。

例:

<config>
    <add key="dependencyVersion" value="Highest" />
    <add key="globalPackagesFolder" value="c:\packages" />
    <add key="repositoryPath" value="c:\installed_packages" />
    <add key="http_proxy" value="http://company-squid:3128@contoso.com" />
    <add key="signatureValidationMode" value="require" />
    <add key="maxHttpRequestsPerSource" value="16" />
    <add key="updatePackageLastAccessTime" value="false" />
</config>

bindingRedirects セクション

パッケージのインストール時に、NuGet で自動バインド リダイレクトを実行するかどうかを構成します。

例:

<bindingRedirects>
    <add key="skip" value="True" />
</bindingRedirects>

packageRestore セクション

ビルド時のパッケージの復元を制御します。

例:

<packageRestore>
    <add key="enabled" value="true" />
    <add key="automatic" value="true" />
</packageRestore>

solution セクション

ソリューションの packages フォルダーをソース管理に含めるかどうかを制御します。 このセクションは、ソリューション フォルダー内の nuget.config ファイルでのみ機能します。

例:

<solution>
    <add key="disableSourceControlIntegration" value="true" />
</solution>

パッケージ ソース セクション

packageSources、packageSourceCredentials、apikeys、activePackageSource、disabledPackageSources、trustedSigners、packageSourceMapping のすべての連携によって、インストール、復元、および更新の操作中にパッケージ リポジトリを NuGet で操作する方法が構成されます。

これらの設定を管理するために、通常は、 nuget sources コマンド が使用されます。ただしapikeysの場合は例外であり nuget setapikey コマンドによって管理され、trustedSignersはnuget trusted-signers コマンドを使用して管理されます。

ここで、nuget.org のソース URL は https://api.nuget.org/v3/index.json となります。

packageSources

すべての既知のパッケージ ソースの一覧を表示します。 復元操作中、および PackageReference 形式を使用するプロジェクトでは、順序は無視されます。 NuGet では、次を使用 packages.configするプロジェクトでのインストール操作と更新操作のソースの順序が考慮されます。

例:

<packageSources>
    <clear />
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
    <add key="Contoso" value="https://contoso.com/packages/" />
    <add key="http-source" value="http://httpsourcetrusted/" allowInsecureConnections="true" />
    <add key="Invalid-certificate-https-source" value="https://httpsSourceTrusted/" disableTLSCertificateValidation="true" />
    <add key="Test Source" value="c:\packages" />
</packageSources>

auditSources

NuGet Audit が復元時に使用するすべての既知の監査ソースを一覧表示します。 監査ソースが指定されていない場合、復元ではパッケージ ソースが使用され、 NU1905 が抑制されます。 auditSources が NuGet 6.12 に追加されました。

監査ソースでは、packageSources (protocolVersion, allowInsecureConnections) と同じ属性がサポートされます。認証を必要とするソースは、packageSourceCredentials と同じように packageSources で構成されます。

例:

<auditSources>
    <clear />
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
</auditSources>

packageSourceCredentials

通常、-username スイッチおよび -password スイッチと nuget sources によって指定される、ソースのユーザー名とパスワードを格納します。 -storepasswordincleartext オプションが使用されていない場合、既定ではパスワードが暗号化されます。 必要に応じて、スイッチで有効な認証の種類を -validauthenticationtypes 指定できます。

例:

構成ファイル内の <packageSourceCredentials> 要素には、適用可能なソース名ごとに子ノードが含まれます (名前内のスペースは _x0020_ と置換されます)。 つまり、"Contoso" および "Test Source" という名前のソースの場合は、暗号化されたパスワードを使用するとき、構成ファイルには次の内容が含まれます。

<packageSourceCredentials>
    <Contoso>
        <add key="Username" value="user@contoso.com" />
        <add key="Password" value="..." />
    </Contoso>
    <Test_x0020_Source>
        <add key="Username" value="user" />
        <add key="Password" value="..." />
    </Test_x0020_Source>
</packageSourceCredentials>

また、有効な認証方法を指定できます。

<packageSourceCredentials>
    <Contoso>
        <add key="Username" value="user@contoso.com" />
        <add key="Password" value="..." />
        <add key="ValidAuthenticationTypes" value="basic" />
    </Contoso>
    <Test_x0020_Source>
        <add key="Username" value="user" />
        <add key="Password" value="..." />
        <add key="ValidAuthenticationTypes" value="basic, negotiate" />
    </Test_x0020_Source>
</packageSourceCredentials>

環境変数に格納されている暗号化されていないパスワードを使用する場合:

<packageSourceCredentials>
    <Contoso>
        <add key="Username" value="user@contoso.com" />
        <add key="ClearTextPassword" value="%ContosoPassword%" />
    </Contoso>
    <Test_x0020_Source>
        <add key="Username" value="user" />
        <add key="ClearTextPassword" value="%TestSourcePassword%" />
    </Test_x0020_Source>
</packageSourceCredentials>

暗号化されていないパスワードを使用する場合:

<packageSourceCredentials>
    <Contoso>
        <add key="Username" value="user@contoso.com" />
        <add key="ClearTextPassword" value="33f!!lloppa" />
    </Contoso>
    <Test_x0020_Source>
        <add key="Username" value="user" />
        <add key="ClearTextPassword" value="hal+9ooo_da!sY" />
    </Test_x0020_Source>
</packageSourceCredentials>

apikeys

nuget setapikey コマンドで設定される、API キー認証を使用するソースのキーを格納します。

例:

<apikeys>
    <add key="https://MyRepo/ES/api/v2/package" value="encrypted_api_key" />
</apikeys>

disabledPackageSources

現在無効になっているソースを識別します。 空でもかまいません。 このセクションで特定のソースが無効になっていない限り、有効になります。

例:

<disabledPackageSources>
    <add key="Contoso" value="true" />
</disabledPackageSources>

<!-- Empty list -->
<disabledPackageSources />

上記の例で、パッケージ ソース Contoso は無効で、パッケージのダウンロードやインストールには使用されません。

activePackageSource

(2.x のみ。3.x 以降では非推奨とされます)

現在アクティブなソースを識別し、すべてのソースの集計を示します。

例:

<activePackageSource>
    <!-- Only one active source-->
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />

    <!-- All non-disabled sources are active -->
    <add key="All" value="(Aggregate source)" />
</activePackageSource>

信頼されている署名者 セクション

インストールまたは復元中にパッケージを許可するために使用される信頼された署名者を格納します。 このリストは、ユーザーが 〘 に設定 signatureValidationMode するときに空に requireすることはできません。

このセクションは、コマンドnuget trusted-signers更新できます。

[スキーマ]:

信頼されたサイナーには、特定のサイナーを識別するすべての証明書を登録するcertificateアイテムのコレクションがあります。 信頼できるサイナーには、AuthorかRepositoryのいずれかを指定できます。

信頼されたリポジトリでは、リポジトリのserviceIndex (有効な https URI である必要があります) も指定し、オプションでセミコロン区切りのownersのリストを指定して、その特定のリポジトリから信頼されているユーザーをさらに制限することもできます。

証明書フィンガープリントに使用される対応しているハッシュ アルゴリズムは、次のとおりですSHA256SHA384。 SHA512

certificate指定された証明書としてallowUntrustedRoot指定trueされている場合、署名検証の一環として証明書チェーンを構築するときに、信頼されていないrootにチェーンできます。

例:

<trustedSigners>
    <author name="microsoft">
        <certificate fingerprint="3F9001EA83C560D712C24CF213C3D312CB3BFF51EE89435D3430BD06B5D0EECE" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
        <certificate fingerprint="AA12DA22A49BCE7D5C1AE64CC1F3D892F150DA76140F210ABD2CBFFCA2C18A27" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
        <certificate fingerprint="566A31882BE208BE4422F7CFD66ED09F5D4524A5994F50CCC8B05EC0528C1353" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
    </author>
    <repository name="nuget.org" serviceIndex="https://api.nuget.org/v3/index.json">
        <certificate fingerprint="0E5F38F57DC1BCC806D8494F4F90FBCEDD988B46760709CBEEC6F4219AA6157D" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
        <certificate fingerprint="5A2901D6ADA3D18260B9C6DFE2133C95D74B9EEF6AE0E5DC334C8454D1477DF4" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
        <certificate fingerprint="1F4B311D9ACC115C8DC8018B5A49E00FCE6DA8E2855F9F014CA6F34570BC482D" hashAlgorithm="SHA256" allowUntrustedRoot="false" />        
        <owners>microsoft;aspnet;nuget</owners>
    </repository>
</trustedSigners>

fallbackPackageFoldersセクション

(3.5 以降) フォールバック フォルダーにパッケージが見つかった場合に作業を行う必要がないように、パッケージをプレインストールする方法を提供します。 フォールバック パッケージ フォルダーにグローバル パッケージ フォルダーとまったく同じフォルダーとファイル構造があります。 .nupkg が存在し、すべてのファイルが抽出されます。

この構成のリファレンスロジックは次のとおりです。

• グローバル パッケージ フォルダーを調べ、パッケージ/バージョンが既にダウンロードされているかどうかを確認します。

• フォールバック フォルダーでパッケージ/バージョンの一致を確認します。

検索が成功した場合、ダウンロードは不要。

一致が見つからない場合、NuGet はファイル ソースをチェックしてから http ソースをダウンロードし、パッケージをダウンロードします。

例:

<fallbackPackageFolders>
   <add key="XYZ Offline Packages" value="C:\somePath\someFolder\"/>
</fallbackPackageFolders>

パッケージのソース マップセクション

この packageSourceMapping セクションには、NuGet パッケージ操作でパッケージ ID のダウンロード先を決定するのに役立つ詳細を含む。

このセクションは、現在、手動でのみ管理できます。

packageSourceMappingセクションには packageSource セクションのみを包含できます。

packageSource

packageSourceMapping セクションのサブセクション NuGet が目的のパッケージをダウンロードするためにソースを考慮する必要があるかどうかを判断するのに役立つマッピングを含む。

packageSourceの下のpackageSourceMappingセクションはkeyで一意識別されます。

パッケージ

は package セクションの packageSource 一部です。

例:

<packageSourceMapping>
  <packageSource key="contoso.com">
    <package pattern="Contoso.*" />
  </packageSource>
</packageSourceMapping>

packageManagement セクション

既定のパッケージ管理形式 (packages.config または PackageReference) を設定します。 SDK スタイルのプロジェクトでは、常に PackageReference が使用されます。

例:

<packageManagement>
   <add key="format" value="1" />
   <add key="disabled" value="False" />
</packageManagement>

環境変数の使用

環境変数を nuget.config 値 (NuGet 3.4 以降) に使用することで、実行時に設定を適用できます。

例えば、Windows 上の HOME 環境変数を c:\users\username に設定すると、構成ファイル内の %HOME%\NuGetRepository の値は c:\users\username\NuGetRepository に解決されます。

Mac/Linux でも Windows スタイルの環境変数 (開始と終了は %) を使用する必要があることに注意してください。 $HOME/NuGetRepository構成ファイルに含まれると解決することができません。 Mac/Linux では、値 %HOME%/NuGetRepository は /home/myStuff/NuGetRepository.

環境変数が見つからない場合、NuGet は構成ファイルからのリテラル値を使用します。 例えば %MY_UNDEFINED_VAR%/NuGetRepository 、次のように解決されます。 path/to/current_working_dir/$MY_UNDEFINED_VAR/NuGetRepository

次の表は、NuGet.Config ファイルの環境変数の構文とパス区切り記号対応を示しています。

NuGet.Config 環境変数に対応

構成ファイルの例

オプションの設定を含む複数の設定を示す nuget.config ファイルの例を次に示します：

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <config>
        <!--
            Used to specify the default ___location to expand packages.
            See: nuget.exe help install
            See: nuget.exe help update

            In this example, %PACKAGEHOME% is an environment variable.
            This syntax works on Windows/Mac/Linux
        -->
        <add key="repositoryPath" value="%PACKAGEHOME%/External" />

        <!--
            Used to specify default source for the push command.
            See: nuget.exe help push
        -->

        <add key="defaultPushSource" value="https://MyRepo/ES/api/v2/package" />

        <!-- Proxy settings -->
        <add key="http_proxy" value="host" />
        <add key="http_proxy.user" value="username" />
        <add key="http_proxy.password" value="encrypted_password" />
    </config>

    <packageRestore>
        <!-- Allow NuGet to download missing packages -->
        <add key="enabled" value="True" />

        <!-- Automatically check for missing packages during build in Visual Studio -->
        <add key="automatic" value="True" />
    </packageRestore>

    <!--
        Used to specify the default Sources for list, install and update.
        See: nuget.exe help list
        See: nuget.exe help install
        See: nuget.exe help update
    -->
    <packageSources>
        <clear />
        <add key="NuGet official package source" value="https://api.nuget.org/v3/index.json" />
        <add key="MyRepo - ES" value="https://MyRepo/ES/nuget" />
    </packageSources>

    <!-- Used to store credentials -->
    <packageSourceCredentials />

    <!-- Used to disable package sources  -->
    <disabledPackageSources />

    <!--
        Used to specify default API key associated with sources.
        See: nuget.exe help setApiKey
        See: nuget.exe help push
        See: nuget.exe help mirror
    -->
    <apikeys>
        <add key="https://MyRepo/ES/api/v2/package" value="encrypted_api_key" />
    </apikeys>

    <!--
        Used to specify trusted signers to allow during signature verification.
        See: nuget.exe help trusted-signers
    -->
    <trustedSigners>
        <author name="microsoft">
            <certificate fingerprint="3F9001EA83C560D712C24CF213C3D312CB3BFF51EE89435D3430BD06B5D0EECE" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
            <certificate fingerprint="AA12DA22A49BCE7D5C1AE64CC1F3D892F150DA76140F210ABD2CBFFCA2C18A27" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
            <certificate fingerprint="566A31882BE208BE4422F7CFD66ED09F5D4524A5994F50CCC8B05EC0528C1353" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
        </author>
        <repository name="nuget.org" serviceIndex="https://api.nuget.org/v3/index.json">
            <certificate fingerprint="0E5F38F57DC1BCC806D8494F4F90FBCEDD988B46760709CBEEC6F4219AA6157D" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
            <certificate fingerprint="5A2901D6ADA3D18260B9C6DFE2133C95D74B9EEF6AE0E5DC334C8454D1477DF4" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
            <certificate fingerprint="1F4B311D9ACC115C8DC8018B5A49E00FCE6DA8E2855F9F014CA6F34570BC482D" hashAlgorithm="SHA256" allowUntrustedRoot="false" />
            <owners>microsoft;aspnet;nuget</owners>
        </repository>
    </trustedSigners>
</configuration>