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 applianceDefinitions 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/applianceDefinitions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Solutions/applianceDefinitions@2016-09-01-preview' = {
identity: {
type: 'SystemAssigned'
}
location: 'string'
managedBy: 'string'
name: 'string'
properties: {
artifacts: [
{
name: 'string'
type: 'string'
uri: 'string'
}
]
authorizations: [
{
principalId: 'string'
roleDefinitionId: 'string'
}
]
description: 'string'
displayName: 'string'
lockLevel: 'string'
packageFileUri: 'string'
}
sku: {
capacity: int
family: 'string'
model: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Solutions/applianceDefinitions
| Name | Description | Value |
|---|---|---|
| identity | The identity of the resource. | Identity |
| 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) |
| properties | The appliance definition properties. | ApplianceDefinitionProperties (required) |
| sku | The SKU of the resource. | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ApplianceArtifact
| Name | Description | Value |
|---|---|---|
| name | The appliance artifact name. | string |
| type | The appliance artifact type. | 'Custom' 'Template' |
| uri | The appliance artifact blob uri. | string |
ApplianceDefinitionProperties
| Name | Description | Value |
|---|---|---|
| artifacts | The collection of appliance artifacts. The portal will use the files specified as artifacts to construct the user experience of creating an appliance from an appliance definition. | ApplianceArtifact[] |
| authorizations | The appliance provider authorizations. | ApplianceProviderAuthorization[] (required) |
| description | The appliance definition description. | string |
| displayName | The appliance definition display name. | string |
| lockLevel | The appliance lock level. | 'CanNotDelete' 'None' 'ReadOnly' (required) |
| packageFileUri | The appliance definition package file Uri. | string (required) |
ApplianceProviderAuthorization
| Name | Description | Value |
|---|---|---|
| principalId | The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. | string (required) |
| roleDefinitionId | The provider's role definition identifier. This role will define all the permissions that the provider must have on the appliance's container resource group. This role definition cannot have permission to delete the resource group. | string (required) |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
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 applianceDefinitions 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/applianceDefinitions resource, add the following JSON to your template.
{
"type": "Microsoft.Solutions/applianceDefinitions",
"apiVersion": "2016-09-01-preview",
"name": "string",
"identity": {
"type": "SystemAssigned"
},
"location": "string",
"managedBy": "string",
"properties": {
"artifacts": [
{
"name": "string",
"type": "string",
"uri": "string"
}
],
"authorizations": [
{
"principalId": "string",
"roleDefinitionId": "string"
}
],
"description": "string",
"displayName": "string",
"lockLevel": "string",
"packageFileUri": "string"
},
"sku": {
"capacity": "int",
"family": "string",
"model": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Solutions/applianceDefinitions
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2016-09-01-preview' |
| identity | The identity of the resource. | Identity |
| 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) |
| properties | The appliance definition properties. | ApplianceDefinitionProperties (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/applianceDefinitions' |
ApplianceArtifact
| Name | Description | Value |
|---|---|---|
| name | The appliance artifact name. | string |
| type | The appliance artifact type. | 'Custom' 'Template' |
| uri | The appliance artifact blob uri. | string |
ApplianceDefinitionProperties
| Name | Description | Value |
|---|---|---|
| artifacts | The collection of appliance artifacts. The portal will use the files specified as artifacts to construct the user experience of creating an appliance from an appliance definition. | ApplianceArtifact[] |
| authorizations | The appliance provider authorizations. | ApplianceProviderAuthorization[] (required) |
| description | The appliance definition description. | string |
| displayName | The appliance definition display name. | string |
| lockLevel | The appliance lock level. | 'CanNotDelete' 'None' 'ReadOnly' (required) |
| packageFileUri | The appliance definition package file Uri. | string (required) |
ApplianceProviderAuthorization
| Name | Description | Value |
|---|---|---|
| principalId | The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. | string (required) |
| roleDefinitionId | The provider's role definition identifier. This role will define all the permissions that the provider must have on the appliance's container resource group. This role definition cannot have permission to delete the resource group. | string (required) |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
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 applianceDefinitions 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/applianceDefinitions resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Solutions/applianceDefinitions@2016-09-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
managedBy = "string"
properties = {
artifacts = [
{
name = "string"
type = "string"
uri = "string"
}
]
authorizations = [
{
principalId = "string"
roleDefinitionId = "string"
}
]
description = "string"
displayName = "string"
lockLevel = "string"
packageFileUri = "string"
}
sku = {
capacity = int
family = "string"
model = "string"
name = "string"
size = "string"
tier = "string"
}
}
}
Property Values
Microsoft.Solutions/applianceDefinitions
| Name | Description | Value |
|---|---|---|
| identity | The identity of the resource. | Identity |
| 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) |
| properties | The appliance definition properties. | ApplianceDefinitionProperties (required) |
| sku | The SKU of the resource. | Sku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Solutions/applianceDefinitions@2016-09-01-preview" |
ApplianceArtifact
| Name | Description | Value |
|---|---|---|
| name | The appliance artifact name. | string |
| type | The appliance artifact type. | 'Custom' 'Template' |
| uri | The appliance artifact blob uri. | string |
ApplianceDefinitionProperties
| Name | Description | Value |
|---|---|---|
| artifacts | The collection of appliance artifacts. The portal will use the files specified as artifacts to construct the user experience of creating an appliance from an appliance definition. | ApplianceArtifact[] |
| authorizations | The appliance provider authorizations. | ApplianceProviderAuthorization[] (required) |
| description | The appliance definition description. | string |
| displayName | The appliance definition display name. | string |
| lockLevel | The appliance lock level. | 'CanNotDelete' 'None' 'ReadOnly' (required) |
| packageFileUri | The appliance definition package file Uri. | string (required) |
ApplianceProviderAuthorization
| Name | Description | Value |
|---|---|---|
| principalId | The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. | string (required) |
| roleDefinitionId | The provider's role definition identifier. This role will define all the permissions that the provider must have on the appliance's container resource group. This role definition cannot have permission to delete the resource group. | string (required) |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
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 |