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

artifactory.getLocalDockerV1Repository

Explore with Pulumi AI

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

    Retrieves a local Docker (v1) repository resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as artifactory from "@pulumi/artifactory";
    
    const artifactoryLocalTestDockerV1Repository = artifactory.getLocalDockerV1Repository({
        key: "artifactory_local_test_docker_v1_repository",
    });
    
    import pulumi
    import pulumi_artifactory as artifactory
    
    artifactory_local_test_docker_v1_repository = artifactory.get_local_docker_v1_repository(key="artifactory_local_test_docker_v1_repository")
    
    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.GetLocalDockerV1Repository(ctx, &artifactory.GetLocalDockerV1RepositoryArgs{
    			Key: "artifactory_local_test_docker_v1_repository",
    		}, 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 artifactoryLocalTestDockerV1Repository = Artifactory.GetLocalDockerV1Repository.Invoke(new()
        {
            Key = "artifactory_local_test_docker_v1_repository",
        });
    
    });
    
    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.GetLocalDockerV1RepositoryArgs;
    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 artifactoryLocalTestDockerV1Repository = ArtifactoryFunctions.getLocalDockerV1Repository(GetLocalDockerV1RepositoryArgs.builder()
                .key("artifactory_local_test_docker_v1_repository")
                .build());
    
        }
    }
    
    variables:
      artifactoryLocalTestDockerV1Repository:
        fn::invoke:
          Function: artifactory:getLocalDockerV1Repository
          Arguments:
            key: artifactory_local_test_docker_v1_repository
    

    Using getLocalDockerV1Repository

    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 getLocalDockerV1Repository(args: GetLocalDockerV1RepositoryArgs, opts?: InvokeOptions): Promise<GetLocalDockerV1RepositoryResult>
    function getLocalDockerV1RepositoryOutput(args: GetLocalDockerV1RepositoryOutputArgs, opts?: InvokeOptions): Output<GetLocalDockerV1RepositoryResult>
    def get_local_docker_v1_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,
                                       xray_index: Optional[bool] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetLocalDockerV1RepositoryResult
    def get_local_docker_v1_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,
                                       xray_index: Optional[pulumi.Input[bool]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetLocalDockerV1RepositoryResult]
    func GetLocalDockerV1Repository(ctx *Context, args *GetLocalDockerV1RepositoryArgs, opts ...InvokeOption) (*GetLocalDockerV1RepositoryResult, error)
    func GetLocalDockerV1RepositoryOutput(ctx *Context, args *GetLocalDockerV1RepositoryOutputArgs, opts ...InvokeOption) GetLocalDockerV1RepositoryResultOutput

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

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

    The following arguments are supported:

    Key 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. This only applies to manifest v2.
    Notes string
    PriorityResolution bool
    ProjectEnvironments List<string>
    ProjectKey string
    PropertySets List<string>
    RepoLayoutRef string
    XrayIndex bool
    Key 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. This only applies to manifest v2.
    Notes string
    PriorityResolution bool
    ProjectEnvironments []string
    ProjectKey string
    PropertySets []string
    RepoLayoutRef string
    XrayIndex bool
    key 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. This only applies to manifest v2.
    notes String
    priorityResolution Boolean
    projectEnvironments List<String>
    projectKey String
    propertySets List<String>
    repoLayoutRef String
    xrayIndex Boolean
    key 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. This only applies to manifest v2.
    notes string
    priorityResolution boolean
    projectEnvironments string[]
    projectKey string
    propertySets string[]
    repoLayoutRef string
    xrayIndex boolean
    key 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. This only applies to manifest v2.
    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.
    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. This only applies to manifest v2.
    notes String
    priorityResolution Boolean
    projectEnvironments List<String>
    projectKey String
    propertySets List<String>
    repoLayoutRef String
    xrayIndex Boolean

    getLocalDockerV1Repository Result

    The following output properties are available:

    ApiVersion string
    The Docker API version in use.
    BlockPushingSchema1 bool
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    Id string
    The provider-assigned unique ID for this managed resource.
    Key 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. This only applies to manifest v2.
    PackageType string
    ProjectEnvironments List<string>
    TagRetention int
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    ArchiveBrowsingEnabled bool
    BlackedOut bool
    CdnRedirect bool
    Description string
    DownloadDirect bool
    ExcludesPattern string
    IncludesPattern string
    Notes string
    PriorityResolution bool
    ProjectKey string
    PropertySets List<string>
    RepoLayoutRef string
    XrayIndex bool
    ApiVersion string
    The Docker API version in use.
    BlockPushingSchema1 bool
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    Id string
    The provider-assigned unique ID for this managed resource.
    Key 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. This only applies to manifest v2.
    PackageType string
    ProjectEnvironments []string
    TagRetention int
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    ArchiveBrowsingEnabled bool
    BlackedOut bool
    CdnRedirect bool
    Description string
    DownloadDirect bool
    ExcludesPattern string
    IncludesPattern string
    Notes string
    PriorityResolution bool
    ProjectKey string
    PropertySets []string
    RepoLayoutRef string
    XrayIndex bool
    apiVersion String
    The Docker API version in use.
    blockPushingSchema1 Boolean
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    id String
    The provider-assigned unique ID for this managed resource.
    key 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. This only applies to manifest v2.
    packageType String
    projectEnvironments List<String>
    tagRetention Integer
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    archiveBrowsingEnabled Boolean
    blackedOut Boolean
    cdnRedirect Boolean
    description String
    downloadDirect Boolean
    excludesPattern String
    includesPattern String
    notes String
    priorityResolution Boolean
    projectKey String
    propertySets List<String>
    repoLayoutRef String
    xrayIndex Boolean
    apiVersion string
    The Docker API version in use.
    blockPushingSchema1 boolean
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    id string
    The provider-assigned unique ID for this managed resource.
    key 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. This only applies to manifest v2.
    packageType string
    projectEnvironments string[]
    tagRetention number
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    archiveBrowsingEnabled boolean
    blackedOut boolean
    cdnRedirect boolean
    description string
    downloadDirect boolean
    excludesPattern string
    includesPattern string
    notes string
    priorityResolution boolean
    projectKey string
    propertySets string[]
    repoLayoutRef string
    xrayIndex boolean
    api_version str
    The Docker API version in use.
    block_pushing_schema1 bool
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    id str
    The provider-assigned unique ID for this managed resource.
    key 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. This only applies to manifest v2.
    package_type str
    project_environments Sequence[str]
    tag_retention int
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    archive_browsing_enabled bool
    blacked_out bool
    cdn_redirect bool
    description str
    download_direct bool
    excludes_pattern str
    includes_pattern str
    notes str
    priority_resolution bool
    project_key str
    property_sets Sequence[str]
    repo_layout_ref str
    xray_index bool
    apiVersion String
    The Docker API version in use.
    blockPushingSchema1 Boolean
    When set, Artifactory will block the pushing of Docker images with manifest v2 schema 1 to this repository.
    id String
    The provider-assigned unique ID for this managed resource.
    key 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. This only applies to manifest v2.
    packageType String
    projectEnvironments List<String>
    tagRetention Number
    If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2.
    archiveBrowsingEnabled Boolean
    blackedOut Boolean
    cdnRedirect Boolean
    description String
    downloadDirect Boolean
    excludesPattern String
    includesPattern 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