Microsoft.Resources resourceGroups 2021-01-01

Bicep resource definition

The resourceGroups resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Resources/resourceGroups resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Resources/resourceGroups@2021-01-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  managedBy: 'string'
  properties: {}
}

Property values

resourceGroups

Name Description Value
name The resource name string (required)

Character limit: 1-90

Valid characters:
Underscores, hyphens, periods, and letters or digits as defined by the Char.IsLetterOrDigit function.

Valid characters are members of the following categories in UnicodeCategory:
UppercaseLetter,
LowercaseLetter,
TitlecaseLetter,
ModifierLetter,
OtherLetter,
DecimalDigitNumber.

Can't end with period.
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)
tags The tags attached to the resource group. Dictionary of tag names and values. See Tags in templates
managedBy The ID of the resource that manages this resource group. string
properties The resource group properties. ResourceGroupProperties

ResourceGroupProperties

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a resourceGroup

Deploy to Azure
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

Deploy to Azure
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.

ARM template resource definition

The resourceGroups resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Resources/resourceGroups resource, add the following JSON to your template.

{
  "type": "Microsoft.Resources/resourceGroups",
  "apiVersion": "2021-01-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "managedBy": "string",
  "properties": {}
}

Property values

resourceGroups

Name Description Value
type The resource type 'Microsoft.Resources/resourceGroups'
apiVersion The resource api version '2021-01-01'
name The resource name string (required)

Character limit: 1-90

Valid characters:
Underscores, hyphens, periods, and letters or digits as defined by the Char.IsLetterOrDigit function.

Valid characters are members of the following categories in UnicodeCategory:
UppercaseLetter,
LowercaseLetter,
TitlecaseLetter,
ModifierLetter,
OtherLetter,
DecimalDigitNumber.

Can't end with period.
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)
tags The tags attached to the resource group. Dictionary of tag names and values. See Tags in templates
managedBy The ID of the resource that manages this resource group. string
properties The resource group properties. ResourceGroupProperties

ResourceGroupProperties

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a resourceGroup

Deploy to Azure
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

Deploy to Azure
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.

Terraform (AzAPI provider) resource definition

The resourceGroups resource type can be deployed to:

  • Subscriptions

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Resources/resourceGroups resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Resources/resourceGroups@2021-01-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {}
    managedBy = "string"
  })
}

Property values

resourceGroups

Name Description Value
type The resource type "Microsoft.Resources/resourceGroups@2021-01-01"
name The resource name string (required)

Character limit: 1-90

Valid characters:
Underscores, hyphens, periods, and letters or digits as defined by the Char.IsLetterOrDigit function.

Valid characters are members of the following categories in UnicodeCategory:
UppercaseLetter,
LowercaseLetter,
TitlecaseLetter,
ModifierLetter,
OtherLetter,
DecimalDigitNumber.

Can't end with period.
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)
parent_id To deploy to a subscription, use the ID of that subscription. string (required)
tags The tags attached to the resource group. Dictionary of tag names and values.
managedBy The ID of the resource that manages this resource group. string
properties The resource group properties. ResourceGroupProperties

ResourceGroupProperties

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.