Microsoft Azure Application API
The Application API from Microsoft Azure — 24 operation(s) for application.
Microsoft Azure Application API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Application. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.
This API exposes 35 operations across 24 paths, and defines 133 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.
35 operations
24 paths
133 schemas
4 DELETE14 GET3 PATCH12 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 35
Across 24 paths, the API surfaces 35 operations — 4 DELETE, 14 GET, 3 PATCH, 12 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Application 35
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications Applicationname
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications Applicationname
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications Applicationname
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications Applicationname
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Applicationgroups Applicationgroupname Applications Applicationname
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Applicationgroups Applicationgroupname Applications Applicationname
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Applicationgroups Applicationgroupname Applications Applicationname
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Applicationgroups Applicationgroupname Applications Applicationname
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Applicationgroups Applicationgroupname Applications
POST
/{tenantID}/applications
Microsoft Azure Post Tenantid Applications
GET
/{tenantID}/applications
Microsoft Azure Get Tenantid Applications
DELETE
/{tenantID}/deletedApplications/{applicationObjectId}
Microsoft Azure Delete Tenantid Deletedapplications Applicationobjectid
DELETE
/{tenantID}/applications/{applicationObjectId}
Microsoft Azure Delete Tenantid Applications Applicationobjectid
GET
/{tenantID}/applications/{applicationObjectId}
Microsoft Azure Get Tenantid Applications Applicationobjectid
PATCH
/{tenantID}/applications/{applicationObjectId}
Microsoft Azure Patch Tenantid Applications Applicationobjectid
POST
/Applications/$/Create
Microsoft Azure Creates A Service Fabric Application
POST
/Applications/{applicationId}/$/Delete
Microsoft Azure Deletes An Existing Service Fabric Application
GET
/Applications/{applicationId}/$/GetLoadInformation
Microsoft Azure Gets Load Information About A Service Fabric Application
GET
/Applications
Microsoft Azure Gets The List Of Applications Created In The Service Fabric Cluster That Match The Specified Filters
GET
/Applications/{applicationId}
Microsoft Azure Gets Information About A Service Fabric Application
GET
/Applications/{applicationId}/$/GetHealth
Microsoft Azure Gets The Health Of The Service Fabric Application
POST
/Applications/{applicationId}/$/GetHealth
Microsoft Azure Gets The Health Of A Service Fabric Application Using The Specified Policy
POST
/Applications/{applicationId}/$/ReportHealth
Microsoft Azure Sends A Health Report On The Service Fabric Application
POST
/Applications/{applicationId}/$/Upgrade
Microsoft Azure Starts Upgrading An Application In The Service Fabric Cluster
GET
/Applications/{applicationId}/$/GetUpgradeProgress
Microsoft Azure Gets Details For The Latest Upgrade Performed On This Application
POST
/Applications/{applicationId}/$/UpdateUpgrade
Microsoft Azure Updates An Ongoing Application Upgrade In The Service Fabric Cluster
POST
/Applications/{applicationId}/$/Update
Microsoft Azure Updates A Service Fabric Application
POST
/Applications/{applicationId}/$/MoveToNextUpgradeDomain
Microsoft Azure Resumes Upgrading An Application In The Service Fabric Cluster
POST
/Applications/{applicationId}/$/RollbackUpgrade
Microsoft Azure Starts Rolling Back The Currently On Going Upgrade Of An Application In The Service Fabric Cluster
GET
/Nodes/{nodeName}/$/GetApplications
Microsoft Azure Gets The List Of Applications Deployed On A Service Fabric Node
GET
/Nodes/{nodeName}/$/GetApplications/{applicationId}
Microsoft Azure Gets The Information About An Application Deployed On A Service Fabric Node
GET
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth
Microsoft Azure Gets The Information About Health Of An Application Deployed On A Service Fabric Node
POST
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth
Microsoft Azure Gets The Information About Health Of An Application Deployed On A Service Fabric Node Using The Specified Policy
POST
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/ReportHealth
Microsoft Azure Sends A Health Report On The Service Fabric Application Deployed On A Service Fabric Node
Schemas 133
The contract defines 133 schemas that model the data the API accepts and returns. The most detailed are Application_4 (32 properties), ApplicationBase (29 properties), ApplicationUpgradeProgressInfo (20 properties), ApplicationProperties_3 (14 properties). Each schema is shown below with its type and property counts.
DeployedServicePackageHealthStateList
array
List of health states for a service package deployed on a Service Fabric node.
UpgradeDomainTimeout
string
The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration.…
ErrorMessage
object
Active Directory error message.
1 property
SafetyCheckWrapper
object
A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availabilit…
1 property
ApplicationCreateParameters
object
Request parameters for creating a new application.
2 properties
1 required
ServiceHealthState
object
Represents the health state of a service, which contains the service identifier and its aggregated health state.
1 property
EntityKind
string
The entity type of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
NodeUpgradeProgressInfoList
array
List of upgrading nodes and their statuses
PagedApplicationInfoList
object
The list of applications in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by e…
2 properties
ApplicationProperties
object
The properties associated with the Application.
3 properties
FabricErrorError
object
Error object containing error code and error message.
2 properties
1 required
TargetApplicationName
string
The name of the target application, including the 'fabric:' URI scheme.
ManagedApplicationIdentityList
array
A list of managed application identity objects.
OAuth2Permission
object
Represents an OAuth 2.0 delegated permission scope. The specified OAuth 2.0 delegated permission scopes may be requested by client applications (through the re…
8 properties
ApplicationProperties_3
object
Schema for Application properties.
14 properties
1 required
ServiceTypeHealthPolicyMap
array
Defines a ServiceTypeHealthPolicy per service type name. The entries in the map replace the default service type health policy for each specified service type.…
ApplicationUpdateParameters
object
Request parameters for updating a new application.
2 properties
ApplicationLoadMetricInformation
object
Describes load information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this appli…
4 properties
ApplicationUpgradeProgressInfo
object
Describes the parameters for an application upgrade.
20 properties
ApplicationParameterList
array
List of application parameters with overridden values from their default values specified in the application manifest.
TargetApplicationTypeVersion
string
The target application type version (found in the application manifest) for the application upgrade.
NodeUpgradeDurationString
string
The estimated time spent processing the node since it was deactivated during a node-by-node upgrade.
PreAuthorizedApplication
object
Contains information about pre authorized client application.
3 properties
ApplicationList
object
List of Application definitions.
2 properties
CloudErrorProperties
object
Cloud error object properties.
2 properties
CurrentUpgradeDomainName
string
The name of the upgrade domain. Not applicable to node-by-node upgrades.
CloudError
object
An error response from the Batch service.
1 property
ApplicationBase
object
Active Directive Application common properties shared among GET, POST and PATCH
29 properties
HealthEvaluation
object
Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
3 properties
1 required
ApplicationUpdateDescription
object
Describes the parameters for updating an application instance.
5 properties
UpgradeUnitState
string
The state of the upgrade unit.
EntityHealth
object
Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.
4 properties
PagedDeployedApplicationInfoList
object
The list of deployed applications in activating, downloading, or active states on a node. The list is paged when all of the results cannot fit in a single mess…
2 properties
SafetyCheck
object
Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliab…
1 property
1 required
DirectoryObject
object
Represents an Azure Active Directory object.
3 properties
1 required
HealthStateCount
object
Represents information about how many health entities are in Ok, Warning and Error health state.
3 properties
AppRole
object
6 properties
PreAuthorizedApplicationPermission
object
Contains information about the pre-authorized permissions.
2 properties
ApplicationPatchProperties
object
Application properties that can be patched.
11 properties
UpgradeTimeout
string
The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration.…
SafetyCheckInfoList
array
List of pending safety checks
DeployedApplicationInfo
object
Information about application deployed on the node.
9 properties
Application_3
object
Schema for Application properties.
2 properties
1 required
ForceRestart
boolean
If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
PasswordCredential
object
Active Directory Password Credential information.
5 properties
ApplicationId
string
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.…
Application
object
Contains information about an application in a Batch account.
1 property
HealthStatistics
object
The health statistics of an entity, returned as part of the health query result when the query description is configured to include statistics. The statistics…
1 property
DeployedApplicationHealthState
object
Represents the health state of a deployed application, which contains the entity identifier and the aggregated health state.
2 properties
ServiceTypeHealthPolicy
object
Represents the health policy used to evaluate the health of services belonging to a service type.
3 properties
ResourceAccess
object
Specifies an OAuth 2.0 permission scope or an app role that an application requires. The resourceAccess property of the RequiredResourceAccess type is a collec…
2 properties
1 required
UpgradeUnitInfoList
array
List of upgrade units and their statuses.
ApplicationInfo
object
Information about a Service Fabric application.
9 properties
PreAuthorizedApplicationExtension
object
Representation of an app PreAuthorizedApplicationExtension required by a pre authorized client app.
1 property
ServiceManifestName
string
The name of the service manifest.
HealthInformation
object
Represents common health report information. It is included in all health reports sent to health store and in all health events returned by health queries.
8 properties
3 required
NodeUpgradeProgressInfo
object
Information about the upgrading node and its status
4 properties
DeployedApplicationStatus
string
The status of the application deployed on the node. Following are the possible values.
ApplicationListResult
object
Application list operation result.
2 properties
ManagedApplicationIdentity
object
Describes a managed application identity.
2 properties
1 required
RollingUpgradeUpdateDescription
object
Describes the parameters for updating a rolling upgrade of application or cluster.
10 properties
1 required
UpgradeUnitName
string
The name of the upgrade unit
ApplicationDefinitionKind
string
The mechanism used to define a Service Fabric application.
HealthCheckWaitDuration
string
The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 dur…
UpgradeDomainState
string
The state of the upgrade domain.
UpgradeUnitInfo
object
Information about an upgrade unit.
2 properties
SafetyCheckKind
string
The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliabi…
RequiredResourceAccess
object
Specifies the set of OAuth 2.0 permission scopes and app roles under the specified resource that an application requires access to. The specified OAuth 2.0 per…
2 properties
1 required
ApplicationStatus
string
The status of the application.
UnhealthyEvaluations
array
List of health evaluations that resulted in the current aggregated health state.
CloudError_3
object
Cloud error object.
1 property
ApplicationHealthPolicy
object
Defines a health policy used to evaluate the health of an application or one of its children entities.
4 properties
DeployedApplicationHealth
object
Information about the health of an application deployed on a Service Fabric node.
3 properties
InstanceCloseDelayDurationInSeconds
integer
Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance…
GraphError
object
Active Directory error information.
1 property
FailureReason
string
The cause of an upgrade failure that resulted in FailureAction being executed.
OptionalClaim
object
Specifying the claims to be included in a token.
4 properties
HealthEvaluationWrapper
object
Wrapper object for health evaluation.
1 property
OptionalClaims
object
Specifying the claims to be included in the token.
3 properties
Application_4
object
Active Directory application information.
32 properties
UpgradeKind
string
The kind of upgrade out of the following possible values.
ServicePackageActivationId
string
The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is n…
UpgradeReplicaSetCheckTimeout
integer
The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expire…
DeployedServicePackageHealthState
object
Represents the health state of a deployed service package, containing the entity identifier and the aggregated health state.
4 properties
FailureAction
string
The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is i…
ApplicationUpgradeDescription
object
Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parame…
12 properties
3 required
UpgradeState
string
The state of the upgrade domain.
InformationalUrl
object
Represents a group of URIs that provide terms of service, marketing, support and privacy policy information about an application. The default value for each st…
4 properties
ServiceName
string
The full name of the service with 'fabric:' URI scheme.
ContinuationToken
string
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the…
ApplicationName
string
The name of the application, including the 'fabric:' URI scheme.
ApplicationMetricDescription
object
Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this a…
4 properties
ApplicationDescription
object
Describes a Service Fabric application.
6 properties
3 required
MonitoringPolicyDescription
object
Describes the parameters for monitoring an upgrade in Monitored mode.
6 properties
NextUpgradeDomain
string
The name of the next upgrade domain to be processed. Not applicable to node-by-node upgrades.
ApplicationLoadMetricInformationList
array
List of application load metric information.
FailureUpgradeDomainProgressInfo
object
Information about the upgrade domain progress at the time of upgrade failure.
2 properties
HealthState
string
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
ServiceTypeHealthPolicyMapItem
object
Defines an item in ServiceTypeHealthPolicyMap.
2 properties
2 required
NodeUpgradePhase
string
The state of the upgrading node.
EntityKindHealthStateCount
object
Represents health state count for entities of the specified entity kind.
2 properties
FabricError
object
The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API…
1 property
1 required
ManagedApplicationIdentityDescription
object
Managed application identity description.
2 properties
ApplicationPatch
object
Application properties that can be patched.
2 properties
HealthEvaluationKind
string
The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on…
ApplicationTypeName
string
The application type name as defined in the application manifest.
HealthCheckRetryTimeout
string
The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a strin…
ApplicationTypeVersion
string
The version of the application type as defined in the application manifest.
UpgradeMode
string
The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.
UpgradeDomainInfoList
array
List of upgrade domains and their statuses. Not applicable to node-by-node upgrades.
ApplicationMetricDescriptionList
array
List of application capacity metric description.
KeyCredential
object
Active Directory Key Credential information.
7 properties
ApplicationCapacityDescription
object
Describes capacity information for services of this application. This description can be used for describing the following. - Reserving the capacity for the se…
3 properties
CurrentUpgradeDomainProgressInfo
object
Information about the current in-progress upgrade domain. Not applicable to node-by-node upgrades.
2 properties
FabricErrorCodes
string
Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are…
ApplicationHealth
object
Represents the health of the application. Contains the application aggregated health state and the service and deployed application health states.
3 properties
NodeName
string
The name of a Service Fabric node.
EntityHealthState
object
A base type for the health state of various entities in the cluster. It contains the aggregated health state.
1 property
ApplicationParameter
object
Describes an application parameter override to be applied when creating or upgrading an application.
2 properties
2 required
HealthEvent
object
Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.
6 properties
ProxyResource
object
A definition of an Azure resource.
4 properties
CurrentUpgradeUnitsProgressInfo
object
Information about the current in-progress upgrade units.
2 properties
UpgradeDomainInfo
object
Information about an upgrade domain.
2 properties
ListApplicationsResult
object
The result of performing list applications.
2 properties
UpgradeSortOrder
string
Defines the order in which an upgrade proceeds through the cluster.
HealthCheckStableDuration
string
The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a str…
ApplicationUpgradeUpdateDescription
object
Describes the parameters for updating an ongoing application upgrade.
4 properties
2 required
CloudErrorBody
object
An error response from the Batch service.
4 properties
OdataError
object
Active Directory OData error information.
2 properties
ApplicationLoadInfo
object
Load Information about a Service Fabric application.
5 properties
GroupMembershipClaims
string
Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects.
ResumeApplicationUpgradeDescription
object
Describes the parameters for resuming an unmonitored manual Service Fabric application upgrade
1 property
1 required
UpgradeDomainName
string
The name of the upgrade domain
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Microsoft Azure 12
Other APIs Microsoft Azure publishes across the network.
Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
#Application
Where this information came from
This is an independent, third-party profile of Microsoft Azure Application API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.