artifactory v8.4.0 published on Tuesday, Nov 19, 2024 by Pulumi
artifactory.getLocalMavenRepository
Explore with Pulumi AI
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.typedeployer
: 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 istrue
.handle_snapshots
- If set, Artifactory allows you to deploy snapshot artifacts into this repository. Default istrue
.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.
- Archive
Browsing boolEnabled - Blacked
Out bool - Cdn
Redirect bool - Checksum
Policy stringType - 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
- Download
Direct bool - Excludes
Pattern string - Handle
Releases bool - Handle
Snapshots bool - Includes
Pattern string - Max
Unique intSnapshots - Notes string
- Priority
Resolution bool - Project
Environments List<string> - Project
Key string - Property
Sets List<string> - Repo
Layout stringRef - Snapshot
Version stringBehavior - Suppress
Pom boolConsistency Checks - Xray
Index bool
- Key string
- the identity key of the repo.
- Archive
Browsing boolEnabled - Blacked
Out bool - Cdn
Redirect bool - Checksum
Policy stringType - 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
- Download
Direct bool - Excludes
Pattern string - Handle
Releases bool - Handle
Snapshots bool - Includes
Pattern string - Max
Unique intSnapshots - Notes string
- Priority
Resolution bool - Project
Environments []string - Project
Key string - Property
Sets []string - Repo
Layout stringRef - Snapshot
Version stringBehavior - Suppress
Pom boolConsistency Checks - Xray
Index bool
- key String
- the identity key of the repo.
- archive
Browsing BooleanEnabled - blacked
Out Boolean - cdn
Redirect Boolean - checksum
Policy StringType - 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
- download
Direct Boolean - excludes
Pattern String - handle
Releases Boolean - handle
Snapshots Boolean - includes
Pattern String - max
Unique IntegerSnapshots - notes String
- priority
Resolution Boolean - project
Environments List<String> - project
Key String - property
Sets List<String> - repo
Layout StringRef - snapshot
Version StringBehavior - suppress
Pom BooleanConsistency Checks - xray
Index Boolean
- key string
- the identity key of the repo.
- archive
Browsing booleanEnabled - blacked
Out boolean - cdn
Redirect boolean - checksum
Policy stringType - 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
- download
Direct boolean - excludes
Pattern string - handle
Releases boolean - handle
Snapshots boolean - includes
Pattern string - max
Unique numberSnapshots - notes string
- priority
Resolution boolean - project
Environments string[] - project
Key string - property
Sets string[] - repo
Layout stringRef - snapshot
Version stringBehavior - suppress
Pom booleanConsistency Checks - xray
Index boolean
- key str
- the identity key of the repo.
- archive_
browsing_ boolenabled - blacked_
out bool - cdn_
redirect bool - checksum_
policy_ strtype - 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_ intsnapshots - notes str
- priority_
resolution bool - project_
environments Sequence[str] - project_
key str - property_
sets Sequence[str] - repo_
layout_ strref - snapshot_
version_ strbehavior - suppress_
pom_ boolconsistency_ checks - xray_
index bool
- key String
- the identity key of the repo.
- archive
Browsing BooleanEnabled - blacked
Out Boolean - cdn
Redirect Boolean - checksum
Policy StringType - 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
- download
Direct Boolean - excludes
Pattern String - handle
Releases Boolean - handle
Snapshots Boolean - includes
Pattern String - max
Unique NumberSnapshots - notes String
- priority
Resolution Boolean - project
Environments List<String> - project
Key String - property
Sets List<String> - repo
Layout StringRef - snapshot
Version StringBehavior - suppress
Pom BooleanConsistency Checks - xray
Index Boolean
getLocalMavenRepository Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Key string
- Package
Type string - Project
Environments List<string> - Archive
Browsing boolEnabled - Blacked
Out bool - Cdn
Redirect bool - Checksum
Policy stringType - 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
- Download
Direct bool - Excludes
Pattern string - Handle
Releases bool - Handle
Snapshots bool - Includes
Pattern string - Max
Unique intSnapshots - Notes string
- Priority
Resolution bool - Project
Key string - Property
Sets List<string> - Repo
Layout stringRef - Snapshot
Version stringBehavior - Suppress
Pom boolConsistency Checks - Xray
Index bool
- Id string
- The provider-assigned unique ID for this managed resource.
- Key string
- Package
Type string - Project
Environments []string - Archive
Browsing boolEnabled - Blacked
Out bool - Cdn
Redirect bool - Checksum
Policy stringType - 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
- Download
Direct bool - Excludes
Pattern string - Handle
Releases bool - Handle
Snapshots bool - Includes
Pattern string - Max
Unique intSnapshots - Notes string
- Priority
Resolution bool - Project
Key string - Property
Sets []string - Repo
Layout stringRef - Snapshot
Version stringBehavior - Suppress
Pom boolConsistency Checks - Xray
Index bool
- id String
- The provider-assigned unique ID for this managed resource.
- key String
- package
Type String - project
Environments List<String> - archive
Browsing BooleanEnabled - blacked
Out Boolean - cdn
Redirect Boolean - checksum
Policy StringType - 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
- download
Direct Boolean - excludes
Pattern String - handle
Releases Boolean - handle
Snapshots Boolean - includes
Pattern String - max
Unique IntegerSnapshots - notes String
- priority
Resolution Boolean - project
Key String - property
Sets List<String> - repo
Layout StringRef - snapshot
Version StringBehavior - suppress
Pom BooleanConsistency Checks - xray
Index Boolean
- id string
- The provider-assigned unique ID for this managed resource.
- key string
- package
Type string - project
Environments string[] - archive
Browsing booleanEnabled - blacked
Out boolean - cdn
Redirect boolean - checksum
Policy stringType - 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
- download
Direct boolean - excludes
Pattern string - handle
Releases boolean - handle
Snapshots boolean - includes
Pattern string - max
Unique numberSnapshots - notes string
- priority
Resolution boolean - project
Key string - property
Sets string[] - repo
Layout stringRef - snapshot
Version stringBehavior - suppress
Pom booleanConsistency Checks - xray
Index boolean
- id str
- The provider-assigned unique ID for this managed resource.
- key str
- package_
type str - project_
environments Sequence[str] - archive_
browsing_ boolenabled - blacked_
out bool - cdn_
redirect bool - checksum_
policy_ strtype - 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_ intsnapshots - notes str
- priority_
resolution bool - project_
key str - property_
sets Sequence[str] - repo_
layout_ strref - snapshot_
version_ strbehavior - suppress_
pom_ boolconsistency_ checks - xray_
index bool
- id String
- The provider-assigned unique ID for this managed resource.
- key String
- package
Type String - project
Environments List<String> - archive
Browsing BooleanEnabled - blacked
Out Boolean - cdn
Redirect Boolean - checksum
Policy StringType - 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
- download
Direct Boolean - excludes
Pattern String - handle
Releases Boolean - handle
Snapshots Boolean - includes
Pattern String - max
Unique NumberSnapshots - notes String
- priority
Resolution Boolean - project
Key String - property
Sets List<String> - repo
Layout StringRef - snapshot
Version StringBehavior - suppress
Pom BooleanConsistency Checks - xray
Index Boolean
Package Details
- Repository
- artifactory pulumi/pulumi-artifactory
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
artifactory
Terraform Provider.