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

artifactory.getLocalMavenRepository

Explore with Pulumi AI

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

    Retrieves a local Maven repository.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as artifactory from "@pulumi/artifactory";
    
    const local-test-maven-repo-basic = artifactory.getLocalMavenRepository({
        key: "local-test-maven-repo-basic",
    });
    
    import pulumi
    import pulumi_artifactory as artifactory
    
    local_test_maven_repo_basic = artifactory.get_local_maven_repository(key="local-test-maven-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.LookupLocalMavenRepository(ctx, &artifactory.LookupLocalMavenRepositoryArgs{
    			Key: "local-test-maven-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_maven_repo_basic = Artifactory.GetLocalMavenRepository.Invoke(new()
        {
            Key = "local-test-maven-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.GetLocalMavenRepositoryArgs;
    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-maven-repo-basic = ArtifactoryFunctions.getLocalMavenRepository(GetLocalMavenRepositoryArgs.builder()
                .key("local-test-maven-repo-basic")
                .build());
    
        }
    }
    
    variables:
      local-test-maven-repo-basic:
        fn::invoke:
          Function: artifactory:getLocalMavenRepository
          Arguments:
            key: local-test-maven-repo-basic
    

    * snapshot_version_behavior - Specifies the naming convention for Maven SNAPSHOT versions. The options are

    • unique: Version number is based on a time-stamp (default)
    • non-unique: Version number uses a self-overriding naming pattern of artifactId-version-SNAPSHOT.type
    • deployer: Respects the settings in the Maven client that is deploying the artifact.
    • max_unique_snapshots - The maximum number of unique snapshots of a single artifact to store. Once the number of snapshots exceeds this setting, older versions are removed. A value of 0 (default) indicates there is no limit, and unique snapshots are not cleaned up.
    • handle_releases - If set, Artifactory allows you to deploy release artifacts into this repository. Default is true.
    • handle_snapshots - If set, Artifactory allows you to deploy snapshot artifacts into this repository. Default is true.
    • suppress_pom_consistency_checks - By default, Artifactory keeps your repositories healthy by refusing POMs with incorrect coordinates (path). If the groupId:artifactId:version information inside the POM does not match the deployed path, Artifactory rejects the deployment with a “409 Conflict” error. You can disable this behavior by setting the Suppress POM Consistency Checks checkbox. False by default for Maven repository.

    Using getLocalMavenRepository

    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 getLocalMavenRepository(args: GetLocalMavenRepositoryArgs, opts?: InvokeOptions): Promise<GetLocalMavenRepositoryResult>
    function getLocalMavenRepositoryOutput(args: GetLocalMavenRepositoryOutputArgs, opts?: InvokeOptions): Output<GetLocalMavenRepositoryResult>
    def get_local_maven_repository(archive_browsing_enabled: Optional[bool] = None,
                                   blacked_out: Optional[bool] = None,
                                   cdn_redirect: Optional[bool] = None,
                                   checksum_policy_type: Optional[str] = None,
                                   description: Optional[str] = None,
                                   download_direct: Optional[bool] = None,
                                   excludes_pattern: Optional[str] = None,
                                   handle_releases: Optional[bool] = None,
                                   handle_snapshots: Optional[bool] = None,
                                   includes_pattern: Optional[str] = None,
                                   key: Optional[str] = None,
                                   max_unique_snapshots: Optional[int] = 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,
                                   snapshot_version_behavior: Optional[str] = None,
                                   suppress_pom_consistency_checks: Optional[bool] = None,
                                   xray_index: Optional[bool] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetLocalMavenRepositoryResult
    def get_local_maven_repository_output(archive_browsing_enabled: Optional[pulumi.Input[bool]] = None,
                                   blacked_out: Optional[pulumi.Input[bool]] = None,
                                   cdn_redirect: Optional[pulumi.Input[bool]] = None,
                                   checksum_policy_type: Optional[pulumi.Input[str]] = None,
                                   description: Optional[pulumi.Input[str]] = None,
                                   download_direct: Optional[pulumi.Input[bool]] = None,
                                   excludes_pattern: Optional[pulumi.Input[str]] = None,
                                   handle_releases: Optional[pulumi.Input[bool]] = None,
                                   handle_snapshots: Optional[pulumi.Input[bool]] = None,
                                   includes_pattern: Optional[pulumi.Input[str]] = None,
                                   key: Optional[pulumi.Input[str]] = None,
                                   max_unique_snapshots: Optional[pulumi.Input[int]] = 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,
                                   snapshot_version_behavior: Optional[pulumi.Input[str]] = None,
                                   suppress_pom_consistency_checks: Optional[pulumi.Input[bool]] = None,
                                   xray_index: Optional[pulumi.Input[bool]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetLocalMavenRepositoryResult]
    func LookupLocalMavenRepository(ctx *Context, args *LookupLocalMavenRepositoryArgs, opts ...InvokeOption) (*LookupLocalMavenRepositoryResult, error)
    func LookupLocalMavenRepositoryOutput(ctx *Context, args *LookupLocalMavenRepositoryOutputArgs, opts ...InvokeOption) LookupLocalMavenRepositoryResultOutput

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

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

    The following arguments are supported:

    Key string
    the identity key of the repo.
    ArchiveBrowsingEnabled bool
    BlackedOut bool
    CdnRedirect bool
    ChecksumPolicyType string
    Checksum policy determines how Artifactory behaves when a client checksum for a deployed resource is missing or conflicts with the locally calculated checksum (bad checksum). The options are:

    • client-checksums
    • server-generated-checksums. For more details, please refer to Checksum Policy .
    Description string
    DownloadDirect bool
    ExcludesPattern string
    HandleReleases bool
    HandleSnapshots bool
    IncludesPattern string
    MaxUniqueSnapshots int
    Notes string
    PriorityResolution bool
    ProjectEnvironments List<string>
    ProjectKey string
    PropertySets List<string>
    RepoLayoutRef string
    SnapshotVersionBehavior string
    SuppressPomConsistencyChecks bool
    XrayIndex bool
    Key string
    the identity key of the repo.
    ArchiveBrowsingEnabled bool
    BlackedOut bool
    CdnRedirect bool
    ChecksumPolicyType string
    Checksum policy determines how Artifactory behaves when a client checksum for a deployed resource is missing or conflicts with the locally calculated checksum (bad checksum). The options are:

    • client-checksums
    • server-generated-checksums. For more details, please refer to Checksum Policy .
    Description string
    DownloadDirect bool
    ExcludesPattern string
    HandleReleases bool
    HandleSnapshots bool
    IncludesPattern string
    MaxUniqueSnapshots int
    Notes string
    PriorityResolution bool
    ProjectEnvironments []string
    ProjectKey string
    PropertySets []string
    RepoLayoutRef string
    SnapshotVersionBehavior string
    SuppressPomConsistencyChecks bool
    XrayIndex bool
    key String
    the identity key of the repo.
    archiveBrowsingEnabled Boolean
    blackedOut Boolean
    cdnRedirect Boolean
    checksumPolicyType String
    Checksum policy determines how Artifactory behaves when a client checksum for a deployed resource is missing or conflicts with the locally calculated checksum (bad checksum). The options are:

    • client-checksums
    • server-generated-checksums. For more details, please refer to Checksum Policy .
    description String
    downloadDirect Boolean
    excludesPattern String
    handleReleases Boolean
    handleSnapshots Boolean
    includesPattern String
    maxUniqueSnapshots Integer
    notes String
    priorityResolution Boolean
    projectEnvironments List<String>
    projectKey String
    propertySets List<String>
    repoLayoutRef String
    snapshotVersionBehavior String
    suppressPomConsistencyChecks Boolean
    xrayIndex Boolean
    key string
    the identity key of the repo.
    archiveBrowsingEnabled boolean
    blackedOut boolean
    cdnRedirect boolean
    checksumPolicyType string
    Checksum policy determines how Artifactory behaves when a client checksum for a deployed resource is missing or conflicts with the locally calculated checksum (bad checksum). The options are:

    • client-checksums
    • server-generated-checksums. For more details, please refer to Checksum Policy .
    description string
    downloadDirect boolean
    excludesPattern string
    handleReleases boolean
    handleSnapshots boolean
    includesPattern string
    maxUniqueSnapshots number
    notes string
    priorityResolution boolean
    projectEnvironments string[]
    projectKey string
    propertySets string[]
    repoLayoutRef string
    snapshotVersionBehavior string
    suppressPomConsistencyChecks boolean
    xrayIndex boolean
    key str
    the identity key of the repo.
    archive_browsing_enabled bool
    blacked_out bool
    cdn_redirect bool
    checksum_policy_type str
    Checksum policy determines how Artifactory behaves when a client checksum for a deployed resource is missing or conflicts with the locally calculated checksum (bad checksum). The options are:

    • client-checksums
    • server-generated-checksums. For more details, please refer to Checksum Policy .
    description str
    download_direct bool
    excludes_pattern str
    handle_releases bool
    handle_snapshots bool
    includes_pattern str
    max_unique_snapshots int
    notes str
    priority_resolution bool
    project_environments Sequence[str]
    project_key str
    property_sets Sequence[str]
    repo_layout_ref str
    snapshot_version_behavior str
    suppress_pom_consistency_checks bool
    xray_index bool
    key String
    the identity key of the repo.
    archiveBrowsingEnabled Boolean
    blackedOut Boolean
    cdnRedirect Boolean
    checksumPolicyType String
    Checksum policy determines how Artifactory behaves when a client checksum for a deployed resource is missing or conflicts with the locally calculated checksum (bad checksum). The options are:

    • client-checksums
    • server-generated-checksums. For more details, please refer to Checksum Policy .
    description String
    downloadDirect Boolean
    excludesPattern String
    handleReleases Boolean
    handleSnapshots Boolean
    includesPattern String
    maxUniqueSnapshots Number
    notes String
    priorityResolution Boolean
    projectEnvironments List<String>
    projectKey String
    propertySets List<String>
    repoLayoutRef String
    snapshotVersionBehavior String
    suppressPomConsistencyChecks Boolean
    xrayIndex Boolean

    getLocalMavenRepository 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>
    ArchiveBrowsingEnabled bool
    BlackedOut bool
    CdnRedirect bool
    ChecksumPolicyType string
    Checksum policy determines how Artifactory behaves when a client checksum for a deployed resource is missing or conflicts with the locally calculated checksum (bad checksum). The options are:

    • client-checksums
    • server-generated-checksums. For more details, please refer to Checksum Policy .
    Description string
    DownloadDirect bool
    ExcludesPattern string
    HandleReleases bool
    HandleSnapshots bool
    IncludesPattern string
    MaxUniqueSnapshots int
    Notes string
    PriorityResolution bool
    ProjectKey string
    PropertySets List<string>
    RepoLayoutRef string
    SnapshotVersionBehavior string
    SuppressPomConsistencyChecks bool
    XrayIndex bool
    Id string
    The provider-assigned unique ID for this managed resource.
    Key string
    PackageType string
    ProjectEnvironments []string
    ArchiveBrowsingEnabled bool
    BlackedOut bool
    CdnRedirect bool
    ChecksumPolicyType string
    Checksum policy determines how Artifactory behaves when a client checksum for a deployed resource is missing or conflicts with the locally calculated checksum (bad checksum). The options are:

    • client-checksums
    • server-generated-checksums. For more details, please refer to Checksum Policy .
    Description string
    DownloadDirect bool
    ExcludesPattern string
    HandleReleases bool
    HandleSnapshots bool
    IncludesPattern string
    MaxUniqueSnapshots int
    Notes string
    PriorityResolution bool
    ProjectKey string
    PropertySets []string
    RepoLayoutRef string
    SnapshotVersionBehavior string
    SuppressPomConsistencyChecks bool
    XrayIndex bool
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    packageType String
    projectEnvironments List<String>
    archiveBrowsingEnabled Boolean
    blackedOut Boolean
    cdnRedirect Boolean
    checksumPolicyType String
    Checksum policy determines how Artifactory behaves when a client checksum for a deployed resource is missing or conflicts with the locally calculated checksum (bad checksum). The options are:

    • client-checksums
    • server-generated-checksums. For more details, please refer to Checksum Policy .
    description String
    downloadDirect Boolean
    excludesPattern String
    handleReleases Boolean
    handleSnapshots Boolean
    includesPattern String
    maxUniqueSnapshots Integer
    notes String
    priorityResolution Boolean
    projectKey String
    propertySets List<String>
    repoLayoutRef String
    snapshotVersionBehavior String
    suppressPomConsistencyChecks Boolean
    xrayIndex Boolean
    id string
    The provider-assigned unique ID for this managed resource.
    key string
    packageType string
    projectEnvironments string[]
    archiveBrowsingEnabled boolean
    blackedOut boolean
    cdnRedirect boolean
    checksumPolicyType string
    Checksum policy determines how Artifactory behaves when a client checksum for a deployed resource is missing or conflicts with the locally calculated checksum (bad checksum). The options are:

    • client-checksums
    • server-generated-checksums. For more details, please refer to Checksum Policy .
    description string
    downloadDirect boolean
    excludesPattern string
    handleReleases boolean
    handleSnapshots boolean
    includesPattern string
    maxUniqueSnapshots number
    notes string
    priorityResolution boolean
    projectKey string
    propertySets string[]
    repoLayoutRef string
    snapshotVersionBehavior string
    suppressPomConsistencyChecks boolean
    xrayIndex boolean
    id str
    The provider-assigned unique ID for this managed resource.
    key str
    package_type str
    project_environments Sequence[str]
    archive_browsing_enabled bool
    blacked_out bool
    cdn_redirect bool
    checksum_policy_type str
    Checksum policy determines how Artifactory behaves when a client checksum for a deployed resource is missing or conflicts with the locally calculated checksum (bad checksum). The options are:

    • client-checksums
    • server-generated-checksums. For more details, please refer to Checksum Policy .
    description str
    download_direct bool
    excludes_pattern str
    handle_releases bool
    handle_snapshots bool
    includes_pattern str
    max_unique_snapshots int
    notes str
    priority_resolution bool
    project_key str
    property_sets Sequence[str]
    repo_layout_ref str
    snapshot_version_behavior str
    suppress_pom_consistency_checks bool
    xray_index bool
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    packageType String
    projectEnvironments List<String>
    archiveBrowsingEnabled Boolean
    blackedOut Boolean
    cdnRedirect Boolean
    checksumPolicyType String
    Checksum policy determines how Artifactory behaves when a client checksum for a deployed resource is missing or conflicts with the locally calculated checksum (bad checksum). The options are:

    • client-checksums
    • server-generated-checksums. For more details, please refer to Checksum Policy .
    description String
    downloadDirect Boolean
    excludesPattern String
    handleReleases Boolean
    handleSnapshots Boolean
    includesPattern String
    maxUniqueSnapshots Number
    notes String
    priorityResolution Boolean
    projectKey String
    propertySets List<String>
    repoLayoutRef String
    snapshotVersionBehavior String
    suppressPomConsistencyChecks Boolean
    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