Microsoft.Solutions applicationDefinitions 2017-12-01

  • Article

Bicep resource definition

The applicationDefinitions resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep.

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

Resource format

To create a Microsoft.Solutions/applicationDefinitions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Solutions/applicationDefinitions@2017-12-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    model: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  identity: {
    type: 'SystemAssigned'
  }
  managedBy: 'string'
  properties: {
    artifacts: [
      {
        name: 'string'
        type: 'string'
        uri: 'string'
      }
    ]
    authorizations: [
      {
        principalId: 'string'
        roleDefinitionId: 'string'
      }
    ]
    createUiDefinition: any()
    description: 'string'
    displayName: 'string'
    isEnabled: 'string'
    mainTemplate: any()
    packageFileUri: 'string'
  }
}

Property values

applicationDefinitions

Name Description Value
name The resource name string (required)
location Resource location string
tags Resource tags Dictionary of tag names and values. See Tags in templates
sku The SKU of the resource. Sku
identity The identity of the resource. Identity
managedBy ID of the resource that manages this resource. string
properties The managed application definition properties. ApplicationDefinitionProperties (required)

Identity

Name Description Value
type The identity type. 'SystemAssigned'

ApplicationDefinitionProperties

Name Description Value
artifacts The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ApplicationArtifact[]
authorizations The managed application provider authorizations. ApplicationProviderAuthorization[] (required)
createUiDefinition The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. For Bicep, you can use the any() function.
description The managed application definition description. string
displayName The managed application definition display name. string
isEnabled A value indicating whether the package is enabled or not. string
mainTemplate The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. For Bicep, you can use the any() function.
packageFileUri The managed application definition package file Uri. Use this element string

ApplicationArtifact

Name Description Value
name The managed application artifact name. string
type The managed application artifact type. 'Custom'
'Template'
uri The managed application artifact blob uri. string

ApplicationProviderAuthorization

Name Description Value
principalId The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the managed application resources. string (required)
roleDefinitionId The provider's role definition identifier. This role will define all the permissions that the provider must have on the managed application's container resource group. This role definition cannot have permission to delete the resource group. string (required)

Sku

Name Description Value
capacity The SKU capacity. int
family The SKU family. string
model The SKU model. string
name The SKU name. string (required)
size The SKU size. string
tier The SKU tier. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a managed application with a customized view

Deploy to Azure		 This template creates a managed application that has a customized default view.
Create a managed application that deploys linked templates

Deploy to Azure		 This template creates a managed application that deploys linked templates.
Create a managed application with metrics and alerts

Deploy to Azure		 This template creates a managed application that has application metrics and alerts.

ARM template resource definition

The applicationDefinitions resource type can be deployed to: Resource groups.

To learn about resource group deployments, see ARM template.

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

Resource format

To create a Microsoft.Solutions/applicationDefinitions resource, add the following JSON to your template.

{
  "type": "Microsoft.Solutions/applicationDefinitions",
  "apiVersion": "2017-12-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "model": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "identity": {
    "type": "SystemAssigned"
  },
  "managedBy": "string",
  "properties": {
    "artifacts": [
      {
        "name": "string",
        "type": "string",
        "uri": "string"
      }
    ],
    "authorizations": [
      {
        "principalId": "string",
        "roleDefinitionId": "string"
      }
    ],
    "createUiDefinition": {},
    "description": "string",
    "displayName": "string",
    "isEnabled": "string",
    "mainTemplate": {},
    "packageFileUri": "string"
  }
}

Property values

applicationDefinitions

Name Description Value
type The resource type 'Microsoft.Solutions/applicationDefinitions'
apiVersion The resource api version '2017-12-01'
name The resource name string (required)
location Resource location string
tags Resource tags Dictionary of tag names and values. See Tags in templates
sku The SKU of the resource. Sku
identity The identity of the resource. Identity
managedBy ID of the resource that manages this resource. string
properties The managed application definition properties. ApplicationDefinitionProperties (required)

Identity

Name Description Value
type The identity type. 'SystemAssigned'

ApplicationDefinitionProperties

Name Description Value
artifacts The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ApplicationArtifact[]
authorizations The managed application provider authorizations. ApplicationProviderAuthorization[] (required)
createUiDefinition The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string.
description The managed application definition description. string
displayName The managed application definition display name. string
isEnabled A value indicating whether the package is enabled or not. string
mainTemplate The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string.
packageFileUri The managed application definition package file Uri. Use this element string

ApplicationArtifact

Name Description Value
name The managed application artifact name. string
type The managed application artifact type. 'Custom'
'Template'
uri The managed application artifact blob uri. string

ApplicationProviderAuthorization

Name Description Value
principalId The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the managed application resources. string (required)
roleDefinitionId The provider's role definition identifier. This role will define all the permissions that the provider must have on the managed application's container resource group. This role definition cannot have permission to delete the resource group. string (required)

Sku

Name Description Value
capacity The SKU capacity. int
family The SKU family. string
model The SKU model. string
name The SKU name. string (required)
size The SKU size. string
tier The SKU tier. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a managed application with a customized view

Deploy to Azure		 This template creates a managed application that has a customized default view.
Create a managed application that deploys linked templates

Deploy to Azure		 This template creates a managed application that deploys linked templates.
Create a managed application with metrics and alerts

Deploy to Azure		 This template creates a managed application that has application metrics and alerts.

Terraform (AzAPI provider) resource definition

The applicationDefinitions resource type can be deployed to: Resource groups.

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

Resource format

To create a Microsoft.Solutions/applicationDefinitions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Solutions/applicationDefinitions@2017-12-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      artifacts = [
        {
          name = "string"
          type = "string"
          uri = "string"
        }
      ]
      authorizations = [
        {
          principalId = "string"
          roleDefinitionId = "string"
        }
      ]
      description = "string"
      displayName = "string"
      isEnabled = "string"
      packageFileUri = "string"
    }
    sku = {
      capacity = int
      family = "string"
      model = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
    managedBy = "string"
  })
}

Property values

applicationDefinitions

Name Description Value
type The resource type "Microsoft.Solutions/applicationDefinitions@2017-12-01"
name The resource name string (required)
location Resource location string
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags Dictionary of tag names and values.
sku The SKU of the resource. Sku
identity The identity of the resource. Identity
managedBy ID of the resource that manages this resource. string
properties The managed application definition properties. ApplicationDefinitionProperties (required)

Identity

Name Description Value
type The identity type. "SystemAssigned"

ApplicationDefinitionProperties

Name Description Value
artifacts The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ApplicationArtifact[]
authorizations The managed application provider authorizations. ApplicationProviderAuthorization[] (required)
createUiDefinition The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string.
description The managed application definition description. string
displayName The managed application definition display name. string
isEnabled A value indicating whether the package is enabled or not. string
mainTemplate The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string.
packageFileUri The managed application definition package file Uri. Use this element string

ApplicationArtifact

Name Description Value
name The managed application artifact name. string
type The managed application artifact type. "Custom"
"Template"
uri The managed application artifact blob uri. string

ApplicationProviderAuthorization

Name Description Value
principalId The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the managed application resources. string (required)
roleDefinitionId The provider's role definition identifier. This role will define all the permissions that the provider must have on the managed application's container resource group. This role definition cannot have permission to delete the resource group. string (required)

Sku

Name Description Value
capacity The SKU capacity. int
family The SKU family. string
model The SKU model. string
name The SKU name. string (required)
size The SKU size. string
tier The SKU tier. string