Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Artifactory Provider
  3. API Docs
  4. getFederatedOciRepository
artifactory v8.4.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-artifactory

artifactory.getFederatedOciRepository

Explore with Pulumi AI

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

    Retrieves a federated OCI repository.

    Example Usage

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

const my-oci-federated = artifactory.getFederatedOciRepository({
    key: "my-oci-federated",
});

    import pulumi
import pulumi_artifactory as artifactory

my_oci_federated = artifactory.get_federated_oci_repository(key="my-oci-federated")

    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.LookupFederatedOciRepository(ctx, &artifactory.LookupFederatedOciRepositoryArgs{
			Key: "my-oci-federated",
		}, 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 my_oci_federated = Artifactory.GetFederatedOciRepository.Invoke(new()
    {
        Key = "my-oci-federated",
    });

});

    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.GetFederatedOciRepositoryArgs;
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-federated = ArtifactoryFunctions.getFederatedOciRepository(GetFederatedOciRepositoryArgs.builder()
            .key("my-oci-federated")
            .build());

    }
}

    variables:
  my-oci-federated:
    fn::invoke:
      Function: artifactory:getFederatedOciRepository
      Arguments:
        key: my-oci-federated

    Using getFederatedOciRepository

    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 getFederatedOciRepository(args: GetFederatedOciRepositoryArgs, opts?: InvokeOptions): Promise<GetFederatedOciRepositoryResult>
function getFederatedOciRepositoryOutput(args: GetFederatedOciRepositoryOutputArgs, opts?: InvokeOptions): Output<GetFederatedOciRepositoryResult>
    def get_federated_oci_repository(archive_browsing_enabled: Optional[bool] = None,
                                 blacked_out: Optional[bool] = None,
                                 cdn_redirect: Optional[bool] = None,
                                 cleanup_on_delete: Optional[bool] = None,
                                 description: Optional[str] = None,
                                 disable_proxy: Optional[bool] = 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,
                                 members: Optional[Sequence[GetFederatedOciRepositoryMember]] = 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,
                                 proxy: Optional[str] = None,
                                 repo_layout_ref: Optional[str] = None,
                                 tag_retention: Optional[int] = None,
                                 xray_index: Optional[bool] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetFederatedOciRepositoryResult
def get_federated_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,
                                 cleanup_on_delete: Optional[pulumi.Input[bool]] = None,
                                 description: Optional[pulumi.Input[str]] = None,
                                 disable_proxy: Optional[pulumi.Input[bool]] = 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,
                                 members: Optional[pulumi.Input[Sequence[pulumi.Input[GetFederatedOciRepositoryMemberArgs]]]] = 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,
                                 proxy: Optional[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[GetFederatedOciRepositoryResult]
    func LookupFederatedOciRepository(ctx *Context, args *LookupFederatedOciRepositoryArgs, opts ...InvokeOption) (*LookupFederatedOciRepositoryResult, error)
func LookupFederatedOciRepositoryOutput(ctx *Context, args *LookupFederatedOciRepositoryOutputArgs, opts ...InvokeOption) LookupFederatedOciRepositoryResultOutput

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

    public static class GetFederatedOciRepository 
{
    public static Task<GetFederatedOciRepositoryResult> InvokeAsync(GetFederatedOciRepositoryArgs args, InvokeOptions? opts = null)
    public static Output<GetFederatedOciRepositoryResult> Invoke(GetFederatedOciRepositoryInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFederatedOciRepositoryResult> getFederatedOciRepository(GetFederatedOciRepositoryArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: artifactory:index/getFederatedOciRepository:getFederatedOciRepository
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Key string
    the identity key of the repo.
    ArchiveBrowsingEnabled bool
    BlackedOut bool
    CdnRedirect bool
    CleanupOnDelete bool
    Description string
    DisableProxy bool
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    DownloadDirect bool
    ExcludesPattern string
    IncludesPattern string
    MaxUniqueTags int
    Members List<GetFederatedOciRepositoryMember>
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    Notes string
    PriorityResolution bool
    ProjectEnvironments List<string>
    ProjectKey string
    PropertySets List<string>
    Proxy string
    Proxy key from Artifactory Proxies settings.
    RepoLayoutRef string
    TagRetention int
    XrayIndex bool
    Key string
    the identity key of the repo.
    ArchiveBrowsingEnabled bool
    BlackedOut bool
    CdnRedirect bool
    CleanupOnDelete bool
    Description string
    DisableProxy bool
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    DownloadDirect bool
    ExcludesPattern string
    IncludesPattern string
    MaxUniqueTags int
    Members []GetFederatedOciRepositoryMember
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    Notes string
    PriorityResolution bool
    ProjectEnvironments []string
    ProjectKey string
    PropertySets []string
    Proxy string
    Proxy key from Artifactory Proxies settings.
    RepoLayoutRef string
    TagRetention int
    XrayIndex bool
    key String
    the identity key of the repo.
    archiveBrowsingEnabled Boolean
    blackedOut Boolean
    cdnRedirect Boolean
    cleanupOnDelete Boolean
    description String
    disableProxy Boolean
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    downloadDirect Boolean
    excludesPattern String
    includesPattern String
    maxUniqueTags Integer
    members List<GetFederatedOciRepositoryMember>
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    notes String
    priorityResolution Boolean
    projectEnvironments List<String>
    projectKey String
    propertySets List<String>
    proxy String
    Proxy key from Artifactory Proxies settings.
    repoLayoutRef String
    tagRetention Integer
    xrayIndex Boolean
    key string
    the identity key of the repo.
    archiveBrowsingEnabled boolean
    blackedOut boolean
    cdnRedirect boolean
    cleanupOnDelete boolean
    description string
    disableProxy boolean
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    downloadDirect boolean
    excludesPattern string
    includesPattern string
    maxUniqueTags number
    members GetFederatedOciRepositoryMember[]
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    notes string
    priorityResolution boolean
    projectEnvironments string[]
    projectKey string
    propertySets string[]
    proxy string
    Proxy key from Artifactory Proxies settings.
    repoLayoutRef string
    tagRetention number
    xrayIndex boolean
    key str
    the identity key of the repo.
    archive_browsing_enabled bool
    blacked_out bool
    cdn_redirect bool
    cleanup_on_delete bool
    description str
    disable_proxy bool
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    download_direct bool
    excludes_pattern str
    includes_pattern str
    max_unique_tags int
    members Sequence[GetFederatedOciRepositoryMember]
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    notes str
    priority_resolution bool
    project_environments Sequence[str]
    project_key str
    property_sets Sequence[str]
    proxy str
    Proxy key from Artifactory Proxies settings.
    repo_layout_ref str
    tag_retention int
    xray_index bool
    key String
    the identity key of the repo.
    archiveBrowsingEnabled Boolean
    blackedOut Boolean
    cdnRedirect Boolean
    cleanupOnDelete Boolean
    description String
    disableProxy Boolean
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    downloadDirect Boolean
    excludesPattern String
    includesPattern String
    maxUniqueTags Number
    members List<Property Map>
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    notes String
    priorityResolution Boolean
    projectEnvironments List<String>
    projectKey String
    propertySets List<String>
    proxy String
    Proxy key from Artifactory Proxies settings.
    repoLayoutRef String
    tagRetention Number
    xrayIndex Boolean

    getFederatedOciRepository 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
    CleanupOnDelete bool
    Description string
    DisableProxy bool
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    DownloadDirect bool
    ExcludesPattern string
    IncludesPattern string
    MaxUniqueTags int
    Members List<GetFederatedOciRepositoryMember>
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    Notes string
    PriorityResolution bool
    ProjectKey string
    PropertySets List<string>
    Proxy string
    Proxy key from Artifactory Proxies settings.
    RepoLayoutRef string
    TagRetention int
    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
    CleanupOnDelete bool
    Description string
    DisableProxy bool
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    DownloadDirect bool
    ExcludesPattern string
    IncludesPattern string
    MaxUniqueTags int
    Members []GetFederatedOciRepositoryMember
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    Notes string
    PriorityResolution bool
    ProjectKey string
    PropertySets []string
    Proxy string
    Proxy key from Artifactory Proxies settings.
    RepoLayoutRef string
    TagRetention int
    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
    cleanupOnDelete Boolean
    description String
    disableProxy Boolean
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    downloadDirect Boolean
    excludesPattern String
    includesPattern String
    maxUniqueTags Integer
    members List<GetFederatedOciRepositoryMember>
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    notes String
    priorityResolution Boolean
    projectKey String
    propertySets List<String>
    proxy String
    Proxy key from Artifactory Proxies settings.
    repoLayoutRef String
    tagRetention Integer
    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
    cleanupOnDelete boolean
    description string
    disableProxy boolean
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    downloadDirect boolean
    excludesPattern string
    includesPattern string
    maxUniqueTags number
    members GetFederatedOciRepositoryMember[]
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    notes string
    priorityResolution boolean
    projectKey string
    propertySets string[]
    proxy string
    Proxy key from Artifactory Proxies settings.
    repoLayoutRef string
    tagRetention 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
    cleanup_on_delete bool
    description str
    disable_proxy bool
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    download_direct bool
    excludes_pattern str
    includes_pattern str
    max_unique_tags int
    members Sequence[GetFederatedOciRepositoryMember]
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    notes str
    priority_resolution bool
    project_key str
    property_sets Sequence[str]
    proxy str
    Proxy key from Artifactory Proxies settings.
    repo_layout_ref str
    tag_retention int
    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
    cleanupOnDelete Boolean
    description String
    disableProxy Boolean
    When set to true, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too.
    downloadDirect Boolean
    excludesPattern String
    includesPattern String
    maxUniqueTags Number
    members List<Property Map>
    The list of Federated members and must contain this repository URL (configured base URL /artifactory/ + repo key). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly.
    notes String
    priorityResolution Boolean
    projectKey String
    propertySets List<String>
    proxy String
    Proxy key from Artifactory Proxies settings.
    repoLayoutRef String
    tagRetention Number
    xrayIndex Boolean

    Supporting Types

    GetFederatedOciRepositoryMember

    Enabled bool
    Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
    Url string
    Full URL to ending with the repository name.
    AccessToken string
    Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.
    Enabled bool
    Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
    Url string
    Full URL to ending with the repository name.
    AccessToken string
    Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.
    enabled Boolean
    Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
    url String
    Full URL to ending with the repository name.
    accessToken String
    Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.
    enabled boolean
    Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
    url string
    Full URL to ending with the repository name.
    accessToken string
    Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.
    enabled bool
    Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
    url str
    Full URL to ending with the repository name.
    access_token str
    Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.
    enabled Boolean
    Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
    url String
    Full URL to ending with the repository name.
    accessToken String
    Admin access token for this member Artifactory instance. Used in conjunction with cleanup_on_delete attribute when Access Federation for access tokens is not enabled.

    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
    pulumi/pulumi-artifactory