1. Packages
  2. Artifactory Provider
  3. API Docs
  4. getLocalCargoRepository
artifactory v8.4.0 published on Tuesday, Nov 19, 2024 by Pulumi

artifactory.getLocalCargoRepository

Explore with Pulumi AI

artifactory logo
artifactory v8.4.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Retrieves a local cargo repository.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as artifactory from "@pulumi/artifactory";
    
    const local-test-cargo-repo-basic = artifactory.getLocalCargoRepository({
        key: "local-test-cargo-repo-basic",
    });
    
    import pulumi
    import pulumi_artifactory as artifactory
    
    local_test_cargo_repo_basic = artifactory.get_local_cargo_repository(key="local-test-cargo-repo-basic")
    
    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.LookupLocalCargoRepository(ctx, &artifactory.LookupLocalCargoRepositoryArgs{
    			Key: "local-test-cargo-repo-basic",
    		}, 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 local_test_cargo_repo_basic = Artifactory.GetLocalCargoRepository.Invoke(new()
        {
            Key = "local-test-cargo-repo-basic",
        });
    
    });
    
    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.GetLocalCargoRepositoryArgs;
    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-cargo-repo-basic = ArtifactoryFunctions.getLocalCargoRepository(GetLocalCargoRepositoryArgs.builder()
                .key("local-test-cargo-repo-basic")
                .build());
    
        }
    }
    
    variables:
      local-test-cargo-repo-basic:
        fn::invoke:
          Function: artifactory:getLocalCargoRepository
          Arguments:
            key: local-test-cargo-repo-basic
    

    Using getLocalCargoRepository

    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 getLocalCargoRepository(args: GetLocalCargoRepositoryArgs, opts?: InvokeOptions): Promise<GetLocalCargoRepositoryResult>
    function getLocalCargoRepositoryOutput(args: GetLocalCargoRepositoryOutputArgs, opts?: InvokeOptions): Output<GetLocalCargoRepositoryResult>
    def get_local_cargo_repository(anonymous_access: Optional[bool] = None,
                                   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,
                                   enable_sparse_index: Optional[bool] = None,
                                   excludes_pattern: Optional[str] = None,
                                   includes_pattern: Optional[str] = None,
                                   index_compression_formats: Optional[Sequence[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) -> GetLocalCargoRepositoryResult
    def get_local_cargo_repository_output(anonymous_access: Optional[pulumi.Input[bool]] = None,
                                   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,
                                   enable_sparse_index: Optional[pulumi.Input[bool]] = None,
                                   excludes_pattern: Optional[pulumi.Input[str]] = None,
                                   includes_pattern: Optional[pulumi.Input[str]] = None,
                                   index_compression_formats: Optional[pulumi.Input[Sequence[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[GetLocalCargoRepositoryResult]
    func LookupLocalCargoRepository(ctx *Context, args *LookupLocalCargoRepositoryArgs, opts ...InvokeOption) (*LookupLocalCargoRepositoryResult, error)
    func LookupLocalCargoRepositoryOutput(ctx *Context, args *LookupLocalCargoRepositoryOutputArgs, opts ...InvokeOption) LookupLocalCargoRepositoryResultOutput

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

    public static class GetLocalCargoRepository 
    {
        public static Task<GetLocalCargoRepositoryResult> InvokeAsync(GetLocalCargoRepositoryArgs args, InvokeOptions? opts = null)
        public static Output<GetLocalCargoRepositoryResult> Invoke(GetLocalCargoRepositoryInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetLocalCargoRepositoryResult> getLocalCargoRepository(GetLocalCargoRepositoryArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: artifactory:index/getLocalCargoRepository:getLocalCargoRepository
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Key string
    the identity key of the repo.
    AnonymousAccess bool
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    ArchiveBrowsingEnabled bool
    BlackedOut bool
    CdnRedirect bool
    Description string
    DownloadDirect bool
    EnableSparseIndex bool
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    ExcludesPattern string
    IncludesPattern string
    IndexCompressionFormats List<string>
    Notes string
    PriorityResolution bool
    ProjectEnvironments List<string>
    ProjectKey string
    PropertySets List<string>
    RepoLayoutRef string
    XrayIndex bool
    Key string
    the identity key of the repo.
    AnonymousAccess bool
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    ArchiveBrowsingEnabled bool
    BlackedOut bool
    CdnRedirect bool
    Description string
    DownloadDirect bool
    EnableSparseIndex bool
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    ExcludesPattern string
    IncludesPattern string
    IndexCompressionFormats []string
    Notes string
    PriorityResolution bool
    ProjectEnvironments []string
    ProjectKey string
    PropertySets []string
    RepoLayoutRef string
    XrayIndex bool
    key String
    the identity key of the repo.
    anonymousAccess Boolean
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    archiveBrowsingEnabled Boolean
    blackedOut Boolean
    cdnRedirect Boolean
    description String
    downloadDirect Boolean
    enableSparseIndex Boolean
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    excludesPattern String
    includesPattern String
    indexCompressionFormats List<String>
    notes String
    priorityResolution Boolean
    projectEnvironments List<String>
    projectKey String
    propertySets List<String>
    repoLayoutRef String
    xrayIndex Boolean
    key string
    the identity key of the repo.
    anonymousAccess boolean
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    archiveBrowsingEnabled boolean
    blackedOut boolean
    cdnRedirect boolean
    description string
    downloadDirect boolean
    enableSparseIndex boolean
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    excludesPattern string
    includesPattern string
    indexCompressionFormats string[]
    notes string
    priorityResolution boolean
    projectEnvironments string[]
    projectKey string
    propertySets string[]
    repoLayoutRef string
    xrayIndex boolean
    key str
    the identity key of the repo.
    anonymous_access bool
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    archive_browsing_enabled bool
    blacked_out bool
    cdn_redirect bool
    description str
    download_direct bool
    enable_sparse_index bool
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    excludes_pattern str
    includes_pattern str
    index_compression_formats Sequence[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 String
    the identity key of the repo.
    anonymousAccess Boolean
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    archiveBrowsingEnabled Boolean
    blackedOut Boolean
    cdnRedirect Boolean
    description String
    downloadDirect Boolean
    enableSparseIndex Boolean
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    excludesPattern String
    includesPattern String
    indexCompressionFormats List<String>
    notes String
    priorityResolution Boolean
    projectEnvironments List<String>
    projectKey String
    propertySets List<String>
    repoLayoutRef String
    xrayIndex Boolean

    getLocalCargoRepository 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>
    AnonymousAccess bool
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    ArchiveBrowsingEnabled bool
    BlackedOut bool
    CdnRedirect bool
    Description string
    DownloadDirect bool
    EnableSparseIndex bool
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    ExcludesPattern string
    IncludesPattern string
    IndexCompressionFormats List<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
    PackageType string
    ProjectEnvironments []string
    AnonymousAccess bool
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    ArchiveBrowsingEnabled bool
    BlackedOut bool
    CdnRedirect bool
    Description string
    DownloadDirect bool
    EnableSparseIndex bool
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    ExcludesPattern string
    IncludesPattern string
    IndexCompressionFormats []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
    packageType String
    projectEnvironments List<String>
    anonymousAccess Boolean
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    archiveBrowsingEnabled Boolean
    blackedOut Boolean
    cdnRedirect Boolean
    description String
    downloadDirect Boolean
    enableSparseIndex Boolean
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    excludesPattern String
    includesPattern String
    indexCompressionFormats List<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
    packageType string
    projectEnvironments string[]
    anonymousAccess boolean
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    archiveBrowsingEnabled boolean
    blackedOut boolean
    cdnRedirect boolean
    description string
    downloadDirect boolean
    enableSparseIndex boolean
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    excludesPattern string
    includesPattern string
    indexCompressionFormats 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
    package_type str
    project_environments Sequence[str]
    anonymous_access bool
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    archive_browsing_enabled bool
    blacked_out bool
    cdn_redirect bool
    description str
    download_direct bool
    enable_sparse_index bool
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    excludes_pattern str
    includes_pattern str
    index_compression_formats Sequence[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
    packageType String
    projectEnvironments List<String>
    anonymousAccess Boolean
    Cargo client does not send credentials when performing download and search for crates. Enable this to allow anonymous access to these resources (only), note that this will override the security anonymous access option. Default value is false.
    archiveBrowsingEnabled Boolean
    blackedOut Boolean
    cdnRedirect Boolean
    description String
    downloadDirect Boolean
    enableSparseIndex Boolean
    Enable internal index support based on Cargo sparse index specifications, instead of the default git index. Default value is false.
    excludesPattern String
    includesPattern String
    indexCompressionFormats List<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 logo
    artifactory v8.4.0 published on Tuesday, Nov 19, 2024 by Pulumi