Microsoft Azure
Microsoft Azure Application API

The Application API from Microsoft Azure — 24 operation(s) for application.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Application API
schemes:
- https
tags:
- name: Application
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}
  : put:
      tags:
      - Application
      operationId: microsoftAzureApplicationCreate
      x-ms-examples:
        ApplicationCreate:
          $ref: ./examples/ApplicationCreate.json
      description: Adds an application to the specified Batch account.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/ApplicationNameParameter'
      - name: parameters
        in: body
        required: false
        schema:
          $ref: '#/definitions/Application'
        description: The parameters for the request.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains the application entity.
          schema:
            $ref: '#/definitions/Application'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications Applicationname
    delete:
      tags:
      - Application
      operationId: microsoftAzureApplicationDelete
      x-ms-examples:
        ApplicationDelete:
          $ref: ./examples/ApplicationDelete.json
      description: Deletes an application.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/ApplicationNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful.
        '204':
          description: The operation was successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications Applicationname
    get:
      tags:
      - Application
      operationId: microsoftAzureApplicationGet
      x-ms-examples:
        ApplicationGet:
          $ref: ./examples/ApplicationGet.json
      description: Gets information about the specified application.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/ApplicationNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains the application entity.
          schema:
            $ref: '#/definitions/Application'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications Applicationname
    patch:
      tags:
      - Application
      operationId: microsoftAzureApplicationUpdate
      x-ms-examples:
        ApplicationUpdate:
          $ref: ./examples/ApplicationUpdate.json
      description: Updates settings for the specified application.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/ApplicationNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/Application'
        description: The parameters for the request.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains the application entity.
          schema:
            $ref: '#/definitions/Application'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications Applicationname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications
  : get:
      tags:
      - Application
      operationId: microsoftAzureApplicationList
      x-ms-examples:
        ApplicationList:
          $ref: ./examples/ApplicationList.json
      description: Lists all of the applications in the specified account.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - name: maxresults
        in: query
        required: false
        type: integer
        format: int32
        description: The maximum number of items to return in the response.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains a list of the application entities associated with the specified account.
          schema:
            $ref: '#/definitions/ListApplicationsResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Applications
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
  : get:
      tags:
      - Application
      operationId: microsoftAzureApplicationsGet
      description: Get an application.
      x-ms-examples:
        Application_Get:
          $ref: ./examples/Application_Get.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ApplicationGroupNameParameter'
      - $ref: '#/parameters/ApplicationNameParameter_2'
      responses:
        '200':
          description: Successfully retrieved application.
          schema:
            $ref: '#/definitions/Application_3'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_3'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Applicationgroups Applicationgroupname Applications Applicationname
    put:
      tags:
      - Application
      operationId: microsoftAzureApplicationsCreateorupdate
      description: Create or update an application.
      x-ms-examples:
        Application_Create:
          $ref: ./examples/Application_Create.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ApplicationGroupNameParameter'
      - $ref: '#/parameters/ApplicationNameParameter_2'
      - name: application
        description: Object containing Application definitions.
        in: body
        required: true
        schema:
          $ref: '#/definitions/Application_3'
      responses:
        '200':
          description: Successfully updated application.
          schema:
            $ref: '#/definitions/Application_3'
        '201':
          description: Successfully created application.
          schema:
            $ref: '#/definitions/Application_3'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_3'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Applicationgroups Applicationgroupname Applications Applicationname
    delete:
      tags:
      - Application
      operationId: microsoftAzureApplicationsDelete
      description: Remove an application.
      x-ms-examples:
        Application_Delete:
          $ref: ./examples/Application_Delete.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ApplicationGroupNameParameter'
      - $ref: '#/parameters/ApplicationNameParameter_2'
      responses:
        '200':
          description: Successfully removed application.
        '204':
          description: Application does not exist.
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_3'
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Applicationgroups Applicationgroupname Applications Applicationname
    patch:
      tags:
      - Application
      operationId: microsoftAzureApplicationsUpdate
      description: Update an application.
      x-ms-examples:
        Application_Update:
          $ref: ./examples/Application_Update.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ApplicationGroupNameParameter'
      - $ref: '#/parameters/ApplicationNameParameter_2'
      - name: application
        description: Object containing Application definitions.
        in: body
        required: false
        schema:
          $ref: '#/definitions/ApplicationPatch'
      responses:
        '200':
          description: Successfully updated application.
          schema:
            $ref: '#/definitions/Application_3'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_3'
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Applicationgroups Applicationgroupname Applications Applicationname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications
  : get:
      tags:
      - Application
      operationId: microsoftAzureApplicationsList
      description: List applications.
      x-ms-examples:
        Applications_List:
          $ref: ./examples/Application_List.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/ApplicationGroupNameParameter'
      - name: pageSize
        in: query
        required: false
        type: integer
        format: int32
        description: Number of items per page.
      - name: isDescending
        in: query
        required: false
        type: boolean
        description: Indicates whether the collection is descending.
      - name: initialSkip
        in: query
        required: false
        type: integer
        format: int32
        description: Initial number of items to skip.
      responses:
        '200':
          description: Successfully retrieved applications in application group.
          schema:
            $ref: '#/definitions/ApplicationList'
        default:
          description: Automation error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_3'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Desktopvirtualization Applicationgroups Applicationgroupname Applications
  /{tenantID}/applications:
    post:
      tags:
      - Application
      operationId: microsoftAzureApplicationsCreate
      description: Create a new application.
      parameters:
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ApplicationCreateParameters'
        description: The parameters for creating an application.
      - $ref: '#/parameters/ApiVersionParameter_2'
      - $ref: '#/parameters/tenantIDInPath'
      responses:
        '201':
          description: The application was created successfully.
          schema:
            $ref: '#/definitions/Application_4'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/GraphError'
      summary: Microsoft Azure Post Tenantid Applications
    get:
      tags:
      - Application
      operationId: microsoftAzureApplicationsList
      description: Lists applications by filter parameters.
      parameters:
      - name: $filter
        in: query
        required: false
        type: string
        description: The filters to apply to the operation.
      - $ref: '#/parameters/ApiVersionParameter_2'
      - $ref: '#/parameters/tenantIDInPath'
      responses:
        '200':
          description: OK. The operation was successful.
          schema:
            $ref: '#/definitions/ApplicationListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/GraphError'
      x-ms-odata: '#/definitions/Application'
      x-ms-pageable:
        nextLinkName: odata.nextLink
        operationName: Applications_ListNext
      summary: Microsoft Azure Get Tenantid Applications
  /{tenantID}/deletedApplications/{applicationObjectId}:
    delete:
      tags:
      - Application
      operationId: microsoftAzureDeletedapplicationsHarddelete
      description: Hard-delete an application.
      parameters:
      - name: applicationObjectId
        in: path
        required: true
        type: string
        description: Application object ID.
      - $ref: '#/parameters/ApiVersionParameter_2'
      - $ref: '#/parameters/tenantIDInPath'
      responses:
        '204':
          description: No Content
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/GraphError'
      summary: Microsoft Azure Delete Tenantid Deletedapplications Applicationobjectid
  /{tenantID}/applications/{applicationObjectId}:
    delete:
      tags:
      - Application
      operationId: microsoftAzureApplicationsDelete
      description: Delete an application.
      parameters:
      - name: applicationObjectId
        in: path
        required: true
        type: string
        description: Application object ID.
      - $ref: '#/parameters/ApiVersionParameter_2'
      - $ref: '#/parameters/tenantIDInPath'
      responses:
        '204':
          description: No Content
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/GraphError'
      summary: Microsoft Azure Delete Tenantid Applications Applicationobjectid
    get:
      tags:
      - Application
      operationId: microsoftAzureApplicationsGet
      description: Get an application by object ID.
      parameters:
      - name: applicationObjectId
        in: path
        required: true
        type: string
        description: Application object ID.
      - $ref: '#/parameters/ApiVersionParameter_2'
      - $ref: '#/parameters/tenantIDInPath'
      responses:
        '200':
          description: OK. The operation was successful.
          schema:
            $ref: '#/definitions/Application_4'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/GraphError'
      summary: Microsoft Azure Get Tenantid Applications Applicationobjectid
    patch:
      tags:
      - Application
      operationId: microsoftAzureApplicationsPatch
      description: Update an existing application.
      parameters:
      - name: applicationObjectId
        in: path
        required: true
        type: string
        description: Application object ID.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/ApplicationUpdateParameters'
        description: Parameters to update an existing application.
      - $ref: '#/parameters/ApiVersionParameter_2'
      - $ref: '#/parameters/tenantIDInPath'
      responses:
        '204':
          description: No Content
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/GraphError'
      summary: Microsoft Azure Patch Tenantid Applications Applicationobjectid
  /Applications/$/Create:
    post:
      summary: Microsoft Azure Creates A Service Fabric Application
      description: Creates a Service Fabric application using the specified description.
      operationId: microsoftAzureCreateapplication
      x-ms-examples:
        Create application.:
          $ref: ./examples/CreateApplication-1.json
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ApplicationDescriptionRequiredBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Application
      responses:
        '201':
          description: A successful response means that the application creation has been started. Use GetApplication operation to get the status of the application. Once GetApplicationInfo successfully returns application information, the application is created. If the application has default services those may be in the process of being created. Use GetServiceInfo operation to get the status of the service within the application.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Applications/{applicationId}/$/Delete:
    post:
      summary: Microsoft Azure Deletes An Existing Service Fabric Application
      description: An application must be created before it can be deleted. Deleting an application will delete all services that are part of that application. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if a service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the application and all of its services.
      operationId: microsoftAzureDeleteapplication
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/parameters/ForceRemoveOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Application
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Applications/{applicationId}/$/GetLoadInformation:
    get:
      summary: Microsoft Azure Gets Load Information About A Service Fabric Application
      description: Returns the load information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, minimum nodes, maximum nodes, the number of nodes the application is occupying currently, and application load metric information about the application.
      operationId: microsoftAzureGetapplicationloadinfo
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Application
      responses:
        '200':
          description: Information about the application load.
          schema:
            $ref: '#/definitions/ApplicationLoadInfo'
        '204':
          description: An empty response is returned if the specified applicationId is not found in the cluster.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Applications:
    get:
      summary: Microsoft Azure Gets The List Of Applications Created In The Service Fabric Cluster That Match The Specified Filters
      description: Gets the information about the applications that were created or in the process of being created in the Service Fabric cluster and match the specified filters. The response includes the name, type, status, parameters, and other details about the application. If the applications do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. Filters ApplicationTypeName and ApplicationDefinitionKindFilter cannot be specified at the same time.
      operationId: microsoftAzureGetapplicationinfolist
      parameters:
      - $ref: '#/parameters/ApiVersion_6-1_RequiredQueryParam'
      - $ref: '#/parameters/ApplicationDefinitionKindFilterOptionalQueryParam'
      - $ref: '#/parameters/ApplicationTypeNameOptionalQueryParam'
      - $ref: '#/parameters/ExcludeApplicationParametersOptionalQueryParam'
      - $ref: '#/parameters/ContinuationTokenOptionalQueryParam'
      - $ref: '#/parameters/MaxResultsOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Application
      x-ms-examples:
        Limit maximum results:
          $ref: ./examples/GetApplicationInfoList-1.json
        Page using continuation token:
          $ref: ./examples/GetApplicationInfoList-2.json
      responses:
        '200':
          description: List of applications created in the cluster.
          schema:
            $ref: '#/definitions/PagedApplicationInfoList'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Applications/{applicationId}:
    get:
      summary: Microsoft Azure Gets Information About A Service Fabric Application
      description: Returns the information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, type, status, parameters, and other details about the application.
      operationId: microsoftAzureGetapplicationinfo
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/parameters/ExcludeApplicationParametersOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Application
      x-ms-examples:
        Get a specific application by application id:
          $ref: ./examples/GetApplicationInfoByName-1.json
      responses:
        '200':
          description: Information about the application.
          schema:
            $ref: '#/definitions/ApplicationInfo'
        '204':
          description: An empty response is returned if the specified applicationId is not found in the cluster.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Applications/{applicationId}/$/GetHealth:
    get:
      summary: Microsoft Azure Gets The Health Of The Service Fabric Application
      description: Returns the heath state of the service fabric application. The response reports either Ok, Error or Warning health state. If the entity is not found in the health store, it will return Error.
      operationId: microsoftAzureGetapplicationhealth
      parameters:
      - $ref: '#/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/DeployedApplicationsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/ServicesHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/ExcludeHealthStatisticsOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Application
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested application health information.
          schema:
            $ref: '#/definitions/ApplicationHealth'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
    post:
      operationId: microsoftAzureGetapplicationhealthusingpolicy
      summary: Microsoft Azure Gets The Health Of A Service Fabric Application Using The Specified Policy
      description: Gets the health of a Service Fabric application. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicies to override the health policies used to evaluate the health.
      parameters:
      - $ref: '#/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/DeployedApplicationsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/ServicesHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/ExcludeHealthStatisticsOptionalQueryParam'
      - $ref: '#/parameters/ApplicationHealthPolicyOptionalBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Application
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested node health information.
          schema:
            $ref: '#/definitions/ApplicationHealth'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Applications/{applicationId}/$/ReportHealth:
    post:
      operationId: microsoftAzureReportapplicationhealth
      summary: Microsoft Azure Sends A Health Report On The Service Fabric Application
      description: Reports health state of the specified Service Fabric application. The report must contain the information about the source of the health report and property on which it is reported.<br>The report is sent to a Service Fabric gateway Application, which forwards to the health store.<br>The report may be accepted by the gateway, but rejected by the health store after extra validation.<br>For example, the health store may reject the report because of an invalid parameter, like a stale sequence number.<br>To see whether the report was applied in the health store, get application health and check that the report appears in the HealthEvents section.
      tags:
      - Application
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/parameters/HealthInformationRequiredBodyParam'
      - $ref: '#/parameters/ImmediateOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Applications/{applicationId}/$/Upgrade:
    post:
      summary: Microsoft Azure Starts Upgrading An Application In The Service Fabric Cluster
      description: Validates the supplied application upgrade parameters and starts upgrading the application if the parameters are valid.<br>Note, [ApplicationParameter](https://docs.microsoft.com/dotnet/api/system.fabric.description.applicationdescription.applicationparameters)s are not preserved across an application upgrade.<br>In order to preserve current application parameters, the user should get the parameters using [GetApplicationInfo](./GetApplicationInfo.md) operation first and pass them into the upgrade API call as shown in the example.
      operationId: microsoftAzureStartapplicationupgrade
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/parameters/ApplicationUpgradeDescriptionRequiredBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Application
      x-ms-examples:
        Upgrade an application preserving current application parameters:
          $ref: ./examples/StartApplicationUpgrade-1.json
      responses:
        '200':
          description: A successful response means that the application upgrade has started. Use GetApplicationUpgrade operation to get the status of the upgrade.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Applications/{applicationId}/$/GetUpgradeProgress:
    get:
      summary: Microsoft Azure Gets Details For The Latest Upgrade Performed On This Application
      description: Returns information about the state of the latest application upgrade along with details to aid debugging application health issues.
      operationId: microsoftAzureGetapplicationupgrade
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Application
      responses:
        '200':
          description: The application upgrade details.
          schema:
            $ref: '#/definitions/ApplicationUpgradeProgressInfo'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Applications/{applicationId}/$/UpdateUpgrade:
    post:
      summary: Microsoft Azure Updates An Ongoing Application Upgrade In The Service Fabric Cluster
      description: Updates the parameters of an ongoing application upgrade from the ones specified at the time of starting the application upgrade. This may be required to mitigate stuck application upgrades due to incorrect parameters or issues in the application to make progress.
      operationId: microsoftAzureUpdateapplicationupgrade
      parameters:
     

# --- truncated at 32 KB (196 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-application-api-openapi.yml
Microsoft Azure Application API

Documentation

Specifications

Other Resources

OpenAPI Specification
