Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Modules] Updated DeploymentExamples title & moved Bicep in front of JSON #1632

Merged
merged 47 commits into from
Jul 15, 2022
Merged
Show file tree
Hide file tree
Changes from 45 commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
8542358
Updated Readme Deployment Example Title + Bicep/JSON order
AlexanderSehr Jul 1, 2022
a0439d9
Minor fix
AlexanderSehr Jul 1, 2022
b1c8c19
Minor fix
AlexanderSehr Jul 1, 2022
0770df3
Updated exceptions
AlexanderSehr Jul 4, 2022
8d94ace
Added ordering to ReadMe generation script
AlexanderSehr Jul 5, 2022
270f00b
Small fix
AlexanderSehr Jul 5, 2022
37311ba
Updated a subset of readmes
AlexanderSehr Jul 5, 2022
438205f
Updated ordering functino with null handling
AlexanderSehr Jul 5, 2022
58817ab
Handle empty parameters
AlexanderSehr Jul 5, 2022
79b97c5
Generated more readmes
AlexanderSehr Jul 5, 2022
b6c36e8
Resolved conflict
AlexanderSehr Jul 5, 2022
7d513b3
Added sorting for JSON example
AlexanderSehr Jul 5, 2022
85638e1
Updated docs
AlexanderSehr Jul 5, 2022
97bc4d4
Merged latest main
AlexanderSehr Jul 5, 2022
d57fd28
Merged latest main
AlexanderSehr Jul 7, 2022
f92f761
Added disclaimer to the deployment examples
AlexanderSehr Jul 7, 2022
dbb511a
latest draft
AlexanderSehr Jul 7, 2022
54b55b8
Updated set readme script with comments
AlexanderSehr Jul 8, 2022
e418814
Updated additional readme
AlexanderSehr Jul 8, 2022
9b9ce78
Robustness update
AlexanderSehr Jul 8, 2022
4cee1f4
Updated readmes
AlexanderSehr Jul 8, 2022
7d03399
Updated APIs
AlexanderSehr Jul 8, 2022
e3f51ba
Fixed readme
AlexanderSehr Jul 8, 2022
3a7da54
Fixed readme
AlexanderSehr Jul 8, 2022
0291fe6
Fixed required end search
AlexanderSehr Jul 8, 2022
52318b1
Added special case handling for bicep single line param
AlexanderSehr Jul 8, 2022
620561d
Restructured commenting
AlexanderSehr Jul 8, 2022
4498cbc
Improved regex
AlexanderSehr Jul 8, 2022
f43990e
Further updates
AlexanderSehr Jul 8, 2022
1990908
Updated readmes
AlexanderSehr Jul 8, 2022
a1488e6
Small fix
AlexanderSehr Jul 8, 2022
50e3fd1
Small fix
AlexanderSehr Jul 8, 2022
dcea49b
Regenerated docs
AlexanderSehr Jul 8, 2022
695f24f
Update utilities/tools/Set-ModuleReadMe.ps1
AlexanderSehr Jul 8, 2022
68fd914
Resolved conflicts
AlexanderSehr Jul 8, 2022
383c986
Merge branch 'users/alsehr/readMeTitleUpdate' of https://github.com/A…
AlexanderSehr Jul 8, 2022
d892bb0
Updated deployment examples disclaimer
AlexanderSehr Jul 8, 2022
a5ac48d
Update utilities/tools/Set-ModuleReadMe.ps1
AlexanderSehr Jul 10, 2022
3093027
Update utilities/tools/Set-ModuleReadMe.ps1
AlexanderSehr Jul 10, 2022
995954c
Merged latest main
AlexanderSehr Jul 10, 2022
669aae9
Merge branch 'users/alsehr/readMeTitleUpdate' of https://github.com/A…
AlexanderSehr Jul 10, 2022
3f008e5
Merge branch 'main' into users/alsehr/readMeTitleUpdate
AlexanderSehr Jul 13, 2022
61b5f3c
Merge branch 'main' into users/alsehr/readMeTitleUpdate
AlexanderSehr Jul 14, 2022
a0574ed
Merged main & updated readme
AlexanderSehr Jul 14, 2022
0ae1632
Merged latest main
AlexanderSehr Jul 15, 2022
3702deb
Update bicepconfig.json
AlexanderSehr Jul 15, 2022
64946ba
Change rollback
AlexanderSehr Jul 15, 2022
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
3 changes: 3 additions & 0 deletions bicepconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
"rules": {
"explicit-values-for-loc-params": {
"level": "off" // Reason: Our modules default to e.g. the location of their parent resource group which is sufficient if deploying a self-contained solution
},
"prefer-unquoted-property-names": {
"level": "off" // Reason: This is complains primarily about RBAC roles which are all in quotes to be consistent within the list of roles with and without spaces in their name
AlexanderSehr marked this conversation as resolved.
Show resolved Hide resolved
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion modules/Microsoft.AAD/DomainServices/deploy.bicep
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ param additionalRecipients array = []
])
param domainConfigurationType string = 'FullySynced'

@description('Optional. The value is to synchronise scoped users and groups.')
@description('Optional. The value is to synchronize scoped users and groups.')
param filteredSync string = 'Enabled'

@description('Optional. The value is to enable clients making request using TLSv1.')
Expand Down
161 changes: 85 additions & 76 deletions modules/Microsoft.AAD/DomainServices/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ This template deploys Azure Active Directory Domain Services (AADDS).
| `domainConfigurationType` | string | `'FullySynced'` | `[FullySynced, ResourceTrusting]` | The value is to provide domain configuration type. |
| `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). |
| `externalAccess` | string | `'Enabled'` | `[Enabled, Disabled]` | The value is to enable the Secure LDAP for external services of Azure ADDS Services. |
| `filteredSync` | string | `'Enabled'` | | The value is to synchronise scoped users and groups. |
| `filteredSync` | string | `'Enabled'` | | The value is to synchronize scoped users and groups. |
| `kerberosArmoring` | string | `'Enabled'` | `[Enabled, Disabled]` | The value is to enable to provide a protected channel between the Kerberos client and the KDC. |
| `kerberosRc4Encryption` | string | `'Enabled'` | `[Enabled, Disabled]` | The value is to enable Kerberos requests that use RC4 encryption. |
| `ldaps` | string | `'Enabled'` | `[Enabled, Disabled]` | A flag to determine whether or not Secure LDAP is enabled or disabled. |
Expand Down Expand Up @@ -207,72 +207,11 @@ $pfxCertificate = [System.Convert]::ToBase64String($rawCertByteStream)

## Deployment examples

<h3>Example 1</h3>
The following module usage examples are retrieved from the content of the files hosted in the module's `.test` folder.
>**Note**: The name of each example is based on the name of the file from which it is taken.
>**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.

<details>

<summary>via JSON Parameter file</summary>

```json
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"domainName": {
"value": "<<namePrefix>>.onmicrosoft.com"
},
"sku": {
"value": "Standard"
},
"lock": {
"value": "CanNotDelete"
},
"replicaSets": {
"value": [
{
"location": "WestEurope",
"subnetId": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/adp-<<namePrefix>>-az-vnet-aadds-001/subnets/AADDSSubnet"
}
]
},
"pfxCertificate": {
"reference": {
"keyVault": {
"id": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.KeyVault/vaults/adp-<<namePrefix>>-az-kv-x-001"
},
"secretName": "pfxBase64Certificate"
}
},
"pfxCertificatePassword": {
"reference": {
"keyVault": {
"id": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.KeyVault/vaults/adp-<<namePrefix>>-az-kv-x-001"
},
"secretName": "pfxCertificatePassword"
}
},
"additionalRecipients": {
"value": [
"<<namePrefix>>@noreply.github.com"
]
},
"diagnosticWorkspaceId": {
"value": "/subscriptions/<<subscriptionId>>/resourcegroups/validation-rg/providers/microsoft.operationalinsights/workspaces/adp-<<namePrefix>>-az-law-x-001"
},
"diagnosticStorageAccountId": {
"value": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Storage/storageAccounts/adp<<namePrefix>>azsax001"
},
"diagnosticEventHubAuthorizationRuleId": {
"value": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.EventHub/namespaces/adp-<<namePrefix>>-az-evhns-x-001/AuthorizationRules/RootManageSharedAccessKey"
},
"diagnosticEventHubName": {
"value": "adp-<<namePrefix>>-az-evh-x-001"
}
}
}
```

</details>
<h3>Example 1: Parameters</h3>

<details>

Expand All @@ -287,24 +226,94 @@ resource kv1 'Microsoft.KeyVault/vaults@2019-09-01' existing = {
module DomainServices './Microsoft.AAD/DomainServices/deploy.bicep' = {
name: '${uniqueString(deployment().name)}-DomainServices'
params: {
// Required parameters
domainName: '<<namePrefix>>.onmicrosoft.com'
AlexanderSehr marked this conversation as resolved.
Show resolved Hide resolved
sku: 'Standard'
// Non-required parameters
additionalRecipients: [
'<<namePrefix>>@noreply.github.com'
]
diagnosticEventHubAuthorizationRuleId: '/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.EventHub/namespaces/adp-<<namePrefix>>-az-evhns-x-001/AuthorizationRules/RootManageSharedAccessKey'
diagnosticEventHubName: 'adp-<<namePrefix>>-az-evh-x-001'
diagnosticStorageAccountId: '/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Storage/storageAccounts/adp<<namePrefix>>azsax001'
diagnosticWorkspaceId: '/subscriptions/<<subscriptionId>>/resourcegroups/validation-rg/providers/microsoft.operationalinsights/workspaces/adp-<<namePrefix>>-az-law-x-001'
lock: 'CanNotDelete'
pfxCertificate: kv1.getSecret('pfxBase64Certificate')
pfxCertificatePassword: kv1.getSecret('pfxCertificatePassword')
replicaSets: [
{
location: 'WestEurope'
subnetId: '/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/adp-<<namePrefix>>-az-vnet-aadds-001/subnets/AADDSSubnet'
}
]
pfxCertificate: kv1.getSecret('pfxBase64Certificate')
pfxCertificatePassword: kv1.getSecret('pfxCertificatePassword')
additionalRecipients: [
'<<namePrefix>>@noreply.github.com'
]
diagnosticWorkspaceId: '/subscriptions/<<subscriptionId>>/resourcegroups/validation-rg/providers/microsoft.operationalinsights/workspaces/adp-<<namePrefix>>-az-law-x-001'
diagnosticStorageAccountId: '/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Storage/storageAccounts/adp<<namePrefix>>azsax001'
diagnosticEventHubAuthorizationRuleId: '/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.EventHub/namespaces/adp-<<namePrefix>>-az-evhns-x-001/AuthorizationRules/RootManageSharedAccessKey'
diagnosticEventHubName: 'adp-<<namePrefix>>-az-evh-x-001'
sku: 'Standard'
}
}
```

</details>
<p>

<details>

<summary>via JSON Parameter file</summary>

```json
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
"contentVersion": "1.0.0.0",
"parameters": {
// Required parameters
"domainName": {
"value": "<<namePrefix>>.onmicrosoft.com"
},
// Non-required parameters
"additionalRecipients": {
"value": [
"<<namePrefix>>@noreply.github.com"
]
},
"diagnosticEventHubAuthorizationRuleId": {
"value": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.EventHub/namespaces/adp-<<namePrefix>>-az-evhns-x-001/AuthorizationRules/RootManageSharedAccessKey"
},
"diagnosticEventHubName": {
"value": "adp-<<namePrefix>>-az-evh-x-001"
},
"diagnosticStorageAccountId": {
"value": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Storage/storageAccounts/adp<<namePrefix>>azsax001"
},
"diagnosticWorkspaceId": {
"value": "/subscriptions/<<subscriptionId>>/resourcegroups/validation-rg/providers/microsoft.operationalinsights/workspaces/adp-<<namePrefix>>-az-law-x-001"
},
"lock": {
"value": "CanNotDelete"
},
"pfxCertificate": {
"reference": {
"keyVault": {
"id": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.KeyVault/vaults/adp-<<namePrefix>>-az-kv-x-001"
},
"secretName": "pfxBase64Certificate"
}
},
"pfxCertificatePassword": {
"reference": {
"keyVault": {
"id": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.KeyVault/vaults/adp-<<namePrefix>>-az-kv-x-001"
},
"secretName": "pfxCertificatePassword"
}
},
"replicaSets": {
"value": [
{
"location": "WestEurope",
"subnetId": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/adp-<<namePrefix>>-az-vnet-aadds-001/subnets/AADDSSubnet"
}
]
},
"sku": {
"value": "Standard"
}
}
}
```
Expand Down
Loading