Microsoft.Insights components/favorites 2015-05-01

  • Article

Bicep resource definition

The components/favorites resource type can be deployed with operations that target:

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

Resource format

To create a Microsoft.Insights/components/favorites resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Insights/components/favorites@2015-05-01' = {
  name: 'string'
  Tags: [
    'string'
  ]
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  Category: 'string'
  Config: 'string'
  FavoriteType: 'string'
  IsGeneratedFromTemplate: bool
  SourceType: 'string'
  Version: 'string'
}

Property values

components/favorites

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
Tags A list of 0 or more tags that are associated with this favorite definition string[]
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: components
Category Favorite category, as defined by the user at creation time. string
Config Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON string
FavoriteType Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component. 'shared'
'user'
IsGeneratedFromTemplate Flag denoting wether or not this favorite was generated from a template. bool
SourceType The source of the favorite definition. string
Version This instance's version of the data model. This can change as new features are added that can be marked favorite. Current examples include MetricsExplorer (ME) and Search. string

ARM template resource definition

The components/favorites resource type can be deployed with operations that target:

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

Resource format

To create a Microsoft.Insights/components/favorites resource, add the following JSON to your template.

{
  "type": "Microsoft.Insights/components/favorites",
  "apiVersion": "2015-05-01",
  "name": "string",
  "Tags": [ "string" ],
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "Category": "string",
  "Config": "string",
  "FavoriteType": "string",
  "IsGeneratedFromTemplate": "bool",
  "SourceType": "string",
  "Version": "string"
}

Property values

components/favorites

Name Description Value
type The resource type 'Microsoft.Insights/components/favorites'
apiVersion The resource api version '2015-05-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
Tags A list of 0 or more tags that are associated with this favorite definition string[]
Category Favorite category, as defined by the user at creation time. string
Config Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON string
FavoriteType Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component. 'shared'
'user'
IsGeneratedFromTemplate Flag denoting wether or not this favorite was generated from a template. bool
SourceType The source of the favorite definition. string
Version This instance's version of the data model. This can change as new features are added that can be marked favorite. Current examples include MetricsExplorer (ME) and Search. string

Terraform (AzAPI provider) resource definition

The components/favorites resource type can be deployed with operations that target:

  • Resource groups

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

Resource format

To create a Microsoft.Insights/components/favorites resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/components/favorites@2015-05-01"
  name = "string"
  parent_id = "string"
  Tags = [
    "string"
  ]
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    Category = "string"
    Config = "string"
    FavoriteType = "string"
    IsGeneratedFromTemplate = bool
    SourceType = "string"
    Version = "string"
  })
}

Property values

components/favorites

Name Description Value
type The resource type "Microsoft.Insights/components/favorites@2015-05-01"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: components
Tags A list of 0 or more tags that are associated with this favorite definition string[]
Category Favorite category, as defined by the user at creation time. string
Config Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON string
FavoriteType Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component. "shared"
"user"
IsGeneratedFromTemplate Flag denoting wether or not this favorite was generated from a template. bool
SourceType The source of the favorite definition. string
Version This instance's version of the data model. This can change as new features are added that can be marked favorite. Current examples include MetricsExplorer (ME) and Search. string