Skip to content

Commit 044297c

Browse files
authored
Update configuration guide for CGV with secrets
Clarified instructions for using secrets in ARM templates, including proper configuration for obscuring secret values.
1 parent bd9a273 commit 044297c

1 file changed

Lines changed: 24 additions & 2 deletions

File tree

articles/operator-service-manager/configuration-guide.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,32 @@ Other then seperating secrets into a unique CGS, no special requirements exist f
9797
## CGV with secrets
9898
Consider the following Azure Resource Manager (ARM) template reqiurements to properly obscure secret values throughout the entire CGV resource lifecycle.
9999

100-
* Use `configurationType: 'Secret'` in the template resource properties.
100+
* Use `configurationType: 'Secret'` in the template under resource properties.
101101
* Once a CGV is deployed, this prevents displaying the secret data via most Azure methods.
102+
103+
```json
104+
"parameters": {
105+
"secretCgvContent": {
106+
"type": "SecureObject"
107+
}
108+
}
109+
```
110+
111+
* Use `"type": "secureObject"` in the template under parameter type
112+
* This obscures the display of the secrets as template parameters.
113+
114+
```json
115+
{
116+
"type": "Microsoft.HybridNetwork/configurationGroupValues",
117+
"properties": {
118+
"configurationType": "Secret"
119+
"secretDeploymentValues": "[string(parameters('secretCgvContent'))]"
120+
}
121+
}
122+
```
123+
102124
* Use a template reference to Azure Key Vault (AKV) in place of the plain-text secret.
103-
* This obscures the display of the secret in the CGV deployment template.
125+
* This obscures the display of the secrets as template variables.
104126

105127
> [!NOTE]
106128
> * Only Azure Key Vault is supported by ARM for secret reference substition.

0 commit comments

Comments
 (0)