Configure upstream behavior

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

With Azure Artifacts upstream sources, developers gain the convenience of utilizing a unified feed to both publish and consume packages from Artifact feeds and popular public registries like NuGet.org or npmjs.com. Previously, Artifact feeds combined a list of available package versions from both the feed itself and all the configured upstream sources.

Upstream behavior is a feature that enables developers to choose if they want to consume externally sourced package versions. It governs which packages are accessible from the public registries for specific packages.

Once upstream behavior is enabled, when a package is published to your Azure Artifacts feed, any version from the public registry is blocked and not made available for download.

This approach adds an extra layer of security by preventing potential exposure to malicious packages that might have infiltrated the public registries.

However, users can still deactivate the upstream behavior setting, allowing them to consume packages from the public registries if they prefer to do so.

Note

The new behavior will not impact any package versions that are currently in use, as they are preserved within the feed's @local view.

Applicable scenarios

The following section illustrates various common scenarios where the upstream behavior is triggered to block externally sourced package versions, and other scenarios where there's no need to block access to public packages.

Public versions are blocked

• Private package version made public
• Having both private and public packages

Private package version made public

In this scenario, a team has a private package that was made public. The upstream behavior in this case will be triggered to block any new public versions (untrusted packages).

Having both private and public packages

In this scenario, if a team uses a combination of private and public packages, enabling the upstream behavior blocks any new package versions from the public registry.

Public versions won't be blocked

• All packages are private
• All packages are public
• Public package made private

All packages are private*

If all existing packages are private, and the team has no plans to use any public packages, the new upstream behavior has no effect on the team's workflow in this scenario.

All packages are public

In this scenario, if the team exclusively consumes public packages, whether from the public registry or other open-source repositories, the new upstream behavior doesn't affect their workflow in any way.

Public package made private

In this situation, when a public package is converted to a private package, the new upstream behavior doesn't affect the team's workflow in any way.

Allow external versions

Note

You must be a Feed Owner to allow externally sourced versions. For more information, see Feed permissions.

1. Sign in to your Azure DevOps organization, and then navigate to your project.

2. Select Artifacts, and then select your feed from the dropdown menu.

3. Select your package, and then select the ellipsis button for more options. Select Allow externally-sourced versions.

   

4. Select the toggle button to allow external versions. Select Close when you're done.

   

Allow external versions using the REST API

NuGet

• Set upstreaming behavior
• Get upstreaming behavior

npm

• Set upstreaming behavior
• Set scoped upstreaming behavior
• Get package upstreaming behavior
• Get scoped package upstreaming behavior

Python

• Get upstreaming behavior
• Set upstreaming behavior

Maven

• Get upstreaming behavior
• Set upstreaming behavior

Allow external versions using PowerShell

1. Create a personal access token with Packaging > Read, write, & manage permissions.

   

2. Create an environment variable for your personal access token.

   $env:PATVAR = "YOUR_PERSONAL_ACCESS_TOKEN"
   

3. Convert your personal access token to baser64 encoded string and construct the HTTP request header.

   $token = [Convert]::ToBase64String(([Text.Encoding]::ASCII.GetBytes("username:$env:PatVar")))
   $headers = @{
       Authorization = "Basic $token"
   }
   

4. Construct your endpoint url. Example: //pkgs.dev.azure.com/MyOrg/MyProject/_apis/packaging/feeds/MyFeed/nuget/packages/pkg1.0.0.nupkg/upstreaming?api-version=6.1-preview.1

   • Project-scoped feed:

     $url = "https://pkgs.dev.azure.com/<ORGANIZATION_NAME>/<PROJECT_NAME>/_apis/packaging/feeds/<FEED_NAME>/<PROTOCOL>/packages/<PACKAGE_NAME>/upstreaming?api-version=6.1-preview.1"
     

   • Organization-scoped feed:

     $url = "https://pkgs.dev.azure.com/<ORGANIZATION_NAME>/_apis/packaging/feeds/<FEED_NAME>/<PROTOCOL>/packages/<PACKAGE_NAME>/upstreaming?api-version=6.1-preview.1"
     

Get upstreaming behavior

Run the following command to retrieve the upstream behavior state of your package. $url and $headers are the same variables we used in the previous section.

Invoke-RestMethod -Uri $url -Headers $headers

Set upstreaming behavior

Run the following commands to allow externally sourced versions for your package. This sets versionsFromExternalUpstreams to AllowExternalVersions, and uses the $url and $headers variables to query the REST API.

$body = '{"versionsFromExternalUpstreams": "AllowExternalVersions"}'

Invoke-RestMethod -Uri $url -Headers $headers -Body $body -Method Patch -ContentType "application/json"

Note

In some cases, setting up the upstream behavior can take time to propagate across the service. If your package is not available after updating the settings, please allow up to 3 hours for the new settings to take effect.

Clear upstreaming behavior

To clear the upstream behavior for your package, run the following commands to set versionsFromExternalUpstreams to Auto and query the REST API.

$body = '{"versionsFromExternalUpstreams": "Auto"}'

Invoke-RestMethod -Uri $url -Headers $headers -Body $body -Method Patch -ContentType "application/json"

Related articles

• Understand upstream sources
• Set up upstream sources
• Manage dependencies with upstream sources
• Feeds permissions
• Best practices