1. Packages
  2. Nexus Provider
  3. API Docs
  4. getRepositoryNpmProxy
nexus 2.5.0 published on Monday, Apr 14, 2025 by datadrivers

nexus.getRepositoryNpmProxy

Explore with Pulumi AI

Use this data source to get an existing npm proxy repository.

Example Usage

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

const npmjs = nexus.getRepositoryNpmProxy({
    name: "npmjs",
});
Copy
import pulumi
import pulumi_nexus as nexus

npmjs = nexus.get_repository_npm_proxy(name="npmjs")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nexus/v2/nexus"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nexus.LookupRepositoryNpmProxy(ctx, &nexus.LookupRepositoryNpmProxyArgs{
			Name: "npmjs",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nexus = Pulumi.Nexus;

return await Deployment.RunAsync(() => 
{
    var npmjs = Nexus.GetRepositoryNpmProxy.Invoke(new()
    {
        Name = "npmjs",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nexus.NexusFunctions;
import com.pulumi.nexus.inputs.GetRepositoryNpmProxyArgs;
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 npmjs = NexusFunctions.getRepositoryNpmProxy(GetRepositoryNpmProxyArgs.builder()
            .name("npmjs")
            .build());

    }
}
Copy
variables:
  npmjs:
    fn::invoke:
      function: nexus:getRepositoryNpmProxy
      arguments:
        name: npmjs
Copy

Using getRepositoryNpmProxy

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 getRepositoryNpmProxy(args: GetRepositoryNpmProxyArgs, opts?: InvokeOptions): Promise<GetRepositoryNpmProxyResult>
function getRepositoryNpmProxyOutput(args: GetRepositoryNpmProxyOutputArgs, opts?: InvokeOptions): Output<GetRepositoryNpmProxyResult>
Copy
def get_repository_npm_proxy(name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetRepositoryNpmProxyResult
def get_repository_npm_proxy_output(name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetRepositoryNpmProxyResult]
Copy
func LookupRepositoryNpmProxy(ctx *Context, args *LookupRepositoryNpmProxyArgs, opts ...InvokeOption) (*LookupRepositoryNpmProxyResult, error)
func LookupRepositoryNpmProxyOutput(ctx *Context, args *LookupRepositoryNpmProxyOutputArgs, opts ...InvokeOption) LookupRepositoryNpmProxyResultOutput
Copy

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

public static class GetRepositoryNpmProxy 
{
    public static Task<GetRepositoryNpmProxyResult> InvokeAsync(GetRepositoryNpmProxyArgs args, InvokeOptions? opts = null)
    public static Output<GetRepositoryNpmProxyResult> Invoke(GetRepositoryNpmProxyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRepositoryNpmProxyResult> getRepositoryNpmProxy(GetRepositoryNpmProxyArgs args, InvokeOptions options)
public static Output<GetRepositoryNpmProxyResult> getRepositoryNpmProxy(GetRepositoryNpmProxyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nexus:index/getRepositoryNpmProxy:getRepositoryNpmProxy
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
A unique identifier for this repository
Name This property is required. string
A unique identifier for this repository
name This property is required. String
A unique identifier for this repository
name This property is required. string
A unique identifier for this repository
name This property is required. str
A unique identifier for this repository
name This property is required. String
A unique identifier for this repository

getRepositoryNpmProxy Result

The following output properties are available:

Cleanups List<GetRepositoryNpmProxyCleanup>
Cleanup policies
HttpClients List<GetRepositoryNpmProxyHttpClient>
HTTP Client configuration for proxy repositories
Id string
Used to identify data source at nexus
Name string
A unique identifier for this repository
NegativeCaches List<GetRepositoryNpmProxyNegativeCach>
Configuration of the negative cache handling
Online bool
Whether this repository accepts incoming requests
Proxies List<GetRepositoryNpmProxyProxy>
Configuration for the proxy repository
RemoveNonCataloged bool
Remove non-catalogued versions from the npm package metadata.

Deprecated: Deprecated

RemoveQuarantined bool
Remove quarantined versions from the npm package metadata.
RoutingRule string
The name of the routing rule assigned to this repository
Storages List<GetRepositoryNpmProxyStorage>
The storage configuration of the repository
Cleanups []GetRepositoryNpmProxyCleanup
Cleanup policies
HttpClients []GetRepositoryNpmProxyHttpClient
HTTP Client configuration for proxy repositories
Id string
Used to identify data source at nexus
Name string
A unique identifier for this repository
NegativeCaches []GetRepositoryNpmProxyNegativeCach
Configuration of the negative cache handling
Online bool
Whether this repository accepts incoming requests
Proxies []GetRepositoryNpmProxyProxy
Configuration for the proxy repository
RemoveNonCataloged bool
Remove non-catalogued versions from the npm package metadata.

Deprecated: Deprecated

RemoveQuarantined bool
Remove quarantined versions from the npm package metadata.
RoutingRule string
The name of the routing rule assigned to this repository
Storages []GetRepositoryNpmProxyStorage
The storage configuration of the repository
cleanups List<GetRepositoryNpmProxyCleanup>
Cleanup policies
httpClients List<GetRepositoryNpmProxyHttpClient>
HTTP Client configuration for proxy repositories
id String
Used to identify data source at nexus
name String
A unique identifier for this repository
negativeCaches List<GetRepositoryNpmProxyNegativeCach>
Configuration of the negative cache handling
online Boolean
Whether this repository accepts incoming requests
proxies List<GetRepositoryNpmProxyProxy>
Configuration for the proxy repository
removeNonCataloged Boolean
Remove non-catalogued versions from the npm package metadata.

Deprecated: Deprecated

removeQuarantined Boolean
Remove quarantined versions from the npm package metadata.
routingRule String
The name of the routing rule assigned to this repository
storages List<GetRepositoryNpmProxyStorage>
The storage configuration of the repository
cleanups GetRepositoryNpmProxyCleanup[]
Cleanup policies
httpClients GetRepositoryNpmProxyHttpClient[]
HTTP Client configuration for proxy repositories
id string
Used to identify data source at nexus
name string
A unique identifier for this repository
negativeCaches GetRepositoryNpmProxyNegativeCach[]
Configuration of the negative cache handling
online boolean
Whether this repository accepts incoming requests
proxies GetRepositoryNpmProxyProxy[]
Configuration for the proxy repository
removeNonCataloged boolean
Remove non-catalogued versions from the npm package metadata.

Deprecated: Deprecated

removeQuarantined boolean
Remove quarantined versions from the npm package metadata.
routingRule string
The name of the routing rule assigned to this repository
storages GetRepositoryNpmProxyStorage[]
The storage configuration of the repository
cleanups Sequence[GetRepositoryNpmProxyCleanup]
Cleanup policies
http_clients Sequence[GetRepositoryNpmProxyHttpClient]
HTTP Client configuration for proxy repositories
id str
Used to identify data source at nexus
name str
A unique identifier for this repository
negative_caches Sequence[GetRepositoryNpmProxyNegativeCach]
Configuration of the negative cache handling
online bool
Whether this repository accepts incoming requests
proxies Sequence[GetRepositoryNpmProxyProxy]
Configuration for the proxy repository
remove_non_cataloged bool
Remove non-catalogued versions from the npm package metadata.

Deprecated: Deprecated

remove_quarantined bool
Remove quarantined versions from the npm package metadata.
routing_rule str
The name of the routing rule assigned to this repository
storages Sequence[GetRepositoryNpmProxyStorage]
The storage configuration of the repository
cleanups List<Property Map>
Cleanup policies
httpClients List<Property Map>
HTTP Client configuration for proxy repositories
id String
Used to identify data source at nexus
name String
A unique identifier for this repository
negativeCaches List<Property Map>
Configuration of the negative cache handling
online Boolean
Whether this repository accepts incoming requests
proxies List<Property Map>
Configuration for the proxy repository
removeNonCataloged Boolean
Remove non-catalogued versions from the npm package metadata.

Deprecated: Deprecated

removeQuarantined Boolean
Remove quarantined versions from the npm package metadata.
routingRule String
The name of the routing rule assigned to this repository
storages List<Property Map>
The storage configuration of the repository

Supporting Types

GetRepositoryNpmProxyCleanup

PolicyNames This property is required. List<string>
PolicyNames This property is required. []string
policyNames This property is required. List<String>
policyNames This property is required. string[]
policy_names This property is required. Sequence[str]
policyNames This property is required. List<String>

GetRepositoryNpmProxyHttpClient

Authentications This property is required. List<GetRepositoryNpmProxyHttpClientAuthentication>
AutoBlock This property is required. bool
Blocked This property is required. bool
Connections This property is required. List<GetRepositoryNpmProxyHttpClientConnection>
Authentications This property is required. []GetRepositoryNpmProxyHttpClientAuthentication
AutoBlock This property is required. bool
Blocked This property is required. bool
Connections This property is required. []GetRepositoryNpmProxyHttpClientConnection
authentications This property is required. List<GetRepositoryNpmProxyHttpClientAuthentication>
autoBlock This property is required. Boolean
blocked This property is required. Boolean
connections This property is required. List<GetRepositoryNpmProxyHttpClientConnection>
authentications This property is required. GetRepositoryNpmProxyHttpClientAuthentication[]
autoBlock This property is required. boolean
blocked This property is required. boolean
connections This property is required. GetRepositoryNpmProxyHttpClientConnection[]
authentications This property is required. Sequence[GetRepositoryNpmProxyHttpClientAuthentication]
auto_block This property is required. bool
blocked This property is required. bool
connections This property is required. Sequence[GetRepositoryNpmProxyHttpClientConnection]
authentications This property is required. List<Property Map>
autoBlock This property is required. Boolean
blocked This property is required. Boolean
connections This property is required. List<Property Map>

GetRepositoryNpmProxyHttpClientAuthentication

NtlmDomain This property is required. string
NtlmHost This property is required. string
Password This property is required. string
Type This property is required. string
Username This property is required. string
NtlmDomain This property is required. string
NtlmHost This property is required. string
Password This property is required. string
Type This property is required. string
Username This property is required. string
ntlmDomain This property is required. String
ntlmHost This property is required. String
password This property is required. String
type This property is required. String
username This property is required. String
ntlmDomain This property is required. string
ntlmHost This property is required. string
password This property is required. string
type This property is required. string
username This property is required. string
ntlm_domain This property is required. str
ntlm_host This property is required. str
password This property is required. str
type This property is required. str
username This property is required. str
ntlmDomain This property is required. String
ntlmHost This property is required. String
password This property is required. String
type This property is required. String
username This property is required. String

GetRepositoryNpmProxyHttpClientConnection

EnableCircularRedirects This property is required. bool
EnableCookies This property is required. bool
Retries This property is required. double
Timeout This property is required. double
UseTrustStore This property is required. bool
UserAgentSuffix This property is required. string
EnableCircularRedirects This property is required. bool
EnableCookies This property is required. bool
Retries This property is required. float64
Timeout This property is required. float64
UseTrustStore This property is required. bool
UserAgentSuffix This property is required. string
enableCircularRedirects This property is required. Boolean
enableCookies This property is required. Boolean
retries This property is required. Double
timeout This property is required. Double
useTrustStore This property is required. Boolean
userAgentSuffix This property is required. String
enableCircularRedirects This property is required. boolean
enableCookies This property is required. boolean
retries This property is required. number
timeout This property is required. number
useTrustStore This property is required. boolean
userAgentSuffix This property is required. string
enable_circular_redirects This property is required. bool
enable_cookies This property is required. bool
retries This property is required. float
timeout This property is required. float
use_trust_store This property is required. bool
user_agent_suffix This property is required. str
enableCircularRedirects This property is required. Boolean
enableCookies This property is required. Boolean
retries This property is required. Number
timeout This property is required. Number
useTrustStore This property is required. Boolean
userAgentSuffix This property is required. String

GetRepositoryNpmProxyNegativeCach

Enabled This property is required. bool
Ttl This property is required. double
Enabled This property is required. bool
Ttl This property is required. float64
enabled This property is required. Boolean
ttl This property is required. Double
enabled This property is required. boolean
ttl This property is required. number
enabled This property is required. bool
ttl This property is required. float
enabled This property is required. Boolean
ttl This property is required. Number

GetRepositoryNpmProxyProxy

ContentMaxAge This property is required. double
MetadataMaxAge This property is required. double
RemoteUrl This property is required. string
ContentMaxAge This property is required. float64
MetadataMaxAge This property is required. float64
RemoteUrl This property is required. string
contentMaxAge This property is required. Double
metadataMaxAge This property is required. Double
remoteUrl This property is required. String
contentMaxAge This property is required. number
metadataMaxAge This property is required. number
remoteUrl This property is required. string
content_max_age This property is required. float
metadata_max_age This property is required. float
remote_url This property is required. str
contentMaxAge This property is required. Number
metadataMaxAge This property is required. Number
remoteUrl This property is required. String

GetRepositoryNpmProxyStorage

BlobStoreName This property is required. string
StrictContentTypeValidation This property is required. bool
BlobStoreName This property is required. string
StrictContentTypeValidation This property is required. bool
blobStoreName This property is required. String
strictContentTypeValidation This property is required. Boolean
blobStoreName This property is required. string
strictContentTypeValidation This property is required. boolean
blob_store_name This property is required. str
strict_content_type_validation This property is required. bool
blobStoreName This property is required. String
strictContentTypeValidation This property is required. Boolean

Package Details

Repository
nexus datadrivers/terraform-provider-nexus
License
Notes
This Pulumi package is based on the nexus Terraform Provider.