Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The applications 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.Solutions/applications resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Solutions/applications@2023-12-01-preview' = {
scope: resourceSymbolicName or scope
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
kind: 'string'
___location: 'string'
managedBy: 'string'
name: 'string'
plan: {
name: 'string'
product: 'string'
promotionCode: 'string'
publisher: 'string'
version: 'string'
}
properties: {
applicationDefinitionId: 'string'
jitAccessPolicy: {
jitAccessEnabled: bool
jitApprovalMode: 'string'
jitApprovers: [
{
displayName: 'string'
id: 'string'
type: 'string'
}
]
maximumJitAccessDuration: 'string'
}
managedResourceGroupId: 'string'
parameters: any(...)
}
sku: {
capacity: int
family: 'string'
model: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Solutions/applications
| Name | Description | Value |
|---|---|---|
| identity | The identity of the resource. | Identity |
| kind | The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. | string Constraints: Pattern = ^[-\w\._,\(\)]+$ (required) |
| ___location | Resource ___location | string |
| managedBy | ID of the resource that manages this resource. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 (required) |
| plan | The plan information. | Plan |
| properties | The managed application properties. | ApplicationProperties (required) |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
| sku | The SKU of the resource. | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ApplicationJitAccessPolicy
| Name | Description | Value |
|---|---|---|
| jitAccessEnabled | Whether the JIT access is enabled. | bool (required) |
| jitApprovalMode | JIT approval mode. | 'AutoApprove' 'ManualApprove' 'NotSpecified' |
| jitApprovers | The JIT approvers | JitApproverDefinition[] |
| maximumJitAccessDuration | The maximum duration JIT access is granted. This is an ISO8601 time period value. | string |
ApplicationProperties
| Name | Description | Value |
|---|---|---|
| applicationDefinitionId | The fully qualified path of managed application definition Id. | string |
| jitAccessPolicy | The managed application Jit access policy. | ApplicationJitAccessPolicy |
| managedResourceGroupId | The managed resource group Id. | string |
| parameters | Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. | any |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|
JitApproverDefinition
| Name | Description | Value |
|---|---|---|
| displayName | The approver display name. | string |
| id | The approver service principal Id. | string (required) |
| type | The approver type. | 'group' 'user' |
Plan
| Name | Description | Value |
|---|---|---|
| name | The plan name. | string (required) |
| product | The product code. | string (required) |
| promotionCode | The promotion code. | string |
| publisher | The publisher ID. | string (required) |
| version | The plan's version. | string (required) |
ResourceTags
| Name | Description | Value |
|---|
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 |
UserAssignedResourceIdentity
| Name | Description | Value |
|---|
ARM template resource definition
The applications 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.Solutions/applications resource, add the following JSON to your template.
{
"type": "Microsoft.Solutions/applications",
"apiVersion": "2023-12-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"kind": "string",
"___location": "string",
"managedBy": "string",
"plan": {
"name": "string",
"product": "string",
"promotionCode": "string",
"publisher": "string",
"version": "string"
},
"properties": {
"applicationDefinitionId": "string",
"jitAccessPolicy": {
"jitAccessEnabled": "bool",
"jitApprovalMode": "string",
"jitApprovers": [
{
"displayName": "string",
"id": "string",
"type": "string"
}
],
"maximumJitAccessDuration": "string"
},
"managedResourceGroupId": "string",
"parameters": {}
},
"sku": {
"capacity": "int",
"family": "string",
"model": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Solutions/applications
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-12-01-preview' |
| identity | The identity of the resource. | Identity |
| kind | The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. | string Constraints: Pattern = ^[-\w\._,\(\)]+$ (required) |
| ___location | Resource ___location | string |
| managedBy | ID of the resource that manages this resource. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 (required) |
| plan | The plan information. | Plan |
| properties | The managed application properties. | ApplicationProperties (required) |
| sku | The SKU of the resource. | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Solutions/applications' |
ApplicationJitAccessPolicy
| Name | Description | Value |
|---|---|---|
| jitAccessEnabled | Whether the JIT access is enabled. | bool (required) |
| jitApprovalMode | JIT approval mode. | 'AutoApprove' 'ManualApprove' 'NotSpecified' |
| jitApprovers | The JIT approvers | JitApproverDefinition[] |
| maximumJitAccessDuration | The maximum duration JIT access is granted. This is an ISO8601 time period value. | string |
ApplicationProperties
| Name | Description | Value |
|---|---|---|
| applicationDefinitionId | The fully qualified path of managed application definition Id. | string |
| jitAccessPolicy | The managed application Jit access policy. | ApplicationJitAccessPolicy |
| managedResourceGroupId | The managed resource group Id. | string |
| parameters | Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. | any |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|
JitApproverDefinition
| Name | Description | Value |
|---|---|---|
| displayName | The approver display name. | string |
| id | The approver service principal Id. | string (required) |
| type | The approver type. | 'group' 'user' |
Plan
| Name | Description | Value |
|---|---|---|
| name | The plan name. | string (required) |
| product | The product code. | string (required) |
| promotionCode | The promotion code. | string |
| publisher | The publisher ID. | string (required) |
| version | The plan's version. | string (required) |
ResourceTags
| Name | Description | Value |
|---|
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 |
UserAssignedResourceIdentity
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Create a managed application that deploys linked templates |
This template creates a managed application that deploys linked templates. |
| Create a managed application with a customized view |
This template creates a managed application that has a customized default view. |
| Create a managed application with metrics and alerts |
This template creates a managed application that has application metrics and alerts. |
Terraform (AzAPI provider) resource definition
The applications 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.Solutions/applications resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Solutions/applications@2023-12-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
___location = "string"
tags = {
{customized property} = "string"
}
body = {
kind = "string"
managedBy = "string"
plan = {
name = "string"
product = "string"
promotionCode = "string"
publisher = "string"
version = "string"
}
properties = {
applicationDefinitionId = "string"
jitAccessPolicy = {
jitAccessEnabled = bool
jitApprovalMode = "string"
jitApprovers = [
{
displayName = "string"
id = "string"
type = "string"
}
]
maximumJitAccessDuration = "string"
}
managedResourceGroupId = "string"
parameters = ?
}
sku = {
capacity = int
family = "string"
model = "string"
name = "string"
size = "string"
tier = "string"
}
}
}
Property Values
Microsoft.Solutions/applications
| Name | Description | Value |
|---|---|---|
| identity | The identity of the resource. | Identity |
| kind | The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. | string Constraints: Pattern = ^[-\w\._,\(\)]+$ (required) |
| ___location | Resource ___location | string |
| managedBy | ID of the resource that manages this resource. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| plan | The plan information. | Plan |
| properties | The managed application properties. | ApplicationProperties (required) |
| sku | The SKU of the resource. | Sku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Solutions/applications@2023-12-01-preview" |
ApplicationJitAccessPolicy
| Name | Description | Value |
|---|---|---|
| jitAccessEnabled | Whether the JIT access is enabled. | bool (required) |
| jitApprovalMode | JIT approval mode. | 'AutoApprove' 'ManualApprove' 'NotSpecified' |
| jitApprovers | The JIT approvers | JitApproverDefinition[] |
| maximumJitAccessDuration | The maximum duration JIT access is granted. This is an ISO8601 time period value. | string |
ApplicationProperties
| Name | Description | Value |
|---|---|---|
| applicationDefinitionId | The fully qualified path of managed application definition Id. | string |
| jitAccessPolicy | The managed application Jit access policy. | ApplicationJitAccessPolicy |
| managedResourceGroupId | The managed resource group Id. | string |
| parameters | Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. | any |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|
JitApproverDefinition
| Name | Description | Value |
|---|---|---|
| displayName | The approver display name. | string |
| id | The approver service principal Id. | string (required) |
| type | The approver type. | 'group' 'user' |
Plan
| Name | Description | Value |
|---|---|---|
| name | The plan name. | string (required) |
| product | The product code. | string (required) |
| promotionCode | The promotion code. | string |
| publisher | The publisher ID. | string (required) |
| version | The plan's version. | string (required) |
ResourceTags
| Name | Description | Value |
|---|
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 |
UserAssignedResourceIdentity
| Name | Description | Value |
|---|
Usage Examples
Terraform Samples
A basic example of deploying Managed Application.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
data "azapi_client_config" "current" {}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "___location" {
type = string
default = "westus"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
___location = var.___location
}
resource "azapi_resource" "applicationDefinition" {
type = "Microsoft.Solutions/applicationDefinitions@2021-07-01"
parent_id = azapi_resource.resourceGroup.id
name = "${var.resource_name}-appdef"
___location = var.___location
body = {
properties = {
authorizations = [{
principalId = data.azapi_client_config.current.object_id
roleDefinitionId = "b24988ac-6180-42a0-ab88-20f7382dd24c"
}]
createUiDefinition = " {\n \"$schema\": \"https://schema.management.azure.com/schemas/0.1.2-preview/CreateUIDefinition.MultiVm.json#\",\n \"handler\": \"Microsoft.Azure.CreateUIDef\",\n \"version\": \"0.1.2-preview\",\n \"parameters\": {\n \"basics\": [],\n \"steps\": [],\n \"outputs\": {}\n }\n }\n"
description = "Test Managed App Definition"
displayName = "TestManagedAppDefinition"
isEnabled = true
lockLevel = "ReadOnly"
mainTemplate = " {\n \"$schema\": \"https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#\",\n \"contentVersion\": \"1.0.0.0\",\n \"parameters\": {\n\n \"boolParameter\": {\n \"type\": \"bool\"\n },\n \"intParameter\": {\n \"type\": \"int\"\n },\n \"stringParameter\": {\n \"type\": \"string\"\n },\n \"secureStringParameter\": {\n \"type\": \"secureString\"\n },\n \"objectParameter\": {\n \"type\": \"object\"\n },\n \"arrayParameter\": {\n \"type\": \"array\"\n }\n\n },\n \"variables\": {},\n \"resources\": [],\n \"outputs\": {\n \"boolOutput\": {\n \"type\": \"bool\",\n \"value\": true\n },\n \"intOutput\": {\n \"type\": \"int\",\n \"value\": 100\n },\n \"stringOutput\": {\n \"type\": \"string\",\n \"value\": \"stringOutputValue\"\n },\n \"objectOutput\": {\n \"type\": \"object\",\n \"value\": {\n \"nested_bool\": true,\n \"nested_array\": [\"value_1\", \"value_2\"],\n \"nested_object\": {\n \"key_0\": 0\n }\n }\n },\n \"arrayOutput\": {\n \"type\": \"array\",\n \"value\": [\"value_1\", \"value_2\"]\n }\n }\n }\n"
}
}
}
resource "azapi_resource" "application" {
type = "Microsoft.Solutions/applications@2021-07-01"
parent_id = azapi_resource.resourceGroup.id
name = "${var.resource_name}-app"
___location = var.___location
body = {
kind = "ServiceCatalog"
properties = {
applicationDefinitionId = azapi_resource.applicationDefinition.id
managedResourceGroupId = "/subscriptions/${data.azapi_client_config.current.subscription_id}/resourceGroups/${var.resource_name}-infragroup"
parameters = {
arrayParameter = {
value = ["value_1", "value_2"]
}
boolParameter = {
value = true
}
intParameter = {
value = 100
}
objectParameter = {
value = {
nested_array = ["value_1", "value_2"]
nested_bool = true
nested_object = {
key_0 = 0
}
}
}
secureStringParameter = {
value = ""
}
stringParameter = {
value = "value_1"
}
}
}
}
}