Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 2 additions & 10 deletions docs/reference/cli/function/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,15 +65,7 @@ Numeric min 1 maxInt a-n-- Returns the smallest number
Numeric mod 2 2 --n-- Divides the first number by the second and returns the remainder
Numeric mul 2 2 --n-- Multiplies two or more numbers together
Numeric sub 2 2 --n-- Subtracts the second number from the first
Resource reference 1 1 ---s- Retrieves the output of a previously executed resource
Resource resourceId 2 2 ---s- Constructs a resource ID from the given type and name
String base64 1 1 ---s- Encodes a string to Base64 format
String concat 2 maxInt a--s- Concatenates two or more strings or arrays
String format 2 maxInt -bns- Formats a string using the given arguments
System envvar 1 1 ---s- Retrieves the value of an environment variable
System path 2 maxInt ---s- Concatenates multiple strings into a file path
System secret 1 2 ---s- Retrieves a secret from a vault
System systemRoot 0 0 ---s- Returns the system root path
# truncated
```

### Example 2 - List functions with JSON output
Expand All @@ -84,7 +76,7 @@ This command returns function information in pretty JSON format.
dsc function list --output-format pretty-json
```

```json
```jsonc
{
"category": "Array",
"name": "createArray",
Expand Down
177 changes: 177 additions & 0 deletions docs/reference/schemas/config/functions/secret.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
---
description: Reference for the 'secret' DSC configuration document function
ms.date: 08/22/2025
ms.topic: reference
title: secret
---

# secret

## Synopsis

Retrieves secrets from registered secret management extensions.

## Syntax

```Syntax
secret(<name>)
secret(<name>, <vault>)
```

## Description

The `secret()` function retrieves secrets from extensions that support the
secret capability. It queries all registered extensions that implement secret
management and returns the requested secret value. If multiple extensions
return different values for the same secret name, an error is returned unless
a vault is specified to disambiguate.

The function supports two calling patterns:

- Single argument: Retrieves a secret by name from any available vault
- Two arguments: Retrieves a secret by name from a specific vault

If multiple extensions return the same secret value, the function succeeds and
returns that value. This allows for redundancy across secret management
systems.

## Examples

### Example 1 - Retrieve a secret by name

The following example retrieves a secret named 'DatabasePassword' from any
available vault. The secret expression is used directly as the output value.

```yaml
# secret.example.1.dsc.config.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
- name: Database Connection
type: Microsoft.DSC.Debug/Echo
properties:
output: "[secret('DatabasePassword')]"
```

```bash
dsc config get --file secret.example.1.dsc.config.yaml
```

```yaml
results:
- name: Database Connection
type: Microsoft.DSC.Debug/Echo
result:
actualState:
output: "MySecretPassword123"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how to address this, but if you can currently use the Echo resource to emit secrets retrieved with the secret() function, that's probably something we need to fix.

I'm not sure exactly how to manage this problem yet - but if all you need to do to dump secrets from someone's vault is guess the name and invoke a config, that's not good.

CC @SteveL-MSFT

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you can access the secret (meaning authenticated in some way), you already have access to the secret in memory (or other means). Resources need the secret itself in plaintext and we can only prevent accidental exposure of it, we aren't a security boundary to prevent access to something that have to use.

If we want to add a layer of defense, we could say that secrets are always passed as JSON:

{ "secureString": "plaintext" }

But now anything that needs it needs to parse the JSON and would also need to handle it appropriately anyways, so I'm not sure it adds value since the recipient would already know it's a sensitive string.

messages: []
hadErrors: false
```

### Example 2 - Pass a secret through a parameter default

The following example defines a secureString parameter whose default value
is the secret. The resource then uses the parameter value for the output
property.

```yaml
# secret.example.2.dsc.config.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
parameters:
myString:
type: secureString
defaultValue: "[secret('MySecret')]"
resources:
- name: Database Connection
type: Microsoft.DSC.Debug/Echo
properties:
output: "[parameters('myString')]"
```

```bash
dsc config get --file secret.example.2.dsc.config.yaml
```

```yaml
results:
- name: Database Connection
type: Microsoft.DSC.Debug/Echo
result:
actualState:
output: "MySecretPassword123"
messages: []
hadErrors: false
```

## Parameters

### name

The name of the secret to retrieve.

```yaml
Type: string
Required: true
Position: 1
```

### vault

The name of the vault or secret store to retrieve the secret from. When
specified, only the named vault is queried for the secret, which helps
disambiguate when multiple vaults contain secrets with the same name.

```yaml
Type: string
Required: false
Position: 2
```

## Output

The `secret()` function returns the secret value as a string.

```yaml
Type: string
```

## Error conditions

The `secret()` function can return errors in the following situations:

- **No extensions available**: No secret management extensions are registered
or available
- **Secret not found**: The specified secret name does not exist in any
available vault
- **Multiple different values**: Multiple extensions return different values
for the same secret name (specify a vault to disambiguate)
- **Vault not found**: The specified vault does not exist or is not accessible.
- **Extension error**: An underlying secret management extension returns an
error

## Security considerations

- Secret values are retrieved at runtime and should be handled securely
- Secrets are not cached by DSC and are retrieved fresh on each function call
- Secret values are logged when `--trace-level` is "TRACE"
- Extensions should implement appropriate authentication and authorization for
secret access

## Extension requirements

To support the `secret()` function, extensions must:

1. Declare the `secret` capability in their manifest
2. Implement a secret retrieval method that accepts name and optional vault
parameters
3. Return secret values as single-line strings (multi-line values are not
supported)
4. Handle authentication and authorization according to their secret
management system

## Related functions

- [`parameters()`][00] - Access configuration parameters that may influence
secret selection

<!-- Link reference definitions -->
[00]: ./parameters.md