1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. Apt
  5. Apt/standard
  6. Repository
Proxmox Virtual Environment (Proxmox VE) v6.15.3 published on Monday, Nov 11, 2024 by Daniel Muehlbachler-Pietrzykowski

proxmoxve.Apt/standard.Repository

Explore with Pulumi AI

proxmoxve logo
Proxmox Virtual Environment (Proxmox VE) v6.15.3 published on Monday, Nov 11, 2024 by Daniel Muehlbachler-Pietrzykowski

    Manages an APT standard repository of a Proxmox VE node.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";
    
    const exampleRepository = new proxmoxve.apt.standard.Repository("exampleRepository", {
        handle: "no-subscription",
        node: "pve",
    });
    const exampleApt_repositoryRepository = new proxmoxve.apt.Repository("exampleApt/repositoryRepository", {
        enabled: true,
        filePath: exampleRepository.filePath,
        index: exampleRepository.index,
        node: exampleRepository.node,
    });
    
    import pulumi
    import pulumi_proxmoxve as proxmoxve
    
    example_repository = proxmoxve.apt.standard.Repository("exampleRepository",
        handle="no-subscription",
        node="pve")
    example_apt_repository_repository = proxmoxve.apt.Repository("exampleApt/repositoryRepository",
        enabled=True,
        file_path=example_repository.file_path,
        index=example_repository.index,
        node=example_repository.node)
    
    package main
    
    import (
    	"github.com/muhlba91/pulumi-proxmoxve/sdk/v6/go/proxmoxve/Apt"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleRepository, err := Apt.NewRepository(ctx, "exampleRepository", &Apt.RepositoryArgs{
    			Handle: pulumi.String("no-subscription"),
    			Node:   pulumi.String("pve"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = Apt.NewRepository(ctx, "exampleApt/repositoryRepository", &Apt.RepositoryArgs{
    			Enabled:  pulumi.Bool(true),
    			FilePath: exampleRepository.FilePath,
    			Index:    exampleRepository.Index,
    			Node:     exampleRepository.Node,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using ProxmoxVE = Pulumi.ProxmoxVE;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleRepository = new ProxmoxVE.Apt.Standard.Repository("exampleRepository", new()
        {
            Handle = "no-subscription",
            Node = "pve",
        });
    
        var exampleApt_repositoryRepository = new ProxmoxVE.Apt.Repository("exampleApt/repositoryRepository", new()
        {
            Enabled = true,
            FilePath = exampleRepository.FilePath,
            Index = exampleRepository.Index,
            Node = exampleRepository.Node,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.proxmoxve.Apt.Repository;
    import com.pulumi.proxmoxve.Apt.RepositoryArgs;
    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) {
            var exampleRepository = new Repository("exampleRepository", RepositoryArgs.builder()
                .handle("no-subscription")
                .node("pve")
                .build());
    
            var exampleApt_repositoryRepository = new Repository("exampleApt/repositoryRepository", RepositoryArgs.builder()
                .enabled(true)
                .filePath(exampleRepository.filePath())
                .index(exampleRepository.index())
                .node(exampleRepository.node())
                .build());
    
        }
    }
    
    resources:
      exampleRepository:
        type: proxmoxve:Apt/standard:Repository
        properties:
          handle: no-subscription
          node: pve
      exampleApt/repositoryRepository:
        type: proxmoxve:Apt:Repository
        properties:
          enabled: true
          filePath: ${exampleRepository.filePath}
          index: ${exampleRepository.index}
          node: ${exampleRepository.node}
    

    Create Repository Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Repository(name: string, args: RepositoryArgs, opts?: CustomResourceOptions);
    @overload
    def Repository(resource_name: str,
                   args: RepositoryArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Repository(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   handle: Optional[str] = None,
                   node: Optional[str] = None)
    func NewRepository(ctx *Context, name string, args RepositoryArgs, opts ...ResourceOption) (*Repository, error)
    public Repository(string name, RepositoryArgs args, CustomResourceOptions? opts = null)
    public Repository(String name, RepositoryArgs args)
    public Repository(String name, RepositoryArgs args, CustomResourceOptions options)
    
    type: proxmoxve:Apt/standard/repository:Repository
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args RepositoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RepositoryArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RepositoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RepositoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RepositoryArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Repository Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Repository resource accepts the following input properties:

    Handle string
    The handle of the APT standard repository. Must be ceph-quincy-enterprise | ceph-quincy-no-subscription | ceph-quincy-test | ceph-reef-enterprise | ceph-reef-no-subscription | ceph-reef-test | enterprise | no-subscription | test.
    Node string
    The name of the target Proxmox VE node.
    Handle string
    The handle of the APT standard repository. Must be ceph-quincy-enterprise | ceph-quincy-no-subscription | ceph-quincy-test | ceph-reef-enterprise | ceph-reef-no-subscription | ceph-reef-test | enterprise | no-subscription | test.
    Node string
    The name of the target Proxmox VE node.
    handle String
    The handle of the APT standard repository. Must be ceph-quincy-enterprise | ceph-quincy-no-subscription | ceph-quincy-test | ceph-reef-enterprise | ceph-reef-no-subscription | ceph-reef-test | enterprise | no-subscription | test.
    node String
    The name of the target Proxmox VE node.
    handle string
    The handle of the APT standard repository. Must be ceph-quincy-enterprise | ceph-quincy-no-subscription | ceph-quincy-test | ceph-reef-enterprise | ceph-reef-no-subscription | ceph-reef-test | enterprise | no-subscription | test.
    node string
    The name of the target Proxmox VE node.
    handle str
    The handle of the APT standard repository. Must be ceph-quincy-enterprise | ceph-quincy-no-subscription | ceph-quincy-test | ceph-reef-enterprise | ceph-reef-no-subscription | ceph-reef-test | enterprise | no-subscription | test.
    node str
    The name of the target Proxmox VE node.
    handle String
    The handle of the APT standard repository. Must be ceph-quincy-enterprise | ceph-quincy-no-subscription | ceph-quincy-test | ceph-reef-enterprise | ceph-reef-no-subscription | ceph-reef-test | enterprise | no-subscription | test.
    node String
    The name of the target Proxmox VE node.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Repository resource produces the following output properties:

    Description string
    The description of the APT standard repository.
    FilePath string
    The absolute path of the source list file that contains this standard repository.
    Id string
    The provider-assigned unique ID for this managed resource.
    Index int
    The index within the defining source list file.
    Name string
    The name of the APT standard repository.
    Status int
    Indicates the activation status.
    Description string
    The description of the APT standard repository.
    FilePath string
    The absolute path of the source list file that contains this standard repository.
    Id string
    The provider-assigned unique ID for this managed resource.
    Index int
    The index within the defining source list file.
    Name string
    The name of the APT standard repository.
    Status int
    Indicates the activation status.
    description String
    The description of the APT standard repository.
    filePath String
    The absolute path of the source list file that contains this standard repository.
    id String
    The provider-assigned unique ID for this managed resource.
    index Integer
    The index within the defining source list file.
    name String
    The name of the APT standard repository.
    status Integer
    Indicates the activation status.
    description string
    The description of the APT standard repository.
    filePath string
    The absolute path of the source list file that contains this standard repository.
    id string
    The provider-assigned unique ID for this managed resource.
    index number
    The index within the defining source list file.
    name string
    The name of the APT standard repository.
    status number
    Indicates the activation status.
    description str
    The description of the APT standard repository.
    file_path str
    The absolute path of the source list file that contains this standard repository.
    id str
    The provider-assigned unique ID for this managed resource.
    index int
    The index within the defining source list file.
    name str
    The name of the APT standard repository.
    status int
    Indicates the activation status.
    description String
    The description of the APT standard repository.
    filePath String
    The absolute path of the source list file that contains this standard repository.
    id String
    The provider-assigned unique ID for this managed resource.
    index Number
    The index within the defining source list file.
    name String
    The name of the APT standard repository.
    status Number
    Indicates the activation status.

    Look up Existing Repository Resource

    Get an existing Repository resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RepositoryState, opts?: CustomResourceOptions): Repository
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            file_path: Optional[str] = None,
            handle: Optional[str] = None,
            index: Optional[int] = None,
            name: Optional[str] = None,
            node: Optional[str] = None,
            status: Optional[int] = None) -> Repository
    func GetRepository(ctx *Context, name string, id IDInput, state *RepositoryState, opts ...ResourceOption) (*Repository, error)
    public static Repository Get(string name, Input<string> id, RepositoryState? state, CustomResourceOptions? opts = null)
    public static Repository get(String name, Output<String> id, RepositoryState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    The description of the APT standard repository.
    FilePath string
    The absolute path of the source list file that contains this standard repository.
    Handle string
    The handle of the APT standard repository. Must be ceph-quincy-enterprise | ceph-quincy-no-subscription | ceph-quincy-test | ceph-reef-enterprise | ceph-reef-no-subscription | ceph-reef-test | enterprise | no-subscription | test.
    Index int
    The index within the defining source list file.
    Name string
    The name of the APT standard repository.
    Node string
    The name of the target Proxmox VE node.
    Status int
    Indicates the activation status.
    Description string
    The description of the APT standard repository.
    FilePath string
    The absolute path of the source list file that contains this standard repository.
    Handle string
    The handle of the APT standard repository. Must be ceph-quincy-enterprise | ceph-quincy-no-subscription | ceph-quincy-test | ceph-reef-enterprise | ceph-reef-no-subscription | ceph-reef-test | enterprise | no-subscription | test.
    Index int
    The index within the defining source list file.
    Name string
    The name of the APT standard repository.
    Node string
    The name of the target Proxmox VE node.
    Status int
    Indicates the activation status.
    description String
    The description of the APT standard repository.
    filePath String
    The absolute path of the source list file that contains this standard repository.
    handle String
    The handle of the APT standard repository. Must be ceph-quincy-enterprise | ceph-quincy-no-subscription | ceph-quincy-test | ceph-reef-enterprise | ceph-reef-no-subscription | ceph-reef-test | enterprise | no-subscription | test.
    index Integer
    The index within the defining source list file.
    name String
    The name of the APT standard repository.
    node String
    The name of the target Proxmox VE node.
    status Integer
    Indicates the activation status.
    description string
    The description of the APT standard repository.
    filePath string
    The absolute path of the source list file that contains this standard repository.
    handle string
    The handle of the APT standard repository. Must be ceph-quincy-enterprise | ceph-quincy-no-subscription | ceph-quincy-test | ceph-reef-enterprise | ceph-reef-no-subscription | ceph-reef-test | enterprise | no-subscription | test.
    index number
    The index within the defining source list file.
    name string
    The name of the APT standard repository.
    node string
    The name of the target Proxmox VE node.
    status number
    Indicates the activation status.
    description str
    The description of the APT standard repository.
    file_path str
    The absolute path of the source list file that contains this standard repository.
    handle str
    The handle of the APT standard repository. Must be ceph-quincy-enterprise | ceph-quincy-no-subscription | ceph-quincy-test | ceph-reef-enterprise | ceph-reef-no-subscription | ceph-reef-test | enterprise | no-subscription | test.
    index int
    The index within the defining source list file.
    name str
    The name of the APT standard repository.
    node str
    The name of the target Proxmox VE node.
    status int
    Indicates the activation status.
    description String
    The description of the APT standard repository.
    filePath String
    The absolute path of the source list file that contains this standard repository.
    handle String
    The handle of the APT standard repository. Must be ceph-quincy-enterprise | ceph-quincy-no-subscription | ceph-quincy-test | ceph-reef-enterprise | ceph-reef-no-subscription | ceph-reef-test | enterprise | no-subscription | test.
    index Number
    The index within the defining source list file.
    name String
    The name of the APT standard repository.
    node String
    The name of the target Proxmox VE node.
    status Number
    Indicates the activation status.

    Import

    #!/usr/bin/env sh

    An APT standard repository can be imported using a comma-separated list consisting of the name of the Proxmox VE node,

    and the standard repository handle in the exact same order, e.g.:

    $ pulumi import proxmoxve:Apt/standard/repository:Repository example pve,no-subscription
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    proxmoxve muhlba91/pulumi-proxmoxve
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the proxmox Terraform Provider.
    proxmoxve logo
    Proxmox Virtual Environment (Proxmox VE) v6.15.3 published on Monday, Nov 11, 2024 by Daniel Muehlbachler-Pietrzykowski