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 appliances resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Solutions/appliances resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Solutions/appliances@2016-09-01-preview' = {
identity: {
type: 'SystemAssigned'
}
kind: 'string'
location: 'string'
managedBy: 'string'
name: 'string'
plan: {
name: 'string'
product: 'string'
promotionCode: 'string'
publisher: 'string'
version: 'string'
}
properties: {
applianceDefinitionId: 'string'
managedResourceGroupId: 'string'
parameters: any(...)
uiDefinitionUri: 'string'
}
sku: {
capacity: int
family: 'string'
model: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Solutions/appliances
| Name | Description | Value |
|---|---|---|
| identity | The identity of the resource. | Identity |
| kind | The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. | string Constraints: Pattern = ^[-\w\._,\(\)]+$ |
| 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 appliance properties. | ApplianceProperties |
| sku | The SKU of the resource. | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ApplianceProperties
| Name | Description | Value |
|---|---|---|
| applianceDefinitionId | The fully qualified path of appliance definition Id. | string |
| managedResourceGroupId | The managed resource group Id. | string (required) |
| parameters | Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. | any |
| uiDefinitionUri | The blob URI where the UI definition file is located. | string |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
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 |
ARM template resource definition
The appliances resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Solutions/appliances resource, add the following JSON to your template.
{
"type": "Microsoft.Solutions/appliances",
"apiVersion": "2016-09-01-preview",
"name": "string",
"identity": {
"type": "SystemAssigned"
},
"kind": "string",
"location": "string",
"managedBy": "string",
"plan": {
"name": "string",
"product": "string",
"promotionCode": "string",
"publisher": "string",
"version": "string"
},
"properties": {
"applianceDefinitionId": "string",
"managedResourceGroupId": "string",
"parameters": {},
"uiDefinitionUri": "string"
},
"sku": {
"capacity": "int",
"family": "string",
"model": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Solutions/appliances
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2016-09-01-preview' |
| identity | The identity of the resource. | Identity |
| kind | The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. | string Constraints: Pattern = ^[-\w\._,\(\)]+$ |
| 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 appliance properties. | ApplianceProperties |
| 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/appliances' |
ApplianceProperties
| Name | Description | Value |
|---|---|---|
| applianceDefinitionId | The fully qualified path of appliance definition Id. | string |
| managedResourceGroupId | The managed resource group Id. | string (required) |
| parameters | Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. | any |
| uiDefinitionUri | The blob URI where the UI definition file is located. | string |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
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 |
Usage Examples
Terraform (AzAPI provider) resource definition
The appliances 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.Solutions/appliances resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Solutions/appliances@2016-09-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 = {
applianceDefinitionId = "string"
managedResourceGroupId = "string"
parameters = ?
uiDefinitionUri = "string"
}
sku = {
capacity = int
family = "string"
model = "string"
name = "string"
size = "string"
tier = "string"
}
}
}
Property Values
Microsoft.Solutions/appliances
| Name | Description | Value |
|---|---|---|
| identity | The identity of the resource. | Identity |
| kind | The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. | string Constraints: Pattern = ^[-\w\._,\(\)]+$ |
| 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 appliance properties. | ApplianceProperties |
| sku | The SKU of the resource. | Sku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Solutions/appliances@2016-09-01-preview" |
ApplianceProperties
| Name | Description | Value |
|---|---|---|
| applianceDefinitionId | The fully qualified path of appliance definition Id. | string |
| managedResourceGroupId | The managed resource group Id. | string (required) |
| parameters | Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. | any |
| uiDefinitionUri | The blob URI where the UI definition file is located. | string |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
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 |