Applications - Get By Id

Service:

Managed Applications

API Version:

2019-07-01

Gets the managed application.

GET https://management.azure.com/{applicationId}?api-version=2019-07-01

URI Parameters

Name	In	Required	Type	Description
applicationId	path	True	string	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}
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	Application	OK - Returns the managed application.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Definitions

Name	Description
Application	Information about managed application.
ApplicationArtifact	Managed application artifact.
ApplicationArtifactName	The managed application artifact name.
ApplicationArtifactType	The managed application artifact type.
ApplicationAuthorization	The managed application provider authorization.
ApplicationBillingDetailsDefinition	Managed application billing details definition.
ApplicationClientDetails	The application client details to track the entity creating/updating the managed app resource.
ApplicationJitAccessPolicy	Managed application Jit access policy.
ApplicationManagementMode	The management mode.
ApplicationPackageContact	The application package contact information.
ApplicationPackageSupportUrls	The appliance package support URLs.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Identity	Identity for the resource.
JitApprovalMode	The Jit approval mode.
JitApproverDefinition	JIT approver definition.
JitApproverType	The approver type.
Plan	Plan for the managed application.
ProvisioningState	Provisioning status of the managed application.
ResourceIdentityType	The identity type.
Sku	SKU for the resource.
userAssignedResourceIdentity	Represents the user assigned identity that is contained within the UserAssignedIdentities dictionary on ResourceIdentity

Application

Object

Information about managed application.

Name	Type	Description
id	string	Resource ID
identity	Identity	The identity of the resource.
kind	string pattern: ^[-\w\._,\(\)]+$	The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog.
location	string	Resource location
managedBy	string	ID of the resource that manages this resource.
name	string	Resource name
plan	Plan	The plan information.
properties.applicationDefinitionId	string	The fully qualified path of managed application definition Id.
properties.artifacts	ApplicationArtifact[]	The collection of managed application artifacts.
properties.authorizations	ApplicationAuthorization[]	The read-only authorizations property that is retrieved from the application package.
properties.billingDetails	ApplicationBillingDetailsDefinition	The managed application billing details.
properties.createdBy	ApplicationClientDetails	The client entity that created the JIT request.
properties.customerSupport	ApplicationPackageContact	The read-only customer support property that is retrieved from the application package.
properties.jitAccessPolicy	ApplicationJitAccessPolicy	The managed application Jit access policy.
properties.managedResourceGroupId	string	The managed resource group Id.
properties.managementMode	ApplicationManagementMode	The managed application management mode.
properties.outputs	object	Name and value pairs that define the managed application outputs.
properties.parameters	object	Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string.
properties.provisioningState	ProvisioningState	The managed application provisioning state.
properties.publisherTenantId	string	The publisher tenant Id.
properties.supportUrls	ApplicationPackageSupportUrls	The read-only support URLs property that is retrieved from the application package.
properties.updatedBy	ApplicationClientDetails	The client entity that last updated the JIT request.
sku	Sku	The SKU of the resource.
tags	object	Resource tags
type	string	Resource type

ApplicationArtifact

Object

Managed application artifact.

Name	Type	Description
name	ApplicationArtifactName	The managed application artifact name.
type	ApplicationArtifactType	The managed application artifact type.
uri	string	The managed application artifact blob uri.

ApplicationArtifactName

Enumeration

The managed application artifact name.

Value	Description
NotSpecified
ViewDefinition
Authorizations
CustomRoleDefinition

ApplicationArtifactType

Enumeration

The managed application artifact type.

Value	Description
NotSpecified
Template
Custom

ApplicationAuthorization

Object

The managed application provider authorization.

Name	Type	Description
principalId	string	The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the managed application resources.
roleDefinitionId	string	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.

ApplicationBillingDetailsDefinition

Object

Managed application billing details definition.

Name	Type	Description
resourceUsageId	string	The managed application resource usage Id.

ApplicationClientDetails

Object

The application client details to track the entity creating/updating the managed app resource.

Name	Type	Description
applicationId	string	The client application Id.
oid	string	The client Oid.
puid	string	The client Puid

ApplicationJitAccessPolicy

Object

Managed application Jit access policy.

Name	Type	Description
jitAccessEnabled	boolean	Whether the JIT access is enabled.
jitApprovalMode	JitApprovalMode	JIT approval mode.
jitApprovers	JitApproverDefinition[]	The JIT approvers
maximumJitAccessDuration	string	The maximum duration JIT access is granted. This is an ISO8601 time period value.

ApplicationManagementMode

Enumeration

The management mode.

Value	Description
NotSpecified
Unmanaged
Managed

ApplicationPackageContact

Object

The application package contact information.

Name	Type	Description
contactName	string	The contact name.
email	string	The contact email.
phone	string	The contact phone number.

ApplicationPackageSupportUrls

Object

The appliance package support URLs.

Name	Type	Description
governmentCloud	string	The government cloud support URL.
publicAzure	string	The public azure support URL.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Identity

Object

Identity for the resource.

Name	Type	Description
principalId	string	The principal ID of resource identity.
tenantId	string	The tenant ID of resource.
type	ResourceIdentityType	The identity type.
userAssignedIdentities	<string,  userAssignedResourceIdentity>	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}'.

JitApprovalMode

Enumeration

The Jit approval mode.

Value	Description
NotSpecified
AutoApprove
ManualApprove

JitApproverDefinition

Object

JIT approver definition.

Name	Type	Description
displayName	string	The approver display name.
id	string	The approver service principal Id.
type	JitApproverType	The approver type.

JitApproverType

Enumeration

The approver type.

Value	Description
user
group

Plan

Object

Plan for the managed application.

Name	Type	Description
name	string	The plan name.
product	string	The product code.
promotionCode	string	The promotion code.
publisher	string	The publisher ID.
version	string	The plan's version.

ProvisioningState

Enumeration

Provisioning status of the managed application.

Value	Description
NotSpecified
Accepted
Running
Ready
Creating
Created
Deleting
Deleted
Canceled
Failed
Succeeded
Updating

ResourceIdentityType

Enumeration

The identity type.

Value	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

Sku

Object

SKU for the resource.

Name	Type	Description
capacity	integer (int32)	The SKU capacity.
family	string	The SKU family.
model	string	The SKU model.
name	string	The SKU name.
size	string	The SKU size.
tier	string	The SKU tier.

userAssignedResourceIdentity

Object

Represents the user assigned identity that is contained within the UserAssignedIdentities dictionary on ResourceIdentity

Name	Type	Description
principalId	string	The principal id of user assigned identity.
tenantId	string	The tenant id of user assigned identity.