Skip to content

File Resource

Synopsis

Manages files on the local filesystem. Supports creating files with specified content and removing files. Works on Windows, Linux, and macOS.

Type

OpenDsc.FileSystem/File

Capabilities

  • Get
  • Set
  • Delete

Properties

path

Path to the file.

Type: string
Required: Yes
Access: Read/Write
Default value: None

content

Content of the file.

Type: string
Required: No
Access: Read/Write
Default value: None

_exist

Whether the file should exist.

Type: bool
Required: No
Access: Read/Write
Default value: true

Examples

Example 1 — Get a file

$resourceInput = @'
path: /etc/hostname
'@

dsc resource get -r OpenDsc.FileSystem/File --input $resourceInput

resource_input=$(cat <<'EOF'
path: /etc/hostname
EOF
)

dsc resource get -r OpenDsc.FileSystem/File --input "$resource_input"

Example 2 — Create a file with content

$resourceInput = @'
path: /tmp/hello.txt
content: Hello, World!
'@

dsc resource set -r OpenDsc.FileSystem/File --input $resourceInput

resource_input=$(cat <<'EOF'
path: /tmp/hello.txt
content: Hello, World!
EOF
)

dsc resource set -r OpenDsc.FileSystem/File --input "$resource_input"

Example 3 — Delete a file

$resourceInput = @'
path: /tmp/hello.txt
'@

dsc resource delete -r OpenDsc.FileSystem/File --input $resourceInput

resource_input=$(cat <<'EOF'
path: /tmp/hello.txt
EOF
)

dsc resource delete -r OpenDsc.FileSystem/File --input "$resource_input"

Example 4 — Configuration document

$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
  - name: Application config file
    type: OpenDsc.FileSystem/File
    properties:
      path: /opt/myapp/config.json
      content: |
        {
          "logLevel": "Information",
          "port": 8080
        }

Exit codes

Code Description
0 Success
1 Error
2 Invalid JSON
3 Access denied
4 Invalid argument
5 IO error