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.
The report is sent to a Service Fabric gateway Application, which forwards to the health store.
The report may be accepted by the gateway, but rejected by the health store after extra validation.
For example, the health store may reject the report because of an invalid parameter, like a stale sequence number.
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.
Note, [ApplicationParameter](https://docs.microsoft.com/dotnet/api/system.fabric.description.applicationdescription.applicationparameters)s are not preserved across an application upgrade.
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:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/ApplicationIdRequiredPathParam'
- $ref: '#/parameters/ApplicationUpgradeUpdateDescriptionRequiredBodyParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
tags:
- Application
responses:
'200':
description: A successful response means that the application upgrade has updated with the specified parameters. Use GetApplicationUpgrade operation to get the status of the upgrade.
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/Applications/{applicationId}/$/Update:
post:
operationId: microsoftAzureUpdateapplication
summary: Microsoft Azure Updates A Service Fabric Application
description: Updates a Service Fabric application instance. The set of properties that can be updated are a subset of the properties that were specified at the time of creating the application.
parameters:
- $ref: '#/parameters/ApiVersion_8-1_RequiredQueryParam'
- $ref: '#/parameters/ApplicationIdRequiredPathParam'
- $ref: '#/parameters/ApplicationUpdateDescriptionRequiredBodyParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
tags:
- Application
responses:
'200':
description: A successful response means that the application instance was updated with the specified parameters.
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/Applications/{applicationId}/$/MoveToNextUpgradeDomain:
post:
summary: Microsoft Azure Resumes Upgrading An Application In The Service Fabric Cluster
description: Resumes an unmonitored manual Service Fabric application upgrade. Service Fabric upgrades one upgrade domain at a time. For unmonitored manual upgrades, after Service Fabric finishes an upgrade domain, it waits for you to call this API before proceeding to the next upgrade domain.
operationId: microsoftAzureResumeapplicationupgrade
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/ApplicationIdRequiredPathParam'
- $ref: '#/parameters/ResumeApplicationUpgradeDescriptionRequiredBodyParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
tags:
- Application
responses:
'200':
description: A successful response means that the application upgrade has been resumed in the specified upgrade domain. Use GetApplicationUpgrade operation to get the status of the upgrade.
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/Applications/{applicationId}/$/RollbackUpgrade:
post:
summary: Microsoft Azure Starts Rolling Back The Currently On Going Upgrade Of An Application In The Service Fabric Cluster
description: Starts rolling back the current application upgrade to the previous version. This API can only be used to roll back the current in-progress upgrade that is rolling forward to new version. If the application is not currently being upgraded use StartApplicationUpgrade API to upgrade it to desired version, including rolling back to a previous version.
operationId: microsoftAzureRollbackapplicationupgrade
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/ApplicationIdRequiredPathParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
tags:
- Application
responses:
'200':
description: A successful response means that the application has started to roll back. Use GetApplicationUpgrade operation to get the status of the upgrade.
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/Nodes/{nodeName}/$/GetApplications:
get:
operationId: microsoftAzureGetdeployedapplicationinfolist
summary: Microsoft Azure Gets The List Of Applications Deployed On A Service Fabric Node
description: Gets the list of applications deployed on a Service Fabric node. The results do not include information about deployed system applications unless explicitly queried for by ID. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster.
tags:
- Application
parameters:
- $ref: '#/parameters/ApiVersion_6-1_RequiredQueryParam'
- $ref: '#/parameters/NodeNameRequiredPathParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
- $ref: '#/parameters/IncludeHealthStateOptionalQueryParam'
- $ref: '#/parameters/ContinuationTokenOptionalQueryParam'
- $ref: '#/parameters/MaxResultsOptionalQueryParam'
x-ms-examples:
Limit maximum results:
$ref: ./examples/GetDeployedApplicationInfoList-1.json
Page using continuation token:
$ref: ./examples/GetDeployedApplicationInfoList-2.json
Include health state in the result:
$ref: ./examples/GetDeployedApplicationInfoList-3.json
responses:
'200':
description: A successful operation will return 200 status code and the list of deployed application information.
schema:
$ref: '#/definitions/PagedDeployedApplicationInfoList'
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/Nodes/{nodeName}/$/GetApplications/{applicationId}:
get:
operationId: microsoftAzureGetdeployedapplicationinfo
summary: Microsoft Azure Gets The Information About An Application Deployed On A Service Fabric Node
description: This query returns system application information if the application ID provided is for system application. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster.
tags:
- Application
parameters:
- $ref: '#/parameters/ApiVersion_6-1_RequiredQueryParam'
- $ref: '#/parameters/NodeNameRequiredPathParam'
- $ref: '#/parameters/ApplicationIdRequiredPathParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
- $ref: '#/parameters/IncludeHealthStateOptionalQueryParam'
x-ms-examples:
Get a specific deployed application by application ID and include the health state in the result:
$ref: ./examples/GetDeployedApplicationInfoByName-1.json
responses:
'200':
description: A successful operation will return 200 status code and the information about the deployed application.
schema:
$ref: '#/definitions/DeployedApplicationInfo'
'204':
description: An empty response is returned if the specified application is not deployed on the node.
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth:
get:
operationId: microsoftAzureGetdeployedapplicationhealth
summary: Microsoft Azure Gets The Information About Health Of An Application Deployed On A Service Fabric Node
description: Gets the information about health of an application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state.
tags:
- Application
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/NodeNameRequiredPathParam'
- $ref: '#/parameters/ApplicationIdRequiredPathParam'
- $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam'
- $ref: '#/parameters/DeployedServicePackagesHealthStateFilterOptionalQueryParam'
- $ref: '#/parameters/ExcludeHealthStatisticsOptionalQueryParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
responses:
'200':
description: A successful operation will return 200 status code and the health information of the deployed application.
schema:
$ref: '#/definitions/DeployedApplicationHealth'
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
post:
operationId: microsoftAzureGetdeployedapplicationhealthusingpolicy
summary: Microsoft Azure Gets The Information About Health Of An Application Deployed On A Service Fabric Node Using The Specified Policy
description: Gets the information about health of an application deployed on a Service Fabric node using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed application.
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/NodeNameRequiredPathParam'
- $ref: '#/parameters/ApplicationIdRequiredPathParam'
- $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam'
- $ref: '#/parameters/DeployedServicePackagesHealthStateFilterOptionalQueryParam'
- $ref: '#/parameters/ApplicationHealthPolicyOptionalBodyParam'
- $ref: '#/parameters/ExcludeHealthStatisticsOptionalQueryParam'
- $ref: '#/parameters/TimeoutOptionalQueryParam'
tags:
- Application
responses:
'200':
description: A successful operation will return 200 status code and the health information of the deployed application.
schema:
$ref: '#/definitions/DeployedApplicationHealth'
default:
description: The detailed error response.
schema:
$ref: '#/definitions/FabricError'
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/ReportHealth:
post:
operationId: microsoftAzureReportdeployedapplicationhealth
summary: Microsoft Azure Sends A Health Report On The Service Fabric Application Deployed On A Service Fabric Node
description: Reports health state of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.
The report is sent to a Service Fabric gateway Service, which forwards to the health store.
The report may be accepted by the gateway, but rejected by the health store after extra validation.
For example, the health store may reject the report because of an invalid parameter, like a stale sequence number.
To see whether the report was applied in the health store, get deployed application health and check that the report appears in the HealthEvents section.
tags:
- Application
parameters:
- $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
- $ref: '#/parameters/NodeNameRequiredPathParam'
- $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'
definitions:
ApplicationInfo:
description: Information about a Service Fabric application.
properties:
Id:
$ref: '#/definitions/ApplicationId'
description: '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.
Starting in version 6.0, hierarchical names are delimited with the "\~" character. For example, if the application name is "fabric:/myapp/app1",
the application identity would be "myapp\~app1" in 6.0+ and "myapp/app1" in previous versions.'
Name:
$ref: '#/definitions/ApplicationName'
description: The name of the application, including the 'fabric:' URI scheme.
TypeName:
$ref: '#/definitions/ApplicationTypeName'
description: The application type name as defined in the application manifest.
TypeVersion:
$ref: '#/definitions/ApplicationTypeVersion'
description: The version of the application type as defined in the application manifest.
Status:
$ref: '#/definitions/ApplicationStatus'
description: The status of the application.
Parameters:
$ref: '#/definitions/ApplicationParameterList'
description: List of application parameters with overridden values from their default values specified in the application manifest.
HealthState:
$ref: '#/definitions/HealthState'
description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
ApplicationDefinitionKind:
$ref: '#/definitions/ApplicationDefinitionKind'
description: The mechanism used to define a Service Fabric application.
ManagedApplicationIdentity:
$ref: '#/definitions/ManagedApplicationIdentityDescription'
description: Managed application identity description.
DirectoryObject:
type: object
discriminator: objectType
properties:
objectId:
type: string
description: The object ID.
readOnly: true
objectType:
type: string
description: The object type.
deletionTimestamp:
type: string
format: date-time
description: The time at which the directory object was deleted.
readOnly: true
x-nullable: true
required:
- objectType
additionalProperties:
type: object
description: Represents an Azure Active Directory object.
FabricErrorError:
description: Error object containing error code and error message.
properties:
Code:
$ref: '#/definitions/FabricErrorCodes'
description: "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 the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"FABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\""
Message:
type: string
description: Error message.
required:
- Code
UpgradeDomainInfoList:
type: array
description: List of upgrade domains and their statuses. Not applicable to node-by-node upgrades.
items:
$ref: '#/definitions/UpgradeDomainInfo'
ManagedApplicationIdentity:
description: Describes a managed application identity.
required:
- Name
properties:
Name:
type: string
description: The name of the identity.
PrincipalId:
type: string
description: The identity's PrincipalId.
InformationalUrl:
type: object
description: Represents a group of URIs that provide terms of service, marketing, support and privacy policy information about an application. The default value for each string is null.
properties:
termsOfService:
description: The terms of service URI
type: string
marketing:
description: The marketing URI
type: string
privacy:
description: The privacy policy URI
type: string
support:
description: The support URI
type: string
HealthInformation:
description: 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.
required:
- SourceId
- Property
- HealthState
properties:
SourceId:
type: string
description: The source name that identifies the client/watchdog/system component that generated the health information.
Property:
type: string
description: 'The property of the health information. An entity can have health reports for different properties.
The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report.
For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node,
so it can report "AvailableDisk" property on that node.
The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node.
In the health store, these reports are treated as separate health events for the specified node.
Together with the SourceId, the property uniquely identifies the health information.'
HealthState:
$ref: '#/definitions/HealthState'
description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
TimeToLiveInMilliSeconds:
type: string
format: duration
description: 'The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration.
When clients report periodically, they should send reports with higher frequency than time to live.
If clients report on transition, they can set the time to live to infinite.
When time to live expires, the health event that contains the health information
is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false.
If not specified, time to live defaults to infinite value.'
Description:
type: string
description: 'The description of the health information. It represents free text used to add human readable information about the report.
The maximum string length for the description is 4096 characters.
If the provided string is longer, it will be automatically truncated.
When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters.
The presence of the marker indicates to users that truncation occurred.
Note that when truncated, the description has less than 4096 characters from the original string.'
SequenceNumber:
type: string
description: 'The sequence number for this health report as a numeric string.
The report sequence number is used by the health store to detect stale reports.
If not specified, a sequence number is auto-generated by the health client when a report is added.'
RemoveWhenExpired:
type: boolean
description: 'Value that indicates whether the report is removed from health store when it expires.
If set to true, the report is removed from the health store after it expires.
If set to false, the report is treated as an error when expired. The value of this property is false by default.
When clients report periodically, they should set RemoveWhenExpired false (default).
This way, if the reporter has issues (e.g. deadlock) and can''t report, the entity is evaluated at error when the health report expires.
This flags the entity as being in Error health state.'
HealthReportId:
type: string
description: 'A health report ID which identifies the health report and can be used to find more detailed information about a specific health event at
aka.ms/sfhealthid'
HealthEvaluationWrapper:
description: Wrapper object for health evaluation.
properties:
HealthEvaluation:
$ref: '#/definitions/HealthEvaluation'
description: Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
ApplicationTypeName:
type: string
description: The application type name as defined in the application manifest.
SafetyCheckWrapper:
description: A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
properties:
SafetyCheck:
$ref: '#/definitions/SafetyCheck'
description: Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
HealthStateCount:
description: Represents information about how many health entities are in Ok, Warning and Error health state.
properties:
OkCount:
type: integer
format: int64
description: The number of health entities with aggregated health state Ok.
minimum: 0
WarningCount:
type: integer
format: int64
description: The number of health entities with aggregated health state Warning.
minimum: 0
ErrorCount:
type: integer
format: int64
description: The number of health entities with aggregated health state Error.
minimum: 0
FailureUpgradeDomainProgressInfo:
description: Information about the upgrade domain progress at the time of upgrade failure.
properties:
DomainName:
$ref: '#/definitions/UpgradeDomainName'
description: The name of the upgrade domain
NodeUpgradeProgressList:
$ref: '#/definitions/NodeUpgradeProgressInfoList'
description: List of upgrading nodes and their statuses
UnhealthyEvaluations:
description: List of health evaluations that resulted in the current aggregated health state.
type: array
items:
$ref: '#/definitions/HealthEvaluationWrapper'
HealthState:
type: string
description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
enum:
- Invalid
- Ok
- Warning
- Error
- Unknown
x-ms-enum:
name: HealthState
modelAsString: true
values:
- value: Invalid
description: Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero.
- value: Ok
description: Indicates the health state is okay. The value is 1.
- value: Warning
description: Indicates the health state is at a warning level. The value is 2.
- value: Error
description: Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3.
- value: Unknown
description: Indicates an unknown health status. The value is 65535.
AppRole:
type: object
properties:
id:
type: string
description: Unique role identifier inside the appRoles collection.
allowedMemberTypes:
type: array
items:
type: string
description: 'Specifies whether this app role definition can be assigned to users and groups by setting to ''User'', or to other applications (that are accessing this application in daemon service scenarios) by setting to ''Application'', or to both. '
description:
type: string
description: Permission help text that appears in the admin app assignment and consent experiences.
displayName:
type: string
description: Display name for the permission that appears in the admin consent and app assignment experiences.
isEnabled:
type: boolean
description: When creating or updating a role definition, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.
value:
type: string
description: Specifies the value of the roles claim that the application should expect in the authentication and access tokens.
ListApplicationsResult:
properties:
value:
type: array
items:
$ref: '#/definitions/Application'
description: The list of applications.
nextLink:
type: string
description: The URL to get the next set of results.
description: The result of performing list applications.
CurrentUpgradeDomainName:
type: string
description: The name of the upgrade domain. Not applicable to node-by-node upgrades.
ApplicationProperties_3:
description: Schema for Application properties.
type: object
required:
- commandLineSetting
properties:
objectId:
type: string
description: ObjectId of Application. (internal use)
readOnly: true
description:
type: string
description: Description of Application.
friendlyName:
type: string
description: Friendly name of Application.
filePath:
type: string
description: Specifies a path for the executable file for the application.
msixPackageFamilyName:
type: string
description: Specifies the package family name for MSIX applications
x-nullable: true
x-ms-mutability:
- create
- read
msixPackageApplicationId:
type: string
description: Specifies the package application Id for MSIX applications
x-nullable: true
x-ms-mutability:
- create
- read
applicationType:
enum:
- InBuilt
- MsixApplication
x-ms-enum:
name: RemoteApplicationType
modelAsString: true
type: string
description: Resource Type of Application.
x-ms-mutability:
- create
- read
commandLineSetting:
enum:
- DoNotAllow
- Allow
- Require
x-ms-enum:
name: CommandLineSetting
modelAsString: true
type: string
description: Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.
x-nullable: false
commandLineArguments:
type: string
description: Command Line Arguments for Application.
showInPortal:
type: boolean
description: Specifies whether to show the RemoteApp program in the RD Web Access server.
iconPath:
type: string
description: Path to icon.
iconIndex:
type: integer
format: int32
description: Index of the icon.
iconHash:
readOnly: true
type: string
description: Hash of the icon.
iconContent:
readOnly: true
type: string
format: byte
description: the icon a 64 bit string as a byte array.
ApplicationHealth:
description: Represents the health of the application. Contains the application aggregated health state and the service and deployed application health states.
allOf:
- $ref: '#/definitions/EntityHealth'
properties:
Name:
$ref: '#/definitions/ApplicationName'
description: The name of the application, including the 'fabric:' URI scheme.
ServiceHealthStates:
type: array
items:
$ref: '#/definitions/ServiceHealthState'
description: Service health states as found in the health store.
DeployedApplicationHealthStates:
type: array
items:
$ref: '#/definitions/DeployedApplicationHealthState'
description: Deployed application health states as found in the health store.
FabricErrorCodes:
type: string
description: "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 the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"FABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\""
enum:
- FABRIC_E_INVALID_PARTITION_KEY
- FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR
- FABRIC_E_INVALID_ADDRESS
- FABRIC_E_APPLICATION_NOT_UPGRADING
- FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR
- FABRIC_E_FABRIC_NOT_UPGRADING
- FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR
- FABRIC_E_INVALID_CONFIGURATION
- FABRIC_E_INVALID_NAME_URI
- FABRIC_E_PATH_TOO_LONG
- FABRIC_E_KEY_TOO_LARGE
- FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED
- FABRIC_E_INVALID_ATOMIC_GROUP
- FABRIC_E_VALUE_EMPTY
- FABRIC_E_NODE_NOT_FOUND
- FABRIC_E_APPLICATION_TYPE_NOT_FOUND
- FABRIC_E_APPLICATION_NOT_FOUND
- FABRIC_E_SERVICE_TYPE_NOT_FOUND
- FABRIC_E_SERVICE_DOES_NOT_EXIST
- FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND
- FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND
- FABRIC_E_PARTITION_NOT_FOUND
- FABRIC_E_REPLICA_DOES_NOT_EXIST
- FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST
- FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND
- FABRIC_E_DIRECTORY_NOT_FOUND
- FABRIC_E_FABRIC_VERSION_NOT_FOUND
- FABRIC_E_FILE_NOT_FOUND
- FABRIC_E_NAME_DOES_NOT_EXIST
- FABRIC_E_PROPERTY_DOES_NOT_EXIST
- FABRIC_E_ENUMERATION_COMPLETED
- FABRIC_E_SERVICE_MANIFEST_NOT_FOUND
- FABRIC_E_KEY_NOT_FOUND
- FABRIC_E_HEALTH_ENTITY_NOT_FOUND
- FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS
- FABRIC_E_APPLICATION_ALREADY_EXISTS
- FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION
- FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS
- FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS
- FABRIC_E_SERVICE_ALREADY_EXISTS
- FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS
- FABRIC_E_APPLICATION_TYPE_IN_USE
- FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION
- FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS
- FABRIC_E_FABRIC_VERSION_IN_USE
- FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS
- FABRIC_E_NAME_ALREADY_EXISTS
- FABRIC_E_NAME_NOT_EMPTY
- FABRIC_E_PROPERTY_CHECK_FAILED
- FABRIC_E_SERVICE_METADATA_MISMATCH
- FABRIC_E_SERVICE_TYPE_MISMATCH
- FABRIC_E_HEALTH_STALE_REPORT
- FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED
- FABRIC_E_NODE_HAS_NOT_STOPPED_YET
- FABRIC_E_INSTANCE_ID_MISMATCH
- FABRIC_E_VALUE_TOO_LARGE
- FABRIC_E_NO_WRITE_QUORUM
- FABRIC_E_NOT_PRIMARY
- FABRIC_E_NOT_READY
- FABRIC_E_RECONFIGURATION_PENDING
- FABRIC_E_SERVICE_OFFLINE
- E_ABORT
- FABRIC_E_COMMUNICATION_ERROR
- FABRIC_E_OPERATION_NOT_COMPLETE
- FABRIC_E_TIMEOUT
- FABRIC_E_NODE_IS_UP
- E_FAIL
- FABRIC_E_BACKUP_IS_ENABLED
- FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH
- FABRIC_E_INVALID_FOR_STATELESS_SERVICES
- FABRIC_E_BACKUP_NOT_ENABLED
- FABRIC_E_BACKUP_POLICY_NOT_EXISTING
- FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING
- FABRIC_E_BACKUP_IN_PROGRESS
- FABRIC_E_RESTORE_IN_PROGRESS
- FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING
- FABRIC_E_INVALID_SERVICE_SCALING_POLICY
- E_INVALIDARG
- FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS
- FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND
- FABRIC_E_VOLUME_ALREADY_EXISTS
- FABRIC_E_VOLUME_NOT_FOUND
- SerializationError
- FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR
x-ms-enum:
name: FabricErrorCodes
modelAsString: true
values:
- value: FABRIC_E_INVALID_PARTITION_KEY
- value: FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR
- value: FABRIC_E_INVALID_ADDRESS
- value: FABRIC_E_APPLICATION_NOT_UPGRADING
- value: FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR
- value: FABRIC_E_FABRIC_NOT_UPGRADING
- value: FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR
- value: FABRIC_E_INVALID_CONFIGURATION
- value: FABRIC_E_INVALID_NAME_URI
- value: FABRIC_E_PATH_TOO_LONG
- value: FABRIC_E_KEY_TOO_LARGE
- value: FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED
- value: FABRIC_E_INVALID_ATOMIC_GROUP
- value: FABRIC_E_VALUE_EMPTY
- value: FABRIC_E_NODE_NOT_FOUND
- value: FABRIC_E_APPLICATION_TYPE_NOT_FOUND
- value: FABRIC_E_APPLICATION_NOT_FOUND
- value: FABRIC_E_SERVICE_TYPE_NOT_FOUND
- value: FABRIC_E_SERVICE_DOES_NOT_EXIST
- value: FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND
- value: FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND
- value: FABRIC_E_PARTITION_NOT_FOUND
- value: FABRIC_E_REPLICA_DOES_NOT_EXIST
- value: FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST
- value: FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND
- value: FABRIC_E_DIRECTORY_NOT_FOUND
- value: FABRIC_E_FABRIC_VERSION_NOT_FOUND
- value: FABRIC_E_FILE_NOT_FOUND
- value: FABRIC_E_NAME_DOES_NOT_EXIST
- value: FABRIC_E_PROPERTY_DOES_NOT_EXIST
- value: FABRIC_E_ENUMERATION_COMPLETED
- value: FABRIC_E_SERVICE_MANIFEST_NOT_FOUND
- value: FABRIC_E_KEY_NOT_FOUND
- value: FABRIC_E_HEALTH_ENTITY_NOT_FOUND
- value: FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS
- value: FABRIC_E_APPLICATION_ALREADY_EXISTS
- value: FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION
- value: FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS
- value: FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS
- value: FABRIC_E_SERVICE_ALREADY_EXISTS
- value: FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS
- value: FABRIC_E_APPLICATION_TYPE_IN_USE
- value: FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION
- value: FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS
- value: FABRIC_E_FABRIC_VERSION_IN_USE
- value: FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS
- value: FABRIC_E_NAME_ALREADY_EXISTS
- value: FABRIC_E_NAME_NOT_EMPTY
- value: FABRIC_E_PROPERTY_CHECK_FAILED
- value: FABRIC_E_SERVICE_METADATA_MISMATCH
- value: FABRIC_E_SERVICE_TYPE_MISMATCH
- value: FABRIC_E_HEALTH_STALE_REPORT
- value: FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED
- value: FABRIC_E_NODE_HAS_NOT_STOPPED_YET
- value: FABRIC_E_INSTANCE_ID_MISMATCH
- value: FABRIC_E_VALUE_TOO_LARGE
- value: FABRIC_E_NO_WRITE_QUORUM
- value: FABRIC_E_NOT_PRIMARY
- value: FABRIC_E_NOT_READY
- value: FABRIC_E_RECONFIGURATION_PENDING
- value: FABRIC_E_SERVICE_OFFLINE
- value: E_ABORT
- value: FABRIC_E_COMMUNICATION_ERROR
- value: FABRIC_E_OPERATION_NOT_COMPLETE
- value: FABRIC_E_TIMEOUT
- value: FABRIC_E_NODE_IS_UP
- value: E_FAIL
- value: FABRIC_E_BACKUP_IS_ENABLED
- value: FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH
- value: FABRIC_E_INVALID_FOR_STATELESS_SERVICES
- value: FABRIC_E_BACKUP_NOT_ENABLED
- value: FABRIC_E_BACKUP_POLICY_NOT_EXISTING
- value: FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING
- value: FABRIC_E_BACKUP_IN_PROGRESS
- value: FABRIC_E_RESTORE_IN_PROGRESS
- value: FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING
- value: FABRIC_E_INVALID_SERVICE_SCALING_POLICY
- value: E_INVALIDARG
- value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS
- value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND
- value: FABRIC_E_VOLUME_ALREADY_EXISTS
- value: FABRIC_E_VOLUME_NOT_FOUND
- value: SerializationError
- value: FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR
ContinuationToken:
type: string
description: 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 system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
ManagedApplicationIdentityList:
description: A list of managed application identity objects.
type: array
items:
$ref: '#/definitions/ManagedApplicationIdentity'
FailureReason:
type: string
description: The cause of an upgrade failure that resulted in FailureAction being executed.
enum:
- None
- Interrupted
- HealthCheck
- UpgradeDomainTimeout
- OverallUpgradeTimeout
x-ms-enum:
name: FailureReason
modelAsString: true
values:
- value: None
description: Indicates the reason is invalid or unknown. All Service Fabric enumerations have the invalid type. The value is zero.
- value: Interrupted
description: There was an external request to roll back the upgrade. The value is 1
- value: HealthCheck
description: The upgrade failed due to health policy violations. The value is 2
- value: UpgradeDomainTimeout
description: An upgrade domain took longer than the allowed upgrade domain timeout to process. The value is 3
- value: OverallUpgradeTimeout
description: The overall upgrade took longer than the allowed upgrade timeout to process. The value is 4
ApplicationMetricDescriptionList:
type: array
items:
$ref: '#/definitions/ApplicationMetricDescription'
description: List of application capacity metric description.
NodeUpgradeProgressInfoList:
type: array
description: List of upgrading nodes and their statuses
items:
$ref: '#/definitions/NodeUpgradeProgressInfo'
ApplicationHealthPolicy:
description: Defines a health policy used to evaluate the health of an application or one of its children entities.
properties:
ConsiderWarningAsError:
type: boolean
description: Indicates whether warnings are treated with the same severity as errors.
default: false
MaxPercentUnhealthyDeployedApplications:
type: integer
description: 'The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.
The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.
This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.
The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.'
default: 0
DefaultServiceTypeHealthPolicy:
$ref: '#/definitions/ServiceTypeHealthPolicy'
description: The health policy used by default to evaluate the health of a service type.
ServiceTypeHealthPolicyMap:
$ref: '#/definitions/ServiceTypeHealthPolicyMap'
description: The map with service type health policy per service type name. The map is empty by default.
SafetyCheckKind:
type: string
description: The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks.
enum:
- Invalid
- EnsureSeedNodeQuorum
- EnsurePartitionQuorum
- WaitForPrimaryPlacement
- WaitForPrimarySwap
- WaitForReconfiguration
- WaitForInbuildReplica
- EnsureAvailability
x-ms-enum:
name: SafetyCheckKind
modelAsString: true
values:
- value: Invalid
description: Indicates that the upgrade safety check kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
- value: EnsureSeedNodeQuorum
description: Indicates that if we bring down the node then this will result in global seed node quorum loss. The value is 1.
- value: EnsurePartitionQuorum
description: Indicates that there is some partition for which if we bring down the replica on the node, it will result in quorum loss for that partition. The value is 2.
- value: WaitForPrimaryPlacement
description: Indicates that there is some replica on the node that was moved out of this node due to upgrade. Service Fabric is now waiting for the primary to be moved back to this node. The value is 3.
- value: WaitForPrimarySwap
description: Indicates that Service Fabric is waiting for a primary replica to be moved out of the node before starting upgrade on that node. The value is 4.
- value: WaitForReconfiguration
description: Indicates that there is some replica on the node that is involved in a reconfiguration. Service Fabric is waiting for the reconfiguration to be complete before staring upgrade on that node. The value is 5.
- value: WaitForInbuildReplica
description: Indicates that there is either a replica on the node that is going through copy, or there is a primary replica on the node that is copying data to some other replica. In both cases, bringing down the replica on the node due to upgrade will abort the copy. The value is 6.
- value: EnsureAvailability
description: Indicates that there is either a stateless service partition on the node having exactly one instance, or there is a primary replica on the node for which the partition is quorum loss. In both cases, bringing down the replicas due to upgrade will result in loss of availability. The value is 7.
ServiceTypeHealthPolicy:
description: Represents the health policy used to evaluate the health of services belonging to a service type.
properties:
MaxPercentUnhealthyPartitionsPerService:
type: integer
description: 'The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100
The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error.
If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning.
The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service.
The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero.'
default: 0
MaxPercentUnhealthyReplicasPerPartition:
type: integer
description: 'The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100.
The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error.
If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning.
The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition.
The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero.'
default: 0
MaxPercentUnhealthyServices:
type: integer
description: 'The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.
The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.
If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.
This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.
The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero.'
default: 0
NodeName:
type: string
description: The name of a Service Fabric node.
ApplicationBase:
type: object
description: Active Directive Application common properties shared among GET, POST and PATCH
properties:
allowGuestsSignIn:
description: A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
type: boolean
allowPassthroughUsers:
description: Indicates that the application supports pass through users who have no presence in the resource tenant.
type: boolean
appLogoUrl:
description: The url for the application logo image stored in a CDN.
type: string
appRoles:
type: array
items:
$ref: '#/definitions/AppRole'
description: The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
appPermissions:
type: array
items:
type: string
description: The application permissions.
availableToOtherTenants:
type: boolean
description: Whether the application is available to other tenants.
errorUrl:
description: A URL provided by the author of the application to report errors when using the application.
type: string
groupMembershipClaims:
$ref: '#/definitions/GroupMembershipClaims'
description: Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects.
homepage:
type: string
description: The home page of the application.
informationalUrls:
$ref: '#/definitions/InformationalUrl'
description: URLs with more information about the application.
isDeviceOnlyAuthSupported:
description: Specifies whether this application supports device authentication without a user. The default is false.
type: boolean
keyCredentials:
type: array
items:
$ref: '#/definitions/KeyCredential'
description: A collection of KeyCredential objects.
knownClientApplications:
description: Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).
type: array
items:
type: string
logoutUrl:
type: string
description: the url of the logout page
oauth2AllowImplicitFlow:
type: boolean
description: Whether to allow implicit grant flow for OAuth2
oauth2AllowUrlPathMatching:
description: Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false.
type: boolean
oauth2Permissions:
description: The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.
type: array
items:
$ref: '#/definitions/OAuth2Permission'
oauth2RequirePostResponse:
description: Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed.
type: boolean
orgRestrictions:
description: A list of tenants allowed to access application.
type: array
items:
type: string
optionalClaims:
$ref: '#/definitions/OptionalClaims'
passwordCredentials:
type: array
items:
$ref: '#/definitions/PasswordCredential'
description: A collection of PasswordCredential objects
preAuthorizedApplications:
type: array
items:
$ref: '#/definitions/PreAuthorizedApplication'
description: list of pre-authorized applications.
publicClient:
description: Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
type: boolean
publisherDomain:
description: Reliable domain which can be used to identify an application.
type: string
replyUrls:
type: array
items:
type: string
description: A collection of reply URLs for the application.
requiredResourceAccess:
type: array
items:
$ref: '#/definitions/RequiredResourceAccess'
description: Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.
samlMetadataUrl:
description: The URL to the SAML metadata for the application.
type: string
signInAudience:
description: Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
type: string
wwwHomepage:
description: The primary Web page.
type: string
NodeUpgradeDurationString:
type: string
description: The estimated time spent processing the node since it was deactivated during a node-by-node upgrade.
CurrentUpgradeDomainProgressInfo:
description: Information about the current in-progress upgrade domain. Not applicable to node-by-node upgrades.
properties:
DomainName:
$ref: '#/definitions/UpgradeDomainName'
description: The name of the upgrade domain
NodeUpgradeProgressList:
$ref: '#/definitions/NodeUpgradeProgressInfoList'
description: List of upgrading nodes and their statuses
OptionalClaims:
type: object
description: Specifying the claims to be included in the token.
properties:
idToken:
description: Optional claims requested to be included in the id token.
type: array
items:
$ref: '#/definitions/OptionalClaim'
accessToken:
description: Optional claims requested to be included in the access token.
type: array
items:
$ref: '#/definitions/OptionalClaim'
samlToken:
description: Optional claims requested to be included in the saml token.
type: array
items:
$ref: '#/definitions/OptionalClaim'
PreAuthorizedApplication:
type: object
description: Contains information about pre authorized client application.
properties:
appId:
description: Represents the application id.
type: string
permissions:
description: Collection of required app permissions/entitlements from the resource application.
type: array
items:
$ref: '#/definitions/PreAuthorizedApplicationPermission'
extensions:
description: Collection of extensions from the resource application.
type: array
items:
$ref: '#/definitions/PreAuthorizedApplicationExtension'
ErrorMessage:
type: object
properties:
value:
type: string
x-ms-client-name: message
description: Error message value.
description: Active Directory error message.
ApplicationParameter:
description: Describes an application parameter override to be applied when creating or upgrading an application.
required:
- Key
- Value
properties:
Key:
type: string
description: The name of the parameter.
Value:
type: string
description: The value of the parameter.
Application_4:
type: object
allOf:
- $ref: '#/definitions/DirectoryObject'
properties:
appId:
type: string
description: The application ID.
allowGuestsSignIn:
description: A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
type: boolean
allowPassthroughUsers:
description: Indicates that the application supports pass through users who have no presence in the resource tenant.
type: boolean
appLogoUrl:
description: The url for the application logo image stored in a CDN.
type: string
appRoles:
type: array
items:
$ref: '#/definitions/AppRole'
description: The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
appPermissions:
type: array
items:
type: string
description: The application permissions.
availableToOtherTenants:
type: boolean
description: Whether the application is available to other tenants.
displayName:
type: string
description: The display name of the application.
errorUrl:
description: A URL provided by the author of the application to report errors when using the application.
type: string
groupMembershipClaims:
$ref: '#/definitions/GroupMembershipClaims'
description: Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects.
homepage:
type: string
description: The home page of the application.
identifierUris:
type: array
items:
type: string
description: A collection of URIs for the application.
informationalUrls:
$ref: '#/definitions/InformationalUrl'
description: URLs with more information about the application.
isDeviceOnlyAuthSupported:
description: Specifies whether this application supports device authentication without a user. The default is false.
type: boolean
keyCredentials:
type: array
items:
$ref: '#/definitions/KeyCredential'
description: A collection of KeyCredential objects.
knownClientApplications:
description: Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).
type: array
items:
type: string
logoutUrl:
type: string
description: the url of the logout page
oauth2AllowImplicitFlow:
type: boolean
description: Whether to allow implicit grant flow for OAuth2
oauth2AllowUrlPathMatching:
description: Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false.
type: boolean
oauth2Permissions:
description: The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.
type: array
items:
$ref: '#/definitions/OAuth2Permission'
oauth2RequirePostResponse:
description: Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed.
type: boolean
orgRestrictions:
description: A list of tenants allowed to access application.
type: array
items:
type: string
optionalClaims:
$ref: '#/definitions/OptionalClaims'
passwordCredentials:
type: array
items:
$ref: '#/definitions/PasswordCredential'
description: A collection of PasswordCredential objects
preAuthorizedApplications:
type: array
items:
$ref: '#/definitions/PreAuthorizedApplication'
description: list of pre-authorized applications.
publicClient:
description: Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
type: boolean
publisherDomain:
description: Reliable domain which can be used to identify an application.
type: string
replyUrls:
type: array
items:
type: string
description: A collection of reply URLs for the application.
requiredResourceAccess:
type: array
items:
$ref: '#/definitions/RequiredResourceAccess'
description: Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.
samlMetadataUrl:
description: The URL to the SAML metadata for the application.
type: string
signInAudience:
description: Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
type: string
wwwHomepage:
description: The primary Web page.
type: string
description: Active Directory application information.
ServiceHealthState:
description: Represents the health state of a service, which contains the service identifier and its aggregated health state.
allOf:
- $ref: '#/definitions/EntityHealthState'
properties:
ServiceName:
$ref: '#/definitions/ServiceName'
description: Name of the service whose health state is represented by this object.
CloudErrorBody:
x-ms-external: true
properties:
code:
type: string
description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message:
type: string
description: A message describing the error, intended to be suitable for display in a user interface.
target:
type: string
description: The target of the particular error. For example, the name of the property in error.
details:
type: array
items:
$ref: '#/definitions/CloudErrorBody'
description: A list of additional details about the error.
description: An error response from the Batch service.
CloudErrorProperties:
description: Cloud error object properties.
type: object
properties:
code:
description: Error code
type: string
message:
description: Error message indicating why the operation failed.
type: string
HealthEvaluation:
discriminator: Kind
description: Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
properties:
Kind:
$ref: '#/definitions/HealthEvaluationKind'
description: The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values.
AggregatedHealthState:
$ref: '#/definitions/HealthState'
description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
Description:
type: string
description: Description of the health evaluation, which represents a summary of the evaluation process.
required:
- Kind
DeployedApplicationStatus:
type: string
description: The status of the application deployed on the node. Following are the possible values.
enum:
- Invalid
- Downloading
- Activating
- Active
- Upgrading
- Deactivating
x-ms-enum:
name: DeployedApplicationStatus
modelAsString: true
values:
- value: Invalid
description: Indicates that deployment status is not valid. All Service Fabric enumerations have the invalid type. The value is zero.
- value: Downloading
description: Indicates that the package is downloading from the ImageStore. The value is 1.
- value: Activating
description: Indicates that the package is activating. The value is 2.
- value: Active
description: Indicates that the package is active. The value is 3.
- value: Upgrading
description: Indicates that the package is upgrading. The value is 4.
- value: Deactivating
description: Indicates that the package is deactivating. The value is 5.
ApplicationUpdateDescription:
description: Describes the parameters for updating an application instance.
properties:
Flags:
type: string
description: 'Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified.
If flags are not specified for a certain property, the property will not be updated even if the new value is provided.
This property can be a combination of those flags obtained using bitwise ''OR'' operator. Exception is RemoveApplicationCapacity which cannot be specified along with other parameters.
For example, if the provided value is 3 then the flags for MinimumNodes (1) and MaximumNodes (2) are set.
- None - Does not indicate any other properties are set. The value is 0.
- MinimumNodes - Indicates whether the MinimumNodes property is set. The value is 1.
- MaximumNodes - Indicates whether the MinimumNodes property is set. The value is 2.
- ApplicationMetrics - Indicates whether the ApplicationMetrics property is set. The value is 4.'
RemoveApplicationCapacity:
type: boolean
description: 'Used to clear all parameters related to Application Capacity for this application. |
It is not possible to specify this parameter together with other Application Capacity parameters.'
default: false
MinimumNodes:
type: integer
format: int64
description: The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.
minimum: 0
MaximumNodes:
type: integer
format: int64
description: The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node.
minimum: 0
default: 0
ApplicationMetrics:
$ref: '#/definitions/ApplicationMetricDescriptionList'
description: List of application capacity metric description.
UpgradeDomainInfo:
description: Information about an upgrade domain.
properties:
Name:
$ref: '#/definitions/UpgradeDomainName'
description: The name of the upgrade domain
State:
$ref: '#/definitions/UpgradeDomainState'
description: The state of the upgrade domain.
ApplicationDefinitionKind:
type: string
description: The mechanism used to define a Service Fabric application.
enum:
- Invalid
- ServiceFabricApplicationDescription
- Compose
x-ms-enum:
name: ApplicationDefinitionKind
modelAsString: true
values:
- value: Invalid
description: Indicates the application definition kind is invalid. All Service Fabric enumerations have the invalid type. The value is 65535.
- value: ServiceFabricApplicationDescription
description: Indicates the application is defined by a Service Fabric application description. The value is 0.
- value: Compose
description: Indicates the application is defined by compose file(s). The value is 1.
HealthEvent:
description: Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.
allOf:
- $ref: '#/definitions/HealthInformation'
properties:
IsExpired:
type: boolean
description: Returns true if the health event is expired, otherwise false.
SourceUtcTimestamp:
type: string
format: date-time
description: The date and time when the health report was sent by the source.
LastModifiedUtcTimestamp:
type: string
format: date-time
description: The date and time when the health report was last modified by the health store.
LastOkTransitionAt:
type: string
format: date-time
description: 'If the current health state is ''Ok'', this property returns the time at which the health report was first reported with ''Ok''.
For periodic reporting, many reports with the same state may have been generated.
This property returns the date and time when the first ''Ok'' health report was received.
If the current health state is ''Error'' or ''Warning'', returns the date and time at which the health state was last in ''Ok'', before transitioning to a different state.
If the health state was never ''Ok'', the value will be zero date-time.'
LastWarningTransitionAt:
type: string
format: date-time
description: 'If the current health state is ''Warning'', this property returns the time at which the health report was first reported with ''Warning''. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first ''Warning'' health report was received.
If the current health state is ''Ok'' or ''Error'', returns the date and time at which the health state was last in ''Warning'', before transitioning to a different state.
If the health state was never ''Warning'', the value will be zero date-time.'
LastErrorTransitionAt:
type: string
format: date-time
description: 'If the current health state is ''Error'', this property returns the time at which the health report was first reported with ''Error''. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first ''Error'' health report was received.
If the current health state is ''Ok'' or ''Warning'', returns the date and time at which the health state was last in ''Error'', before transitioning to a different state.
If the health state was never ''Error'', the value will be zero date-time.'
SafetyCheck:
discriminator: Kind
description: Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
properties:
Kind:
$ref: '#/definitions/SafetyCheckKind'
description: The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks.
required:
- Kind
NodeUpgradePhase:
type: string
description: The state of the upgrading node.
enum:
- Invalid
- PreUpgradeSafetyCheck
- Upgrading
- PostUpgradeSafetyCheck
x-ms-enum:
name: NodeUpgradePhase
modelAsString: true
values:
- value: Invalid
description: Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
- value: PreUpgradeSafetyCheck
description: The upgrade has not started yet due to pending safety checks. The value is 1
- value: Upgrading
description: The upgrade is in progress. The value is 2
- value: PostUpgradeSafetyCheck
description: The upgrade has completed and post upgrade safety checks are being performed. The value is 3
ServiceManifestName:
type: string
description: The name of the service manifest.
ApplicationTypeVersion:
type: string
description: The version of the application type as defined in the application manifest.
ApplicationUpgradeUpdateDescription:
description: Describes the parameters for updating an ongoing application upgrade.
properties:
Name:
$ref: '#/definitions/ApplicationName'
description: The name of the application, including the 'fabric:' URI scheme.
UpgradeKind:
$ref: '#/definitions/UpgradeKind'
description: The kind of upgrade out of the following possible values.
ApplicationHealthPolicy:
$ref: '#/definitions/ApplicationHealthPolicy'
description: Defines a health policy used to evaluate the health of an application or one of its children entities.
UpdateDescription:
$ref: '#/definitions/RollingUpgradeUpdateDescription'
description: Describes the parameters for updating a rolling upgrade of application or cluster.
required:
- Name
- UpgradeKind
ApplicationCreateParameters:
type: object
allOf:
- $ref: '#/definitions/ApplicationBase'
required:
- displayName
properties:
displayName:
type: string
description: The display name of the application.
identifierUris:
type: array
items:
type: string
description: A collection of URIs for the application.
description: Request parameters for creating a new application.
ResumeApplicationUpgradeDescription:
description: Describes the parameters for resuming an unmonitored manual Service Fabric application upgrade
properties:
UpgradeDomainName:
type: string
description: The name of the upgrade domain in which to resume the upgrade.
required:
- UpgradeDomainName
EntityHealth:
description: Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.
properties:
AggregatedHealthState:
$ref: '#/definitions/HealthState'
description: 'The HealthState representing the aggregated health state of the entity computed by Health Manager.
The health evaluation of the entity reflects all events reported on the entity and its children (if any).
The aggregation is done by applying the desired health policy.'
HealthEvents:
type: array
items:
$ref: '#/definitions/HealthEvent'
description: The list of health events reported on the entity.
UnhealthyEvaluations:
$ref: '#/definitions/UnhealthyEvaluations'
description: The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
HealthStatistics:
$ref: '#/definitions/HealthStatistics'
description: Shows the health statistics for all children types of the queried entity.
HealthStatistics:
description: '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 include health state counts for all children types of the current entity.
For example, for cluster, the health statistics include health state counts for nodes, applications, services, partitions, replicas, deployed applications and deployed service packages.
For partition, the health statistics include health counts for replicas.'
properties:
HealthStateCountList:
type: array
items:
$ref: '#/definitions/EntityKindHealthStateCount'
description: List of health state counts per entity kind, which keeps track of how many children of the queried entity are in Ok, Warning and Error state.
EntityHealthState:
description: A base type for the health state of various entities in the cluster. It contains the aggregated health state.
properties:
AggregatedHealthState:
$ref: '#/definitions/HealthState'
description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
ForceRestart:
type: boolean
description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
default: false
CloudError_3:
description: Cloud error object.
type: object
x-ms-external: true
properties:
error:
$ref: '#/definitions/CloudErrorProperties'
InstanceCloseDelayDurationInSeconds:
type: integer
format: int64
description: '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 is closing during the application/cluster
upgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: "#/definitions/StatelessServiceDescription.yaml" for details.
Note, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description.'
default: 4294967295
HealthCheckRetryTimeout:
type: string
description: 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 string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
default: PT0H10M0S
UpgradeUnitName:
type: string
description: The name of the upgrade unit
CurrentUpgradeUnitsProgressInfo:
description: Information about the current in-progress upgrade units.
properties:
DomainName:
$ref: '#/definitions/CurrentUpgradeDomainName'
description: The name of the upgrade domain. Not applicable to node-by-node upgrades.
NodeUpgradeProgressList:
$ref: '#/definitions/NodeUpgradeProgressInfoList'
description: List of upgrading nodes and their statuses
UpgradeUnitInfo:
description: Information about an upgrade unit.
properties:
Name:
$ref: '#/definitions/UpgradeUnitName'
description: The name of the upgrade unit
State:
$ref: '#/definitions/UpgradeUnitState'
description: The state of the upgrade unit.
FailureAction:
type: string
description: 'The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.
Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.
Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.'
enum:
- Invalid
- Rollback
- Manual
x-ms-enum:
name: FailureAction
modelAsString: true
values:
- value: Invalid
description: Indicates the failure action is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
- value: Rollback
description: The upgrade will start rolling back automatically. The value is 1
- value: Manual
description: The upgrade will switch to UnmonitoredManual upgrade mode. The value is 2
TargetApplicationTypeVersion:
type: string
description: The target application type version (found in the application manifest) for the application upgrade.
PagedApplicationInfoList:
description: 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 executing the same query with the continuation token provided in this list.
properties:
ContinuationToken:
$ref: '#/definitions/ContinuationToken'
description: 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 system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
Items:
type: array
description: List of application information.
items:
$ref: '#/definitions/ApplicationInfo'
ApplicationListResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/Application_4'
description: A collection of applications.
odata.nextLink:
type: string
description: The URL to get the next set of results.
description: Application list operation result.
SafetyCheckInfoList:
type: array
description: List of pending safety checks
items:
$ref: '#/definitions/SafetyCheckWrapper'
UpgradeDomainState:
type: string
description: The state of the upgrade domain.
enum:
- Invalid
- Pending
- InProgress
- Completed
x-ms-enum:
name: UpgradeDomainState
modelAsString: true
values:
- value: Invalid
description: Indicates the upgrade domain state is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
- value: Pending
description: The upgrade domain has not started upgrading yet. The value is 1
- value: InProgress
description: The upgrade domain is being upgraded but not complete yet. The value is 2
- value: Completed
description: The upgrade domain has completed upgrade. The value is 3
DeployedApplicationInfo:
description: Information about application deployed on the node.
properties:
Id:
$ref: '#/definitions/ApplicationId'
description: '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.
Starting in version 6.0, hierarchical names are delimited with the "\~" character. For example, if the application name is "fabric:/myapp/app1",
the application identity would be "myapp\~app1" in 6.0+ and "myapp/app1" in previous versions.'
Name:
$ref: '#/definitions/ApplicationName'
description: The name of the application, including the 'fabric:' URI scheme.
TypeName:
$ref: '#/definitions/ApplicationTypeName'
description: The application type name as defined in the application manifest.
TypeVersion:
$ref: '#/definitions/ApplicationTypeVersion'
description: The version of the application type as defined in the application manifest.
Status:
$ref: '#/definitions/DeployedApplicationStatus'
description: The status of the application deployed on the node. Following are the possible values.
WorkDirectory:
type: string
description: The work directory of the application on the node. The work directory can be used to store application data.
LogDirectory:
type: string
description: The log directory of the application on the node. The log directory can be used to store application logs.
TempDirectory:
type: string
description: The temp directory of the application on the node. The code packages belonging to the application are forked with this directory set as their temporary directory.
HealthState:
$ref: '#/definitions/HealthState'
description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
ApplicationLoadMetricInformation:
description: 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 application.
properties:
Name:
type: string
description: The name of the metric.
ReservationCapacity:
type: integer
format: int64
description: 'This is the capacity reserved in the cluster for the application.
It''s the product of NodeReservationCapacity and MinimumNodes.
If set to zero, no capacity is reserved for this metric.
When setting application capacity or when updating application capacity this value must be smaller than or equal to MaximumCapacity for each metric.'
ApplicationCapacity:
type: integer
format: int64
description: Total capacity for this metric in this application instance.
ApplicationLoad:
type: integer
format: int64
description: Current load for this metric in this application instance.
ProxyResource:
properties:
id:
readOnly: true
type: string
description: The ID of the resource.
name:
readOnly: true
type: string
description: The name of the resource.
type:
readOnly: true
type: string
description: The type of the resource.
etag:
readOnly: true
type: string
description: The ETag of the resource, used for concurrency statements.
description: A definition of an Azure resource.
x-ms-azure-resource: true
ApplicationUpgradeProgressInfo:
description: Describes the parameters for an application upgrade.
properties:
Name:
$ref: '#/definitions/TargetApplicationName'
description: The name of the target application, including the 'fabric:' URI scheme.
TypeName:
$ref: '#/definitions/ApplicationTypeName'
description: The application type name as defined in the application manifest.
TargetApplicationTypeVersion:
$ref: '#/definitions/TargetApplicationTypeVersion'
description: The target application type version (found in the application manifest) for the application upgrade.
UpgradeDomains:
$ref: '#/definitions/UpgradeDomainInfoList'
description: List of upgrade domains and their statuses. Not applicable to node-by-node upgrades.
UpgradeUnits:
$ref: '#/definitions/UpgradeUnitInfoList'
description: List of upgrade units and their statuses.
UpgradeState:
$ref: '#/definitions/UpgradeState'
description: The state of the upgrade domain.
NextUpgradeDomain:
$ref: '#/definitions/NextUpgradeDomain'
description: The name of the next upgrade domain to be processed. Not applicable to node-by-node upgrades.
RollingUpgradeMode:
$ref: '#/definitions/UpgradeMode'
description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.
UpgradeDescription:
$ref: '#/definitions/ApplicationUpgradeDescription'
description: Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.
UpgradeDurationInMilliseconds:
type: string
description: The estimated total amount of time spent processing the overall upgrade.
UpgradeDomainDurationInMilliseconds:
type: string
description: The estimated total amount of time spent processing the current upgrade domain.
UnhealthyEvaluations:
$ref: '#/definitions/UnhealthyEvaluations'
description: List of health evaluations that resulted in the current aggregated health state.
CurrentUpgradeDomainProgress:
$ref: '#/definitions/CurrentUpgradeDomainProgressInfo'
description: Information about the current in-progress upgrade domain. Not applicable to node-by-node upgrades.
CurrentUpgradeUnitsProgress:
$ref: '#/definitions/CurrentUpgradeUnitsProgressInfo'
description: Information about the current in-progress upgrade units.
StartTimestampUtc:
type: string
description: The estimated UTC datetime when the upgrade started.
FailureTimestampUtc:
type: string
description: The estimated UTC datetime when the upgrade failed and FailureAction was executed.
FailureReason:
$ref: '#/definitions/FailureReason'
description: The cause of an upgrade failure that resulted in FailureAction being executed.
UpgradeDomainProgressAtFailure:
$ref: '#/definitions/FailureUpgradeDomainProgressInfo'
description: Information about the upgrade domain progress at the time of upgrade failure.
UpgradeStatusDetails:
type: string
description: Additional detailed information about the status of the pending upgrade.
IsNodeByNode:
type: boolean
description: Indicates whether this upgrade is node-by-node.
default: false
UpgradeReplicaSetCheckTimeout:
type: integer
format: int64
description: 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 expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
default: 42949672925
EntityKindHealthStateCount:
description: Represents health state count for entities of the specified entity kind.
properties:
EntityKind:
$ref: '#/definitions/EntityKind'
description: The entity kind for which health states are evaluated.
HealthStateCount:
$ref: '#/definitions/HealthStateCount'
description: The health state count for the entities of the specified kind.
ManagedApplicationIdentityDescription:
description: Managed application identity description.
properties:
TokenServiceEndpoint:
type: string
description: Token service endpoint.
ManagedIdentities:
$ref: '#/definitions/ManagedApplicationIdentityList'
description: A list of managed application identity objects.
ApplicationLoadInfo:
description: Load Information about a Service Fabric application.
properties:
Id:
$ref: '#/definitions/ApplicationId'
description: '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.
Starting in version 6.0, hierarchical names are delimited with the "\~" character. For example, if the application name is "fabric:/myapp/app1",
the application identity would be "myapp\~app1" in 6.0+ and "myapp/app1" in previous versions.'
MinimumNodes:
type: integer
format: int64
description: 'The minimum number of nodes for this application.
It is the number of nodes where Service Fabric will reserve Capacity in the cluster which equals to ReservedLoad * MinimumNodes for this Application instance.
For applications that do not have application capacity defined this value will be zero.'
MaximumNodes:
type: integer
format: int64
description: 'The maximum number of nodes where this application can be instantiated.
It is the number of nodes this application is allowed to span.
For applications that do not have application capacity defined this value will be zero.'
NodeCount:
type: integer
format: int64
description: 'The number of nodes on which this application is instantiated.
For applications that do not have application capacity defined this value will be zero.'
ApplicationLoadMetricInformation:
$ref: '#/definitions/ApplicationLoadMetricInformationList'
description: List of application load metric information.
ApplicationList:
type: object
title: ApplicationList
description: List of Application definitions.
properties:
value:
type: array
description: List of Application definitions.
items:
$ref: '#/definitions/Application_3'
nextLink:
type: string
readOnly: true
description: Link to the next page of results.
ApplicationDescription:
description: Describes a Service Fabric application.
properties:
Name:
$ref: '#/definitions/ApplicationName'
description: The name of the application, including the 'fabric:' URI scheme.
TypeName:
$ref: '#/definitions/ApplicationTypeName'
description: The application type name as defined in the application manifest.
TypeVersion:
$ref: '#/definitions/ApplicationTypeVersion'
description: The version of the application type as defined in the application manifest.
ParameterList:
$ref: '#/definitions/ApplicationParameterList'
description: List of application parameters with overridden values from their default values specified in the application manifest.
ApplicationCapacity:
$ref: '#/definitions/ApplicationCapacityDescription'
description: 'Describes capacity information for services of this application. This description can be used for describing the following.
- Reserving the capacity for the services on the nodes
- Limiting the total number of nodes that services of this application can run on
- Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application'
ManagedApplicationIdentity:
$ref: '#/definitions/ManagedApplicationIdentityDescription'
description: Managed application identity description.
required:
- Name
- TypeName
- TypeVersion
HealthEvaluationKind:
type: string
description: The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values.
enum:
- Invalid
- Event
- Replicas
- Partitions
- DeployedServicePackages
- DeployedApplications
- Services
- Nodes
- Applications
- SystemApplication
- UpgradeDomainDeployedApplications
- UpgradeDomainNodes
- Replica
- Partition
- DeployedServicePackage
- DeployedApplication
- Service
- Node
- Application
- DeltaNodesCheck
- UpgradeDomainDeltaNodesCheck
- ApplicationTypeApplications
- NodeTypeNodes
x-ms-enum:
name: HealthEvaluationKind
modelAsString: true
values:
- value: Invalid
description: Indicates that the health evaluation is invalid. The value is zero.
- value: Event
description: Indicates that the health evaluation is for a health event. The value is 1.
- value: Replicas
description: Indicates that the health evaluation is for the replicas of a partition. The value is 2.
- value: Partitions
description: Indicates that the health evaluation is for the partitions of a service. The value is 3.
- value: DeployedServicePackages
description: Indicates that the health evaluation is for the deployed service packages of a deployed application. The value is 4.
- value: DeployedApplications
description: Indicates that the health evaluation is for the deployed applications of an application. The value is 5.
- value: Services
description: Indicates that the health evaluation is for services of an application. The value is 6.
- value: Nodes
description: Indicates that the health evaluation is for the cluster nodes. The value is 7.
- value: Applications
description: Indicates that the health evaluation is for the cluster applications. The value is 8.
- value: SystemApplication
description: Indicates that the health evaluation is for the system application. The value is 9.
- value: UpgradeDomainDeployedApplications
description: Indicates that the health evaluation is for the deployed applications of an application in an upgrade domain. The value is 10.
- value: UpgradeDomainNodes
description: Indicates that the health evaluation is for the cluster nodes in an upgrade domain. The value is 11.
- value: Replica
description: Indicates that the health evaluation is for a replica. The value is 13.
- value: Partition
description: Indicates that the health evaluation is for a partition. The value is 14.
- value: DeployedServicePackage
description: Indicates that the health evaluation is for a deployed service package. The value is 16.
- value: DeployedApplication
description: Indicates that the health evaluation is for a deployed application. The value is 17.
- value: Service
description: Indicates that the health evaluation is for a service. The value is 15.
- value: Node
description: Indicates that the health evaluation is for a node. The value is 12.
- value: Application
description: Indicates that the health evaluation is for an application. The value is 18.
- value: DeltaNodesCheck
description: Indicates that the health evaluation is for the delta of unhealthy cluster nodes. The value is 19.
- value: UpgradeDomainDeltaNodesCheck
description: Indicates that the health evaluation is for the delta of unhealthy upgrade domain cluster nodes. The value is 20.
- value: ApplicationTypeApplications
description: – Indicates that the health evaluation is for applications of an application type. The value is 21.
- value: NodeTypeNodes
description: – Indicates that the health evaluation is for nodes of a node type. The value is 22.
ApplicationId:
type: string
description: '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.
Starting in version 6.0, hierarchical names are delimited with the "\~" character. For example, if the application name is "fabric:/myapp/app1",
the application identity would be "myapp\~app1" in 6.0+ and "myapp/app1" in previous versions.'
UpgradeSortOrder:
type: string
description: Defines the order in which an upgrade proceeds through the cluster.
enum:
- Invalid
- Default
- Numeric
- Lexicographical
- ReverseNumeric
- ReverseLexicographical
default: Default
x-ms-enum:
name: UpgradeSortOrder
modelAsString: true
values:
- value: Invalid
description: Indicates that this sort order is not valid. All Service Fabric enumerations have the invalid type. The value is 0.
- value: Default
description: Indicates that the default sort order (as specified in cluster manifest) will be used. The value is 1.
- value: Numeric
description: Indicates that forward numeric sort order (UD names sorted as numbers) will be used. The value is 2.
- value: Lexicographical
description: Indicates that forward lexicographical sort order (UD names sorted as strings) will be used. The value is 3.
- value: ReverseNumeric
description: Indicates that reverse numeric sort order (UD names sorted as numbers) will be used. The value is 4.
- value: ReverseLexicographical
description: Indicates that reverse lexicographical sort order (UD names sorted as strings) will be used. The value is 5.
GraphError:
type: object
properties:
odata.error:
type: object
x-ms-client-flatten: true
$ref: '#/definitions/OdataError'
description: A Graph API error.
description: Active Directory error information.
ServiceTypeHealthPolicyMap:
type: array
items:
$ref: '#/definitions/ServiceTypeHealthPolicyMapItem'
description: 'Defines a ServiceTypeHealthPolicy per service type name.
The entries in the map replace the default service type health policy for each specified service type. For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently. With policy per service type, there''s more granular control of the health of the service.
If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.'
ServiceName:
type: string
description: The full name of the service with 'fabric:' URI scheme.
PasswordCredential:
type: object
properties:
startDate:
type: string
format: date-time
description: Start date.
endDate:
type: string
format: date-time
description: End date.
keyId:
type: string
description: Key ID.
value:
type: string
description: Key value.
customKeyIdentifier:
type: string
format: byte
description: Custom Key Identifier
additionalProperties:
type: object
description: Active Directory Password Credential information.
PreAuthorizedApplicationExtension:
type: object
description: Representation of an app PreAuthorizedApplicationExtension required by a pre authorized client app.
properties:
conditions:
description: The extension's conditions.
type: array
items:
type: string
ApplicationUpdateParameters:
type: object
allOf:
- $ref: '#/definitions/ApplicationBase'
description: Request parameters for updating a new application.
properties:
displayName:
type: string
description: The display name of the application.
identifierUris:
type: array
items:
type: string
description: A collection of URIs for the application.
UpgradeDomainTimeout:
type: string
description: 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. If that fails, then it is interpreted as a number representing the total number of milliseconds.
default: P10675199DT02H48M05.4775807S
FabricError:
description: The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful.
properties:
Error:
$ref: '#/definitions/FabricErrorError'
description: Error object containing error code and error message.
required:
- Error
DeployedApplicationHealthState:
description: Represents the health state of a deployed application, which contains the entity identifier and the aggregated health state.
allOf:
- $ref: '#/definitions/EntityHealthState'
properties:
NodeName:
$ref: '#/definitions/NodeName'
description: Name of the node on which the service package is deployed.
ApplicationName:
$ref: '#/definitions/ApplicationName'
description: The name of the application, including the 'fabric:' URI scheme.
DeployedServicePackageHealthStateList:
description: List of health states for a service package deployed on a Service Fabric node.
type: array
items:
$ref: '#/definitions/DeployedServicePackageHealthState'
PagedDeployedApplicationInfoList:
description: '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 message.
The next set of results can be obtained by executing the same query with the continuation token provided in this list.'
properties:
ContinuationToken:
$ref: '#/definitions/ContinuationToken'
description: 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 system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
Items:
type: array
description: List of deployed application information.
items:
$ref: '#/definitions/DeployedApplicationInfo'
UpgradeUnitState:
type: string
description: The state of the upgrade unit.
enum:
- Invalid
- Pending
- InProgress
- Completed
- Failed
x-ms-enum:
name: UpgradeUnitState
modelAsString: true
values:
- value: Invalid
description: Indicates the upgrade unit state is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
- value: Pending
description: The upgrade unit has not started upgrading yet. The value is 1
- value: InProgress
description: The upgrade unit is being upgraded but not complete yet. The value is 2
- value: Completed
description: The upgrade unit has completed upgrade. The value is 3
- value: Failed
description: The upgrade unit has failed to upgrade. The value is 4
RollingUpgradeUpdateDescription:
description: Describes the parameters for updating a rolling upgrade of application or cluster.
properties:
RollingUpgradeMode:
$ref: '#/definitions/UpgradeMode'
description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.
ForceRestart:
$ref: '#/definitions/ForceRestart'
description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
ReplicaSetCheckTimeoutInMilliseconds:
$ref: '#/definitions/UpgradeReplicaSetCheckTimeout'
description: 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 expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
FailureAction:
$ref: '#/definitions/FailureAction'
description: 'The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.
Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.
Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.'
HealthCheckWaitDurationInMilliseconds:
$ref: '#/definitions/HealthCheckWaitDuration'
description: 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 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
HealthCheckStableDurationInMilliseconds:
$ref: '#/definitions/HealthCheckStableDuration'
description: 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 string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
HealthCheckRetryTimeoutInMilliseconds:
$ref: '#/definitions/HealthCheckRetryTimeout'
description: 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 string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
UpgradeTimeoutInMilliseconds:
$ref: '#/definitions/UpgradeTimeout'
description: 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. If that fails, then it is interpreted as a number representing the total number of milliseconds.
UpgradeDomainTimeoutInMilliseconds:
$ref: '#/definitions/UpgradeDomainTimeout'
description: 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. If that fails, then it is interpreted as a number representing the total number of milliseconds.
InstanceCloseDelayDurationInSeconds:
$ref: '#/definitions/InstanceCloseDelayDurationInSeconds'
description: '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 is closing during the application/cluster
upgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: "#/definitions/StatelessServiceDescription.yaml" for details.
Note, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description.'
required:
- RollingUpgradeMode
KeyCredential:
type: object
properties:
startDate:
type: string
format: date-time
description: Start date.
endDate:
type: string
format: date-time
description: End date.
value:
type: string
description: Key value.
keyId:
type: string
description: Key ID.
usage:
type: string
description: Usage. Acceptable values are 'Verify' and 'Sign'.
type:
type: string
description: Type. Acceptable values are 'AsymmetricX509Cert' and 'Symmetric'.
customKeyIdentifier:
type: string
description: Custom Key Identifier
additionalProperties:
type: object
description: Active Directory Key Credential information.
ApplicationCapacityDescription:
description: 'Describes capacity information for services of this application. This description can be used for describing the following.
- Reserving the capacity for the services on the nodes
- Limiting the total number of nodes that services of this application can run on
- Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application'
properties:
MinimumNodes:
type: integer
format: int64
description: The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.
minimum: 0
MaximumNodes:
type: integer
format: int64
description: The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node.
minimum: 0
default: 0
ApplicationMetrics:
$ref: '#/definitions/ApplicationMetricDescriptionList'
description: List of application capacity metric description.
UpgradeMode:
type: string
description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.
enum:
- Invalid
- UnmonitoredAuto
- UnmonitoredManual
- Monitored
- UnmonitoredDeferred
default: UnmonitoredAuto
x-ms-enum:
name: UpgradeMode
modelAsString: true
values:
- value: Invalid
description: Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
- value: UnmonitoredAuto
description: The upgrade will proceed automatically without performing any health monitoring. The value is 1
- value: UnmonitoredManual
description: The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2
- value: Monitored
description: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3
- value: UnmonitoredDeferred
description: Perform a node-by-node upgrade. No action is performed when upgrade starts; upgrade is applied on each node when it is deactivated with intent restart or higher. The value is 4
ApplicationPatch:
type: object
description: Application properties that can be patched.
properties:
tags:
type: object
additionalProperties:
type: string
description: tags to be updated
properties:
description: Detailed properties for Application
x-ms-client-flatten: true
$ref: '#/definitions/ApplicationPatchProperties'
MonitoringPolicyDescription:
description: Describes the parameters for monitoring an upgrade in Monitored mode.
properties:
FailureAction:
$ref: '#/definitions/FailureAction'
description: 'The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.
Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.
Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.'
HealthCheckWaitDurationInMilliseconds:
$ref: '#/definitions/HealthCheckWaitDuration'
description: 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 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
HealthCheckStableDurationInMilliseconds:
$ref: '#/definitions/HealthCheckStableDuration'
description: 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 string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
HealthCheckRetryTimeoutInMilliseconds:
$ref: '#/definitions/HealthCheckRetryTimeout'
description: 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 string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
UpgradeTimeoutInMilliseconds:
$ref: '#/definitions/UpgradeTimeout'
description: 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. If that fails, then it is interpreted as a number representing the total number of milliseconds.
UpgradeDomainTimeoutInMilliseconds:
$ref: '#/definitions/UpgradeDomainTimeout'
description: 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. If that fails, then it is interpreted as a number representing the total number of milliseconds.
Application_3:
description: Schema for Application properties.
type: object
allOf:
- $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/Resource
required:
- properties
properties:
systemData:
$ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
description: Metadata pertaining to creation and last modification of the resource.
properties:
description: Detailed properties for Application
x-ms-client-flatten: true
$ref: '#/definitions/ApplicationProperties_3'
x-nullable: false
ResourceAccess:
type: object
properties:
id:
type: string
description: The unique identifier for one of the OAuth2Permission or AppRole instances that the resource application exposes.
type:
type: string
description: Specifies whether the id property references an OAuth2Permission or an AppRole. Possible values are "scope" or "role".
additionalProperties:
type: object
required:
- id
description: Specifies an OAuth 2.0 permission scope or an app role that an application requires. The resourceAccess property of the RequiredResourceAccess type is a collection of ResourceAccess.
TargetApplicationName:
type: string
description: The name of the target application, including the 'fabric:' URI scheme.
ServicePackageActivationId:
type: string
description: 'The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service
is ''SharedProcess'' (or if it is not specified, in which case it defaults to ''SharedProcess''), then value of ServicePackageActivationId
is always an empty string.'
ApplicationLoadMetricInformationList:
type: array
items:
$ref: '#/definitions/ApplicationLoadMetricInformation'
description: List of application load metric information.
HealthCheckWaitDuration:
type: string
description: 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 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
default: '0'
ApplicationParameterList:
type: array
items:
$ref: '#/definitions/ApplicationParameter'
description: List of application parameters with overridden values from their default values specified in the application manifest.
ApplicationProperties:
properties:
displayName:
type: string
description: The display name for the application.
allowUpdates:
type: boolean
description: A value indicating whether packages within the application may be overwritten using the same version string.
defaultVersion:
type: string
description: The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package.
description: The properties associated with the Application.
ApplicationStatus:
type: string
description: The status of the application.
enum:
- Invalid
- Ready
- Upgrading
- Creating
- Deleting
- Failed
x-ms-enum:
name: ApplicationStatus
modelAsString: true
values:
- value: Invalid
description: Indicates the application status is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
- value: Ready
description: Indicates the application status is ready. The value is 1.
- value: Upgrading
description: Indicates the application status is upgrading. The value is 2.
- value: Creating
description: Indicates the application status is creating. The value is 3.
- value: Deleting
description: Indicates the application status is deleting. The value is 4.
- value: Failed
description: Indicates the creation or deletion of application was terminated due to persistent failures. Another create/delete request can be accepted to resume a failed application. The value is 5.
RequiredResourceAccess:
type: object
properties:
resourceAccess:
type: array
items:
$ref: '#/definitions/ResourceAccess'
description: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource.
resourceAppId:
type: string
description: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application.
additionalProperties:
type: object
required:
- resourceAccess
description: 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 permission scopes may be requested by client applications (through the requiredResourceAccess collection) when calling a resource application. The requiredResourceAccess property of the Application entity is a collection of RequiredResourceAccess.
UpgradeDomainName:
type: string
description: The name of the upgrade domain
ApplicationMetricDescription:
description: 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 application.
properties:
Name:
type: string
description: The name of the metric.
MaximumCapacity:
type: integer
format: int64
description: 'The maximum node capacity for Service Fabric application.
This is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value.
If set to zero, capacity for this metric is unlimited on each node.
When creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.
When updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.'
ReservationCapacity:
type: integer
format: int64
description: 'The node reservation capacity for Service Fabric application.
This is the amount of load which is reserved on nodes which have instances of this application.
If MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application.
If set to zero, no capacity is reserved for this metric.
When setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric.'
TotalApplicationCapacity:
description: 'The total metric capacity for Service Fabric application.
This is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value.
When creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.'
type: integer
format: int64
Application:
properties:
properties:
x-ms-client-flatten: true
$ref: '#/definitions/ApplicationProperties'
description: The properties associated with the Application.
allOf:
- $ref: '#/definitions/ProxyResource'
description: Contains information about an application in a Batch account.
OdataError:
type: object
properties:
code:
type: string
description: Error code.
message:
type: object
x-ms-client-flatten: true
$ref: '#/definitions/ErrorMessage'
description: Error Message.
description: Active Directory OData error information.
UpgradeKind:
type: string
description: The kind of upgrade out of the following possible values.
default: Rolling
enum:
- Invalid
- Rolling
x-ms-enum:
name: UpgradeKind
modelAsString: true
values:
- value: Invalid
description: Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
- value: Rolling
description: The upgrade progresses one upgrade domain at a time. The value is 1
UpgradeUnitInfoList:
type: array
description: List of upgrade units and their statuses.
items:
$ref: '#/definitions/UpgradeUnitInfo'
ApplicationName:
type: string
description: The name of the application, including the 'fabric:' URI scheme.
ServiceTypeHealthPolicyMapItem:
description: Defines an item in ServiceTypeHealthPolicyMap.
required:
- Key
- Value
properties:
Key:
type: string
description: The key of the service type health policy map item. This is the name of the service type.
Value:
$ref: '#/definitions/ServiceTypeHealthPolicy'
description: The value of the service type health policy map item. This is the ServiceTypeHealthPolicy for this service type.
ApplicationUpgradeDescription:
description: Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.
properties:
Name:
$ref: '#/definitions/TargetApplicationName'
description: The name of the target application, including the 'fabric:' URI scheme.
TargetApplicationTypeVersion:
$ref: '#/definitions/TargetApplicationTypeVersion'
description: The target application type version (found in the application manifest) for the application upgrade.
Parameters:
$ref: '#/definitions/ApplicationParameterList'
description: List of application parameters with overridden values from their default values specified in the application manifest.
UpgradeKind:
$ref: '#/definitions/UpgradeKind'
description: The kind of upgrade out of the following possible values.
RollingUpgradeMode:
$ref: '#/definitions/UpgradeMode'
description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.
UpgradeReplicaSetCheckTimeoutInSeconds:
$ref: '#/definitions/UpgradeReplicaSetCheckTimeout'
description: 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 expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
ForceRestart:
$ref: '#/definitions/ForceRestart'
description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
SortOrder:
$ref: '#/definitions/UpgradeSortOrder'
description: Defines the order in which an upgrade proceeds through the cluster.
MonitoringPolicy:
$ref: '#/definitions/MonitoringPolicyDescription'
description: Describes the parameters for monitoring an upgrade in Monitored mode.
ApplicationHealthPolicy:
$ref: '#/definitions/ApplicationHealthPolicy'
description: Defines a health policy used to evaluate the health of an application or one of its children entities.
InstanceCloseDelayDurationInSeconds:
$ref: '#/definitions/InstanceCloseDelayDurationInSeconds'
description: '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 is closing during the application/cluster
upgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: "#/definitions/StatelessServiceDescription.yaml" for details.
Note, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description.'
ManagedApplicationIdentity:
$ref: '#/definitions/ManagedApplicationIdentityDescription'
description: Managed application identity description.
required:
- Name
- TargetApplicationTypeVersion
- UpgradeKind
NodeUpgradeProgressInfo:
description: Information about the upgrading node and its status
properties:
NodeName:
$ref: '#/definitions/NodeName'
description: The name of a Service Fabric node.
UpgradePhase:
$ref: '#/definitions/NodeUpgradePhase'
description: The state of the upgrading node.
PendingSafetyChecks:
$ref: '#/definitions/SafetyCheckInfoList'
description: List of pending safety checks
UpgradeDuration:
$ref: '#/definitions/NodeUpgradeDurationString'
description: The estimated time spent processing the node since it was deactivated during a node-by-node upgrade.
PreAuthorizedApplicationPermission:
type: object
description: Contains information about the pre-authorized permissions.
properties:
directAccessGrant:
description: Indicates whether the permission set is DirectAccess or impersonation.
type: boolean
accessGrants:
description: The list of permissions.
type: array
items:
type: string
OAuth2Permission:
type: object
description: Represents an OAuth 2.0 delegated permission scope. The specified OAuth 2.0 delegated permission scopes may be requested by client applications (through the requiredResourceAccess collection on the Application object) when calling a resource application. The oauth2Permissions property of the ServicePrincipal entity and of the Application entity is a collection of OAuth2Permission.
properties:
adminConsentDescription:
description: Permission help text that appears in the admin consent and app assignment experiences.
type: string
adminConsentDisplayName:
description: Display name for the permission that appears in the admin consent and app assignment experiences.
type: string
id:
description: Unique scope permission identifier inside the oauth2Permissions collection.
type: string
isEnabled:
description: 'When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. '
type: boolean
type:
description: Specifies whether this scope permission can be consented to by an end user, or whether it is a tenant-wide permission that must be consented to by a Company Administrator. Possible values are "User" or "Admin".
type: string
userConsentDescription:
description: Permission help text that appears in the end user consent experience.
type: string
userConsentDisplayName:
description: Display name for the permission that appears in the end user consent experience.
type: string
value:
description: The value of the scope claim that the resource application should expect in the OAuth 2.0 access token.
type: string
NextUpgradeDomain:
type: string
description: The name of the next upgrade domain to be processed. Not applicable to node-by-node upgrades.
OptionalClaim:
type: object
description: Specifying the claims to be included in a token.
properties:
name:
description: Claim name.
type: string
source:
description: Claim source.
type: string
essential:
description: Is this a required claim.
type: boolean
additionalProperties:
type: object
ApplicationPatchProperties:
description: Application properties that can be patched.
type: object
properties:
description:
type: string
description: Description of Application.
friendlyName:
type: string
description: Friendly name of Application.
filePath:
type: string
description: Specifies a path for the executable file for the application.
commandLineSetting:
enum:
- DoNotAllow
- Allow
- Require
x-ms-enum:
name: CommandLineSetting
modelAsString: true
type: string
description: Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.
commandLineArguments:
type: string
description: Command Line Arguments for Application.
showInPortal:
type: boolean
description: Specifies whether to show the RemoteApp program in the RD Web Access server.
iconPath:
type: string
description: Path to icon.
iconIndex:
type: integer
format: int32
description: Index of the icon.
msixPackageFamilyName:
type: string
description: Specifies the package family name for MSIX applications
x-nullable: true
msixPackageApplicationId:
type: string
description: Specifies the package application Id for MSIX applications
x-nullable: true
applicationType:
enum:
- InBuilt
- MsixApplication
x-ms-enum:
name: RemoteApplicationType
modelAsString: true
type: string
description: Resource Type of Application.
HealthCheckStableDuration:
type: string
description: 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 string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
default: PT0H2M0S
DeployedServicePackageHealthState:
description: Represents the health state of a deployed service package, containing the entity identifier and the aggregated health state.
allOf:
- $ref: '#/definitions/EntityHealthState'
properties:
NodeName:
$ref: '#/definitions/NodeName'
description: Name of the node on which the service package is deployed.
ApplicationName:
$ref: '#/definitions/ApplicationName'
description: The name of the application, including the 'fabric:' URI scheme.
ServiceManifestName:
$ref: '#/definitions/ServiceManifestName'
description: Name of the manifest describing the service package.
ServicePackageActivationId:
$ref: '#/definitions/ServicePackageActivationId'
description: 'The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service
is ''SharedProcess'' (or if it is not specified, in which case it defaults to ''SharedProcess''), then value of ServicePackageActivationId
is always an empty string.'
UpgradeTimeout:
type: string
description: 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. If that fails, then it is interpreted as a number representing the total number of milliseconds.
default: P10675199DT02H48M05.4775807S
UpgradeState:
type: string
description: The state of the upgrade domain.
enum:
- Invalid
- RollingBackInProgress
- RollingBackCompleted
- RollingForwardPending
- RollingForwardInProgress
- RollingForwardCompleted
- Failed
x-ms-enum:
name: UpgradeState
modelAsString: true
values:
- value: Invalid
description: Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
- value: RollingBackInProgress
description: The upgrade is rolling back to the previous version but is not complete yet. The value is 1
- value: RollingBackCompleted
description: The upgrade has finished rolling back. The value is 2
- value: RollingForwardPending
description: The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3
- value: RollingForwardInProgress
description: The upgrade is rolling forward to the target version but is not complete yet. The value is 4
- value: RollingForwardCompleted
description: The upgrade has finished rolling forward. The value is 5
- value: Failed
description: The upgrade has failed and is unable to execute FailureAction. The value is 6
CloudError:
x-ms-external: true
properties:
error:
$ref: '#/definitions/CloudErrorBody'
description: An error response from the Batch service.
EntityKind:
type: string
description: The entity type of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
enum:
- Invalid
- Node
- Partition
- Service
- Application
- Replica
- DeployedApplication
- DeployedServicePackage
- Cluster
x-ms-enum:
name: EntityKind
modelAsString: true
values:
- value: Invalid
description: Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type. The value is zero.
- value: Node
description: Indicates the entity is a Service Fabric node. The value is 1.
- value: Partition
description: Indicates the entity is a Service Fabric partition. The value is 2.
- value: Service
description: Indicates the entity is a Service Fabric service. The value is 3.
- value: Application
description: Indicates the entity is a Service Fabric application. The value is 4.
- value: Replica
description: Indicates the entity is a Service Fabric replica. The value is 5.
- value: DeployedApplication
description: Indicates the entity is a Service Fabric deployed application. The value is 6.
- value: DeployedServicePackage
description: Indicates the entity is a Service Fabric deployed service package. The value is 7.
- value: Cluster
description: Indicates the entity is a Service Fabric cluster. The value is 8.
GroupMembershipClaims:
type: string
description: Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects.
enum:
- None
- SecurityGroup
- All
x-ms-enum:
name: GroupMembershipClaimTypes
modelAsString: true
DeployedApplicationHealth:
description: Information about the health of an application deployed on a Service Fabric node.
allOf:
- $ref: '#/definitions/EntityHealth'
properties:
Name:
$ref: '#/definitions/ApplicationName'
description: Name of the application deployed on the node whose health information is described by this object.
NodeName:
$ref: '#/definitions/NodeName'
description: Name of the node where this application is deployed.
DeployedServicePackageHealthStates:
$ref: '#/definitions/DeployedServicePackageHealthStateList'
description: Deployed service package health states for the current deployed application as found in the health store.
parameters:
ResourceGroupNameParameter:
name: resourceGroupName
in: path
required: true
type: string
description: The name of the resource group that contains the Batch account.
x-ms-parameter-location: method
NodeNameRequiredPathParam:
name: nodeName
in: path
x-ms-parameter-location: method
type: string
required: true
description: The name of the node.
TimeoutOptionalQueryParam:
name: timeout
in: query
x-ms-parameter-location: method
type: integer
format: int64
required: false
minimum: 1
maximum: 4294967295
default: 60
description: The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
ExcludeHealthStatisticsOptionalQueryParam:
name: ExcludeHealthStatistics
description: 'Indicates whether the health statistics should be returned as part of the query result. False by default.
The statistics show the number of children entities in health state Ok, Warning, and Error.'
in: query
x-ms-parameter-location: method
type: boolean
required: false
default: false
ResumeApplicationUpgradeDescriptionRequiredBodyParam:
name: ResumeApplicationUpgradeDescription
in: body
description: Describes the parameters for resuming an application upgrade.
required: true
x-ms-parameter-location: method
schema:
$ref: '#/definitions/ResumeApplicationUpgradeDescription'
ApiVersion_8-1_RequiredQueryParam:
name: api-version
in: query
x-ms-parameter-location: method
type: string
enum:
- '8.1'
required: true
default: '8.1'
description: 'The version of the API. This parameter is required and its value must be ''8.1''.
Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.
Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.'
x-ms-enum:
name: ApiVersion_8-1_RequiredQueryParam
modelAsString: true
values:
- value: '8.1'
description: The 8.1 version of the API.
HealthInformationRequiredBodyParam:
name: HealthInformation
in: body
description: Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.
required: true
x-ms-parameter-location: method
schema:
$ref: '#/definitions/HealthInformation'
AccountNameParameter:
name: accountName
in: path
required: true
type: string
pattern: ^[a-zA-Z0-9]+$
minLength: 3
maxLength: 24
description: The name of the Batch account.
x-ms-parameter-location: method
ApiVersion_6-1_RequiredQueryParam:
name: api-version
in: query
x-ms-parameter-location: method
type: string
enum:
- '6.1'
required: true
default: '6.1'
description: 'The version of the API. This parameter is required and its value must be ''6.1''.
Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.
Additionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.'
x-ms-enum:
name: ApiVersion_6-1_RequiredQueryParam
modelAsString: true
values:
- value: '6.1'
description: The 6.1 version of the API.
DeployedApplicationsHealthStateFilterOptionalQueryParam:
name: DeployedApplicationsHealthStateFilter
description: 'Allows filtering of the deployed applications health state objects returned in the result of application health query based on their health state.
The possible values for this parameter include integer value of one of the following health states. Only deployed applications that match the filter will be returned.
All deployed applications are used to evaluate the aggregated health state. If not specified, all entries are returned.
The state values are flag-based enumeration, so the value could be a combination of these values, obtained using bitwise ''OR'' operator.
For example, if the provided value is 6 then health state of deployed applications with HealthState value of OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn''t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.
- Ok - Filter that matches input with HealthState value Ok. The value is 2.
- Warning - Filter that matches input with HealthState value Warning. The value is 4.
- Error - Filter that matches input with HealthState value Error. The value is 8.
- All - Filter that matches input with any HealthState value. The value is 65535.'
in: query
x-ms-parameter-location: method
type: integer
required: false
default: 0
ApplicationDescriptionRequiredBodyParam:
name: ApplicationDescription
in: body
description: Description for creating an application.
required: true
x-ms-parameter-location: method
schema:
$ref: '#/definitions/ApplicationDescription'
ApplicationDefinitionKindFilterOptionalQueryParam:
name: ApplicationDefinitionKindFilter
description: 'Used to filter on ApplicationDefinitionKind, which is the mechanism used to define a Service Fabric application.
- Default - Default value, which performs the same function as selecting "All". The value is 0.
- All - Filter that matches input with any ApplicationDefinitionKind value. The value is 65535.
- ServiceFabricApplicationDescription - Filter that matches input with ApplicationDefinitionKind value ServiceFabricApplicationDescription. The value is 1.
- Compose - Filter that matches input with ApplicationDefinitionKind value Compose. The value is 2.'
in: query
x-ms-parameter-location: method
type: integer
required: false
default: 0
ContinuationTokenOptionalQueryParam:
name: ContinuationToken
in: query
x-ms-parameter-location: method
x-ms-skip-url-encoding: true
type: string
required: false
description: The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
ApplicationNameParameter_2:
name: applicationName
in: path
required: true
type: string
description: The name of the application within the specified application group
maxLength: 24
minLength: 3
x-ms-parameter-location: method
ApplicationTypeNameOptionalQueryParam:
name: ApplicationTypeName
in: query
x-ms-parameter-location: method
type: string
required: false
description: The application type name used to filter the applications to query for. This value should not contain the application type version.
ApiVersionParameter_2:
name: api-version
in: query
required: true
type: string
description: Client API version.
ApplicationHealthPolicyOptionalBodyParam:
name: ApplicationHealthPolicy
in: body
description: 'Describes the health policies used to evaluate the health of an application or one of its children.
If not present, the health evaluation uses the health policy from application manifest or the default health policy.'
required: false
x-ms-parameter-location: method
schema:
$ref: '#/definitions/ApplicationHealthPolicy'
ForceRemoveOptionalQueryParam:
name: ForceRemove
in: query
x-ms-parameter-location: method
type: boolean
required: false
description: Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas.
ApplicationUpgradeUpdateDescriptionRequiredBodyParam:
name: ApplicationUpgradeUpdateDescription
in: body
description: Parameters for updating an existing application upgrade.
required: true
x-ms-parameter-location: method
schema:
$ref: '#/definitions/ApplicationUpgradeUpdateDescription'
tenantIDInPath:
name: tenantID
in: path
required: true
type: string
description: The tenant ID.
x-ms-parameter-location: client
ApplicationIdRequiredPathParam:
name: applicationId
in: path
x-ms-parameter-location: method
x-ms-skip-url-encoding: true
type: string
required: true
description: 'The identity of the application. This is typically the full name of the application without the ''fabric:'' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the "~" character.
For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.'
ApiVersionParameter:
name: api-version
in: query
required: true
type: string
description: The API version to be used with the HTTP request.
ServicesHealthStateFilterOptionalQueryParam:
name: ServicesHealthStateFilter
description: 'Allows filtering of the services health state objects returned in the result of services health query based on their health state.
The possible values for this parameter include integer value of one of the following health states.
Only services that match the filter are returned. All services are used to evaluate the aggregated health state.
If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values,
obtained using bitwise ''OR'' operator. For example, if the provided value is 6 then health state of services with HealthState value of OK (2) and Warning (4) will be returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn''t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.
- Ok - Filter that matches input with HealthState value Ok. The value is 2.
- Warning - Filter that matches input with HealthState value Warning. The value is 4.
- Error - Filter that matches input with HealthState value Error. The value is 8.
- All - Filter that matches input with any HealthState value. The value is 65535.'
in: query
x-ms-parameter-location: method
type: integer
required: false
default: 0
ImmediateOptionalQueryParam:
name: Immediate
in: query
x-ms-parameter-location: method
type: boolean
required: false
default: false
description: 'A flag that indicates whether the report should be sent immediately.
A health report is sent to a Service Fabric gateway Application, which forwards to the health store.
If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using.
This is useful for critical reports that should be sent as soon as possible.
Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn''t reach the Gateway.
If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration.
This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing.
By default, reports are not sent immediately.'
ApplicationGroupNameParameter:
name: applicationGroupName
in: path
required: true
type: string
description: The name of the application group
maxLength: 64
minLength: 3
x-ms-parameter-location: method
DeployedServicePackagesHealthStateFilterOptionalQueryParam:
name: DeployedServicePackagesHealthStateFilter
description: 'Allows filtering of the deployed service package health state objects returned in the result of deployed application health query based on their health state.
The possible values for this parameter include integer value of one of the following health states.
Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the aggregated health state of the deployed application.
If not specified, all entries are returned.
The state values are flag-based enumeration, so the value can be a combination of these values, obtained using the bitwise ''OR'' operator.
For example, if the provided value is 6 then health state of service packages with HealthState value of OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn''t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.
- Ok - Filter that matches input with HealthState value Ok. The value is 2.
- Warning - Filter that matches input with HealthState value Warning. The value is 4.
- Error - Filter that matches input with HealthState value Error. The value is 8.
- All - Filter that matches input with any HealthState value. The value is 65535.'
in: query
x-ms-parameter-location: method
type: integer
required: false
default: 0
ApplicationUpgradeDescriptionRequiredBodyParam:
name: ApplicationUpgradeDescription
in: body
description: Parameters for an application upgrade.
required: true
x-ms-parameter-location: method
schema:
$ref: '#/definitions/ApplicationUpgradeDescription'
IncludeHealthStateOptionalQueryParam:
name: IncludeHealthState
in: query
x-ms-parameter-location: method
type: boolean
required: false
default: false
description: 'Include the health state of an entity.
If this parameter is false or not specified, then the health state returned is "Unknown".
When set to true, the query goes in parallel to the node and the health system service before the results are merged.
As a result, the query is more expensive and may take a longer time.'
SubscriptionIdParameter:
name: subscriptionId
in: path
required: true
type: string
description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
ApplicationNameParameter:
name: applicationName
in: path
required: true
type: string
pattern: ^[a-zA-Z0-9_-]+$
minLength: 1
maxLength: 64
description: The name of the application. This must be unique within the account.
x-ms-parameter-location: method
ApplicationUpdateDescriptionRequiredBodyParam:
name: ApplicationUpdateDescription
in: body
description: Parameters for updating an existing application instance.
required: true
x-ms-parameter-location: method
schema:
$ref: '#/definitions/ApplicationUpdateDescription'
EventsHealthStateFilterOptionalQueryParam:
name: EventsHealthStateFilter
description: 'Allows filtering the collection of HealthEvent objects returned based on health state.
The possible values for this parameter include integer value of one of the following health states.
Only events that match the filter are returned. All events are used to evaluate the aggregated health state.
If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ''OR'' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned.
- Default - Default value. Matches any HealthState. The value is zero.
- None - Filter that doesn''t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.
- Ok - Filter that matches input with HealthState value Ok. The value is 2.
- Warning - Filter that matches input with HealthState value Warning. The value is 4.
- Error - Filter that matches input with HealthState value Error. The value is 8.
- All - Filter that matches input with any HealthState value. The value is 65535.'
in: query
x-ms-parameter-location: method
type: integer
required: false
default: 0
ApiVersion_6-0_RequiredQueryParam:
name: api-version
in: query
x-ms-parameter-location: method
type: string
enum:
- '6.0'
required: true
default: '6.0'
description: 'The version of the API. This parameter is required and its value must be ''6.0''.
Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.
Additionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.'
x-ms-enum:
name: ApiVersion_6-0_RequiredQueryParam
modelAsString: true
values:
- value: '6.0'
description: The 6.0 version of the API.
ExcludeApplicationParametersOptionalQueryParam:
name: ExcludeApplicationParameters
in: query
x-ms-parameter-location: method
type: boolean
required: false
default: false
description: The flag that specifies whether application parameters will be excluded from the result.
MaxResultsOptionalQueryParam:
name: MaxResults
in: query
x-ms-parameter-location: method
type: integer
format: int64
minimum: 0
default: 0
required: false
description: The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
x-ms-parameterized-host:
hostTemplate: '{endpoint}'
useSchemePrefix: false
parameters:
- $ref: '#/parameters/Endpoint'