Microsoft.Solutions (preview:2016-09-01)

2025/12/05 • 18 new, 18 deleted methods

ListOperations (new)
Description :  Lists all of the available Microsoft.Solutions REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Solutions/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Microsoft.Solutions operations. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Solutions ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Profile, endpoint, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
Appliances_Get (new)
Description :  Gets the appliance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/appliances/{applianceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applianceName:
{
Description: The name of the appliance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}

⚐ Response (404)

{}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_Delete (new)
Description :  Deletes the appliance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/appliances/{applianceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applianceName:
{
Description: The name of the appliance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_CreateOrUpdate (new)
Description :  Creates a new appliance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/appliances/{applianceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applianceName:
{
Description: The name of the appliance. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update an appliance. ,
Required: True ,
}
{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_Update (new)
Description :  Updates an existing appliance. The only value that can be updated via PATCH currently is the tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/appliances/{applianceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applianceName:
{
Description: The name of the appliance. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update an existing appliance. ,
Required: False ,
}
{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplianceDefinitions_Get (new)
Description :  Gets the appliance definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applianceDefinitions/{applianceDefinitionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applianceDefinitionName:
{
Description: The name of the appliance definition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplianceDefinitions_Delete (new)
Description :  Deletes the appliance definition.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applianceDefinitions/{applianceDefinitionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applianceDefinitionName:
{
Description: The name of the appliance definition to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplianceDefinitions_CreateOrUpdate (new)
Description :  Creates a new appliance definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applianceDefinitions/{applianceDefinitionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applianceDefinitionName:
{
Description: The name of the appliance definition. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update an appliance definition. ,
Required: True ,
}
{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplianceDefinitions_ListByResourceGroup (new)
Description :  Lists the appliance definitions in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applianceDefinitions
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of appliance definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_ListByResourceGroup (new)
Description :  Gets all the appliances within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/appliances
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of appliances. ,
Required: False ,
}
[
{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_ListBySubscription (new)
Description :  Gets all the appliances within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Solutions/appliances
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of appliances. ,
Required: False ,
}
[
{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_GetById (new)
Description :  Gets the appliance.
Reference :  Link ¶

⚼ Request

GET:  /{applianceId}
{
applianceId:
{
Description: The fully qualified ID of the appliance, including the appliance name and the appliance resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/appliances/{appliance-name} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}

⚐ Response (404)

{}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_DeleteById (new)
Description :  Deletes the appliance.
Reference :  Link ¶

⚼ Request

DELETE:  /{applianceId}
{
applianceId:
{
Description: The fully qualified ID of the appliance, including the appliance name and the appliance resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/appliances/{appliance-name} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_CreateOrUpdateById (new)
Description :  Creates a new appliance.
Reference :  Link ¶

⚼ Request

PUT:  /{applianceId}
{
applianceId:
{
Description: The fully qualified ID of the appliance, including the appliance name and the appliance resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/appliances/{appliance-name} ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update an appliance. ,
Required: True ,
}
{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_UpdateById (new)
Description :  Updates an existing appliance. The only value that can be updated via PATCH currently is the tags.
Reference :  Link ¶

⚼ Request

PATCH:  /{applianceId}
{
applianceId:
{
Description: The fully qualified ID of the appliance, including the appliance name and the appliance resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/appliances/{appliance-name} ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update an existing appliance. ,
Required: False ,
}
{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplianceDefinitions_GetById (new)
Description :  Gets the appliance definition.
Reference :  Link ¶

⚼ Request

GET:  /{applianceDefinitionId}
{
applianceDefinitionId:
{
Description: The fully qualified ID of the appliance definition, including the appliance name and the appliance definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applianceDefinitions/{applianceDefinition-name} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplianceDefinitions_DeleteById (new)
Description :  Deletes the appliance definition.
Reference :  Link ¶

⚼ Request

DELETE:  /{applianceDefinitionId}
{
applianceDefinitionId:
{
Description: The fully qualified ID of the appliance definition, including the appliance name and the appliance definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applianceDefinitions/{applianceDefinition-name} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplianceDefinitions_CreateOrUpdateById (new)
Description :  Creates a new appliance definition.
Reference :  Link ¶

⚼ Request

PUT:  /{applianceDefinitionId}
{
applianceDefinitionId:
{
Description: The fully qualified ID of the appliance definition, including the appliance name and the appliance definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applianceDefinitions/{applianceDefinition-name} ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update an appliance definition. ,
Required: True ,
}
{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ListOperations (removed)
Description :  Lists all of the available Microsoft.Solutions REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Solutions/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Microsoft.Solutions operations. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Solutions ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Profile, endpoint, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}
Appliances_Get (removed)
Description :  Gets the appliance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/appliances/{applianceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applianceName:
{
Description: The name of the appliance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}

⚐ Response (404)

{}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_Delete (removed)
Description :  Deletes the appliance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/appliances/{applianceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applianceName:
{
Description: The name of the appliance. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_CreateOrUpdate (removed)
Description :  Creates a new appliance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/appliances/{applianceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applianceName:
{
Description: The name of the appliance. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update an appliance. ,
Required: True ,
}
{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_Update (removed)
Description :  Updates an existing appliance. The only value that can be updated via PATCH currently is the tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/appliances/{applianceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applianceName:
{
Description: The name of the appliance. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update an existing appliance. ,
Required: False ,
}
{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplianceDefinitions_Get (removed)
Description :  Gets the appliance definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applianceDefinitions/{applianceDefinitionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applianceDefinitionName:
{
Description: The name of the appliance definition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplianceDefinitions_Delete (removed)
Description :  Deletes the appliance definition.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applianceDefinitions/{applianceDefinitionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applianceDefinitionName:
{
Description: The name of the appliance definition to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplianceDefinitions_CreateOrUpdate (removed)
Description :  Creates a new appliance definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applianceDefinitions/{applianceDefinitionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applianceDefinitionName:
{
Description: The name of the appliance definition. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update an appliance definition. ,
Required: True ,
}
{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplianceDefinitions_ListByResourceGroup (removed)
Description :  Lists the appliance definitions in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applianceDefinitions
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of appliance definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_ListByResourceGroup (removed)
Description :  Gets all the appliances within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/appliances
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of appliances. ,
Required: False ,
}
[
{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_ListBySubscription (removed)
Description :  Gets all the appliances within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Solutions/appliances
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of appliances. ,
Required: False ,
}
[
{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_GetById (removed)
Description :  Gets the appliance.
Reference :  Link ¶

⚼ Request

GET:  /{applianceId}
{
applianceId:
{
Description: The fully qualified ID of the appliance, including the appliance name and the appliance resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/appliances/{appliance-name} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}

⚐ Response (404)

{}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_DeleteById (removed)
Description :  Deletes the appliance.
Reference :  Link ¶

⚼ Request

DELETE:  /{applianceId}
{
applianceId:
{
Description: The fully qualified ID of the appliance, including the appliance name and the appliance resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/appliances/{appliance-name} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_CreateOrUpdateById (removed)
Description :  Creates a new appliance.
Reference :  Link ¶

⚼ Request

PUT:  /{applianceId}
{
applianceId:
{
Description: The fully qualified ID of the appliance, including the appliance name and the appliance resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/appliances/{appliance-name} ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update an appliance. ,
Required: True ,
}
{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Appliances_UpdateById (removed)
Description :  Updates an existing appliance. The only value that can be updated via PATCH currently is the tags.
Reference :  Link ¶

⚼ Request

PATCH:  /{applianceId}
{
applianceId:
{
Description: The fully qualified ID of the appliance, including the appliance name and the appliance resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/appliances/{appliance-name} ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update an existing appliance. ,
Required: False ,
}
{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance properties. ,
Required: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applianceDefinitionId:
{
Description: The fully qualified path of appliance definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the appliance outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The appliance provisioning state. ,
Enum:
{
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
uiDefinitionUri:
{
Description: The blob URI where the UI definition file is located. ,
Required: False ,
}
string ,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: True ,
}
string ,
product:
{
Description: The product code. ,
Required: True ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: True ,
}
string ,
}
,
kind:
{
Description: The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplianceDefinitions_GetById (removed)
Description :  Gets the appliance definition.
Reference :  Link ¶

⚼ Request

GET:  /{applianceDefinitionId}
{
applianceDefinitionId:
{
Description: The fully qualified ID of the appliance definition, including the appliance name and the appliance definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applianceDefinitions/{applianceDefinition-name} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplianceDefinitions_DeleteById (removed)
Description :  Deletes the appliance definition.
Reference :  Link ¶

⚼ Request

DELETE:  /{applianceDefinitionId}
{
applianceDefinitionId:
{
Description: The fully qualified ID of the appliance definition, including the appliance name and the appliance definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applianceDefinitions/{applianceDefinition-name} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApplianceDefinitions_CreateOrUpdateById (removed)
Description :  Creates a new appliance definition.
Reference :  Link ¶

⚼ Request

PUT:  /{applianceDefinitionId}
{
applianceDefinitionId:
{
Description: The fully qualified ID of the appliance definition, including the appliance name and the appliance definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applianceDefinitions/{applianceDefinition-name} ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update an appliance definition. ,
Required: True ,
}
{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The appliance definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The appliance lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The appliance definition display name. ,
Required: False ,
}
string ,
authorizations:
{
Description: The appliance provider authorizations. ,
Required: True ,
}
[
{
principalId:
{
Description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The appliance artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The appliance artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The appliance artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The appliance definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The appliance definition package file Uri. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
httpStatus:
{
Description: Http status code. ,
Required: False ,
}
string ,
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}