1. Packages
  2. Artifactory
  3. API Docs
  4. getVirtualHelmRepository
artifactory v6.7.1 published on Friday, Apr 26, 2024 by Pulumi

artifactory.getVirtualHelmRepository

Explore with Pulumi AI

artifactory logo
artifactory v6.7.1 published on Friday, Apr 26, 2024 by Pulumi

    Retrieves a virtual Helm repository.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as artifactory from "@pulumi/artifactory";
    
    const virtual-helm = artifactory.getVirtualHelmRepository({
        key: "virtual-helm",
    });
    
    import pulumi
    import pulumi_artifactory as artifactory
    
    virtual_helm = artifactory.get_virtual_helm_repository(key="virtual-helm")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-artifactory/sdk/v6/go/artifactory"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := artifactory.LookupVirtualHelmRepository(ctx, &artifactory.LookupVirtualHelmRepositoryArgs{
    			Key: "virtual-helm",
    		}, 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 virtual_helm = Artifactory.GetVirtualHelmRepository.Invoke(new()
        {
            Key = "virtual-helm",
        });
    
    });
    
    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.GetVirtualHelmRepositoryArgs;
    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 virtual-helm = ArtifactoryFunctions.getVirtualHelmRepository(GetVirtualHelmRepositoryArgs.builder()
                .key("virtual-helm")
                .build());
    
        }
    }
    
    variables:
      virtual-helm:
        fn::invoke:
          Function: artifactory:getVirtualHelmRepository
          Arguments:
            key: virtual-helm
    

    Using getVirtualHelmRepository

    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 getVirtualHelmRepository(args: GetVirtualHelmRepositoryArgs, opts?: InvokeOptions): Promise<GetVirtualHelmRepositoryResult>
    function getVirtualHelmRepositoryOutput(args: GetVirtualHelmRepositoryOutputArgs, opts?: InvokeOptions): Output<GetVirtualHelmRepositoryResult>
    def get_virtual_helm_repository(artifactory_requests_can_retrieve_remote_artifacts: Optional[bool] = None,
                                    default_deployment_repo: Optional[str] = None,
                                    description: Optional[str] = None,
                                    excludes_pattern: Optional[str] = None,
                                    includes_pattern: Optional[str] = None,
                                    key: Optional[str] = None,
                                    notes: Optional[str] = None,
                                    project_environments: Optional[Sequence[str]] = None,
                                    project_key: Optional[str] = None,
                                    repo_layout_ref: Optional[str] = None,
                                    repositories: Optional[Sequence[str]] = None,
                                    retrieval_cache_period_seconds: Optional[int] = None,
                                    use_namespaces: Optional[bool] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetVirtualHelmRepositoryResult
    def get_virtual_helm_repository_output(artifactory_requests_can_retrieve_remote_artifacts: Optional[pulumi.Input[bool]] = None,
                                    default_deployment_repo: Optional[pulumi.Input[str]] = None,
                                    description: Optional[pulumi.Input[str]] = None,
                                    excludes_pattern: Optional[pulumi.Input[str]] = None,
                                    includes_pattern: Optional[pulumi.Input[str]] = None,
                                    key: Optional[pulumi.Input[str]] = None,
                                    notes: Optional[pulumi.Input[str]] = None,
                                    project_environments: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                    project_key: Optional[pulumi.Input[str]] = None,
                                    repo_layout_ref: Optional[pulumi.Input[str]] = None,
                                    repositories: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                    retrieval_cache_period_seconds: Optional[pulumi.Input[int]] = None,
                                    use_namespaces: Optional[pulumi.Input[bool]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetVirtualHelmRepositoryResult]
    func LookupVirtualHelmRepository(ctx *Context, args *LookupVirtualHelmRepositoryArgs, opts ...InvokeOption) (*LookupVirtualHelmRepositoryResult, error)
    func LookupVirtualHelmRepositoryOutput(ctx *Context, args *LookupVirtualHelmRepositoryOutputArgs, opts ...InvokeOption) LookupVirtualHelmRepositoryResultOutput

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

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

    The following arguments are supported:

    Key string
    the identity key of the repo.
    ArtifactoryRequestsCanRetrieveRemoteArtifacts bool
    DefaultDeploymentRepo string
    Description string
    ExcludesPattern string
    IncludesPattern string
    Notes string
    ProjectEnvironments List<string>
    ProjectKey string
    RepoLayoutRef string
    Repositories List<string>
    RetrievalCachePeriodSeconds int
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    UseNamespaces bool
    (Optional) From Artifactory 7.24.1 (SaaS Version), you can explicitly state a specific aggregated local or remote repository to fetch from a virtual by assigning namespaces to local and remote repositories. See the documentation here. Default is false.
    Key string
    the identity key of the repo.
    ArtifactoryRequestsCanRetrieveRemoteArtifacts bool
    DefaultDeploymentRepo string
    Description string
    ExcludesPattern string
    IncludesPattern string
    Notes string
    ProjectEnvironments []string
    ProjectKey string
    RepoLayoutRef string
    Repositories []string
    RetrievalCachePeriodSeconds int
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    UseNamespaces bool
    (Optional) From Artifactory 7.24.1 (SaaS Version), you can explicitly state a specific aggregated local or remote repository to fetch from a virtual by assigning namespaces to local and remote repositories. See the documentation here. Default is false.
    key String
    the identity key of the repo.
    artifactoryRequestsCanRetrieveRemoteArtifacts Boolean
    defaultDeploymentRepo String
    description String
    excludesPattern String
    includesPattern String
    notes String
    projectEnvironments List<String>
    projectKey String
    repoLayoutRef String
    repositories List<String>
    retrievalCachePeriodSeconds Integer
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    useNamespaces Boolean
    (Optional) From Artifactory 7.24.1 (SaaS Version), you can explicitly state a specific aggregated local or remote repository to fetch from a virtual by assigning namespaces to local and remote repositories. See the documentation here. Default is false.
    key string
    the identity key of the repo.
    artifactoryRequestsCanRetrieveRemoteArtifacts boolean
    defaultDeploymentRepo string
    description string
    excludesPattern string
    includesPattern string
    notes string
    projectEnvironments string[]
    projectKey string
    repoLayoutRef string
    repositories string[]
    retrievalCachePeriodSeconds number
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    useNamespaces boolean
    (Optional) From Artifactory 7.24.1 (SaaS Version), you can explicitly state a specific aggregated local or remote repository to fetch from a virtual by assigning namespaces to local and remote repositories. See the documentation here. Default is false.
    key str
    the identity key of the repo.
    artifactory_requests_can_retrieve_remote_artifacts bool
    default_deployment_repo str
    description str
    excludes_pattern str
    includes_pattern str
    notes str
    project_environments Sequence[str]
    project_key str
    repo_layout_ref str
    repositories Sequence[str]
    retrieval_cache_period_seconds int
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    use_namespaces bool
    (Optional) From Artifactory 7.24.1 (SaaS Version), you can explicitly state a specific aggregated local or remote repository to fetch from a virtual by assigning namespaces to local and remote repositories. See the documentation here. Default is false.
    key String
    the identity key of the repo.
    artifactoryRequestsCanRetrieveRemoteArtifacts Boolean
    defaultDeploymentRepo String
    description String
    excludesPattern String
    includesPattern String
    notes String
    projectEnvironments List<String>
    projectKey String
    repoLayoutRef String
    repositories List<String>
    retrievalCachePeriodSeconds Number
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    useNamespaces Boolean
    (Optional) From Artifactory 7.24.1 (SaaS Version), you can explicitly state a specific aggregated local or remote repository to fetch from a virtual by assigning namespaces to local and remote repositories. See the documentation here. Default is false.

    getVirtualHelmRepository 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>
    ArtifactoryRequestsCanRetrieveRemoteArtifacts bool
    DefaultDeploymentRepo string
    Description string
    ExcludesPattern string
    IncludesPattern string
    Notes string
    ProjectKey string
    RepoLayoutRef string
    Repositories List<string>
    RetrievalCachePeriodSeconds int
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    UseNamespaces bool
    (Optional) From Artifactory 7.24.1 (SaaS Version), you can explicitly state a specific aggregated local or remote repository to fetch from a virtual by assigning namespaces to local and remote repositories. See the documentation here. Default is false.
    Id string
    The provider-assigned unique ID for this managed resource.
    Key string
    PackageType string
    ProjectEnvironments []string
    ArtifactoryRequestsCanRetrieveRemoteArtifacts bool
    DefaultDeploymentRepo string
    Description string
    ExcludesPattern string
    IncludesPattern string
    Notes string
    ProjectKey string
    RepoLayoutRef string
    Repositories []string
    RetrievalCachePeriodSeconds int
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    UseNamespaces bool
    (Optional) From Artifactory 7.24.1 (SaaS Version), you can explicitly state a specific aggregated local or remote repository to fetch from a virtual by assigning namespaces to local and remote repositories. See the documentation here. Default is false.
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    packageType String
    projectEnvironments List<String>
    artifactoryRequestsCanRetrieveRemoteArtifacts Boolean
    defaultDeploymentRepo String
    description String
    excludesPattern String
    includesPattern String
    notes String
    projectKey String
    repoLayoutRef String
    repositories List<String>
    retrievalCachePeriodSeconds Integer
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    useNamespaces Boolean
    (Optional) From Artifactory 7.24.1 (SaaS Version), you can explicitly state a specific aggregated local or remote repository to fetch from a virtual by assigning namespaces to local and remote repositories. See the documentation here. Default is false.
    id string
    The provider-assigned unique ID for this managed resource.
    key string
    packageType string
    projectEnvironments string[]
    artifactoryRequestsCanRetrieveRemoteArtifacts boolean
    defaultDeploymentRepo string
    description string
    excludesPattern string
    includesPattern string
    notes string
    projectKey string
    repoLayoutRef string
    repositories string[]
    retrievalCachePeriodSeconds number
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    useNamespaces boolean
    (Optional) From Artifactory 7.24.1 (SaaS Version), you can explicitly state a specific aggregated local or remote repository to fetch from a virtual by assigning namespaces to local and remote repositories. See the documentation here. Default is false.
    id str
    The provider-assigned unique ID for this managed resource.
    key str
    package_type str
    project_environments Sequence[str]
    artifactory_requests_can_retrieve_remote_artifacts bool
    default_deployment_repo str
    description str
    excludes_pattern str
    includes_pattern str
    notes str
    project_key str
    repo_layout_ref str
    repositories Sequence[str]
    retrieval_cache_period_seconds int
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    use_namespaces bool
    (Optional) From Artifactory 7.24.1 (SaaS Version), you can explicitly state a specific aggregated local or remote repository to fetch from a virtual by assigning namespaces to local and remote repositories. See the documentation here. Default is false.
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    packageType String
    projectEnvironments List<String>
    artifactoryRequestsCanRetrieveRemoteArtifacts Boolean
    defaultDeploymentRepo String
    description String
    excludesPattern String
    includesPattern String
    notes String
    projectKey String
    repoLayoutRef String
    repositories List<String>
    retrievalCachePeriodSeconds Number
    (Optional, Default: 7200) This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated repositories. A value of 0 indicates no caching.
    useNamespaces Boolean
    (Optional) From Artifactory 7.24.1 (SaaS Version), you can explicitly state a specific aggregated local or remote repository to fetch from a virtual by assigning namespaces to local and remote repositories. See the documentation here. Default is false.

    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 v6.7.1 published on Friday, Apr 26, 2024 by Pulumi