Skip to content

Commit c8baf48

Browse files
committed
feat: Update documentation
1 parent 29c277f commit c8baf48

File tree

1 file changed

+38
-24
lines changed
  • ql/lib/codeql/bicep/frameworks/Microsoft

1 file changed

+38
-24
lines changed

ql/lib/codeql/bicep/frameworks/Microsoft/Cache.qll

Lines changed: 38 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -96,24 +96,10 @@ module Cache {
9696
string toString() { result = "CacheProperties" }
9797
}
9898

99-
// redisConfiguration: {
100-
// aad-enabled: 'string'
101-
// aof-backup-enabled: 'string'
102-
// aof-storage-connection-string-0: 'string'
103-
// aof-storage-connection-string-1: 'string'
104-
// authnotrequired: 'string'
105-
// maxfragmentationmemory-reserved: 'string'
106-
// maxmemory-delta: 'string'
107-
// maxmemory-policy: 'string'
108-
// maxmemory-reserved: 'string'
109-
// notify-keyspace-events: 'string'
110-
// preferred-data-persistence-auth-method: 'string'
111-
// rdb-backup-enabled: 'string'
112-
// rdb-backup-frequency: 'string'
113-
// rdb-backup-max-snapshot-count: 'string'
114-
// rdb-storage-connection-string: 'string'
115-
// storage-subscription-id: 'string'
116-
// }
99+
/**
100+
* Represents the redisConfiguration object for Azure Cache for Redis.
101+
* Provides accessors for all supported redisConfiguration properties.
102+
*/
117103
class RedisConfiguration extends Object {
118104
private Properties properties;
119105

@@ -122,103 +108,131 @@ module Cache {
122108
*/
123109
RedisConfiguration() { this = properties.getProperty("redisConfiguration") }
124110

125-
/**
126-
* Returns the 'aad-enabled' property as a StringLiteral, if present.
127-
*/
111+
/** Returns the 'aad-enabled' property as a StringLiteral, if present. */
128112
StringLiteral getAadEnabled() { result = this.getProperty("aad-enabled") }
129113

130114
/** Returns the 'aad-enabled' property as a string, if present. */
131115
string aadEnabled() { result = this.getAadEnabled().getValue() }
132116

133-
/**
134-
* Returns the 'aof-backup-enabled' property as a StringLiteral, if present.
135-
*/
117+
/** Returns the 'aof-backup-enabled' property as a StringLiteral, if present. */
136118
StringLiteral getAofBackupEnabled() { result = this.getProperty("aof-backup-enabled") }
137119

120+
/** Returns the 'aof-backup-enabled' property as a string, if present. */
138121
string aofBackupEnabled() { result = this.getAofBackupEnabled().getValue() }
139122

123+
/** Returns the 'aof-storage-connection-string-0' property as a StringLiteral, if present. */
140124
StringLiteral getAofStorageConnectionString0() {
141125
result = this.getProperty("aof-storage-connection-string-0")
142126
}
143127

128+
/** Returns the 'aof-storage-connection-string-0' property as a string, if present. */
144129
string aofStorageConnectionString0() {
145130
result = this.getAofStorageConnectionString0().getValue()
146131
}
147132

133+
/** Returns the 'aof-storage-connection-string-1' property as a StringLiteral, if present. */
148134
StringLiteral getAofStorageConnectionString1() {
149135
result = this.getProperty("aof-storage-connection-string-1")
150136
}
151137

138+
/** Returns the 'aof-storage-connection-string-1' property as a string, if present. */
152139
string aofStorageConnectionString1() {
153140
result = this.getAofStorageConnectionString1().getValue()
154141
}
155142

143+
/** Returns the 'authnotrequired' property as a StringLiteral, if present. */
156144
StringLiteral getAuthNotRequired() { result = this.getProperty("authnotrequired") }
157145

146+
/** Returns the 'authnotrequired' property as a string, if present. */
158147
string authNotRequired() { result = this.getAuthNotRequired().getValue() }
159148

149+
/** Returns the 'maxfragmentationmemory-reserved' property as a StringLiteral, if present. */
160150
StringLiteral getMaxFragmentationMemoryReserved() {
161151
result = this.getProperty("maxfragmentationmemory-reserved")
162152
}
163153

154+
/** Returns the 'maxfragmentationmemory-reserved' property as a string, if present. */
164155
string maxFragmentationMemoryReserved() {
165156
result = this.getMaxFragmentationMemoryReserved().getValue()
166157
}
167158

159+
/** Returns the 'maxmemory-delta' property as a StringLiteral, if present. */
168160
StringLiteral getMaxMemoryDelta() { result = this.getProperty("maxmemory-delta") }
169161

162+
/** Returns the 'maxmemory-delta' property as a string, if present. */
170163
string maxMemoryDelta() { result = this.getMaxMemoryDelta().getValue() }
171164

165+
/** Returns the 'maxmemory-policy' property as a StringLiteral, if present. */
172166
StringLiteral getMaxMemoryPolicy() { result = this.getProperty("maxmemory-policy") }
173167

168+
/** Returns the 'maxmemory-policy' property as a string, if present. */
174169
string maxMemoryPolicy() { result = this.getMaxMemoryPolicy().getValue() }
175170

171+
/** Returns the 'maxmemory-reserved' property as a StringLiteral, if present. */
176172
StringLiteral getMaxMemoryReserved() { result = this.getProperty("maxmemory-reserved") }
177173

174+
/** Returns the 'maxmemory-reserved' property as a string, if present. */
178175
string maxMemoryReserved() { result = this.getMaxMemoryReserved().getValue() }
179176

177+
/** Returns the 'notify-keyspace-events' property as a StringLiteral, if present. */
180178
StringLiteral getNotifyKeyspaceEvents() {
181179
result = this.getProperty("notify-keyspace-events")
182180
}
183181

182+
/** Returns the 'notify-keyspace-events' property as a string, if present. */
184183
string notifyKeyspaceEvents() { result = this.getNotifyKeyspaceEvents().getValue() }
185184

185+
/** Returns the 'preferred-data-persistence-auth-method' property as a StringLiteral, if present. */
186186
StringLiteral getPreferredDataPersistenceAuthMethod() {
187187
result = this.getProperty("preferred-data-persistence-auth-method")
188188
}
189189

190+
/** Returns the 'preferred-data-persistence-auth-method' property as a string, if present. */
190191
string preferredDataPersistenceAuthMethod() {
191192
result = this.getPreferredDataPersistenceAuthMethod().getValue()
192193
}
193194

195+
/** Returns the 'rdb-backup-enabled' property as a StringLiteral, if present. */
194196
StringLiteral getRdbBackupEnabled() { result = this.getProperty("rdb-backup-enabled") }
195197

198+
/** Returns the 'rdb-backup-enabled' property as a string, if present. */
196199
string rdbBackupEnabled() { result = this.getRdbBackupEnabled().getValue() }
197200

201+
/** Returns the 'rdb-backup-frequency' property as a StringLiteral, if present. */
198202
StringLiteral getRdbBackupFrequency() { result = this.getProperty("rdb-backup-frequency") }
199203

204+
/** Returns the 'rdb-backup-frequency' property as a string, if present. */
200205
string rdbBackupFrequency() { result = this.getRdbBackupFrequency().getValue() }
201206

207+
/** Returns the 'rdb-backup-max-snapshot-count' property as a StringLiteral, if present. */
202208
StringLiteral getRdbBackupMaxSnapshotCount() {
203209
result = this.getProperty("rdb-backup-max-snapshot-count")
204210
}
205211

212+
/** Returns the 'rdb-backup-max-snapshot-count' property as a string, if present. */
206213
string rdbBackupMaxSnapshotCount() { result = this.getRdbBackupMaxSnapshotCount().getValue() }
207214

215+
/** Returns the 'rdb-storage-connection-string' property as a StringLiteral, if present. */
208216
StringLiteral getRdbStorageConnectionString() {
209217
result = this.getProperty("rdb-storage-connection-string")
210218
}
211219

220+
/** Returns the 'rdb-storage-connection-string' property as a string, if present. */
212221
string rdbStorageConnectionString() {
213222
result = this.getRdbStorageConnectionString().getValue()
214223
}
215224

225+
/** Returns the 'storage-subscription-id' property as a StringLiteral, if present. */
216226
StringLiteral getStorageSubscriptionId() {
217227
result = this.getProperty("storage-subscription-id")
218228
}
219229

230+
/** Returns the 'storage-subscription-id' property as a string, if present. */
220231
string storageSubscriptionId() { result = this.getStorageSubscriptionId().getValue() }
221232

233+
/**
234+
* Returns a string representation of the RedisConfiguration object.
235+
*/
222236
string toString() { result = "RedisConfiguration" }
223237
}
224238
}

0 commit comments

Comments
 (0)