Skip to content

Commit a561e0e

Browse files
feat: Service-Fabric-Cluster - Updated UDTs to pending specs (#4104)
## Description Updated user-defined types with pending Azure/Azure-Verified-Modules#1738 & #4098. ## Pipeline Reference <!-- Insert your Pipeline Status Badge below --> | Pipeline | | -------- | [![avm.res.service-fabric.cluster](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.service-fabric.cluster.yml/badge.svg?branch=users%2Falsehr%2Favm.res.service-fabric.cluster_udt&event=workflow_dispatch)](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.service-fabric.cluster.yml) ## Type of Change <!-- Use the checkboxes [x] on the options that are relevant. --> - [ ] Update to CI Environment or utilities (Non-module affecting changes) - [x] Azure Verified Module updates: - [ ] Bugfix containing backwards-compatible bug fixes, and I have NOT bumped the MAJOR or MINOR version in `version.json`: - [ ] Someone has opened a bug report issue, and I have included "Closes #{bug_report_issue_number}" in the PR description. - [ ] The bug was found by the module author, and no one has opened an issue to report it yet. - [ ] Feature update backwards compatible feature updates, and I have bumped the MINOR version in `version.json`. - [ ] Breaking changes and I have bumped the MAJOR version in `version.json`. - [ ] Update to documentation
1 parent 5379df8 commit a561e0e

File tree

6 files changed

+190
-193
lines changed

6 files changed

+190
-193
lines changed

avm/res/service-fabric/cluster/README.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This module deploys a Service Fabric Cluster.
88
- [Usage examples](#Usage-examples)
99
- [Parameters](#Parameters)
1010
- [Outputs](#Outputs)
11+
- [Cross-referenced modules](#Cross-referenced-modules)
1112
- [Data Collection](#Data-Collection)
1213

1314
## Resource Types
@@ -82,7 +83,6 @@ module cluster 'br/public:avm/res/service-fabric/cluster:<version>' = {
8283
isAdmin: true
8384
}
8485
]
85-
location: '<location>'
8686
}
8787
}
8888
```
@@ -147,9 +147,6 @@ module cluster 'br/public:avm/res/service-fabric/cluster:<version>' = {
147147
"isAdmin": true
148148
}
149149
]
150-
},
151-
"location": {
152-
"value": "<location>"
153150
}
154151
}
155152
}
@@ -202,7 +199,6 @@ param clientCertificateThumbprints = [
202199
isAdmin: true
203200
}
204201
]
205-
param location = '<location>'
206202
```
207203

208204
</details>
@@ -246,7 +242,6 @@ module cluster 'br/public:avm/res/service-fabric/cluster:<version>' = {
246242
certificate: {
247243
thumbprint: '0AC113D5E1D94C401DDEB0EE2B1B96CC130'
248244
}
249-
location: '<location>'
250245
}
251246
}
252247
```
@@ -297,9 +292,6 @@ module cluster 'br/public:avm/res/service-fabric/cluster:<version>' = {
297292
"value": {
298293
"thumbprint": "0AC113D5E1D94C401DDEB0EE2B1B96CC130"
299294
}
300-
},
301-
"location": {
302-
"value": "<location>"
303295
}
304296
}
305297
}
@@ -340,7 +332,6 @@ param reliabilityLevel = 'None'
340332
param certificate = {
341333
thumbprint: '0AC113D5E1D94C401DDEB0EE2B1B96CC130'
342334
}
343-
param location = '<location>'
344335
```
345336

346337
</details>
@@ -1060,7 +1051,6 @@ module cluster 'br/public:avm/res/service-fabric/cluster:<version>' = {
10601051
]
10611052
}
10621053
]
1063-
location: '<location>'
10641054
maxUnusedVersionsToKeep: 2
10651055
notifications: [
10661056
{
@@ -1241,9 +1231,6 @@ module cluster 'br/public:avm/res/service-fabric/cluster:<version>' = {
12411231
}
12421232
]
12431233
},
1244-
"location": {
1245-
"value": "<location>"
1246-
},
12471234
"maxUnusedVersionsToKeep": {
12481235
"value": 2
12491236
},
@@ -1410,7 +1397,6 @@ param fabricSettings = [
14101397
]
14111398
}
14121399
]
1413-
param location = '<location>'
14141400
param maxUnusedVersionsToKeep = 2
14151401
param notifications = [
14161402
{
@@ -2104,6 +2090,14 @@ Boolean to pause automatic runtime version upgrades to the cluster.
21042090
| `resourceGroupName` | string | The Service Fabric Cluster resource group. |
21052091
| `resourceId` | string | The Service Fabric Cluster resource ID. |
21062092

2093+
## Cross-referenced modules
2094+
2095+
This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).
2096+
2097+
| Reference | Type |
2098+
| :-- | :-- |
2099+
| `br/public:avm/utl/types/avm-common-types:0.5.1` | Remote reference |
2100+
21072101
## Data Collection
21082102

21092103
The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the [repository](https://aka.ms/avm/telemetry). There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at <https://go.microsoft.com/fwlink/?LinkID=824704>. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.

avm/res/service-fabric/cluster/main.bicep

Lines changed: 22 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ param location string = resourceGroup().location
1111
@description('Optional. Tags of the resource.')
1212
param tags object?
1313

14+
import { lockType } from 'br/public:avm/utl/types/avm-common-types:0.5.1'
1415
@description('Optional. The lock settings of the service.')
15-
param lock lockType
16+
param lock lockType?
1617

1718
@allowed([
1819
'BackupRestoreService'
@@ -30,16 +31,16 @@ param maxUnusedVersionsToKeep int = 3
3031
param azureActiveDirectory object = {}
3132

3233
@description('Conditional. The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client. Required if the certificateCommonNames parameter is not used.')
33-
param certificate certificateType
34+
param certificate certificateType?
3435

3536
@description('Conditional. Describes a list of server certificates referenced by common name that are used to secure the cluster. Required if the certificate parameter is not used.')
36-
param certificateCommonNames certificateCommonNameType
37+
param certificateCommonNames certificateCommonNameType?
3738

3839
@description('Optional. The list of client certificates referenced by common name that are allowed to manage the cluster. Cannot be used if the clientCertificateThumbprints parameter is used.')
39-
param clientCertificateCommonNames clientCertificateCommonNameType
40+
param clientCertificateCommonNames clientCertificateCommonNameType[]?
4041

4142
@description('Optional. The list of client certificates referenced by thumbprint that are allowed to manage the cluster. Cannot be used if the clientCertificateCommonNames parameter is used.')
42-
param clientCertificateThumbprints clientCertificateThumbprintType
43+
param clientCertificateThumbprints clientCertificateThumbprintType[]?
4344

4445
@description('Optional. The Service Fabric runtime version of the cluster. This property can only by set the user when upgradeMode is set to "Manual". To get list of available Service Fabric versions for new clusters use ClusterVersion API. To get the list of available version for existing clusters use availableClusterVersions.')
4546
param clusterCodeVersion string?
@@ -125,8 +126,9 @@ param vmssZonalUpgradeMode string = 'Hierarchical'
125126
@description('Optional. Boolean to pause automatic runtime version upgrades to the cluster.')
126127
param waveUpgradePaused bool = false
127128

129+
import { roleAssignmentType } from 'br/public:avm/utl/types/avm-common-types:0.5.1'
128130
@description('Optional. Array of role assignments to create.')
129-
param roleAssignments roleAssignmentType
131+
param roleAssignments roleAssignmentType[]?
130132

131133
@description('Optional. Array of Service Fabric cluster application types.')
132134
param applicationTypes array = []
@@ -403,6 +405,8 @@ output location string = serviceFabricCluster.location
403405
// Definitions //
404406
// =============== //
405407

408+
@export()
409+
@description('The type for a certificate.')
406410
type certificateType = {
407411
@description('Required. The thumbprint of the primary certificate.')
408412
thumbprint: string
@@ -420,11 +424,13 @@ type certificateType = {
420424
| 'Root'
421425
| 'TrustedPeople'
422426
| 'TrustedPublisher')?
423-
}?
427+
}
424428

429+
@export()
430+
@description('The type for a certificate common name.')
425431
type certificateCommonNameType = {
426432
@description('Required. The list of server certificates referenced by common name that are used to secure the cluster.')
427-
commonNames: serverCertificateCommonNameType
433+
commonNames: serverCertificateCommonNameType[]
428434

429435
@description('Optional. The local certificate store location.')
430436
x509StoreName: (
@@ -436,16 +442,18 @@ type certificateCommonNameType = {
436442
| 'Root'
437443
| 'TrustedPeople'
438444
| 'TrustedPublisher')?
439-
}?
445+
}
440446

447+
@description('The type for a server certificate common name.')
441448
type serverCertificateCommonNameType = {
442449
@description('Required. The common name of the server certificate.')
443450
certificateCommonName: string
444451

445452
@description('Required. The issuer thumbprint of the server certificate.')
446453
certificateIssuerThumbprint: string
447-
}[]
454+
}
448455

456+
@description('The type for a client certificate common name.')
449457
type clientCertificateCommonNameType = {
450458
@description('Required. The common name of the client certificate.')
451459
certificateCommonName: string
@@ -455,46 +463,14 @@ type clientCertificateCommonNameType = {
455463

456464
@description('Required. Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster.')
457465
isAdmin: bool
458-
}[]?
466+
}
459467

468+
@export()
469+
@description('The type for a client certificate thumbprint.')
460470
type clientCertificateThumbprintType = {
461471
@description('Required. The thumbprint of the client certificate.')
462472
certificateThumbprint: string
463473

464474
@description('Required. Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster.')
465475
isAdmin: bool
466-
}[]?
467-
468-
type lockType = {
469-
@description('Optional. Specify the name of lock.')
470-
name: string?
471-
472-
@description('Optional. Specify the type of lock.')
473-
kind: ('CanNotDelete' | 'ReadOnly' | 'None')?
474-
}?
475-
476-
type roleAssignmentType = {
477-
@description('Optional. The name (as GUID) of the role assignment. If not provided, a GUID will be generated.')
478-
name: string?
479-
480-
@description('Required. The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: \'/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11\'.')
481-
roleDefinitionIdOrName: string
482-
483-
@description('Required. The principal ID of the principal (user/group/identity) to assign the role to.')
484-
principalId: string
485-
486-
@description('Optional. The principal type of the assigned principal ID.')
487-
principalType: ('ServicePrincipal' | 'Group' | 'User' | 'ForeignGroup' | 'Device')?
488-
489-
@description('Optional. The description of the role assignment.')
490-
description: string?
491-
492-
@description('Optional. The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container".')
493-
condition: string?
494-
495-
@description('Optional. Version of the condition.')
496-
conditionVersion: '2.0'?
497-
498-
@description('Optional. The Resource Id of the delegated managed identity resource.')
499-
delegatedManagedIdentityResourceId: string?
500-
}[]?
476+
}

0 commit comments

Comments
 (0)