Microsoft.Solutions (preview:2020-08-21)

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

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of Microsoft.Solutions operations. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Solutions ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Application, JitRequest, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Localized friendly description for the operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
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 properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product code. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
kind:
{
Description: The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
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 properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
boolean ,
authorizations:
{
Description: The managed application provider authorizations. ,
Required: False ,
}
[
{
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 definition artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ApplicationResourceTemplate: No description available. ,
CreateUiDefinition: No description available. ,
MainTemplateParameters: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application definition artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application definition artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
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 ,
storageAccountId:
{
Description: The storage account id for bring your own storage scenario. ,
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 ,
notificationPolicy:
{
Description: The managed application notification policy. ,
Required: False ,
}
{
notificationEndpoints:
{
Description: The managed application notification endpoint. ,
Required: True ,
}
[
{
uri:
{
Description: The managed application notification endpoint uri. ,
Required: True ,
}
string ,
}
,
]
,
}
,
lockingPolicy:
{
Description: The managed application locking policy. ,
Required: False ,
}
{
allowedActions:
{
Description: The deny assignment excluded actions. ,
Required: False ,
}
[
string ,
]
,
allowedDataActions:
{
Description: The deny assignment excluded data actions. ,
Required: False ,
}
[
string ,
]
,
}
,
deploymentPolicy:
{
Description: The managed application deployment policy. ,
Required: False ,
}
{
deploymentMode:
{
Description: The managed application deployment mode. ,
Enum:
{
NotSpecified: No description available. ,
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
managementPolicy:
{
Description: The managed application management policy that determines publisher's access to the managed resource group. ,
Required: False ,
}
{
mode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
policies:
{
Description: The managed application provider policies. ,
Required: False ,
}
[
{
name:
{
Description: The policy name ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The policy definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: The policy parameters. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
boolean ,
authorizations:
{
Description: The managed application provider authorizations. ,
Required: False ,
}
[
{
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 definition artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ApplicationResourceTemplate: No description available. ,
CreateUiDefinition: No description available. ,
MainTemplateParameters: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application definition artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application definition artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
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 ,
storageAccountId:
{
Description: The storage account id for bring your own storage scenario. ,
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 ,
notificationPolicy:
{
Description: The managed application notification policy. ,
Required: False ,
}
{
notificationEndpoints:
{
Description: The managed application notification endpoint. ,
Required: True ,
}
[
{
uri:
{
Description: The managed application notification endpoint uri. ,
Required: True ,
}
string ,
}
,
]
,
}
,
lockingPolicy:
{
Description: The managed application locking policy. ,
Required: False ,
}
{
allowedActions:
{
Description: The deny assignment excluded actions. ,
Required: False ,
}
[
string ,
]
,
allowedDataActions:
{
Description: The deny assignment excluded data actions. ,
Required: False ,
}
[
string ,
]
,
}
,
deploymentPolicy:
{
Description: The managed application deployment policy. ,
Required: False ,
}
{
deploymentMode:
{
Description: The managed application deployment mode. ,
Enum:
{
NotSpecified: No description available. ,
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
managementPolicy:
{
Description: The managed application management policy that determines publisher's access to the managed resource group. ,
Required: False ,
}
{
mode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
policies:
{
Description: The managed application provider policies. ,
Required: False ,
}
[
{
name:
{
Description: The policy name ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The policy definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: The policy parameters. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The 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 ,
}
boolean ,
authorizations:
{
Description: The managed application provider authorizations. ,
Required: False ,
}
[
{
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 definition artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ApplicationResourceTemplate: No description available. ,
CreateUiDefinition: No description available. ,
MainTemplateParameters: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application definition artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application definition artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
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 ,
storageAccountId:
{
Description: The storage account id for bring your own storage scenario. ,
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 ,
notificationPolicy:
{
Description: The managed application notification policy. ,
Required: False ,
}
{
notificationEndpoints:
{
Description: The managed application notification endpoint. ,
Required: True ,
}
[
{
uri:
{
Description: The managed application notification endpoint uri. ,
Required: True ,
}
string ,
}
,
]
,
}
,
lockingPolicy:
{
Description: The managed application locking policy. ,
Required: False ,
}
{
allowedActions:
{
Description: The deny assignment excluded actions. ,
Required: False ,
}
[
string ,
]
,
allowedDataActions:
{
Description: The deny assignment excluded data actions. ,
Required: False ,
}
[
string ,
]
,
}
,
deploymentPolicy:
{
Description: The managed application deployment policy. ,
Required: False ,
}
{
deploymentMode:
{
Description: The managed application deployment mode. ,
Enum:
{
NotSpecified: No description available. ,
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
managementPolicy:
{
Description: The managed application management policy that determines publisher's access to the managed resource group. ,
Required: False ,
}
{
mode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
policies:
{
Description: The managed application provider policies. ,
Required: False ,
}
[
{
name:
{
Description: The policy name ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The policy definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: The policy parameters. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ 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 ,
}
boolean ,
authorizations:
{
Description: The managed application provider authorizations. ,
Required: False ,
}
[
{
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 definition artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ApplicationResourceTemplate: No description available. ,
CreateUiDefinition: No description available. ,
MainTemplateParameters: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application definition artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application definition artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
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 ,
storageAccountId:
{
Description: The storage account id for bring your own storage scenario. ,
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 ,
notificationPolicy:
{
Description: The managed application notification policy. ,
Required: False ,
}
{
notificationEndpoints:
{
Description: The managed application notification endpoint. ,
Required: True ,
}
[
{
uri:
{
Description: The managed application notification endpoint uri. ,
Required: True ,
}
string ,
}
,
]
,
}
,
lockingPolicy:
{
Description: The managed application locking policy. ,
Required: False ,
}
{
allowedActions:
{
Description: The deny assignment excluded actions. ,
Required: False ,
}
[
string ,
]
,
allowedDataActions:
{
Description: The deny assignment excluded data actions. ,
Required: False ,
}
[
string ,
]
,
}
,
deploymentPolicy:
{
Description: The managed application deployment policy. ,
Required: False ,
}
{
deploymentMode:
{
Description: The managed application deployment mode. ,
Enum:
{
NotSpecified: No description available. ,
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
managementPolicy:
{
Description: The managed application management policy that determines publisher's access to the managed resource group. ,
Required: False ,
}
{
mode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
policies:
{
Description: The managed application provider policies. ,
Required: False ,
}
[
{
name:
{
Description: The policy name ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The policy definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: The policy parameters. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
boolean ,
authorizations:
{
Description: The managed application provider authorizations. ,
Required: False ,
}
[
{
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 definition artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ApplicationResourceTemplate: No description available. ,
CreateUiDefinition: No description available. ,
MainTemplateParameters: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application definition artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application definition artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
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 ,
storageAccountId:
{
Description: The storage account id for bring your own storage scenario. ,
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 ,
notificationPolicy:
{
Description: The managed application notification policy. ,
Required: False ,
}
{
notificationEndpoints:
{
Description: The managed application notification endpoint. ,
Required: True ,
}
[
{
uri:
{
Description: The managed application notification endpoint uri. ,
Required: True ,
}
string ,
}
,
]
,
}
,
lockingPolicy:
{
Description: The managed application locking policy. ,
Required: False ,
}
{
allowedActions:
{
Description: The deny assignment excluded actions. ,
Required: False ,
}
[
string ,
]
,
allowedDataActions:
{
Description: The deny assignment excluded data actions. ,
Required: False ,
}
[
string ,
]
,
}
,
deploymentPolicy:
{
Description: The managed application deployment policy. ,
Required: False ,
}
{
deploymentMode:
{
Description: The managed application deployment mode. ,
Enum:
{
NotSpecified: No description available. ,
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
managementPolicy:
{
Description: The managed application management policy that determines publisher's access to the managed resource group. ,
Required: False ,
}
{
mode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
policies:
{
Description: The managed application provider policies. ,
Required: False ,
}
[
{
name:
{
Description: The policy name ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The policy definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: The policy parameters. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JitRequests_Get (new)
Description :  Gets the JIT request.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/jitRequests/{jitRequestName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
jitRequestName:
{
Description: The name of the JIT request. ,
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 JIT request properties. ,
Required: False ,
}
{
applicationResourceId:
{
Description: The parent application id. ,
Required: True ,
}
string ,
publisherTenantId:
{
Description: The publisher tenant id. ,
Required: False ,
}
string ,
jitAuthorizationPolicies:
{
Description: The JIT authorization policies. ,
Required: True ,
}
[
{
principalId:
{
Description: The the principal id that will be granted JIT access. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The role definition id that will be granted to the Principal. ,
Required: True ,
}
string ,
}
,
]
,
jitSchedulingPolicy:
{
Description: The JIT request properties. ,
Required: True ,
}
{
type:
{
Description: The type of JIT schedule. ,
Enum:
{
NotSpecified: No description available. ,
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: True ,
}
enum ,
duration:
{
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the request. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The JIT request provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
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 ,
jitRequestState:
{
Description: The JIT request state. ,
Enum:
{
NotSpecified: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
jitRequests_CreateOrUpdate (new)
Description :  Creates or updates the JIT request.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/jitRequests/{jitRequestName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
jitRequestName:
{
Description: The name of the JIT request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update JIT request. ,
Required: True ,
}
{
properties:
{
Description: The JIT request properties. ,
Required: False ,
}
{
applicationResourceId:
{
Description: The parent application id. ,
Required: True ,
}
string ,
publisherTenantId:
{
Description: The publisher tenant id. ,
Required: False ,
}
string ,
jitAuthorizationPolicies:
{
Description: The JIT authorization policies. ,
Required: True ,
}
[
{
principalId:
{
Description: The the principal id that will be granted JIT access. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The role definition id that will be granted to the Principal. ,
Required: True ,
}
string ,
}
,
]
,
jitSchedulingPolicy:
{
Description: The JIT request properties. ,
Required: True ,
}
{
type:
{
Description: The type of JIT schedule. ,
Enum:
{
NotSpecified: No description available. ,
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: True ,
}
enum ,
duration:
{
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the request. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The JIT request provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
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 ,
jitRequestState:
{
Description: The JIT request state. ,
Enum:
{
NotSpecified: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The JIT request properties. ,
Required: False ,
}
{
applicationResourceId:
{
Description: The parent application id. ,
Required: True ,
}
string ,
publisherTenantId:
{
Description: The publisher tenant id. ,
Required: False ,
}
string ,
jitAuthorizationPolicies:
{
Description: The JIT authorization policies. ,
Required: True ,
}
[
{
principalId:
{
Description: The the principal id that will be granted JIT access. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The role definition id that will be granted to the Principal. ,
Required: True ,
}
string ,
}
,
]
,
jitSchedulingPolicy:
{
Description: The JIT request properties. ,
Required: True ,
}
{
type:
{
Description: The type of JIT schedule. ,
Enum:
{
NotSpecified: No description available. ,
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: True ,
}
enum ,
duration:
{
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the request. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The JIT request provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
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 ,
jitRequestState:
{
Description: The JIT request state. ,
Enum:
{
NotSpecified: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The JIT request properties. ,
Required: False ,
}
{
applicationResourceId:
{
Description: The parent application id. ,
Required: True ,
}
string ,
publisherTenantId:
{
Description: The publisher tenant id. ,
Required: False ,
}
string ,
jitAuthorizationPolicies:
{
Description: The JIT authorization policies. ,
Required: True ,
}
[
{
principalId:
{
Description: The the principal id that will be granted JIT access. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The role definition id that will be granted to the Principal. ,
Required: True ,
}
string ,
}
,
]
,
jitSchedulingPolicy:
{
Description: The JIT request properties. ,
Required: True ,
}
{
type:
{
Description: The type of JIT schedule. ,
Enum:
{
NotSpecified: No description available. ,
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: True ,
}
enum ,
duration:
{
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the request. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The JIT request provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
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 ,
jitRequestState:
{
Description: The JIT request state. ,
Enum:
{
NotSpecified: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JitRequests_Update (new)
Description :  Updates the JIT request.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/jitRequests/{jitRequestName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
jitRequestName:
{
Description: The name of the JIT request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update JIT request. ,
Required: True ,
}
{
tags:
{
Description: Jit request tags ,
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 JIT request properties. ,
Required: False ,
}
{
applicationResourceId:
{
Description: The parent application id. ,
Required: True ,
}
string ,
publisherTenantId:
{
Description: The publisher tenant id. ,
Required: False ,
}
string ,
jitAuthorizationPolicies:
{
Description: The JIT authorization policies. ,
Required: True ,
}
[
{
principalId:
{
Description: The the principal id that will be granted JIT access. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The role definition id that will be granted to the Principal. ,
Required: True ,
}
string ,
}
,
]
,
jitSchedulingPolicy:
{
Description: The JIT request properties. ,
Required: True ,
}
{
type:
{
Description: The type of JIT schedule. ,
Enum:
{
NotSpecified: No description available. ,
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: True ,
}
enum ,
duration:
{
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the request. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The JIT request provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
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 ,
jitRequestState:
{
Description: The JIT request state. ,
Enum:
{
NotSpecified: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
jitRequests_Delete (new)
Description :  Deletes the JIT request.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/jitRequests/{jitRequestName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
jitRequestName:
{
Description: The name of the JIT request. ,
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 (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
jitRequests_ListBySubscription (new)
Description :  Retrieves all JIT requests within the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Solutions/jitRequests
{
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 Jit request definition. ,
Required: False ,
}
[
{
properties:
{
Description: The JIT request properties. ,
Required: False ,
}
{
applicationResourceId:
{
Description: The parent application id. ,
Required: True ,
}
string ,
publisherTenantId:
{
Description: The publisher tenant id. ,
Required: False ,
}
string ,
jitAuthorizationPolicies:
{
Description: The JIT authorization policies. ,
Required: True ,
}
[
{
principalId:
{
Description: The the principal id that will be granted JIT access. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The role definition id that will be granted to the Principal. ,
Required: True ,
}
string ,
}
,
]
,
jitSchedulingPolicy:
{
Description: The JIT request properties. ,
Required: True ,
}
{
type:
{
Description: The type of JIT schedule. ,
Enum:
{
NotSpecified: No description available. ,
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: True ,
}
enum ,
duration:
{
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the request. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The JIT request provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
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 ,
jitRequestState:
{
Description: The JIT request state. ,
Enum:
{
NotSpecified: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
jitRequests_ListByResourceGroup (new)
Description :  Retrieves all JIT requests within the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/jitRequests
{
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 Jit request definition. ,
Required: False ,
}
[
{
properties:
{
Description: The JIT request properties. ,
Required: False ,
}
{
applicationResourceId:
{
Description: The parent application id. ,
Required: True ,
}
string ,
publisherTenantId:
{
Description: The publisher tenant id. ,
Required: False ,
}
string ,
jitAuthorizationPolicies:
{
Description: The JIT authorization policies. ,
Required: True ,
}
[
{
principalId:
{
Description: The the principal id that will be granted JIT access. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The role definition id that will be granted to the Principal. ,
Required: True ,
}
string ,
}
,
]
,
jitSchedulingPolicy:
{
Description: The JIT request properties. ,
Required: True ,
}
{
type:
{
Description: The type of JIT schedule. ,
Enum:
{
NotSpecified: No description available. ,
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: True ,
}
enum ,
duration:
{
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the request. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The JIT request provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
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 ,
jitRequestState:
{
Description: The JIT request state. ,
Enum:
{
NotSpecified: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Applications_RefreshPermissions (new)
Description :  Refresh Permissions for application.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}/refreshPermissions
{
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)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ListOperations (removed)
Description :  Lists all of the available Microsoft.Solutions REST API operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of Microsoft.Solutions operations. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Solutions ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Application, JitRequest, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Localized friendly description for the operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
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 properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: False ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
}
,
plan:
{
Description: The plan information. ,
Required: False ,
}
{
name:
{
Description: The plan name. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product code. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
kind:
{
Description: The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
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 properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
boolean ,
authorizations:
{
Description: The managed application provider authorizations. ,
Required: False ,
}
[
{
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 definition artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ApplicationResourceTemplate: No description available. ,
CreateUiDefinition: No description available. ,
MainTemplateParameters: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application definition artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application definition artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
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 ,
storageAccountId:
{
Description: The storage account id for bring your own storage scenario. ,
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 ,
notificationPolicy:
{
Description: The managed application notification policy. ,
Required: False ,
}
{
notificationEndpoints:
{
Description: The managed application notification endpoint. ,
Required: True ,
}
[
{
uri:
{
Description: The managed application notification endpoint uri. ,
Required: True ,
}
string ,
}
,
]
,
}
,
lockingPolicy:
{
Description: The managed application locking policy. ,
Required: False ,
}
{
allowedActions:
{
Description: The deny assignment excluded actions. ,
Required: False ,
}
[
string ,
]
,
allowedDataActions:
{
Description: The deny assignment excluded data actions. ,
Required: False ,
}
[
string ,
]
,
}
,
deploymentPolicy:
{
Description: The managed application deployment policy. ,
Required: False ,
}
{
deploymentMode:
{
Description: The managed application deployment mode. ,
Enum:
{
NotSpecified: No description available. ,
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
managementPolicy:
{
Description: The managed application management policy that determines publisher's access to the managed resource group. ,
Required: False ,
}
{
mode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
policies:
{
Description: The managed application provider policies. ,
Required: False ,
}
[
{
name:
{
Description: The policy name ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The policy definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: The policy parameters. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
boolean ,
authorizations:
{
Description: The managed application provider authorizations. ,
Required: False ,
}
[
{
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 definition artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ApplicationResourceTemplate: No description available. ,
CreateUiDefinition: No description available. ,
MainTemplateParameters: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application definition artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application definition artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
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 ,
storageAccountId:
{
Description: The storage account id for bring your own storage scenario. ,
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 ,
notificationPolicy:
{
Description: The managed application notification policy. ,
Required: False ,
}
{
notificationEndpoints:
{
Description: The managed application notification endpoint. ,
Required: True ,
}
[
{
uri:
{
Description: The managed application notification endpoint uri. ,
Required: True ,
}
string ,
}
,
]
,
}
,
lockingPolicy:
{
Description: The managed application locking policy. ,
Required: False ,
}
{
allowedActions:
{
Description: The deny assignment excluded actions. ,
Required: False ,
}
[
string ,
]
,
allowedDataActions:
{
Description: The deny assignment excluded data actions. ,
Required: False ,
}
[
string ,
]
,
}
,
deploymentPolicy:
{
Description: The managed application deployment policy. ,
Required: False ,
}
{
deploymentMode:
{
Description: The managed application deployment mode. ,
Enum:
{
NotSpecified: No description available. ,
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
managementPolicy:
{
Description: The managed application management policy that determines publisher's access to the managed resource group. ,
Required: False ,
}
{
mode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
policies:
{
Description: The managed application provider policies. ,
Required: False ,
}
[
{
name:
{
Description: The policy name ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The policy definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: The policy parameters. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The 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 ,
}
boolean ,
authorizations:
{
Description: The managed application provider authorizations. ,
Required: False ,
}
[
{
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 definition artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ApplicationResourceTemplate: No description available. ,
CreateUiDefinition: No description available. ,
MainTemplateParameters: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application definition artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application definition artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
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 ,
storageAccountId:
{
Description: The storage account id for bring your own storage scenario. ,
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 ,
notificationPolicy:
{
Description: The managed application notification policy. ,
Required: False ,
}
{
notificationEndpoints:
{
Description: The managed application notification endpoint. ,
Required: True ,
}
[
{
uri:
{
Description: The managed application notification endpoint uri. ,
Required: True ,
}
string ,
}
,
]
,
}
,
lockingPolicy:
{
Description: The managed application locking policy. ,
Required: False ,
}
{
allowedActions:
{
Description: The deny assignment excluded actions. ,
Required: False ,
}
[
string ,
]
,
allowedDataActions:
{
Description: The deny assignment excluded data actions. ,
Required: False ,
}
[
string ,
]
,
}
,
deploymentPolicy:
{
Description: The managed application deployment policy. ,
Required: False ,
}
{
deploymentMode:
{
Description: The managed application deployment mode. ,
Enum:
{
NotSpecified: No description available. ,
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
managementPolicy:
{
Description: The managed application management policy that determines publisher's access to the managed resource group. ,
Required: False ,
}
{
mode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
policies:
{
Description: The managed application provider policies. ,
Required: False ,
}
[
{
name:
{
Description: The policy name ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The policy definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: The policy parameters. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ 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 ,
}
boolean ,
authorizations:
{
Description: The managed application provider authorizations. ,
Required: False ,
}
[
{
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 definition artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ApplicationResourceTemplate: No description available. ,
CreateUiDefinition: No description available. ,
MainTemplateParameters: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application definition artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application definition artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
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 ,
storageAccountId:
{
Description: The storage account id for bring your own storage scenario. ,
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 ,
notificationPolicy:
{
Description: The managed application notification policy. ,
Required: False ,
}
{
notificationEndpoints:
{
Description: The managed application notification endpoint. ,
Required: True ,
}
[
{
uri:
{
Description: The managed application notification endpoint uri. ,
Required: True ,
}
string ,
}
,
]
,
}
,
lockingPolicy:
{
Description: The managed application locking policy. ,
Required: False ,
}
{
allowedActions:
{
Description: The deny assignment excluded actions. ,
Required: False ,
}
[
string ,
]
,
allowedDataActions:
{
Description: The deny assignment excluded data actions. ,
Required: False ,
}
[
string ,
]
,
}
,
deploymentPolicy:
{
Description: The managed application deployment policy. ,
Required: False ,
}
{
deploymentMode:
{
Description: The managed application deployment mode. ,
Enum:
{
NotSpecified: No description available. ,
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
managementPolicy:
{
Description: The managed application management policy that determines publisher's access to the managed resource group. ,
Required: False ,
}
{
mode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
policies:
{
Description: The managed application provider policies. ,
Required: False ,
}
[
{
name:
{
Description: The policy name ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The policy definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: The policy parameters. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
boolean ,
authorizations:
{
Description: The managed application provider authorizations. ,
Required: False ,
}
[
{
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 definition artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ApplicationResourceTemplate: No description available. ,
CreateUiDefinition: No description available. ,
MainTemplateParameters: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application definition artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application definition artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
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 ,
storageAccountId:
{
Description: The storage account id for bring your own storage scenario. ,
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 ,
notificationPolicy:
{
Description: The managed application notification policy. ,
Required: False ,
}
{
notificationEndpoints:
{
Description: The managed application notification endpoint. ,
Required: True ,
}
[
{
uri:
{
Description: The managed application notification endpoint uri. ,
Required: True ,
}
string ,
}
,
]
,
}
,
lockingPolicy:
{
Description: The managed application locking policy. ,
Required: False ,
}
{
allowedActions:
{
Description: The deny assignment excluded actions. ,
Required: False ,
}
[
string ,
]
,
allowedDataActions:
{
Description: The deny assignment excluded data actions. ,
Required: False ,
}
[
string ,
]
,
}
,
deploymentPolicy:
{
Description: The managed application deployment policy. ,
Required: False ,
}
{
deploymentMode:
{
Description: The managed application deployment mode. ,
Enum:
{
NotSpecified: No description available. ,
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
managementPolicy:
{
Description: The managed application management policy that determines publisher's access to the managed resource group. ,
Required: False ,
}
{
mode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
policies:
{
Description: The managed application provider policies. ,
Required: False ,
}
[
{
name:
{
Description: The policy name ,
Required: False ,
}
string ,
policyDefinitionId:
{
Description: The policy definition Id. ,
Required: False ,
}
string ,
parameters:
{
Description: The policy parameters. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The managed application properties. ,
Required: True ,
}
{
managedResourceGroupId:
{
Description: The managed resource group Id. ,
Required: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
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: False ,
}
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:
{
NotSpecified: No description available. ,
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 ,
billingDetails:
{
Description: The managed application billing details. ,
Required: False ,
}
{
resourceUsageId:
{
Description: The managed application resource usage Id. ,
Required: False ,
}
string ,
}
,
jitAccessPolicy:
{
Description: The managed application Jit access policy. ,
Required: False ,
}
{
jitAccessEnabled:
{
Description: Whether the JIT access is enabled. ,
Required: True ,
}
boolean ,
jitApprovalMode:
{
Description: JIT approval mode. ,
Enum:
{
NotSpecified: No description available. ,
AutoApprove: No description available. ,
ManualApprove: No description available. ,
}
,
Required: False ,
}
enum ,
jitApprovers:
{
Description: The JIT approvers ,
Required: False ,
}
[
{
id:
{
Description: The approver service principal Id. ,
Required: True ,
}
string ,
type:
{
Description: The approver type. ,
Enum:
{
user: No description available. ,
group: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The approver display name. ,
Required: False ,
}
string ,
}
,
]
,
maximumJitAccessDuration:
{
Description: The maximum duration JIT access is granted. This is an ISO8601 time period value. ,
Required: False ,
}
string ,
}
,
publisherTenantId:
{
Description: The publisher tenant Id. ,
Required: False ,
}
string ,
authorizations:
{
Description: The read-only authorizations property that is retrieved from the application package. ,
Required: False ,
}
[
{
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 ,
}
,
]
,
managementMode:
{
Description: The managed application management mode. ,
Enum:
{
NotSpecified: No description available. ,
Unmanaged: No description available. ,
Managed: No description available. ,
}
,
Required: False ,
}
enum ,
customerSupport:
{
Description: The read-only customer support property that is retrieved from the application package. ,
Required: False ,
}
{
contactName:
{
Description: The contact name. ,
Required: False ,
}
string ,
email:
{
Description: The contact email. ,
Required: True ,
}
string ,
phone:
{
Description: The contact phone number. ,
Required: True ,
}
string ,
}
,
supportUrls:
{
Description: The read-only support URLs property that is retrieved from the application package. ,
Required: False ,
}
{
publicAzure:
{
Description: The public azure support URL. ,
Required: False ,
}
string ,
governmentCloud:
{
Description: The government cloud support URL. ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: The collection of managed application artifacts. ,
Required: False ,
}
[
{
name:
{
Description: The managed application artifact name. ,
Enum:
{
NotSpecified: No description available. ,
ViewDefinition: No description available. ,
Authorizations: No description available. ,
CustomRoleDefinition: No description available. ,
}
,
Required: True ,
}
enum ,
uri:
{
Description: The managed application artifact blob uri. ,
Required: True ,
}
string ,
type:
{
Description: The managed application artifact type. ,
Enum:
{
NotSpecified: No description available. ,
Template: No description available. ,
Custom: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
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 ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JitRequests_Get (removed)
Description :  Gets the JIT request.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/jitRequests/{jitRequestName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
jitRequestName:
{
Description: The name of the JIT request. ,
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 JIT request properties. ,
Required: False ,
}
{
applicationResourceId:
{
Description: The parent application id. ,
Required: True ,
}
string ,
publisherTenantId:
{
Description: The publisher tenant id. ,
Required: False ,
}
string ,
jitAuthorizationPolicies:
{
Description: The JIT authorization policies. ,
Required: True ,
}
[
{
principalId:
{
Description: The the principal id that will be granted JIT access. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The role definition id that will be granted to the Principal. ,
Required: True ,
}
string ,
}
,
]
,
jitSchedulingPolicy:
{
Description: The JIT request properties. ,
Required: True ,
}
{
type:
{
Description: The type of JIT schedule. ,
Enum:
{
NotSpecified: No description available. ,
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: True ,
}
enum ,
duration:
{
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the request. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The JIT request provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
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 ,
jitRequestState:
{
Description: The JIT request state. ,
Enum:
{
NotSpecified: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
jitRequests_CreateOrUpdate (removed)
Description :  Creates or updates the JIT request.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/jitRequests/{jitRequestName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
jitRequestName:
{
Description: The name of the JIT request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update JIT request. ,
Required: True ,
}
{
properties:
{
Description: The JIT request properties. ,
Required: False ,
}
{
applicationResourceId:
{
Description: The parent application id. ,
Required: True ,
}
string ,
publisherTenantId:
{
Description: The publisher tenant id. ,
Required: False ,
}
string ,
jitAuthorizationPolicies:
{
Description: The JIT authorization policies. ,
Required: True ,
}
[
{
principalId:
{
Description: The the principal id that will be granted JIT access. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The role definition id that will be granted to the Principal. ,
Required: True ,
}
string ,
}
,
]
,
jitSchedulingPolicy:
{
Description: The JIT request properties. ,
Required: True ,
}
{
type:
{
Description: The type of JIT schedule. ,
Enum:
{
NotSpecified: No description available. ,
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: True ,
}
enum ,
duration:
{
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the request. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The JIT request provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
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 ,
jitRequestState:
{
Description: The JIT request state. ,
Enum:
{
NotSpecified: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The JIT request properties. ,
Required: False ,
}
{
applicationResourceId:
{
Description: The parent application id. ,
Required: True ,
}
string ,
publisherTenantId:
{
Description: The publisher tenant id. ,
Required: False ,
}
string ,
jitAuthorizationPolicies:
{
Description: The JIT authorization policies. ,
Required: True ,
}
[
{
principalId:
{
Description: The the principal id that will be granted JIT access. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The role definition id that will be granted to the Principal. ,
Required: True ,
}
string ,
}
,
]
,
jitSchedulingPolicy:
{
Description: The JIT request properties. ,
Required: True ,
}
{
type:
{
Description: The type of JIT schedule. ,
Enum:
{
NotSpecified: No description available. ,
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: True ,
}
enum ,
duration:
{
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the request. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The JIT request provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
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 ,
jitRequestState:
{
Description: The JIT request state. ,
Enum:
{
NotSpecified: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The JIT request properties. ,
Required: False ,
}
{
applicationResourceId:
{
Description: The parent application id. ,
Required: True ,
}
string ,
publisherTenantId:
{
Description: The publisher tenant id. ,
Required: False ,
}
string ,
jitAuthorizationPolicies:
{
Description: The JIT authorization policies. ,
Required: True ,
}
[
{
principalId:
{
Description: The the principal id that will be granted JIT access. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The role definition id that will be granted to the Principal. ,
Required: True ,
}
string ,
}
,
]
,
jitSchedulingPolicy:
{
Description: The JIT request properties. ,
Required: True ,
}
{
type:
{
Description: The type of JIT schedule. ,
Enum:
{
NotSpecified: No description available. ,
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: True ,
}
enum ,
duration:
{
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the request. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The JIT request provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
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 ,
jitRequestState:
{
Description: The JIT request state. ,
Enum:
{
NotSpecified: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JitRequests_Update (removed)
Description :  Updates the JIT request.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/jitRequests/{jitRequestName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
jitRequestName:
{
Description: The name of the JIT request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update JIT request. ,
Required: True ,
}
{
tags:
{
Description: Jit request tags ,
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 JIT request properties. ,
Required: False ,
}
{
applicationResourceId:
{
Description: The parent application id. ,
Required: True ,
}
string ,
publisherTenantId:
{
Description: The publisher tenant id. ,
Required: False ,
}
string ,
jitAuthorizationPolicies:
{
Description: The JIT authorization policies. ,
Required: True ,
}
[
{
principalId:
{
Description: The the principal id that will be granted JIT access. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The role definition id that will be granted to the Principal. ,
Required: True ,
}
string ,
}
,
]
,
jitSchedulingPolicy:
{
Description: The JIT request properties. ,
Required: True ,
}
{
type:
{
Description: The type of JIT schedule. ,
Enum:
{
NotSpecified: No description available. ,
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: True ,
}
enum ,
duration:
{
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the request. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The JIT request provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
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 ,
jitRequestState:
{
Description: The JIT request state. ,
Enum:
{
NotSpecified: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
jitRequests_Delete (removed)
Description :  Deletes the JIT request.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/jitRequests/{jitRequestName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
jitRequestName:
{
Description: The name of the JIT request. ,
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 (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
jitRequests_ListBySubscription (removed)
Description :  Retrieves all JIT requests within the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Solutions/jitRequests
{
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 Jit request definition. ,
Required: False ,
}
[
{
properties:
{
Description: The JIT request properties. ,
Required: False ,
}
{
applicationResourceId:
{
Description: The parent application id. ,
Required: True ,
}
string ,
publisherTenantId:
{
Description: The publisher tenant id. ,
Required: False ,
}
string ,
jitAuthorizationPolicies:
{
Description: The JIT authorization policies. ,
Required: True ,
}
[
{
principalId:
{
Description: The the principal id that will be granted JIT access. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The role definition id that will be granted to the Principal. ,
Required: True ,
}
string ,
}
,
]
,
jitSchedulingPolicy:
{
Description: The JIT request properties. ,
Required: True ,
}
{
type:
{
Description: The type of JIT schedule. ,
Enum:
{
NotSpecified: No description available. ,
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: True ,
}
enum ,
duration:
{
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the request. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The JIT request provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
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 ,
jitRequestState:
{
Description: The JIT request state. ,
Enum:
{
NotSpecified: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
jitRequests_ListByResourceGroup (removed)
Description :  Retrieves all JIT requests within the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/jitRequests
{
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 Jit request definition. ,
Required: False ,
}
[
{
properties:
{
Description: The JIT request properties. ,
Required: False ,
}
{
applicationResourceId:
{
Description: The parent application id. ,
Required: True ,
}
string ,
publisherTenantId:
{
Description: The publisher tenant id. ,
Required: False ,
}
string ,
jitAuthorizationPolicies:
{
Description: The JIT authorization policies. ,
Required: True ,
}
[
{
principalId:
{
Description: The the principal id that will be granted JIT access. ,
Required: True ,
}
string ,
roleDefinitionId:
{
Description: The role definition id that will be granted to the Principal. ,
Required: True ,
}
string ,
}
,
]
,
jitSchedulingPolicy:
{
Description: The JIT request properties. ,
Required: True ,
}
{
type:
{
Description: The type of JIT schedule. ,
Enum:
{
NotSpecified: No description available. ,
Once: No description available. ,
Recurring: No description available. ,
}
,
Required: True ,
}
enum ,
duration:
{
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the request. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: The JIT request provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
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 ,
jitRequestState:
{
Description: The JIT request state. ,
Enum:
{
NotSpecified: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
createdBy:
{
Description: The client entity that created the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
updatedBy:
{
Description: The client entity that last updated the JIT request. ,
Required: False ,
}
{
oid:
{
Description: The client Oid. ,
Required: False ,
}
string ,
puid:
{
Description: The client Puid ,
Required: False ,
}
string ,
applicationId:
{
Description: The client application Id. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Applications_RefreshPermissions (removed)
Description :  Refresh Permissions for application.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}/refreshPermissions
{
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)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}