1. Packages
  2. Artifactory Provider
  3. API Docs
  4. getLocalOciRepository
artifactory v8.8.0 published on Friday, Mar 7, 2025 by Pulumi

artifactory.getLocalOciRepository

Explore with Pulumi AI

artifactory v8.8.0 published on Friday, Mar 7, 2025 by Pulumi

Retrieves a local OCI repository resource

Example Usage

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

const my_oci_local = artifactory.getLocalOciRepository({
    key: "my-oci-local",
});
Copy
import pulumi
import pulumi_artifactory as artifactory

my_oci_local = artifactory.get_local_oci_repository(key="my-oci-local")
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.LookupLocalOciRepository(ctx, &artifactory.LookupLocalOciRepositoryArgs{
			Key: "my-oci-local",
		}, 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 my_oci_local = Artifactory.GetLocalOciRepository.Invoke(new()
    {
        Key = "my-oci-local",
    });

});
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.GetLocalOciRepositoryArgs;
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 my-oci-local = ArtifactoryFunctions.getLocalOciRepository(GetLocalOciRepositoryArgs.builder()
            .key("my-oci-local")
            .build());

    }
}
Copy
variables:
  my-oci-local:
    fn::invoke:
      function: artifactory:getLocalOciRepository
      arguments:
        key: my-oci-local
Copy

Using getLocalOciRepository

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 getLocalOciRepository(args: GetLocalOciRepositoryArgs, opts?: InvokeOptions): Promise<GetLocalOciRepositoryResult>
function getLocalOciRepositoryOutput(args: GetLocalOciRepositoryOutputArgs, opts?: InvokeOptions): Output<GetLocalOciRepositoryResult>
Copy
def get_local_oci_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,
                             max_unique_tags: 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,
                             tag_retention: Optional[int] = None,
                             xray_index: Optional[bool] = None,
                             opts: Optional[InvokeOptions] = None) -> GetLocalOciRepositoryResult
def get_local_oci_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,
                             max_unique_tags: 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,
                             tag_retention: Optional[pulumi.Input[int]] = None,
                             xray_index: Optional[pulumi.Input[bool]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetLocalOciRepositoryResult]
Copy
func LookupLocalOciRepository(ctx *Context, args *LookupLocalOciRepositoryArgs, opts ...InvokeOption) (*LookupLocalOciRepositoryResult, error)
func LookupLocalOciRepositoryOutput(ctx *Context, args *LookupLocalOciRepositoryOutputArgs, opts ...InvokeOption) LookupLocalOciRepositoryResultOutput
Copy

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

public static class GetLocalOciRepository 
{
    public static Task<GetLocalOciRepositoryResult> InvokeAsync(GetLocalOciRepositoryArgs args, InvokeOptions? opts = null)
    public static Output<GetLocalOciRepositoryResult> Invoke(GetLocalOciRepositoryInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetLocalOciRepositoryResult> getLocalOciRepository(GetLocalOciRepositoryArgs args, InvokeOptions options)
public static Output<GetLocalOciRepositoryResult> getLocalOciRepository(GetLocalOciRepositoryArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: artifactory:index/getLocalOciRepository:getLocalOciRepository
  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
MaxUniqueTags int
The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit.
Notes string
PriorityResolution bool
ProjectEnvironments List<string>
ProjectKey string
PropertySets List<string>
RepoLayoutRef string
TagRetention int
If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
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
MaxUniqueTags int
The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit.
Notes string
PriorityResolution bool
ProjectEnvironments []string
ProjectKey string
PropertySets []string
RepoLayoutRef string
TagRetention int
If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
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
maxUniqueTags Integer
The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit.
notes String
priorityResolution Boolean
projectEnvironments List<String>
projectKey String
propertySets List<String>
repoLayoutRef String
tagRetention Integer
If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
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
maxUniqueTags number
The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit.
notes string
priorityResolution boolean
projectEnvironments string[]
projectKey string
propertySets string[]
repoLayoutRef string
tagRetention number
If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
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
max_unique_tags int
The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit.
notes str
priority_resolution bool
project_environments Sequence[str]
project_key str
property_sets Sequence[str]
repo_layout_ref str
tag_retention int
If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
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
maxUniqueTags Number
The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit.
notes String
priorityResolution Boolean
projectEnvironments List<String>
projectKey String
propertySets List<String>
repoLayoutRef String
tagRetention Number
If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
xrayIndex Boolean

getLocalOciRepository 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
Description string
DownloadDirect bool
ExcludesPattern string
IncludesPattern string
MaxUniqueTags int
The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit.
Notes string
PriorityResolution bool
ProjectKey string
PropertySets List<string>
RepoLayoutRef string
TagRetention int
If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
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
Description string
DownloadDirect bool
ExcludesPattern string
IncludesPattern string
MaxUniqueTags int
The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit.
Notes string
PriorityResolution bool
ProjectKey string
PropertySets []string
RepoLayoutRef string
TagRetention int
If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
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
description String
downloadDirect Boolean
excludesPattern String
includesPattern String
maxUniqueTags Integer
The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit.
notes String
priorityResolution Boolean
projectKey String
propertySets List<String>
repoLayoutRef String
tagRetention Integer
If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
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
description string
downloadDirect boolean
excludesPattern string
includesPattern string
maxUniqueTags number
The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit.
notes string
priorityResolution boolean
projectKey string
propertySets string[]
repoLayoutRef string
tagRetention number
If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
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
description str
download_direct bool
excludes_pattern str
includes_pattern str
max_unique_tags int
The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit.
notes str
priority_resolution bool
project_key str
property_sets Sequence[str]
repo_layout_ref str
tag_retention int
If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
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
description String
downloadDirect Boolean
excludesPattern String
includesPattern String
maxUniqueTags Number
The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit.
notes String
priorityResolution Boolean
projectKey String
propertySets List<String>
repoLayoutRef String
tagRetention Number
If greater than 1, overwritten tags will be saved by their digest, up to the set up number.
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.0 published on Friday, Mar 7, 2025 by Pulumi