Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Artifactory Provider
  3. API Docs
  4. getLocalPypiRepository
artifactory v8.8.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-artifactory

artifactory.getLocalPypiRepository

Explore with Pulumi AI

artifactory v8.8.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-artifactory

Retrieves a local pypi repository.

Example Usage

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

const local_test_pypi_repo = artifactory.getLocalPypiRepository({
    key: "local-test-pypi-repo",
});
Copy
import pulumi
import pulumi_artifactory as artifactory

local_test_pypi_repo = artifactory.get_local_pypi_repository(key="local-test-pypi-repo")
Copy
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.LookupLocalPypiRepository(ctx, &artifactory.LookupLocalPypiRepositoryArgs{
			Key: "local-test-pypi-repo",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Artifactory = Pulumi.Artifactory;

return await Deployment.RunAsync(() => 
{
    var local_test_pypi_repo = Artifactory.GetLocalPypiRepository.Invoke(new()
    {
        Key = "local-test-pypi-repo",
    });

});
Copy
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.GetLocalPypiRepositoryArgs;
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 local-test-pypi-repo = ArtifactoryFunctions.getLocalPypiRepository(GetLocalPypiRepositoryArgs.builder()
            .key("local-test-pypi-repo")
            .build());

    }
}
Copy
variables:
  local-test-pypi-repo:
    fn::invoke:
      function: artifactory:getLocalPypiRepository
      arguments:
        key: local-test-pypi-repo
Copy

Using getLocalPypiRepository

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 getLocalPypiRepository(args: GetLocalPypiRepositoryArgs, opts?: InvokeOptions): Promise<GetLocalPypiRepositoryResult>
function getLocalPypiRepositoryOutput(args: GetLocalPypiRepositoryOutputArgs, opts?: InvokeOptions): Output<GetLocalPypiRepositoryResult>
Copy
def get_local_pypi_repository(archive_browsing_enabled: Optional[bool] = None,
                              blacked_out: Optional[bool] = None,
                              cdn_redirect: Optional[bool] = None,
                              description: Optional[str] = None,
                              download_direct: Optional[bool] = None,
                              excludes_pattern: Optional[str] = None,
                              includes_pattern: Optional[str] = None,
                              key: Optional[str] = None,
                              notes: Optional[str] = None,
                              priority_resolution: Optional[bool] = None,
                              project_environments: Optional[Sequence[str]] = None,
                              project_key: Optional[str] = None,
                              property_sets: Optional[Sequence[str]] = None,
                              repo_layout_ref: Optional[str] = None,
                              xray_index: Optional[bool] = None,
                              opts: Optional[InvokeOptions] = None) -> GetLocalPypiRepositoryResult
def get_local_pypi_repository_output(archive_browsing_enabled: Optional[pulumi.Input[bool]] = None,
                              blacked_out: Optional[pulumi.Input[bool]] = None,
                              cdn_redirect: Optional[pulumi.Input[bool]] = None,
                              description: Optional[pulumi.Input[str]] = None,
                              download_direct: Optional[pulumi.Input[bool]] = None,
                              excludes_pattern: Optional[pulumi.Input[str]] = None,
                              includes_pattern: Optional[pulumi.Input[str]] = None,
                              key: Optional[pulumi.Input[str]] = None,
                              notes: Optional[pulumi.Input[str]] = None,
                              priority_resolution: Optional[pulumi.Input[bool]] = None,
                              project_environments: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                              project_key: Optional[pulumi.Input[str]] = None,
                              property_sets: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                              repo_layout_ref: Optional[pulumi.Input[str]] = None,
                              xray_index: Optional[pulumi.Input[bool]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetLocalPypiRepositoryResult]
Copy
func LookupLocalPypiRepository(ctx *Context, args *LookupLocalPypiRepositoryArgs, opts ...InvokeOption) (*LookupLocalPypiRepositoryResult, error)
func LookupLocalPypiRepositoryOutput(ctx *Context, args *LookupLocalPypiRepositoryOutputArgs, opts ...InvokeOption) LookupLocalPypiRepositoryResultOutput
Copy

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

public static class GetLocalPypiRepository 
{
    public static Task<GetLocalPypiRepositoryResult> InvokeAsync(GetLocalPypiRepositoryArgs args, InvokeOptions? opts = null)
    public static Output<GetLocalPypiRepositoryResult> Invoke(GetLocalPypiRepositoryInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetLocalPypiRepositoryResult> getLocalPypiRepository(GetLocalPypiRepositoryArgs args, InvokeOptions options)
public static Output<GetLocalPypiRepositoryResult> getLocalPypiRepository(GetLocalPypiRepositoryArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: artifactory:index/getLocalPypiRepository:getLocalPypiRepository
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Key
This property is required.
Changes to this property will trigger replacement.
string
the identity key of the repo.
ArchiveBrowsingEnabled bool
BlackedOut bool
CdnRedirect bool
Description string
DownloadDirect bool
ExcludesPattern string
IncludesPattern string
Notes string
PriorityResolution bool
ProjectEnvironments List<string>
ProjectKey string
PropertySets List<string>
RepoLayoutRef string
XrayIndex bool
Key
This property is required.
Changes to this property will trigger replacement.
string
the identity key of the repo.
ArchiveBrowsingEnabled bool
BlackedOut bool
CdnRedirect bool
Description string
DownloadDirect bool
ExcludesPattern string
IncludesPattern string
Notes string
PriorityResolution bool
ProjectEnvironments []string
ProjectKey string
PropertySets []string
RepoLayoutRef string
XrayIndex bool
key
This property is required.
Changes to this property will trigger replacement.
String
the identity key of the repo.
archiveBrowsingEnabled Boolean
blackedOut Boolean
cdnRedirect Boolean
description String
downloadDirect Boolean
excludesPattern String
includesPattern String
notes String
priorityResolution Boolean
projectEnvironments List<String>
projectKey String
propertySets List<String>
repoLayoutRef String
xrayIndex Boolean
key
This property is required.
Changes to this property will trigger replacement.
string
the identity key of the repo.
archiveBrowsingEnabled boolean
blackedOut boolean
cdnRedirect boolean
description string
downloadDirect boolean
excludesPattern string
includesPattern string
notes string
priorityResolution boolean
projectEnvironments string[]
projectKey string
propertySets string[]
repoLayoutRef string
xrayIndex boolean
key
This property is required.
Changes to this property will trigger replacement.
str
the identity key of the repo.
archive_browsing_enabled bool
blacked_out bool
cdn_redirect bool
description str
download_direct bool
excludes_pattern str
includes_pattern str
notes str
priority_resolution bool
project_environments Sequence[str]
project_key str
property_sets Sequence[str]
repo_layout_ref str
xray_index bool
key
This property is required.
Changes to this property will trigger replacement.
String
the identity key of the repo.
archiveBrowsingEnabled Boolean
blackedOut Boolean
cdnRedirect Boolean
description String
downloadDirect Boolean
excludesPattern String
includesPattern String
notes String
priorityResolution Boolean
projectEnvironments List<String>
projectKey String
propertySets List<String>
repoLayoutRef String
xrayIndex Boolean

getLocalPypiRepository Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Key string
the identity key of the repo.
PackageType string
ProjectEnvironments List<string>
ArchiveBrowsingEnabled bool
BlackedOut bool
CdnRedirect bool
Description string
DownloadDirect bool
ExcludesPattern string
IncludesPattern string
Notes string
PriorityResolution bool
ProjectKey string
PropertySets List<string>
RepoLayoutRef string
XrayIndex bool
Id string
The provider-assigned unique ID for this managed resource.
Key string
the identity key of the repo.
PackageType string
ProjectEnvironments []string
ArchiveBrowsingEnabled bool
BlackedOut bool
CdnRedirect bool
Description string
DownloadDirect bool
ExcludesPattern string
IncludesPattern string
Notes string
PriorityResolution bool
ProjectKey string
PropertySets []string
RepoLayoutRef string
XrayIndex bool
id String
The provider-assigned unique ID for this managed resource.
key String
the identity key of the repo.
packageType String
projectEnvironments List<String>
archiveBrowsingEnabled Boolean
blackedOut Boolean
cdnRedirect Boolean
description String
downloadDirect Boolean
excludesPattern String
includesPattern String
notes String
priorityResolution Boolean
projectKey String
propertySets List<String>
repoLayoutRef String
xrayIndex Boolean
id string
The provider-assigned unique ID for this managed resource.
key string
the identity key of the repo.
packageType string
projectEnvironments string[]
archiveBrowsingEnabled boolean
blackedOut boolean
cdnRedirect boolean
description string
downloadDirect boolean
excludesPattern string
includesPattern string
notes string
priorityResolution boolean
projectKey string
propertySets string[]
repoLayoutRef string
xrayIndex boolean
id str
The provider-assigned unique ID for this managed resource.
key str
the identity key of the repo.
package_type str
project_environments Sequence[str]
archive_browsing_enabled bool
blacked_out bool
cdn_redirect bool
description str
download_direct bool
excludes_pattern str
includes_pattern str
notes str
priority_resolution bool
project_key str
property_sets Sequence[str]
repo_layout_ref str
xray_index bool
id String
The provider-assigned unique ID for this managed resource.
key String
the identity key of the repo.
packageType String
projectEnvironments List<String>
archiveBrowsingEnabled Boolean
blackedOut Boolean
cdnRedirect Boolean
description String
downloadDirect Boolean
excludesPattern String
includesPattern String
notes String
priorityResolution Boolean
projectKey String
propertySets List<String>
repoLayoutRef String
xrayIndex Boolean

Package Details

Repository
artifactory pulumi/pulumi-artifactory
License
Apache-2.0
Notes
This Pulumi package is based on the artifactory Terraform Provider.
artifactory v8.8.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-artifactory