-
Notifications
You must be signed in to change notification settings - Fork 517
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
26740 - Feature - Generated Parameter Markdowns for Orchestration (#466)
Co-authored-by: Jack Tracey <41163455+jtracey93@users.noreply.github.com>
- Loading branch information
Showing
16 changed files
with
779 additions
and
82 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
76 changes: 76 additions & 0 deletions
76
...a-as-code/bicep/CRML/containerRegistry/generateddocs/containerRegistry.bicep.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| # ALZ Bicep CRML - Container Registry Module | ||
|
|
||
| Module to create an Azure Container Registry to store private Bicep Modules | ||
|
|
||
| ## Parameters | ||
|
|
||
| Parameter name | Required | Description | ||
| -------------- | -------- | ----------- | ||
| parAcrName | No | Provide a globally unique name of your Azure Container Registry | ||
| parLocation | No | Provide a location for the registry. | ||
| parAcrSku | No | Provide a tier of your Azure Container Registry. | ||
| parTags | No | Tags to be applied to resource when deployed. Default: None | ||
|
|
||
| ### parAcrName | ||
|
|
||
|  | ||
|
|
||
| Provide a globally unique name of your Azure Container Registry | ||
|
|
||
| - Default value: `[format('acr{0}', uniqueString(resourceGroup().id))]` | ||
|
|
||
| ### parLocation | ||
|
|
||
|  | ||
|
|
||
| Provide a location for the registry. | ||
|
|
||
| - Default value: `[resourceGroup().location]` | ||
|
|
||
| ### parAcrSku | ||
|
|
||
|  | ||
|
|
||
| Provide a tier of your Azure Container Registry. | ||
|
|
||
| - Default value: `Basic` | ||
|
|
||
| ### parTags | ||
|
|
||
|  | ||
|
|
||
| Tags to be applied to resource when deployed. Default: None | ||
|
|
||
| ## Outputs | ||
|
|
||
| Name | Type | Description | ||
| ---- | ---- | ----------- | ||
| outLoginServer | string | Output the login server property for later use | ||
|
|
||
| ## Snippets | ||
|
|
||
| ### Parameter file | ||
|
|
||
| ```json | ||
| { | ||
| "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", | ||
| "contentVersion": "1.0.0.0", | ||
| "metadata": { | ||
| "template": "infra-as-code/bicep/CRML/containerRegistry/containerRegistry.json" | ||
| }, | ||
| "parameters": { | ||
| "parAcrName": { | ||
| "value": "[format('acr{0}', uniqueString(resourceGroup().id))]" | ||
| }, | ||
| "parLocation": { | ||
| "value": "[resourceGroup().location]" | ||
| }, | ||
| "parAcrSku": { | ||
| "value": "Basic" | ||
| }, | ||
| "parTags": { | ||
| "value": {} | ||
| } | ||
| } | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
16 changes: 16 additions & 0 deletions
16
...bicep/CRML/customerUsageAttribution/generateddocs/cuaIdManagementGroup.bicep.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Azure template | ||
|
|
||
| ## Snippets | ||
|
|
||
| ### Parameter file | ||
|
|
||
| ```json | ||
| { | ||
| "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", | ||
| "contentVersion": "1.0.0.0", | ||
| "metadata": { | ||
| "template": "infra-as-code/bicep/CRML/customerUsageAttribution/cuaIdManagementGroup.json" | ||
| }, | ||
| "parameters": {} | ||
| } | ||
| ``` |
16 changes: 16 additions & 0 deletions
16
...e/bicep/CRML/customerUsageAttribution/generateddocs/cuaIdResourceGroup.bicep.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Azure template | ||
|
|
||
| ## Snippets | ||
|
|
||
| ### Parameter file | ||
|
|
||
| ```json | ||
| { | ||
| "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", | ||
| "contentVersion": "1.0.0.0", | ||
| "metadata": { | ||
| "template": "infra-as-code/bicep/CRML/customerUsageAttribution/cuaIdResourceGroup.json" | ||
| }, | ||
| "parameters": {} | ||
| } | ||
| ``` |
16 changes: 16 additions & 0 deletions
16
...de/bicep/CRML/customerUsageAttribution/generateddocs/cuaIdSubscription.bicep.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Azure template | ||
|
|
||
| ## Snippets | ||
|
|
||
| ### Parameter file | ||
|
|
||
| ```json | ||
| { | ||
| "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", | ||
| "contentVersion": "1.0.0.0", | ||
| "metadata": { | ||
| "template": "infra-as-code/bicep/CRML/customerUsageAttribution/cuaIdSubscription.json" | ||
| }, | ||
| "parameters": {} | ||
| } | ||
| ``` |
16 changes: 16 additions & 0 deletions
16
...-as-code/bicep/CRML/customerUsageAttribution/generateddocs/cuaIdTenant.bicep.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Azure template | ||
|
|
||
| ## Snippets | ||
|
|
||
| ### Parameter file | ||
|
|
||
| ```json | ||
| { | ||
| "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", | ||
| "contentVersion": "1.0.0.0", | ||
| "metadata": { | ||
| "template": "infra-as-code/bicep/CRML/customerUsageAttribution/cuaIdTenant.json" | ||
| }, | ||
| "parameters": {} | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
107 changes: 107 additions & 0 deletions
107
...a-as-code/bicep/CRML/subscriptionAlias/generateddocs/subscriptionAlias.bicep.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| # ALZ Bicep CRML - Subscription Alias Module | ||
|
|
||
| Module to deploy an Azure Subscription into an existing billing scope that can be from an EA, MCA or MPA | ||
|
|
||
| ## Parameters | ||
|
|
||
| Parameter name | Required | Description | ||
| -------------- | -------- | ----------- | ||
| parSubscriptionName | Yes | Name of the subscription to be created. Will also be used as the alias name. Whilst you can use any name you like we recommend it to be: all lowercase, no spaces, alphanumeric and hyphens only. | ||
| parSubscriptionBillingScope | Yes | The full resource ID of billing scope associated to the EA, MCA or MPA account you wish to create the subscription in. | ||
| parTags | No | Tags you would like to be applied. | ||
| parManagementGroupId | No | The ID of the existing management group where the subscription will be placed. Also known as its parent management group. (Optional) | ||
| parSubscriptionOwnerId | No | The object ID of a responsible user, AAD group or service principal. (Optional) | ||
| parSubscriptionOfferType | No | The offer type of the EA, MCA or MPA subscription to be created. Defaults to = Production | ||
| parTenantId | No | The ID of the tenant. Defaults to = tenant().tenantId | ||
|
|
||
| ### parSubscriptionName | ||
|
|
||
|  | ||
|
|
||
| Name of the subscription to be created. Will also be used as the alias name. Whilst you can use any name you like we recommend it to be: all lowercase, no spaces, alphanumeric and hyphens only. | ||
|
|
||
| ### parSubscriptionBillingScope | ||
|
|
||
|  | ||
|
|
||
| The full resource ID of billing scope associated to the EA, MCA or MPA account you wish to create the subscription in. | ||
|
|
||
| ### parTags | ||
|
|
||
|  | ||
|
|
||
| Tags you would like to be applied. | ||
|
|
||
| ### parManagementGroupId | ||
|
|
||
|  | ||
|
|
||
| The ID of the existing management group where the subscription will be placed. Also known as its parent management group. (Optional) | ||
|
|
||
| ### parSubscriptionOwnerId | ||
|
|
||
|  | ||
|
|
||
| The object ID of a responsible user, AAD group or service principal. (Optional) | ||
|
|
||
| ### parSubscriptionOfferType | ||
|
|
||
|  | ||
|
|
||
| The offer type of the EA, MCA or MPA subscription to be created. Defaults to = Production | ||
|
|
||
| - Default value: `Production` | ||
|
|
||
| - Allowed values: `DevTest`, `Production` | ||
|
|
||
| ### parTenantId | ||
|
|
||
|  | ||
|
|
||
| The ID of the tenant. Defaults to = tenant().tenantId | ||
|
|
||
| - Default value: `[tenant().tenantId]` | ||
|
|
||
| ## Outputs | ||
|
|
||
| Name | Type | Description | ||
| ---- | ---- | ----------- | ||
| outSubscriptionName | string | | ||
| outSubscriptionId | string | | ||
|
|
||
| ## Snippets | ||
|
|
||
| ### Parameter file | ||
|
|
||
| ```json | ||
| { | ||
| "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", | ||
| "contentVersion": "1.0.0.0", | ||
| "metadata": { | ||
| "template": "infra-as-code/bicep/CRML/subscriptionAlias/subscriptionAlias.json" | ||
| }, | ||
| "parameters": { | ||
| "parSubscriptionName": { | ||
| "value": "" | ||
| }, | ||
| "parSubscriptionBillingScope": { | ||
| "value": "" | ||
| }, | ||
| "parTags": { | ||
| "value": {} | ||
| }, | ||
| "parManagementGroupId": { | ||
| "value": "" | ||
| }, | ||
| "parSubscriptionOwnerId": { | ||
| "value": "" | ||
| }, | ||
| "parSubscriptionOfferType": { | ||
| "value": "Production" | ||
| }, | ||
| "parTenantId": { | ||
| "value": "[tenant().tenantId]" | ||
| } | ||
| } | ||
| } | ||
| ``` |
Oops, something went wrong.