1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. Storage
  5. File
Proxmox Virtual Environment (Proxmox VE) v5.12.3 published on Monday, Oct 2, 2023 by Daniel Muehlbachler-Pietrzykowski

proxmoxve.Storage.File

Explore with Pulumi AI

proxmoxve logo
Proxmox Virtual Environment (Proxmox VE) v5.12.3 published on Monday, Oct 2, 2023 by Daniel Muehlbachler-Pietrzykowski

    Create File Resource

    new File(name: string, args: FileArgs, opts?: CustomResourceOptions);
    @overload
    def File(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             content_type: Optional[str] = None,
             datastore_id: Optional[str] = None,
             node_name: Optional[str] = None,
             overwrite: Optional[bool] = None,
             source_file: Optional[_storage.FileSourceFileArgs] = None,
             source_raw: Optional[_storage.FileSourceRawArgs] = None,
             timeout_upload: Optional[int] = None)
    @overload
    def File(resource_name: str,
             args: FileArgs,
             opts: Optional[ResourceOptions] = None)
    func NewFile(ctx *Context, name string, args FileArgs, opts ...ResourceOption) (*File, error)
    public File(string name, FileArgs args, CustomResourceOptions? opts = null)
    public File(String name, FileArgs args)
    public File(String name, FileArgs args, CustomResourceOptions options)
    
    type: proxmoxve:Storage:File
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args FileArgs
    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 FileArgs
    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 FileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FileArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    File Resource Properties

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

    Inputs

    The File resource accepts the following input properties:

    DatastoreId string

    The datastore id

    NodeName string

    The node name

    ContentType string

    The content type

    Overwrite bool

    Whether to overwrite the file if it already exists

    SourceFile Pulumi.ProxmoxVE.Storage.Inputs.FileSourceFile

    The source file

    SourceRaw Pulumi.ProxmoxVE.Storage.Inputs.FileSourceRaw

    The raw source

    TimeoutUpload int

    Timeout for uploading ISO/VSTMPL files in seconds

    DatastoreId string

    The datastore id

    NodeName string

    The node name

    ContentType string

    The content type

    Overwrite bool

    Whether to overwrite the file if it already exists

    SourceFile FileSourceFileArgs

    The source file

    SourceRaw FileSourceRawArgs

    The raw source

    TimeoutUpload int

    Timeout for uploading ISO/VSTMPL files in seconds

    datastoreId String

    The datastore id

    nodeName String

    The node name

    contentType String

    The content type

    overwrite Boolean

    Whether to overwrite the file if it already exists

    sourceFile FileSourceFile

    The source file

    sourceRaw FileSourceRaw

    The raw source

    timeoutUpload Integer

    Timeout for uploading ISO/VSTMPL files in seconds

    datastoreId string

    The datastore id

    nodeName string

    The node name

    contentType string

    The content type

    overwrite boolean

    Whether to overwrite the file if it already exists

    sourceFile FileSourceFile

    The source file

    sourceRaw FileSourceRaw

    The raw source

    timeoutUpload number

    Timeout for uploading ISO/VSTMPL files in seconds

    datastore_id str

    The datastore id

    node_name str

    The node name

    content_type str

    The content type

    overwrite bool

    Whether to overwrite the file if it already exists

    source_file FileSourceFileArgs

    The source file

    source_raw FileSourceRawArgs

    The raw source

    timeout_upload int

    Timeout for uploading ISO/VSTMPL files in seconds

    datastoreId String

    The datastore id

    nodeName String

    The node name

    contentType String

    The content type

    overwrite Boolean

    Whether to overwrite the file if it already exists

    sourceFile Property Map

    The source file

    sourceRaw Property Map

    The raw source

    timeoutUpload Number

    Timeout for uploading ISO/VSTMPL files in seconds

    Outputs

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

    FileModificationDate string

    The file modification date

    FileName string

    The file name

    FileSize int

    The file size in bytes

    FileTag string

    The file tag

    Id string

    The provider-assigned unique ID for this managed resource.

    FileModificationDate string

    The file modification date

    FileName string

    The file name

    FileSize int

    The file size in bytes

    FileTag string

    The file tag

    Id string

    The provider-assigned unique ID for this managed resource.

    fileModificationDate String

    The file modification date

    fileName String

    The file name

    fileSize Integer

    The file size in bytes

    fileTag String

    The file tag

    id String

    The provider-assigned unique ID for this managed resource.

    fileModificationDate string

    The file modification date

    fileName string

    The file name

    fileSize number

    The file size in bytes

    fileTag string

    The file tag

    id string

    The provider-assigned unique ID for this managed resource.

    file_modification_date str

    The file modification date

    file_name str

    The file name

    file_size int

    The file size in bytes

    file_tag str

    The file tag

    id str

    The provider-assigned unique ID for this managed resource.

    fileModificationDate String

    The file modification date

    fileName String

    The file name

    fileSize Number

    The file size in bytes

    fileTag String

    The file tag

    id String

    The provider-assigned unique ID for this managed resource.

    Look up Existing File Resource

    Get an existing File 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?: FileState, opts?: CustomResourceOptions): File
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            content_type: Optional[str] = None,
            datastore_id: Optional[str] = None,
            file_modification_date: Optional[str] = None,
            file_name: Optional[str] = None,
            file_size: Optional[int] = None,
            file_tag: Optional[str] = None,
            node_name: Optional[str] = None,
            overwrite: Optional[bool] = None,
            source_file: Optional[_storage.FileSourceFileArgs] = None,
            source_raw: Optional[_storage.FileSourceRawArgs] = None,
            timeout_upload: Optional[int] = None) -> File
    func GetFile(ctx *Context, name string, id IDInput, state *FileState, opts ...ResourceOption) (*File, error)
    public static File Get(string name, Input<string> id, FileState? state, CustomResourceOptions? opts = null)
    public static File get(String name, Output<String> id, FileState 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:
    ContentType string

    The content type

    DatastoreId string

    The datastore id

    FileModificationDate string

    The file modification date

    FileName string

    The file name

    FileSize int

    The file size in bytes

    FileTag string

    The file tag

    NodeName string

    The node name

    Overwrite bool

    Whether to overwrite the file if it already exists

    SourceFile Pulumi.ProxmoxVE.Storage.Inputs.FileSourceFile

    The source file

    SourceRaw Pulumi.ProxmoxVE.Storage.Inputs.FileSourceRaw

    The raw source

    TimeoutUpload int

    Timeout for uploading ISO/VSTMPL files in seconds

    ContentType string

    The content type

    DatastoreId string

    The datastore id

    FileModificationDate string

    The file modification date

    FileName string

    The file name

    FileSize int

    The file size in bytes

    FileTag string

    The file tag

    NodeName string

    The node name

    Overwrite bool

    Whether to overwrite the file if it already exists

    SourceFile FileSourceFileArgs

    The source file

    SourceRaw FileSourceRawArgs

    The raw source

    TimeoutUpload int

    Timeout for uploading ISO/VSTMPL files in seconds

    contentType String

    The content type

    datastoreId String

    The datastore id

    fileModificationDate String

    The file modification date

    fileName String

    The file name

    fileSize Integer

    The file size in bytes

    fileTag String

    The file tag

    nodeName String

    The node name

    overwrite Boolean

    Whether to overwrite the file if it already exists

    sourceFile FileSourceFile

    The source file

    sourceRaw FileSourceRaw

    The raw source

    timeoutUpload Integer

    Timeout for uploading ISO/VSTMPL files in seconds

    contentType string

    The content type

    datastoreId string

    The datastore id

    fileModificationDate string

    The file modification date

    fileName string

    The file name

    fileSize number

    The file size in bytes

    fileTag string

    The file tag

    nodeName string

    The node name

    overwrite boolean

    Whether to overwrite the file if it already exists

    sourceFile FileSourceFile

    The source file

    sourceRaw FileSourceRaw

    The raw source

    timeoutUpload number

    Timeout for uploading ISO/VSTMPL files in seconds

    content_type str

    The content type

    datastore_id str

    The datastore id

    file_modification_date str

    The file modification date

    file_name str

    The file name

    file_size int

    The file size in bytes

    file_tag str

    The file tag

    node_name str

    The node name

    overwrite bool

    Whether to overwrite the file if it already exists

    source_file FileSourceFileArgs

    The source file

    source_raw FileSourceRawArgs

    The raw source

    timeout_upload int

    Timeout for uploading ISO/VSTMPL files in seconds

    contentType String

    The content type

    datastoreId String

    The datastore id

    fileModificationDate String

    The file modification date

    fileName String

    The file name

    fileSize Number

    The file size in bytes

    fileTag String

    The file tag

    nodeName String

    The node name

    overwrite Boolean

    Whether to overwrite the file if it already exists

    sourceFile Property Map

    The source file

    sourceRaw Property Map

    The raw source

    timeoutUpload Number

    Timeout for uploading ISO/VSTMPL files in seconds

    Supporting Types

    FileSourceFile, FileSourceFileArgs

    Path string
    Changed bool
    Checksum string
    FileName string
    Insecure bool
    Path string
    Changed bool
    Checksum string
    FileName string
    Insecure bool
    path String
    changed Boolean
    checksum String
    fileName String
    insecure Boolean
    path string
    changed boolean
    checksum string
    fileName string
    insecure boolean
    path String
    changed Boolean
    checksum String
    fileName String
    insecure Boolean

    FileSourceRaw, FileSourceRawArgs

    Data string
    FileName string
    Resize int
    Data string
    FileName string
    Resize int
    data String
    fileName String
    resize Integer
    data string
    fileName string
    resize number
    data String
    fileName String
    resize Number

    Package Details

    Repository
    proxmoxve muhlba91/pulumi-proxmoxve
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the proxmoxve Terraform Provider.

    proxmoxve logo
    Proxmox Virtual Environment (Proxmox VE) v5.12.3 published on Monday, Oct 2, 2023 by Daniel Muehlbachler-Pietrzykowski