Skip to content
Open
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ To create a Microsoft.Addons/supportProviders/supportPlanTypes resource, add the
"name": "string"
}
```
## Usage Examples
## Property Values
### Microsoft.Addons/supportProviders/supportPlanTypes

Expand All @@ -74,7 +75,6 @@ To create a Microsoft.Addons/supportProviders/supportPlanTypes resource, add the
| name | The resource name | 'Advanced'<br />'Essential'<br />'Standard' (required) |
| type | The resource type | 'Microsoft.Addons/supportProviders/supportPlanTypes' |

## Usage Examples

::: zone-end

Expand Down

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -58,27 +58,6 @@ resource symbolicname 'Microsoft.Resources/resourceGroups@2024-07-01' = {
}
}
```
## Property Values
### Microsoft.Resources/resourceGroups

| Name | Description | Value |
| ---- | ----------- | ------------ |
| location | The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. | string (required) |
| managedBy | The ID of the resource that manages this resource group. | string |
| name | The resource name | string <br /><br />Constraints:<br />Min length = 1<br />Max length = 90<br />Pattern = `^[-\w\._\(\)]+$` (required) |
| properties | The resource group properties. | [ResourceGroupProperties](#resourcegroupproperties) |
| tags | Resource tags | Dictionary of tag names and values. See [Tags in templates](/azure/azure-resource-manager/management/tag-resources#arm-templates) |

### ResourceGroupProperties

| Name | Description | Value |
| ---- | ----------- | ------------ |

### ResourceGroupTags

| Name | Description | Value |
| ---- | ----------- | ------------ |

## Usage Examples
### Bicep Samples

Expand Down Expand Up @@ -118,6 +97,27 @@ The following [Azure Quickstart templates](https://aka.ms/azqst) contain Bicep s
> | [Create a subscription, resourceGroup and storageAccount](https://github.com/Azure/azure-quickstart-templates/tree/master/managementgroup-deployments/create-subscription-resourcegroup/main.bicep) | This template is a management group template that will create a subscription, a resourceGroup and a storageAccount in the same template. It can be used for an Enterprise Agreement billing mode only. The official documentation shows modifications needed for other types of accounts. |
> | [Create an Azure Virtual Network Manager and sample VNETs](https://github.com/Azure/azure-quickstart-templates/tree/master/subscription-deployments/microsoft.network/virtual-network-manager-connectivity/main.bicep) | This template deploys an Azure Virtual Network Manager and sample virtual networks into the named resource group. It supports multiple connectivity topologies and network group membership types. |

## Property Values
### Microsoft.Resources/resourceGroups

| Name | Description | Value |
| ---- | ----------- | ------------ |
| location | The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. | string (required) |
| managedBy | The ID of the resource that manages this resource group. | string |
| name | The resource name | string <br /><br />Constraints:<br />Min length = 1<br />Max length = 90<br />Pattern = `^[-\w\._\(\)]+$` (required) |
| properties | The resource group properties. | [ResourceGroupProperties](#resourcegroupproperties) |
| tags | Resource tags | Dictionary of tag names and values. See [Tags in templates](/azure/azure-resource-manager/management/tag-resources#arm-templates) |

### ResourceGroupProperties

| Name | Description | Value |
| ---- | ----------- | ------------ |

### ResourceGroupTags

| Name | Description | Value |
| ---- | ----------- | ------------ |


::: zone-end

Expand Down Expand Up @@ -149,6 +149,21 @@ To create a Microsoft.Resources/resourceGroups resource, add the following JSON
}
}
```
## Usage Examples
### Azure Quickstart Templates

The following [Azure Quickstart templates](https://aka.ms/azqst) deploy this resource type.

> [!div class="mx-tableFixed"]
> | Template | Description |
> | ----- | ----- |
> | [ Configure Deployment Environments service](https://github.com/Azure/azure-quickstart-templates/tree/master/quickstarts/microsoft.devcenter/deployment-environments)<br><br>[![Deploy to Azure](~/media/deploy-to-azure.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.devcenter%2Fdeployment-environments%2Fazuredeploy.json) | This template provides a way to configure Deployment Environments. |
> | [Create a new Datadog Organization](https://github.com/Azure/azure-quickstart-templates/tree/master/quickstarts/microsoft.datadog/datadog)<br><br>[![Deploy to Azure](~/media/deploy-to-azure.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.datadog%2Fdatadog%2Fazuredeploy.json) | This template creates a new Datadog - An Azure Native ISV Service resource and a Datadog organization to monitor resources in your subscription. |
> | [Create a resourceGroup](https://github.com/Azure/azure-quickstart-templates/tree/master/subscription-deployments/create-rg)<br><br>[![Deploy to Azure](~/media/deploy-to-azure.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fsubscription-deployments%2Fcreate-rg%2Fazuredeploy.json) | This template is a subscription level template that will create a resourceGroup. Currently, this template can be deployed via the Azure Portal. |
> | [Create a resourceGroup, apply a lock and RBAC](https://github.com/Azure/azure-quickstart-templates/tree/master/subscription-deployments/create-rg-lock-role-assignment)<br><br>[![Deploy to Azure](~/media/deploy-to-azure.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fsubscription-deployments%2Fcreate-rg-lock-role-assignment%2Fazuredeploy.json) | This template is a subscription level template that will create a resourceGroup, apply a lock the the resourceGroup and assign contributor permssions to the supplied principalId. Currently, this template cannot be deployed via the Azure Portal. |
> | [Create a subscription, resourceGroup and storageAccount](https://github.com/Azure/azure-quickstart-templates/tree/master/managementgroup-deployments/create-subscription-resourcegroup)<br><br>[![Deploy to Azure](~/media/deploy-to-azure.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fmanagementgroup-deployments%2Fcreate-subscription-resourcegroup%2Fazuredeploy.json) | This template is a management group template that will create a subscription, a resourceGroup and a storageAccount in the same template. It can be used for an Enterprise Agreement billing mode only. The official documentation shows modifications needed for other types of accounts. |
> | [Create an Azure Virtual Network Manager and sample VNETs](https://github.com/Azure/azure-quickstart-templates/tree/master/subscription-deployments/microsoft.network/virtual-network-manager-connectivity)<br><br>[![Deploy to Azure](~/media/deploy-to-azure.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fsubscription-deployments%2Fmicrosoft.network%2Fvirtual-network-manager-connectivity%2Fazuredeploy.json) | This template deploys an Azure Virtual Network Manager and sample virtual networks into the named resource group. It supports multiple connectivity topologies and network group membership types. |

## Property Values
### Microsoft.Resources/resourceGroups

Expand All @@ -172,21 +187,6 @@ To create a Microsoft.Resources/resourceGroups resource, add the following JSON
| Name | Description | Value |
| ---- | ----------- | ------------ |

## Usage Examples
### Azure Quickstart Templates

The following [Azure Quickstart templates](https://aka.ms/azqst) deploy this resource type.

> [!div class="mx-tableFixed"]
> | Template | Description |
> | ----- | ----- |
> | [ Configure Deployment Environments service](https://github.com/Azure/azure-quickstart-templates/tree/master/quickstarts/microsoft.devcenter/deployment-environments)<br><br>[![Deploy to Azure](~/media/deploy-to-azure.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.devcenter%2Fdeployment-environments%2Fazuredeploy.json) | This template provides a way to configure Deployment Environments. |
> | [Create a new Datadog Organization](https://github.com/Azure/azure-quickstart-templates/tree/master/quickstarts/microsoft.datadog/datadog)<br><br>[![Deploy to Azure](~/media/deploy-to-azure.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.datadog%2Fdatadog%2Fazuredeploy.json) | This template creates a new Datadog - An Azure Native ISV Service resource and a Datadog organization to monitor resources in your subscription. |
> | [Create a resourceGroup](https://github.com/Azure/azure-quickstart-templates/tree/master/subscription-deployments/create-rg)<br><br>[![Deploy to Azure](~/media/deploy-to-azure.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fsubscription-deployments%2Fcreate-rg%2Fazuredeploy.json) | This template is a subscription level template that will create a resourceGroup. Currently, this template can be deployed via the Azure Portal. |
> | [Create a resourceGroup, apply a lock and RBAC](https://github.com/Azure/azure-quickstart-templates/tree/master/subscription-deployments/create-rg-lock-role-assignment)<br><br>[![Deploy to Azure](~/media/deploy-to-azure.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fsubscription-deployments%2Fcreate-rg-lock-role-assignment%2Fazuredeploy.json) | This template is a subscription level template that will create a resourceGroup, apply a lock the the resourceGroup and assign contributor permssions to the supplied principalId. Currently, this template cannot be deployed via the Azure Portal. |
> | [Create a subscription, resourceGroup and storageAccount](https://github.com/Azure/azure-quickstart-templates/tree/master/managementgroup-deployments/create-subscription-resourcegroup)<br><br>[![Deploy to Azure](~/media/deploy-to-azure.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fmanagementgroup-deployments%2Fcreate-subscription-resourcegroup%2Fazuredeploy.json) | This template is a management group template that will create a subscription, a resourceGroup and a storageAccount in the same template. It can be used for an Enterprise Agreement billing mode only. The official documentation shows modifications needed for other types of accounts. |
> | [Create an Azure Virtual Network Manager and sample VNETs](https://github.com/Azure/azure-quickstart-templates/tree/master/subscription-deployments/microsoft.network/virtual-network-manager-connectivity)<br><br>[![Deploy to Azure](~/media/deploy-to-azure.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fsubscription-deployments%2Fmicrosoft.network%2Fvirtual-network-manager-connectivity%2Fazuredeploy.json) | This template deploys an Azure Virtual Network Manager and sample virtual networks into the named resource group. It supports multiple connectivity topologies and network group membership types. |


::: zone-end

Expand Down Expand Up @@ -220,6 +220,16 @@ resource "azapi_resource" "symbolicname" {
}
}
```
## Usage Examples
### Azure Verified Modules

The following [Azure Verified Modules](https://aka.ms/avm) can be used to deploy this resource type.

> [!div class="mx-tableFixed"]
> | Module | Description |
> | ----- | ----- |
> | [Resource Group](https://github.com/Azure/terraform-azurerm-avm-res-resources-resourcegroup) | AVM Resource Module for Resource Group |

## Property Values
### Microsoft.Resources/resourceGroups

Expand All @@ -242,15 +252,5 @@ resource "azapi_resource" "symbolicname" {
| Name | Description | Value |
| ---- | ----------- | ------------ |

## Usage Examples
### Azure Verified Modules

The following [Azure Verified Modules](https://aka.ms/avm) can be used to deploy this resource type.

> [!div class="mx-tableFixed"]
> | Module | Description |
> | ----- | ----- |
> | [Resource Group](https://github.com/Azure/terraform-azurerm-avm-res-resources-resourcegroup) | AVM Resource Module for Resource Group |


::: zone-end
24 changes: 12 additions & 12 deletions src/TemplateRefGenerator/Generators/MarkdownGenerator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -356,16 +356,16 @@ Set the **{discObjectType.Discriminator}** property to specify the type of objec
}
}

sb.Append(GenerateOptionalSection("Property Values", [
GetPropertyValues(resource, DeploymentType.Bicep, namedTypes, remarks, anchorIndex),
]));

sb.Append(GenerateOptionalSection("Usage Examples", [
GetBicepSamplesSection(remarksLoader, resource, remarks),
GetAvmSection(configLoader.GetSamples(), AvmLinkType.Bicep, resource),
GetBicepQuickstartsSection(configLoader.GetSamples(), resource),
]));

sb.Append(GenerateOptionalSection("Property Values", [
GetPropertyValues(resource, DeploymentType.Bicep, namedTypes, remarks, anchorIndex),
]));

sb.Append($"""

::: zone-end
Expand Down Expand Up @@ -485,14 +485,14 @@ Set the **{discObjectType.Discriminator}** property to specify the type of objec
}
}

sb.Append(GenerateOptionalSection("Property Values", [
GetPropertyValues(resource, DeploymentType.Json, namedTypes, remarks, anchorIndex),
]));

sb.Append(GenerateOptionalSection("Usage Examples", [
GetJsonQuickstartsSection(configLoader.GetSamples(), resource),
]));

sb.Append(GenerateOptionalSection("Property Values", [
GetPropertyValues(resource, DeploymentType.Json, namedTypes, remarks, anchorIndex),
]));

sb.Append($"""

::: zone-end
Expand Down Expand Up @@ -586,14 +586,14 @@ Set the **{discObjectType.Discriminator}** property to specify the type of objec
}
}

sb.Append(GenerateOptionalSection("Property Values", [
GetPropertyValues(resource, DeploymentType.Terraform, namedTypes, remarks, anchorIndex),
]));

sb.Append(GenerateOptionalSection("Usage Examples", [
GetAvmSection(configLoader.GetSamples(), AvmLinkType.Terraform, resource),
]));

sb.Append(GenerateOptionalSection("Property Values", [
GetPropertyValues(resource, DeploymentType.Terraform, namedTypes, remarks, anchorIndex),
]));

sb.Append($"""

::: zone-end
Expand Down