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] Rename common test to max #4190

Merged
merged 3 commits into from
Nov 4, 2023
Merged
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 3 additions & 3 deletions modules/aad/domain-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ This instance deploys the module with most of its features enabled.

```bicep
module domainService 'br:bicep/modules/aad.domain-service:1.0.0' = {
name: '${uniqueString(deployment().name, location)}-test-aaddscom'
name: '${uniqueString(deployment().name, location)}-test-aaddsmax'
params: {
// Required parameters
domainName: 'onmicrosoft.com'
Expand All @@ -63,7 +63,7 @@ module domainService 'br:bicep/modules/aad.domain-service:1.0.0' = {
kind: 'CanNotDelete'
name: 'myCustomLockName'
}
name: 'aaddscom001'
name: 'aaddsmax001'
pfxCertificate: '<pfxCertificate>'
pfxCertificatePassword: '<pfxCertificatePassword>'
replicaSets: [
Expand Down Expand Up @@ -125,7 +125,7 @@ module domainService 'br:bicep/modules/aad.domain-service:1.0.0' = {
}
},
"name": {
"value": "aaddscom001"
"value": "aaddsmax001"
},
"pfxCertificate": {
"value": "<pfxCertificate>"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ param resourceGroupName string = 'dep-${namePrefix}-aad.domainservices-${service
param location string = deployment().location

@description('Optional. A short identifier for the kind of deployment. Should be kept short to not run into resource-name length-constraints.')
param serviceShort string = 'aaddscom'
param serviceShort string = 'aaddsmax'

@description('Optional. Enable telemetry via a Globally Unique Identifier (GUID).')
param enableDefaultTelemetry bool = true
Expand Down
108 changes: 54 additions & 54 deletions modules/analysis-services/server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,58 @@ The following section provides usage examples for the module, which were used to

>**Note**: To reference the module, please use the following syntax `br:bicep/modules/analysis-services.server:1.0.0`.

- [Using large parameter set](#example-1-using-large-parameter-set)
- [Using only defaults](#example-2-using-only-defaults)
- [Using only defaults](#example-1-using-only-defaults)
- [Using large parameter set](#example-2-using-large-parameter-set)

### Example 1: _Using large parameter set_
### Example 1: _Using only defaults_

This instance deploys the module with the minimum set of required parameters.


<details>

<summary>via Bicep module</summary>

```bicep
module server 'br:bicep/modules/analysis-services.server:1.0.0' = {
name: '${uniqueString(deployment().name, location)}-test-assmin'
params: {
// Required parameters
name: 'assmin'
// Non-required parameters
enableDefaultTelemetry: '<enableDefaultTelemetry>'
}
}
```

</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
"name": {
"value": "assmin"
},
// Non-required parameters
"enableDefaultTelemetry": {
"value": "<enableDefaultTelemetry>"
}
}
}
```

</details>
<p>

### Example 2: _Using large parameter set_

This instance deploys the module with most of its features enabled.

Expand All @@ -41,10 +89,10 @@ This instance deploys the module with most of its features enabled.

```bicep
module server 'br:bicep/modules/analysis-services.server:1.0.0' = {
name: '${uniqueString(deployment().name, location)}-test-asscom'
name: '${uniqueString(deployment().name, location)}-test-assmax'
params: {
// Required parameters
name: 'asscom'
name: 'assmax'
// Non-required parameters
diagnosticSettings: [
{
Expand Down Expand Up @@ -115,7 +163,7 @@ module server 'br:bicep/modules/analysis-services.server:1.0.0' = {
"parameters": {
// Required parameters
"name": {
"value": "asscom"
"value": "assmax"
},
// Non-required parameters
"diagnosticSettings": {
Expand Down Expand Up @@ -192,54 +240,6 @@ module server 'br:bicep/modules/analysis-services.server:1.0.0' = {
</details>
<p>

### Example 2: _Using only defaults_

This instance deploys the module with the minimum set of required parameters.


<details>

<summary>via Bicep module</summary>

```bicep
module server 'br:bicep/modules/analysis-services.server:1.0.0' = {
name: '${uniqueString(deployment().name, location)}-test-assmin'
params: {
// Required parameters
name: 'assmin'
// Non-required parameters
enableDefaultTelemetry: '<enableDefaultTelemetry>'
}
}
```

</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
"name": {
"value": "assmin"
},
// Non-required parameters
"enableDefaultTelemetry": {
"value": "<enableDefaultTelemetry>"
}
}
}
```

</details>
<p>


## Parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ param resourceGroupName string = 'dep-${namePrefix}-analysisservices.servers-${s
param location string = deployment().location

@description('Optional. A short identifier for the kind of deployment. Should be kept short to not run into resource-name length-constraints.')
param serviceShort string = 'asscom'
param serviceShort string = 'assmax'

@description('Optional. Enable telemetry via a Globally Unique Identifier (GUID).')
param enableDefaultTelemetry bool = true
Expand Down
124 changes: 62 additions & 62 deletions modules/api-management/service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,66 @@ The following section provides usage examples for the module, which were used to

>**Note**: To reference the module, please use the following syntax `br:bicep/modules/api-management.service:1.0.0`.

- [Using large parameter set](#example-1-using-large-parameter-set)
- [Using only defaults](#example-2-using-only-defaults)
- [Using only defaults](#example-1-using-only-defaults)
- [Using large parameter set](#example-2-using-large-parameter-set)

### Example 1: _Using large parameter set_
### Example 1: _Using only defaults_

This instance deploys the module with the minimum set of required parameters.


<details>

<summary>via Bicep module</summary>

```bicep
module service 'br:bicep/modules/api-management.service:1.0.0' = {
name: '${uniqueString(deployment().name, location)}-test-apismin'
params: {
// Required parameters
name: 'apismin001'
publisherEmail: 'apimgmt-noreply@mail.windowsazure.com'
publisherName: 'az-amorg-x-001'
// Non-required parameters
enableDefaultTelemetry: '<enableDefaultTelemetry>'
}
}
```

</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
"name": {
"value": "apismin001"
},
"publisherEmail": {
"value": "apimgmt-noreply@mail.windowsazure.com"
},
"publisherName": {
"value": "az-amorg-x-001"
},
// Non-required parameters
"enableDefaultTelemetry": {
"value": "<enableDefaultTelemetry>"
}
}
}
```

</details>
<p>

### Example 2: _Using large parameter set_

This instance deploys the module with most of its features enabled.

Expand All @@ -56,10 +112,10 @@ This instance deploys the module with most of its features enabled.

```bicep
module service 'br:bicep/modules/api-management.service:1.0.0' = {
name: '${uniqueString(deployment().name, location)}-test-apiscom'
name: '${uniqueString(deployment().name, location)}-test-apismax'
params: {
// Required parameters
name: 'apiscom001'
name: 'apismax001'
publisherEmail: 'apimgmt-noreply@mail.windowsazure.com'
publisherName: 'az-amorg-x-001'
// Non-required parameters
Expand Down Expand Up @@ -224,7 +280,7 @@ module service 'br:bicep/modules/api-management.service:1.0.0' = {
"parameters": {
// Required parameters
"name": {
"value": "apiscom001"
"value": "apismax001"
},
"publisherEmail": {
"value": "apimgmt-noreply@mail.windowsazure.com"
Expand Down Expand Up @@ -415,62 +471,6 @@ module service 'br:bicep/modules/api-management.service:1.0.0' = {
</details>
<p>

### Example 2: _Using only defaults_

This instance deploys the module with the minimum set of required parameters.


<details>

<summary>via Bicep module</summary>

```bicep
module service 'br:bicep/modules/api-management.service:1.0.0' = {
name: '${uniqueString(deployment().name, location)}-test-apismin'
params: {
// Required parameters
name: 'apismin001'
publisherEmail: 'apimgmt-noreply@mail.windowsazure.com'
publisherName: 'az-amorg-x-001'
// Non-required parameters
enableDefaultTelemetry: '<enableDefaultTelemetry>'
}
}
```

</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
"name": {
"value": "apismin001"
},
"publisherEmail": {
"value": "apimgmt-noreply@mail.windowsazure.com"
},
"publisherName": {
"value": "az-amorg-x-001"
},
// Non-required parameters
"enableDefaultTelemetry": {
"value": "<enableDefaultTelemetry>"
}
}
}
```

</details>
<p>


## Parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ param resourceGroupName string = 'dep-${namePrefix}-apimanagement.service-${serv
param location string = deployment().location

@description('Optional. A short identifier for the kind of deployment. Should be kept short to not run into resource-name length-constraints.')
param serviceShort string = 'apiscom'
param serviceShort string = 'apismax'

@description('Optional. Enable telemetry via a Globally Unique Identifier (GUID).')
param enableDefaultTelemetry bool = true
Expand Down
Loading
Loading