Microsoft.Solutions (stable:2017-09-01)

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

Applications_Get (new)
Description :  Gets the managed application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the managed application. ,
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 managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 ,
}
Applications_Delete (new)
Description :  Deletes the managed application.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the managed application. ,
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 ,
}
Applications_CreateOrUpdate (new)
Description :  Creates a new managed application.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the managed application. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update a managed application. ,
Required: True ,
}
{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 ,
}
Applications_Update (new)
Description :  Updates an existing managed application. The only value that can be updated via PATCH currently is the tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the managed application. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update an existing managed application. ,
Required: False ,
}
{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 ,
}
ApplicationDefinitions_Get (new)
Description :  Gets the managed application definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applicationDefinitions/{applicationDefinitionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationDefinitionName:
{
Description: The name of the managed application 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 managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
ApplicationDefinitions_Delete (new)
Description :  Deletes the managed application definition.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applicationDefinitions/{applicationDefinitionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationDefinitionName:
{
Description: The name of the managed application 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 ,
}
ApplicationDefinitions_CreateOrUpdate (new)
Description :  Creates a new managed application definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applicationDefinitions/{applicationDefinitionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationDefinitionName:
{
Description: The name of the managed application definition. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update an managed application definition. ,
Required: True ,
}
{
properties:
{
Description: The managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}
,
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 managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
ApplicationDefinitions_ListByResourceGroup (new)
Description :  Lists the managed application definitions in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applicationDefinitions
{
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 managed application definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}
,
]
,
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 ,
}
Applications_ListByResourceGroup (new)
Description :  Gets all the applications within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications
{
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 managed applications. ,
Required: False ,
}
[
{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 ,
}
Applications_ListBySubscription (new)
Description :  Gets all the applications within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Solutions/applications
{
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 managed applications. ,
Required: False ,
}
[
{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 ,
}
Applications_GetById (new)
Description :  Gets the managed application.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 ,
}
Applications_DeleteById (new)
Description :  Deletes the managed application.
Reference :  Link ¶

⚼ Request

DELETE:  /{applicationId}
{
applicationId:
{
Description: The fully qualified ID of the managed application, including the managed application name and the managed application resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applications/{application-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 ,
}
Applications_CreateOrUpdateById (new)
Description :  Creates a new managed application.
Reference :  Link ¶

⚼ Request

PUT:  /{applicationId}
{
applicationId:
{
Description: The fully qualified ID of the managed application, including the managed application name and the managed application resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applications/{application-name} ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update a managed application. ,
Required: True ,
}
{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 ,
}
Applications_UpdateById (new)
Description :  Updates an existing managed application. The only value that can be updated via PATCH currently is the tags.
Reference :  Link ¶

⚼ Request

PATCH:  /{applicationId}
{
applicationId:
{
Description: The fully qualified ID of the managed application, including the managed application name and the managed application resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applications/{application-name} ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update an existing managed application. ,
Required: False ,
}
{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 ,
}
ApplicationDefinitions_GetById (new)
Description :  Gets the managed application definition.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
ApplicationDefinitions_DeleteById (new)
Description :  Deletes the managed application definition.
Reference :  Link ¶

⚼ Request

DELETE:  /{applicationDefinitionId}
{
applicationDefinitionId:
{
Description: The fully qualified ID of the managed application definition, including the managed application name and the managed application definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applicationDefinitions/{applicationDefinition-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 ,
}
ApplicationDefinitions_CreateOrUpdateById (new)
Description :  Creates a new managed application definition.
Reference :  Link ¶

⚼ Request

PUT:  /{applicationDefinitionId}
{
applicationDefinitionId:
{
Description: The fully qualified ID of the managed application definition, including the managed application name and the managed application definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applicationDefinitions/{applicationDefinition-name} ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update a managed application definition. ,
Required: True ,
}
{
properties:
{
Description: The managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
Applications_Get (removed)
Description :  Gets the managed application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the managed application. ,
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 managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 ,
}
Applications_Delete (removed)
Description :  Deletes the managed application.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the managed application. ,
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 ,
}
Applications_CreateOrUpdate (removed)
Description :  Creates a new managed application.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the managed application. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update a managed application. ,
Required: True ,
}
{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 ,
}
Applications_Update (removed)
Description :  Updates an existing managed application. The only value that can be updated via PATCH currently is the tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the managed application. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update an existing managed application. ,
Required: False ,
}
{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 ,
}
ApplicationDefinitions_Get (removed)
Description :  Gets the managed application definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applicationDefinitions/{applicationDefinitionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationDefinitionName:
{
Description: The name of the managed application 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 managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
ApplicationDefinitions_Delete (removed)
Description :  Deletes the managed application definition.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applicationDefinitions/{applicationDefinitionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationDefinitionName:
{
Description: The name of the managed application 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 ,
}
ApplicationDefinitions_CreateOrUpdate (removed)
Description :  Creates a new managed application definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applicationDefinitions/{applicationDefinitionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
applicationDefinitionName:
{
Description: The name of the managed application definition. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update an managed application definition. ,
Required: True ,
}
{
properties:
{
Description: The managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}
,
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 managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
ApplicationDefinitions_ListByResourceGroup (removed)
Description :  Lists the managed application definitions in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applicationDefinitions
{
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 managed application definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}
,
]
,
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 ,
}
Applications_ListByResourceGroup (removed)
Description :  Gets all the applications within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications
{
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 managed applications. ,
Required: False ,
}
[
{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 ,
}
Applications_ListBySubscription (removed)
Description :  Gets all the applications within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Solutions/applications
{
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 managed applications. ,
Required: False ,
}
[
{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 ,
}
Applications_GetById (removed)
Description :  Gets the managed application.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 ,
}
Applications_DeleteById (removed)
Description :  Deletes the managed application.
Reference :  Link ¶

⚼ Request

DELETE:  /{applicationId}
{
applicationId:
{
Description: The fully qualified ID of the managed application, including the managed application name and the managed application resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applications/{application-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 ,
}
Applications_CreateOrUpdateById (removed)
Description :  Creates a new managed application.
Reference :  Link ¶

⚼ Request

PUT:  /{applicationId}
{
applicationId:
{
Description: The fully qualified ID of the managed application, including the managed application name and the managed application resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applications/{application-name} ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update a managed application. ,
Required: True ,
}
{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 ,
}
Applications_UpdateById (removed)
Description :  Updates an existing managed application. The only value that can be updated via PATCH currently is the tags.
Reference :  Link ¶

⚼ Request

PATCH:  /{applicationId}
{
applicationId:
{
Description: The fully qualified ID of the managed application, including the managed application name and the managed application resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applications/{application-name} ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update an existing managed application. ,
Required: False ,
}
{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: True ,
}
string ,
applicationDefinitionId:
{
Description: The fully qualified path of managed application definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
outputs:
{
Description: Name and value pairs that define the managed application outputs. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The managed application 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 managed application. Allowed values are MarketPlace and ServiceCatalog. ,
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 ,
}
ApplicationDefinitions_GetById (removed)
Description :  Gets the managed application definition.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
ApplicationDefinitions_DeleteById (removed)
Description :  Deletes the managed application definition.
Reference :  Link ¶

⚼ Request

DELETE:  /{applicationDefinitionId}
{
applicationDefinitionId:
{
Description: The fully qualified ID of the managed application definition, including the managed application name and the managed application definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applicationDefinitions/{applicationDefinition-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 ,
}
ApplicationDefinitions_CreateOrUpdateById (removed)
Description :  Creates a new managed application definition.
Reference :  Link ¶

⚼ Request

PUT:  /{applicationDefinitionId}
{
applicationDefinitionId:
{
Description: The fully qualified ID of the managed application definition, including the managed application name and the managed application definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applicationDefinitions/{applicationDefinition-name} ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update a managed application definition. ,
Required: True ,
}
{
properties:
{
Description: The managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The managed application definition properties. ,
Required: True ,
}
{
lockLevel:
{
Description: The managed application lock level. ,
Enum:
{
CanNotDelete: No description available. ,
ReadOnly: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: The managed application definition display name. ,
Required: False ,
}
string ,
isEnabled:
{
Description: A value indicating whether the package is enabled or not. ,
Required: False ,
}
string ,
authorizations:
{
Description: The managed application 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 managed application 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 managed application's container resource group. This role definition cannot have permission to delete the resource group. ,
Required: True ,
}
string ,
}
,
]
,
artifacts:
{
Description: The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Required: False ,
}
string ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: False ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
Template: No description available. ,
Custom: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
description:
{
Description: The managed application definition description. ,
Required: False ,
}
string ,
packageFileUri:
{
Description: The managed application definition package file Uri. Use this element ,
Required: False ,
}
string ,
mainTemplate:
{
Description: The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
createUiDefinition:
{
Description: The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}