1. Packages
  2. Artifactory Provider
  3. API Docs
  4. getVirtualNpmRepository
Viewing docs for artifactory v8.10.3
published on Thursday, Feb 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-artifactory

artifactory.getVirtualNpmRepository

artifactory logo
Viewing docs for artifactory v8.10.3
published on Thursday, Feb 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-artifactory

    Retrieves a virtual NPM repository.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as artifactory from "@pulumi/artifactory";

const virtual_npm = artifactory.getVirtualNpmRepository({
    key: "virtual-npm",
});

    import pulumi
import pulumi_artifactory as artifactory

virtual_npm = artifactory.get_virtual_npm_repository(key="virtual-npm")

    package main

import (
	"github.com/pulumi/pulumi-artifactory/sdk/v8/go/artifactory"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := artifactory.LookupVirtualNpmRepository(ctx, &artifactory.LookupVirtualNpmRepositoryArgs{
			Key: "virtual-npm",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Artifactory = Pulumi.Artifactory;

return await Deployment.RunAsync(() => 
{
    var virtual_npm = Artifactory.GetVirtualNpmRepository.Invoke(new()
    {
        Key = "virtual-npm",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.artifactory.ArtifactoryFunctions;
import com.pulumi.artifactory.inputs.GetVirtualNpmRepositoryArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var virtual-npm = ArtifactoryFunctions.getVirtualNpmRepository(GetVirtualNpmRepositoryArgs.builder()
            .key("virtual-npm")
            .build());

    }
}

    variables:
  virtual-npm:
    fn::invoke:
      function: artifactory:getVirtualNpmRepository
      arguments:
        key: virtual-npm

    Using getVirtualNpmRepository

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVirtualNpmRepository(args: GetVirtualNpmRepositoryArgs, opts?: InvokeOptions): Promise<GetVirtualNpmRepositoryResult>
function getVirtualNpmRepositoryOutput(args: GetVirtualNpmRepositoryOutputArgs, opts?: InvokeOptions): Output<GetVirtualNpmRepositoryResult>
    def get_virtual_npm_repository(artifactory_requests_can_retrieve_remote_artifacts: Optional[bool] = None,
                               default_deployment_repo: Optional[str] = None,
                               description: Optional[str] = None,
                               excludes_pattern: Optional[str] = None,
                               external_dependencies_enabled: Optional[bool] = None,
                               external_dependencies_patterns: Optional[Sequence[str]] = None,
                               external_dependencies_remote_repo: Optional[str] = None,
                               includes_pattern: Optional[str] = None,
                               key: Optional[str] = None,
                               notes: Optional[str] = None,
                               project_environments: Optional[Sequence[str]] = None,
                               project_key: Optional[str] = None,
                               repo_layout_ref: Optional[str] = None,
                               repositories: Optional[Sequence[str]] = None,
                               retrieval_cache_period_seconds: Optional[int] = None,
                               opts: Optional[InvokeOptions] = None) -> GetVirtualNpmRepositoryResult
def get_virtual_npm_repository_output(artifactory_requests_can_retrieve_remote_artifacts: Optional[pulumi.Input[bool]] = None,
                               default_deployment_repo: Optional[pulumi.Input[str]] = None,
                               description: Optional[pulumi.Input[str]] = None,
                               excludes_pattern: Optional[pulumi.Input[str]] = None,
                               external_dependencies_enabled: Optional[pulumi.Input[bool]] = None,
                               external_dependencies_patterns: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                               external_dependencies_remote_repo: Optional[pulumi.Input[str]] = None,
                               includes_pattern: Optional[pulumi.Input[str]] = None,
                               key: Optional[pulumi.Input[str]] = None,
                               notes: Optional[pulumi.Input[str]] = None,
                               project_environments: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                               project_key: Optional[pulumi.Input[str]] = None,
                               repo_layout_ref: Optional[pulumi.Input[str]] = None,
                               repositories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                               retrieval_cache_period_seconds: Optional[pulumi.Input[int]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetVirtualNpmRepositoryResult]
    func LookupVirtualNpmRepository(ctx *Context, args *LookupVirtualNpmRepositoryArgs, opts ...InvokeOption) (*LookupVirtualNpmRepositoryResult, error)
func LookupVirtualNpmRepositoryOutput(ctx *Context, args *LookupVirtualNpmRepositoryOutputArgs, opts ...InvokeOption) LookupVirtualNpmRepositoryResultOutput

    > Note: This function is named LookupVirtualNpmRepository in the Go SDK.

    public static class GetVirtualNpmRepository 
{
    public static Task<GetVirtualNpmRepositoryResult> InvokeAsync(GetVirtualNpmRepositoryArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualNpmRepositoryResult> Invoke(GetVirtualNpmRepositoryInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVirtualNpmRepositoryResult> getVirtualNpmRepository(GetVirtualNpmRepositoryArgs args, InvokeOptions options)
public static Output<GetVirtualNpmRepositoryResult> getVirtualNpmRepository(GetVirtualNpmRepositoryArgs args, InvokeOptions options)

    fn::invoke:
  function: artifactory:index/getVirtualNpmRepository:getVirtualNpmRepository
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Key string
    the identity key of the repo.
    ArtifactoryRequestsCanRetrieveRemoteArtifacts bool
    DefaultDeploymentRepo string
    Description string
    ExcludesPattern string
    ExternalDependenciesEnabled bool
    ExternalDependenciesPatterns List<string>
    ExternalDependenciesRemoteRepo string
    IncludesPattern string
    Notes string
    ProjectEnvironments List<string>
    ProjectKey string
    RepoLayoutRef string
    Repositories List<string>
    RetrievalCachePeriodSeconds int
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    Key string
    the identity key of the repo.
    ArtifactoryRequestsCanRetrieveRemoteArtifacts bool
    DefaultDeploymentRepo string
    Description string
    ExcludesPattern string
    ExternalDependenciesEnabled bool
    ExternalDependenciesPatterns []string
    ExternalDependenciesRemoteRepo string
    IncludesPattern string
    Notes string
    ProjectEnvironments []string
    ProjectKey string
    RepoLayoutRef string
    Repositories []string
    RetrievalCachePeriodSeconds int
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    key String
    the identity key of the repo.
    artifactoryRequestsCanRetrieveRemoteArtifacts Boolean
    defaultDeploymentRepo String
    description String
    excludesPattern String
    externalDependenciesEnabled Boolean
    externalDependenciesPatterns List<String>
    externalDependenciesRemoteRepo String
    includesPattern String
    notes String
    projectEnvironments List<String>
    projectKey String
    repoLayoutRef String
    repositories List<String>
    retrievalCachePeriodSeconds Integer
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    key string
    the identity key of the repo.
    artifactoryRequestsCanRetrieveRemoteArtifacts boolean
    defaultDeploymentRepo string
    description string
    excludesPattern string
    externalDependenciesEnabled boolean
    externalDependenciesPatterns string[]
    externalDependenciesRemoteRepo string
    includesPattern string
    notes string
    projectEnvironments string[]
    projectKey string
    repoLayoutRef string
    repositories string[]
    retrievalCachePeriodSeconds number
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    key str
    the identity key of the repo.
    artifactory_requests_can_retrieve_remote_artifacts bool
    default_deployment_repo str
    description str
    excludes_pattern str
    external_dependencies_enabled bool
    external_dependencies_patterns Sequence[str]
    external_dependencies_remote_repo str
    includes_pattern str
    notes str
    project_environments Sequence[str]
    project_key str
    repo_layout_ref str
    repositories Sequence[str]
    retrieval_cache_period_seconds int
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    key String
    the identity key of the repo.
    artifactoryRequestsCanRetrieveRemoteArtifacts Boolean
    defaultDeploymentRepo String
    description String
    excludesPattern String
    externalDependenciesEnabled Boolean
    externalDependenciesPatterns List<String>
    externalDependenciesRemoteRepo String
    includesPattern String
    notes String
    projectEnvironments List<String>
    projectKey String
    repoLayoutRef String
    repositories List<String>
    retrievalCachePeriodSeconds Number
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.

    getVirtualNpmRepository Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Key string
    PackageType string
    ProjectEnvironments List<string>
    ArtifactoryRequestsCanRetrieveRemoteArtifacts bool
    DefaultDeploymentRepo string
    Description string
    ExcludesPattern string
    ExternalDependenciesEnabled bool
    ExternalDependenciesPatterns List<string>
    ExternalDependenciesRemoteRepo string
    IncludesPattern string
    Notes string
    ProjectKey string
    RepoLayoutRef string
    Repositories List<string>
    RetrievalCachePeriodSeconds int
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    Id string
    The provider-assigned unique ID for this managed resource.
    Key string
    PackageType string
    ProjectEnvironments []string
    ArtifactoryRequestsCanRetrieveRemoteArtifacts bool
    DefaultDeploymentRepo string
    Description string
    ExcludesPattern string
    ExternalDependenciesEnabled bool
    ExternalDependenciesPatterns []string
    ExternalDependenciesRemoteRepo string
    IncludesPattern string
    Notes string
    ProjectKey string
    RepoLayoutRef string
    Repositories []string
    RetrievalCachePeriodSeconds int
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    packageType String
    projectEnvironments List<String>
    artifactoryRequestsCanRetrieveRemoteArtifacts Boolean
    defaultDeploymentRepo String
    description String
    excludesPattern String
    externalDependenciesEnabled Boolean
    externalDependenciesPatterns List<String>
    externalDependenciesRemoteRepo String
    includesPattern String
    notes String
    projectKey String
    repoLayoutRef String
    repositories List<String>
    retrievalCachePeriodSeconds Integer
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    id string
    The provider-assigned unique ID for this managed resource.
    key string
    packageType string
    projectEnvironments string[]
    artifactoryRequestsCanRetrieveRemoteArtifacts boolean
    defaultDeploymentRepo string
    description string
    excludesPattern string
    externalDependenciesEnabled boolean
    externalDependenciesPatterns string[]
    externalDependenciesRemoteRepo string
    includesPattern string
    notes string
    projectKey string
    repoLayoutRef string
    repositories string[]
    retrievalCachePeriodSeconds number
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    id str
    The provider-assigned unique ID for this managed resource.
    key str
    package_type str
    project_environments Sequence[str]
    artifactory_requests_can_retrieve_remote_artifacts bool
    default_deployment_repo str
    description str
    excludes_pattern str
    external_dependencies_enabled bool
    external_dependencies_patterns Sequence[str]
    external_dependencies_remote_repo str
    includes_pattern str
    notes str
    project_key str
    repo_layout_ref str
    repositories Sequence[str]
    retrieval_cache_period_seconds int
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    packageType String
    projectEnvironments List<String>
    artifactoryRequestsCanRetrieveRemoteArtifacts Boolean
    defaultDeploymentRepo String
    description String
    excludesPattern String
    externalDependenciesEnabled Boolean
    externalDependenciesPatterns List<String>
    externalDependenciesRemoteRepo String
    includesPattern String
    notes String
    projectKey String
    repoLayoutRef String
    repositories List<String>
    retrievalCachePeriodSeconds Number
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.

    Package Details

    Repository
    artifactory pulumi/pulumi-artifactory
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the artifactory Terraform Provider.
    artifactory logo
    Viewing docs for artifactory v8.10.3
    published on Thursday, Feb 12, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-artifactory
      Try Pulumi Cloud free. Your team will thank you.