swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Applications API schemes: - https tags: - name: Applications paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName} : get: tags: - Applications operationId: microsoftAzureApplicationsGet description: Gets the managed application. x-ms-examples: Get a managed application: $ref: ./examples/getApplication.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ApplicationNameParameter' responses: '200': description: OK - Returns the managed application. schema: $ref: '#/definitions/Application' '404': description: NotFound. x-ms-error-response: false default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Solutions Applications Applicationname delete: tags: - Applications operationId: microsoftAzureApplicationsDelete description: Deletes the managed application. x-ms-examples: Delete managed application: $ref: ./examples/deleteApplication.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ApplicationNameParameter' responses: '200': description: OK '202': description: Accepted - Returns this status until the asynchronous operation has completed. '204': description: NoContent default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Solutions Applications Applicationname put: tags: - Applications operationId: microsoftAzureApplicationsCreateorupdate description: Creates or updates a managed application. x-ms-examples: Create or update managed application: $ref: ./examples/createOrUpdateApplication.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ApplicationNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/Application' description: Parameters supplied to the create or update a managed application. responses: '200': description: OK - Returns information about the managed application, including provisioning status. schema: $ref: '#/definitions/Application' '201': description: Created - Returns information about the managed application, including provisioning status. schema: $ref: '#/definitions/Application' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Solutions Applications Applicationname patch: tags: - Applications operationId: microsoftAzureApplicationsUpdate description: Updates an existing managed application. x-ms-examples: Updates managed application: $ref: ./examples/updateApplication.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ApplicationNameParameter' - name: parameters in: body schema: $ref: '#/definitions/ApplicationPatchable' description: Parameters supplied to update an existing managed application. responses: '200': description: OK. schema: $ref: '#/definitions/ApplicationPatchable' '202': description: Accepted - Returns this status until the asynchronous operation has completed. schema: $ref: '#/definitions/ApplicationPatchable' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Solutions Applications Applicationname /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications: get: tags: - Applications operationId: microsoftAzureApplicationsListbyresourcegroup description: Lists all the applications within a resource group. x-ms-examples: Lists all the applications within a resource group: $ref: ./examples/listApplicationsByResourceGroup.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: OK - Returns an array of applications. schema: $ref: '#/definitions/ApplicationListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Solutions Applications /subscriptions/{subscriptionId}/providers/Microsoft.Solutions/applications: get: tags: - Applications operationId: microsoftAzureApplicationsListbysubscription description: Lists all the applications within a subscription. x-ms-examples: Lists all the applications within a subscription: $ref: ./examples/listApplicationsByResourceGroup.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: OK - Returns an array of applications. schema: $ref: '#/definitions/ApplicationListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Solutions Applications /{applicationId}: get: tags: - Applications operationId: microsoftAzureApplicationsGetbyid description: Gets the managed application. x-ms-examples: Gets the managed application: $ref: ./examples/getApplicationById.json parameters: - name: applicationId in: path required: true type: string description: The fully qualified ID of the managed application, including the managed application name and the managed application resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applications/{application-name} x-ms-skip-url-encoding: true - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: OK - Returns the managed application. schema: $ref: '#/definitions/Application' '404': description: NotFound. x-ms-error-response: false default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Applicationid delete: tags: - Applications operationId: microsoftAzureApplicationsDeletebyid description: Deletes the managed application. x-ms-examples: Deletes the managed application: $ref: ./examples/deleteApplicationById.json parameters: - name: applicationId in: path required: true type: string description: The fully qualified ID of the managed application, including the managed application name and the managed application resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applications/{application-name} x-ms-skip-url-encoding: true - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: NoContent '202': description: Accepted - Returns this status until the asynchronous operation has completed. '204': description: NoContent default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Delete Applicationid put: tags: - Applications operationId: microsoftAzureApplicationsCreateorupdatebyid description: Creates or updates a managed application. x-ms-examples: Creates or updates a managed application: $ref: ./examples/createOrUpdateApplicationById.json parameters: - name: applicationId in: path required: true type: string description: The fully qualified ID of the managed application, including the managed application name and the managed application resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applications/{application-name} x-ms-skip-url-encoding: true - name: parameters in: body required: true schema: $ref: '#/definitions/Application' description: Parameters supplied to the create or update a managed application. - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: OK - Returns information about the managed application, including provisioning status. schema: $ref: '#/definitions/Application' '201': description: Created - Returns information about the managed application, including provisioning status. schema: $ref: '#/definitions/Application' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Put Applicationid patch: tags: - Applications operationId: microsoftAzureApplicationsUpdatebyid description: Updates an existing managed application. x-ms-examples: Updates an existing managed application: $ref: ./examples/updateApplicationById.json parameters: - name: applicationId in: path required: true type: string description: The fully qualified ID of the managed application, including the managed application name and the managed application resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applications/{application-name} x-ms-skip-url-encoding: true - name: parameters in: body schema: $ref: '#/definitions/ApplicationPatchable' description: Parameters supplied to update an existing managed application. - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: OK - Returns information about the managed application, including provisioning status. schema: $ref: '#/definitions/ApplicationPatchable' '202': description: Accepted - Returns information about the managed application, including provisioning status. schema: $ref: '#/definitions/ApplicationPatchable' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Patch Applicationid ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}/refreshPermissions : post: tags: - Applications operationId: microsoftAzureApplicationsRefreshpermissions description: Refresh Permissions for application. x-ms-examples: Refresh managed application permissions: $ref: ./examples/refreshApplicationPermissions.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ApplicationNameParameter' responses: '200': description: OK. '202': description: Accepted - Returns this status until the asynchronous operation has completed. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Solutions Applications Applicationname Refreshpermissions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}/listAllowedUpgradePlans : post: tags: - Applications operationId: microsoftAzureApplicationsListallowedupgradeplans description: List allowed upgrade plans for application. x-ms-examples: List allowed upgrade plans for application: $ref: ./examples/listAllowedUpgradePlans.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ApplicationNameParameter' responses: '200': description: OK - Returns an array of managed identity tokens. schema: $ref: '#/definitions/AllowedUpgradePlansResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Solutions Applications Applicationname Listallowedupgradeplans ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}/updateAccess : post: tags: - Applications operationId: microsoftAzureApplicationsUpdateaccess description: Update access for application. x-ms-examples: Update access for application: $ref: ./examples/updateAccess.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - name: applicationName in: path required: true type: string description: The name of the managed application. minLength: 3 maxLength: 64 - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - name: parameters in: body required: true schema: $ref: '#/definitions/UpdateAccessDefinition' description: Request body parameters to list tokens. responses: '200': description: OK. '202': description: Accepted - Returns this status until the asynchronous operation has completed. schema: $ref: '#/definitions/UpdateAccessDefinition' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Solutions Applications Applicationname Updateaccess ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}/listTokens : post: tags: - Applications operationId: microsoftAzureApplicationsListtokens description: List tokens for application. x-ms-examples: List tokens for application: $ref: ./examples/listToken.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - name: applicationName in: path required: true type: string description: The name of the managed application. minLength: 3 maxLength: 64 - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - name: parameters in: body required: true schema: $ref: '#/definitions/ListTokenRequest' description: Request body parameters to list tokens. responses: '200': description: OK - Returns an array of managed identity tokens. schema: $ref: '#/definitions/ManagedIdentityTokenResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Solutions Applications Applicationname Listtokens /applications: get: operationId: microsoftAzureBatchListapplications summary: Microsoft Azure Lists All Of The Applications Available In The Specified Account description: This operation returns only Applications and versions that are available for
use on Compute Nodes; that is, that can be used in an Package reference. For
administrator information about applications and versions that are not yet
available to Compute Nodes, use the Azure portal or the Azure Resource Manager
API. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: maxresults in: query description: 'The maximum number of items to return in the response. A maximum of 1000 applications can be returned.' required: false type: integer format: int32 default: 1000 minimum: 1 maximum: 1000 responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchApplicationListResult' headers: ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: List applications: $ref: ./examples/ApplicationList.json x-ms-pageable: nextLinkName: odata.nextLink tags: - Applications /applications/{applicationId}: get: operationId: microsoftAzureBatchGetapplication summary: Microsoft Azure Gets Information About The Specified Application description: This operation returns only Applications and versions that are available for
use on Compute Nodes; that is, that can be used in an Package reference. For
administrator information about Applications and versions that are not yet
available to Compute Nodes, use the Azure portal or the Azure Resource Manager
API. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: timeOut in: query description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". required: false type: integer format: int32 default: 30 - name: client-request-id in: header description: 'The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.' required: false type: string x-ms-client-name: clientRequestId - name: return-client-request-id in: header description: Whether the server should return the client-request-id in the response. required: false type: boolean default: false x-ms-client-name: returnClientRequestId - name: ocp-date in: header description: 'The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.' required: false type: string format: date-time-rfc7231 x-ms-client-name: ocpdate - name: applicationId in: path description: The ID of the Application required: true type: string responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/BatchApplication' headers: ETag: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. Last-Modified: type: string format: date-time-rfc7231 description: The time at which the resource was last modified. client-request-id: type: string description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. request-id: type: string description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. default: description: An unexpected error response. schema: $ref: '#/definitions/BatchError' x-ms-examples: Get applications: $ref: ./examples/ApplicationGet.json tags: - Applications ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IntegrationSpaces/spaces/{spaceName}/applications : get: operationId: microsoftAzureApplicationsListbyspace tags: - Applications description: List Application resources by Space parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/Azure.Core.TopQueryParameter' - $ref: '#/parameters/Azure.Core.SkipQueryParameter' - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter' - $ref: '#/parameters/Azure.Core.FilterQueryParameter' - $ref: '#/parameters/Azure.Core.SelectQueryParameter' - $ref: '#/parameters/Azure.Core.ExpandQueryParameter' - $ref: '#/parameters/Azure.Core.OrderByQueryParameter' - name: spaceName in: path description: The name of the space required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/ApplicationListResult_4' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: ListApplicationsBySpace: $ref: ./examples/Applications_ListBySpace.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Integrationspaces Spaces Spacename Applications ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IntegrationSpaces/spaces/{spaceName}/applications/{applicationName} : get: operationId: microsoftAzureApplicationsGet tags: - Applications description: Get a Application parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: spaceName in: path description: The name of the space required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' - name: applicationName in: path description: The name of the Application required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/Application_2' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: GetApplication: $ref: ./examples/Applications_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Integrationspaces Spaces Spacename Applications Applicationname put: operationId: microsoftAzureApplicationsCreateorupdate tags: - Applications description: Create a Application parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: spaceName in: path description: The name of the space required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' - name: applicationName in: path description: The name of the Application required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' - name: resource in: body description: Resource create parameters. required: true schema: $ref: '#/definitions/Application_2' responses: '200': description: Resource 'Application' update operation succeeded schema: $ref: '#/definitions/Application_2' '201': description: Resource 'Application' create operation succeeded schema: $ref: '#/definitions/Application_2' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: CreateOrUpdateApplication: $ref: ./examples/Applications_CreateOrUpdate.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Integrationspaces Spaces Spacename Applications Applicationname patch: operationId: microsoftAzureApplicationsPatch tags: - Applications description: Update a Application parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: spaceName in: path description: The name of the space required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' - name: applicationName in: path description: The name of the Application required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' - name: properties in: body description: The resource properties to be updated. required: true schema: $ref: '#/definitions/ApplicationUpdate' responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/Application_2' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: PatchApplication: $ref: ./examples/Applications_Patch.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Integrationspaces Spaces Spacename Applications Applicationname delete: operationId: microsoftAzureApplicationsDelete tags: - Applications description: Delete a Application parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: spaceName in: path description: The name of the space required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' - name: applicationName in: path description: The name of the Application required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' responses: '200': description: Resource deleted successfully. '204': description: Resource deleted successfully. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: DeleteApplication: $ref: ./examples/Applications_Delete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Integrationspaces Spaces Spacename Applications Applicationname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IntegrationSpaces/spaces/{spaceName}/applications/{applicationName}/deleteBusinessProcessDevelopmentArtifact : post: operationId: microsoftAzureApplicationsDeletebusinessprocessdevelopmentartifact tags: - Applications description: The delete business process development artifact action. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: spaceName in: path description: The name of the space required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' - name: applicationName in: path description: The name of the Application required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' - name: body in: body description: The content of the action request required: true schema: $ref: '#/definitions/GetOrDeleteBusinessProcessDevelopmentArtifactRequest' responses: '200': description: The business process development artifact success response. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: DeleteBusinessProcessDevelopmentArtifact: $ref: ./examples/Applications_DeleteBusinessProcessDevelopmentArtifact.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Integrationspaces Spaces Spacename Applications Applicationname Deletebusinessprocessdevelopmentartifact ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IntegrationSpaces/spaces/{spaceName}/applications/{applicationName}/getBusinessProcessDevelopmentArtifact : post: operationId: microsoftAzureApplicationsGetbusinessprocessdevelopmentartifact tags: - Applications description: The get business process development artifact action. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: spaceName in: path description: The name of the space required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' - name: applicationName in: path description: The name of the Application required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' - name: body in: body description: The content of the action request required: true schema: $ref: '#/definitions/GetOrDeleteBusinessProcessDevelopmentArtifactRequest' responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/SaveOrGetBusinessProcessDevelopmentArtifactResponse' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: GetBusinessProcessDevelopmentArtifact: $ref: ./examples/Applications_GetBusinessProcessDevelopmentArtifact.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Integrationspaces Spaces Spacename Applications Applicationname Getbusinessprocessdevelopmentartifact ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IntegrationSpaces/spaces/{spaceName}/applications/{applicationName}/listBusinessProcessDevelopmentArtifacts : post: operationId: microsoftAzureApplicationsListbusinessprocessdevelopmentartifacts tags: - Applications description: The list business process development artifacts action. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: spaceName in: path description: The name of the space required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' - name: applicationName in: path description: The name of the Application required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/ListBusinessProcessDevelopmentArtifactsResponse' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: ListBusinessProcessDevelopmentArtifacts: $ref: ./examples/Applications_ListBusinessProcessDevelopmentArtifacts.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Integrationspaces Spaces Spacename Applications Applicationname Listbusinessprocessdevelopmentartifacts ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IntegrationSpaces/spaces/{spaceName}/applications/{applicationName}/saveBusinessProcessDevelopmentArtifact : post: operationId: microsoftAzureApplicationsSavebusinessprocessdevelopmentartifact tags: - Applications description: The save business process development artifact action. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: spaceName in: path description: The name of the space required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' - name: applicationName in: path description: The name of the Application required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' - name: body in: body description: The content of the action request required: true schema: $ref: '#/definitions/SaveOrValidateBusinessProcessDevelopmentArtifactRequest' responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/SaveOrGetBusinessProcessDevelopmentArtifactResponse' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: SaveBusinessProcessDevelopmentArtifact: $ref: ./examples/Applications_SaveBusinessProcessDevelopmentArtifact.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Integrationspaces Spaces Spacename Applications Applicationname Savebusinessprocessdevelopmentartifact ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IntegrationSpaces/spaces/{spaceName}/applications/{applicationName}/validateBusinessProcessDevelopmentArtifact : post: operationId: microsoftAzureApplicationsValidatebusinessprocessdevelopmentartifact tags: - Applications description: The validate business process development artifact action. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: spaceName in: path description: The name of the space required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' - name: applicationName in: path description: The name of the Application required: true type: string pattern: '[a-zA-Z0-9_.()-]{0,79}$' - name: body in: body description: The content of the action request required: true schema: $ref: '#/definitions/SaveOrValidateBusinessProcessDevelopmentArtifactRequest' responses: '200': description: The business process development artifact success response. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: ValidateBusinessProcessDevelopmentArtifact: $ref: ./examples/Applications_ValidateBusinessProcessDevelopmentArtifact.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Integrationspaces Spaces Spacename Applications Applicationname Validatebusinessprocessdevelopmentartifact ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName} : put: operationId: microsoftAzureApplicationCreate x-ms-examples: ApplicationCreateOrUpdate: $ref: ./examples/ApplicationCreateOrUpdate.json summary: Microsoft Azure Creates Or Updates An Application Resource description: Creates an application resource with the specified name and description. If an application with the same name already exists, then its description is updated to the one indicated in this request.

Use network resources to provide public connectivity to the services of an application.
parameters: - $ref: '#/parameters/subscriptionIdRequiredPathParam' - $ref: '#/parameters/api-versionRequiredQueryParam' - $ref: '#/parameters/ResourceGroupNameRequiredPathParam' - $ref: '#/parameters/ApplicationNameRequiredPathParam' - $ref: '#/parameters/ApplicationResourceDescriptionRequiredBodyParam' tags: - Applications responses: '200': description: Ok schema: $ref: '#/definitions/ApplicationResourceDescription' '201': description: Created schema: $ref: '#/definitions/ApplicationResourceDescription' default: description: Error schema: $ref: '#/definitions/ErrorModel' get: operationId: microsoftAzureApplicationGet x-ms-examples: ApplicationGet: $ref: ./examples/ApplicationGet.json summary: Microsoft Azure Gets The Application Resource description: Gets the information about the application resource with a given name. The information includes the information about the application's services and other runtime properties. parameters: - $ref: '#/parameters/subscriptionIdRequiredPathParam' - $ref: '#/parameters/api-versionRequiredQueryParam' - $ref: '#/parameters/ResourceGroupNameRequiredPathParam' - $ref: '#/parameters/ApplicationNameRequiredPathParam' tags: - Applications responses: '200': description: OK schema: $ref: '#/definitions/ApplicationResourceDescription' default: description: Error schema: $ref: '#/definitions/ErrorModel' delete: operationId: microsoftAzureApplicationDelete x-ms-examples: ApplicationDelete: $ref: ./examples/ApplicationDelete.json summary: Microsoft Azure Deletes The Application Resource description: Deletes the application resource identified by the name. parameters: - $ref: '#/parameters/subscriptionIdRequiredPathParam' - $ref: '#/parameters/api-versionRequiredQueryParam' - $ref: '#/parameters/ResourceGroupNameRequiredPathParam' - $ref: '#/parameters/ApplicationNameRequiredPathParam' tags: - Applications responses: '200': description: OK '202': description: Accepted '204': description: No Content - the specified application was not found. default: description: Error schema: $ref: '#/definitions/ErrorModel' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications: get: operationId: microsoftAzureApplicationListbyresourcegroup x-ms-examples: ApplicationList: $ref: ./examples/ApplicationsByResourceGroup.json summary: Microsoft Azure Gets All The Application Resources In A Given Resource Group description: Gets the information about all application resources in a given resource group. The information includes the information about the application's services and other runtime properties. parameters: - $ref: '#/parameters/subscriptionIdRequiredPathParam' - $ref: '#/parameters/api-versionRequiredQueryParam' - $ref: '#/parameters/ResourceGroupNameRequiredPathParam' tags: - Applications responses: '200': description: OK schema: $ref: '#/definitions/ApplicationResourceDescriptionList' default: description: Error schema: $ref: '#/definitions/ErrorModel' x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/applications: get: operationId: microsoftAzureApplicationListbysubscription x-ms-examples: ApplicationList: $ref: ./examples/ApplicationsBySubscriptionId.json summary: Microsoft Azure Gets All The Application Resources In A Given Subscription description: Gets the information about all application resources in a given subscription. The information includes the information about the application's services and other runtime properties. parameters: - $ref: '#/parameters/subscriptionIdRequiredPathParam' - $ref: '#/parameters/api-versionRequiredQueryParam' tags: - Applications responses: '200': description: OK schema: $ref: '#/definitions/ApplicationResourceDescriptionList' default: description: Error schema: $ref: '#/definitions/ErrorModel' x-ms-pageable: nextLinkName: nextLink /Applications/{applicationId}/$/GetServices: get: summary: Microsoft Azure Gets The Information About All Services Belonging To The Application Specified By The Application Id description: Returns the information about all services belonging to the application specified by the application ID. operationId: microsoftAzureGetserviceinfolist parameters: - $ref: '#/parameters/ApplicationIdRequiredPathParam' - $ref: '#/parameters/ServiceTypeNameOptionalQueryParam' - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/ContinuationTokenOptionalQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Applications responses: '200': description: List of services in the cluster for the specified application. schema: $ref: '#/definitions/PagedServiceInfoList' default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Applications/{applicationId}/$/GetServices/{serviceId}: get: summary: Microsoft Azure Gets The Information About The Specific Service Belonging To The Service Fabric Application description: Returns the information about the specified service belonging to the specified Service Fabric application. operationId: microsoftAzureGetserviceinfo parameters: - $ref: '#/parameters/ApplicationIdRequiredPathParam' - $ref: '#/parameters/ServiceIdRequiredPathParam' - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Applications responses: '200': description: Information about the specified service. schema: $ref: '#/definitions/ServiceInfo' '204': description: An empty response is returned if the specified service is not part of the specified application. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Applications/{applicationId}/$/GetServices/$/Create: post: operationId: microsoftAzureCreateservice summary: Microsoft Azure Creates The Specified Service Fabric Service description: This api allows creating a new Service Fabric stateless or stateful service under a specified Service Fabric application. The description for creating the service includes partitioning information and optional properties for placement and load balancing. Some of the properties can later be modified using `UpdateService` API. x-ms-examples: Basic stateless service: $ref: ./examples/CreateService-1.json Basic stateful service: $ref: ./examples/CreateService-2.json Stateless service with dns name and auto scaling: $ref: ./examples/CreateService-3.json Stateful service with named partitions and auto scaling: $ref: ./examples/CreateService-4.json tags: - Applications parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/ApplicationIdRequiredPathParam' - $ref: '#/parameters/ServiceDescriptionRequiredBodyParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' responses: '202': description: A successful operation will return 202 status code. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' /Applications/{applicationId}/$/GetServices/$/CreateFromTemplate: post: summary: Microsoft Azure Creates A Service Fabric Service From The Service Template description: Creates a Service Fabric service from the service template defined in the application manifest. A service template contains the properties that will be same for the service instance of the same type. The API allows overriding the properties that are usually different for different services of the same service type. operationId: microsoftAzureCreateservicefromtemplate parameters: - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam' - $ref: '#/parameters/ApplicationIdRequiredPathParam' - $ref: '#/parameters/CreateServiceFromTemplateRequiredBodyParam' - $ref: '#/parameters/TimeoutOptionalQueryParam' tags: - Applications responses: '202': description: A successful operation will return 202 status code. default: description: The detailed error response. schema: $ref: '#/definitions/FabricError' definitions: CorrelationSchemeList: type: array items: $ref: '#/definitions/ServiceCorrelationDescription' description: A list that describes the correlation of the service with other services. ScalingTriggerKind: type: string description: Enumerates the ways that a service can be scaled. enum: - Invalid - AveragePartitionLoad - AverageServiceLoad x-ms-enum: name: ScalingTriggerKind modelAsString: true values: - value: Invalid description: Indicates the scaling trigger is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: AveragePartitionLoad description: Indicates a trigger where scaling decisions are made based on average load of a partition. The value is 1. - value: AverageServiceLoad description: Indicates a trigger where scaling decisions are made based on average load of a service. The value is 2. 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 ErrorModel: properties: error: $ref: '#/definitions/ErrorErrorModel' description: Error model information description: The error details. required: - error ListTokenRequest: properties: authorizationAudience: type: string description: The authorization audience. userAssignedIdentities: description: The user assigned identities. type: array items: $ref: '#/definitions/UserAssignedIdentity' description: List token request body. NetworkRef: description: Describes a network reference in a service. type: object properties: name: type: string description: Name of the network. ProvisioningState_2: type: string description: The status of the current operation. enum: - Succeeded - Failed - Canceled - Provisioning - Updating - Deleting - Accepted x-ms-enum: name: ProvisioningState modelAsString: true values: - name: Succeeded value: Succeeded description: Resource has been created. - name: Failed value: Failed description: Resource creation failed. - name: Canceled value: Canceled description: Resource creation was canceled. - name: Provisioning value: Provisioning - name: Updating value: Updating - name: Deleting value: Deleting - name: Accepted value: Accepted ApplicationResourceDescriptionList: description: A pageable list of application resources. type: object properties: value: type: array items: $ref: '#/definitions/ApplicationResourceDescription' description: One page of the list. nextLink: type: string description: URI to fetch the next page of the list. JitRequestMetadata: properties: originRequestId: type: string description: The origin request id. requestorId: type: string description: The requestor id. tenantDisplayName: type: string description: The publisher's tenant name. subjectDisplayName: type: string description: The subject display name. description: The JIT request metadata. HealthState: type: string description: The health state of a resource such as Application, Service, or Network. 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. ImageRegistryCredential: description: Image registry credential. type: object properties: server: type: string description: Docker image registry server, without protocol such as `http` and `https`. username: type: string description: The username for the private registry. password: type: string description: The password for the private registry. required: - server - username DiagnosticsDescription: description: Describes the diagnostics options available type: object properties: sinks: description: List of supported sinks that can be referenced. type: array items: $ref: '#/definitions/DiagnosticsSinkProperties' enabled: description: Status of whether or not sinks are enabled. type: boolean defaultSinkRefs: description: The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level. type: array items: type: string ScalingPolicyDescription: description: Describes how the scaling should be performed required: - ScalingTrigger - ScalingMechanism properties: ScalingTrigger: $ref: '#/definitions/ScalingTriggerDescription' description: Specifies the trigger associated with this scaling policy ScalingMechanism: $ref: '#/definitions/ScalingMechanismDescription' description: Specifies the mechanism associated with this scaling policy ApplicationProperties_3: description: This type describes properties of an application resource. type: object properties: description: description: User readable description of the application. type: string debugParams: description: Internal use. type: string services: type: array description: describes the services in the application. items: $ref: '#/definitions/ServiceResourceDescription' healthState: readOnly: true $ref: '#/definitions/HealthState' description: Describes the health state of an application resource. unhealthyEvaluation: readOnly: true type: string description: When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy. status: readOnly: true type: string description: Status of the application resource. enum: - Invalid - Ready - Upgrading - Creating - Deleting - Failed x-ms-enum: name: ApplicationResourceStatus modelAsString: true statusDetails: readOnly: true type: string description: Gives additional information about the current status of the application deployment. serviceNames: readOnly: true description: Names of the services in the application. type: array items: type: string diagnostics: $ref: '#/definitions/DiagnosticsDescription' description: Describes the diagnostics definition and usage for an application resource. GenericResource: type: object properties: managedBy: type: string description: ID of the resource that manages this resource. sku: $ref: '#/definitions/Sku' description: The SKU of the resource. allOf: - $ref: '#/definitions/Resource' description: Resource information. PlanPatchable: type: object properties: name: type: string description: The plan name. publisher: type: string description: The publisher ID. product: type: string description: The product code. promotionCode: type: string description: The promotion code. version: type: string description: The plan's version. description: Plan for the managed application. AllowedUpgradePlansResult: properties: value: type: array items: $ref: '#/definitions/Plan' description: The array of plans. description: The array of plan. ServiceLoadMetricWeight: type: string description: Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. enum: - Zero - Low - Medium - High x-ms-enum: name: ServiceLoadMetricWeight modelAsString: true values: - value: Zero description: Disables resource balancing for this metric. This value is zero. - value: Low description: Specifies the metric weight of the service load as Low. The value is 1. - value: Medium description: Specifies the metric weight of the service load as Medium. The value is 2. - value: High description: Specifies the metric weight of the service load as High. The value is 3. ServiceKind: type: string description: The kind of service (Stateless or Stateful). enum: - Invalid - Stateless - Stateful x-ms-enum: name: ServiceKind modelAsString: true values: - value: Invalid description: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: Stateless description: Does not use Service Fabric to make its state highly available or reliable. The value is 1. - value: Stateful description: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2. 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. ResourceLimits: description: This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted. type: object properties: memoryInGB: description: The memory limit in GB. type: number format: double cpu: description: CPU limits in cores. At present, only full cores are supported. type: number format: double ManagedIdentityToken: properties: accessToken: type: string description: The requested access token. expiresIn: type: string description: The number of seconds the access token will be valid. expiresOn: type: string description: The timespan when the access token expires. This is represented as the number of seconds from epoch. notBefore: type: string description: The timespan when the access token takes effect. This is represented as the number of seconds from epoch. authorizationAudience: type: string description: The aud (audience) the access token was request for. This is the same as what was provided in the listTokens request. resourceId: type: string description: The Azure resource ID for the issued token. This is either the managed application ID or the user-assigned identity ID. tokenType: type: string description: The type of the token. description: The managed identity token for the managed app resource. ProvisionedResourceProperties: description: Describes common properties of a provisioned resource. properties: provisioningState: type: string description: State of the resource. readOnly: true ScalingMechanismDescription: discriminator: Kind description: Describes the mechanism for performing a scaling operation. required: - Kind properties: Kind: $ref: '#/definitions/ScalingMechanismKind' description: Specifies the kind of scaling mechanism BatchApplicationListResult: type: object description: The result of listing the applications available in an Account. properties: value: type: array description: The list of applications available in the Account. items: $ref: '#/definitions/BatchApplication' odata.nextLink: type: string description: The URL to get the next set of results. ContainerState: description: The container state. type: object properties: state: type: string description: The state of this container startTime: type: string format: date-time description: Date/time when the container state started. exitCode: type: string description: The container exit code. finishTime: type: string format: date-time description: Date/time when the container state finished. detailStatus: description: Human-readable status of this state. type: string ServiceResourceDescription: description: This type describes a service resource. allOf: - $ref: '#/definitions/ManagedProxyResource' properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ServiceResourceProperties' description: This type describes properties of a service resource. required: - properties ContainerCodePackageProperties: description: Describes a container and its runtime properties. type: object properties: name: description: The name of the code package. type: string image: description: The Container image to use. type: string imageRegistryCredential: $ref: '#/definitions/ImageRegistryCredential' description: Image registry credential. entrypoint: description: Override for the default entry point in the container. type: string commands: description: Command array to execute within the container in exec form. type: array items: type: string environmentVariables: description: The environment variables to set in this container type: array items: $ref: '#/definitions/EnvironmentVariable' settings: description: The settings to set in this container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\\secrets". The path for Linux container is "/var/secrets". type: array items: $ref: '#/definitions/Setting' labels: description: The labels to set in this container. type: array items: $ref: '#/definitions/ContainerLabel' endpoints: description: The endpoints exposed by this container. type: array items: $ref: '#/definitions/EndpointProperties' resources: $ref: '#/definitions/ResourceRequirements' description: This type describes the resource requirements for a container or a service. volumeRefs: description: The volumes to be attached to the container. type: array items: $ref: '#/definitions/ContainerVolume' instanceView: readOnly: true $ref: '#/definitions/ContainerInstanceView' description: Runtime information of a container instance. diagnostics: $ref: '#/definitions/DiagnosticsRef' description: Reference to sinks in DiagnosticsDescription. required: - name - image - resources ContainerEvent: description: A container event. type: object properties: name: type: string description: The name of the container event. count: type: integer description: The count of the event. firstTimestamp: type: string description: Date/time of the first event. lastTimestamp: type: string description: Date/time of the last event. message: type: string description: The event message type: type: string description: The event type. GetOrDeleteBusinessProcessDevelopmentArtifactRequest: type: object description: The business process development artifact get or delete request. properties: name: type: string description: The name of the business process development artifact. required: - name BusinessProcessReference: type: object description: The business process reference. properties: name: type: string description: The business process name. version: type: string description: The business process version. PartitionScheme: type: string description: Enumerates the ways that a service can be partitioned. enum: - Invalid - Singleton - UniformInt64Range - Named x-ms-enum: name: PartitionScheme modelAsString: true values: - value: Invalid description: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: Singleton description: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1. - value: UniformInt64Range description: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2. - value: Named description: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3 ApplicationJitAccessPolicy: type: object properties: jitAccessEnabled: type: boolean description: Whether the JIT access is enabled. jitApprovalMode: $ref: '#/definitions/JitApprovalMode' description: JIT approval mode. jitApprovers: type: array items: $ref: '#/definitions/JitApproverDefinition' description: The JIT approvers maximumJitAccessDuration: type: string description: The maximum duration JIT access is granted. This is an ISO8601 time period value. required: - jitAccessEnabled description: Managed application Jit access policy. Setting: description: Describes a setting for the container. type: object properties: name: description: The name of the setting. type: string value: description: The value of the setting. type: string ServicePlacementPoliciesList: type: array items: $ref: '#/definitions/ServicePlacementPolicyDescription' description: A list that describes the correlation of the service with other services. ServicePlacementPolicyDescription: discriminator: Type description: Describes the policy to be used for placement of a Service Fabric service. required: - Type properties: Type: $ref: '#/definitions/ServicePlacementPolicyType' description: The type of placement policy for a service fabric service. Following are the possible values. UpdateAccessDefinition: properties: approver: type: string description: The approver name. metadata: $ref: '#/definitions/JitRequestMetadata' description: The JIT request metadata. status: $ref: '#/definitions/Status' description: The JIT status. subStatus: $ref: '#/definitions/SubStatus' description: The JIT status. required: - metadata - status - subStatus description: Update access request definition. ApplicationAuthorization: type: object properties: principalId: type: string description: The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the managed application resources. roleDefinitionId: type: string description: The provider's role definition identifier. This role will define all the permissions that the provider must have on the managed application's container resource group. This role definition cannot have permission to delete the resource group. required: - principalId - roleDefinitionId description: The managed application provider authorization. userAssignedResourceIdentity: type: object properties: principalId: readOnly: true type: string description: The principal id of user assigned identity. tenantId: readOnly: true type: string description: The tenant id of user assigned identity. description: Represents the user assigned identity that is contained within the UserAssignedIdentities dictionary on ResourceIdentity ApplicationArtifact: type: object properties: name: $ref: '#/definitions/ApplicationArtifactName' description: The managed application artifact name. uri: type: string description: The managed application artifact blob uri. type: $ref: '#/definitions/ApplicationArtifactType' description: The managed application artifact type. required: - name - type - uri description: Managed application artifact. ServiceTypeName: type: string description: Name of the service type as specified in the service manifest. BatchError: type: object description: An error response received from the Azure Batch service. properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: $ref: '#/definitions/BatchErrorMessage' description: A message describing the error, intended to be suitable for display in a user interface. values: type: array description: A collection of key-value pairs containing additional details about the error. items: $ref: '#/definitions/BatchErrorDetail' x-ms-identifiers: [] required: - code ApplicationClientDetails: type: object readOnly: true properties: oid: type: string description: The client Oid. puid: type: string description: The client Puid applicationId: type: string description: The client application Id. description: The application client details to track the entity creating/updating the managed app resource. ServiceInfo: discriminator: ServiceKind description: Information about a Service Fabric service. properties: Id: $ref: '#/definitions/ServiceId' description: 'The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "\~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1\~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.' ServiceKind: $ref: '#/definitions/ServiceKind' description: The kind of service (Stateless or Stateful). Name: $ref: '#/definitions/ServiceName' description: The full name of the service with 'fabric:' URI scheme. TypeName: $ref: '#/definitions/ServiceTypeName' description: Name of the service type as specified in the service manifest. ManifestVersion: description: The version of the service manifest. type: string HealthState: $ref: '#/definitions/HealthState_2' description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. ServiceStatus: $ref: '#/definitions/ServiceStatus' description: The status of the application. IsServiceGroup: description: Whether the service is in a service group. type: boolean required: - ServiceKind BusinessProcessMappingItem: type: object description: The properties of business process mapping. properties: logicAppResourceId: type: string description: The logic app resource id. workflowName: type: string description: The workflow name within the logic app. operationName: type: string description: The operation name. operationType: type: string description: The mapping item operation type of the business process. NodeTagsDescription: description: Describes the tags required for placement or running of the service. required: - Count - Tags properties: Count: type: integer description: The number of tags. Tags: type: array items: type: string description: Array of size specified by the ‘Count’ parameter, for the placement tags of the service. ApplicationArtifactName: description: The managed application artifact name. enum: - NotSpecified - ViewDefinition - Authorizations - CustomRoleDefinition type: string x-ms-enum: name: ApplicationArtifactName modelAsString: true ContainerVolume: description: Describes how a volume is attached to a container. type: object properties: name: description: Name of the volume. type: string readOnly: description: The flag indicating whether the volume is read only. Default is 'false'. type: boolean destinationPath: description: The path within the container at which the volume should be mounted. Only valid path characters are allowed. type: string required: - name - destinationPath EnvironmentVariable: description: Describes an environment variable for the container. type: object properties: name: description: The name of the environment variable. type: string value: description: The value of the environment variable. type: string DiagnosticsRef: description: Reference to sinks in DiagnosticsDescription. type: object properties: enabled: description: Status of whether or not sinks are enabled. type: boolean sinkRefs: description: List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription. type: array items: type: string ApplicationArtifactType: description: The managed application artifact type. enum: - NotSpecified - Template - Custom type: string x-ms-enum: name: ApplicationArtifactType modelAsString: false ErrorDetailsModel: description: Error model details information properties: code: type: string message: type: string description: Error message. required: - code - message ApplicationResourceProperties: description: This type describes properties of an application resource. allOf: - $ref: '#/definitions/ProvisionedResourceProperties' - $ref: '#/definitions/ApplicationProperties_3' ApplicationPackageSupportUrls: type: object properties: publicAzure: type: string description: The public azure support URL. governmentCloud: type: string description: The government cloud support URL. description: The appliance package support URLs. FlowTrackingDefinition: type: object description: The workflow tracking definition. properties: correlationContext: $ref: '#/definitions/TrackingCorrelationContext' description: The tracking correlation context. events: type: object description: The tracking events. additionalProperties: $ref: '#/definitions/TrackingEventDefinition' ApplicationListResult: type: object properties: value: type: array items: $ref: '#/definitions/Application' description: The array of managed applications. nextLink: type: string description: The URL to use for getting the next set of results. description: List of managed applications. object: type: object description: Represent a model properties: {} TrackingDataStore: type: object description: The properties of tracking data store. properties: databaseName: type: string description: The database name. dataStoreResourceId: type: string description: The data store resource id. dataStoreUri: type: string description: The data store URI. dataStoreIngestionUri: type: string description: The data store ingestion URI. required: - databaseName - dataStoreResourceId - dataStoreUri - dataStoreIngestionUri BusinessProcessStage: type: object description: The properties of business process stage. properties: description: type: string description: The description of the business stage. properties: type: object description: The properties within the properties of the business process stage. additionalProperties: type: string stagesBefore: type: array description: The property to keep track of stages before current in the business process stage. items: type: string HealthState_2: 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. ScalingPolicyDescriptionList: type: array items: $ref: '#/definitions/ScalingPolicyDescription' description: A list that describes the scaling policies. ServicePlacementPolicyType: type: string description: The type of placement policy for a service fabric service. Following are the possible values. enum: - Invalid - InvalidDomain - RequireDomain - PreferPrimaryDomain - RequireDomainDistribution - NonPartiallyPlaceService - AllowMultipleStatelessInstancesOnNode x-ms-enum: name: ServicePlacementPolicyType modelAsString: true values: - value: Invalid description: Indicates the type of the placement policy is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: InvalidDomain description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 1. - value: RequireDomain description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 2. - value: PreferPrimaryDomain description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 3. - value: RequireDomainDistribution description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 4. - value: NonPartiallyPlaceService description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 5. - value: AllowMultipleStatelessInstancesOnNode description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementAllowMultipleStatelessInstancesOnNodePolicyDescription, which indicates that multiple stateless instances of a particular partition of the service can be placed on a node. The value is 6. ApplicationListResult_4: type: object description: The response of a Application list operation. properties: value: type: array description: The Application items on this page items: $ref: '#/definitions/Application_2' nextLink: type: string format: uri description: The link to the next page of items required: - value Plan: type: object properties: name: type: string description: The plan name. publisher: type: string description: The publisher ID. product: type: string description: The product code. promotionCode: type: string description: The promotion code. version: type: string description: The plan's version. required: - name - publisher - product - version description: Plan for the managed application. ApplicationBillingDetailsDefinition: type: object properties: resourceUsageId: type: string description: The managed application resource usage Id. description: Managed application billing details definition. JitApproverDefinition: type: object properties: id: type: string description: The approver service principal Id. type: type: string description: The approver type. enum: - user - group x-ms-enum: name: JitApproverType modelAsString: true displayName: type: string description: The approver display name. required: - id description: JIT approver definition. Resource: type: object properties: id: readOnly: true type: string description: Resource ID name: readOnly: true type: string description: Resource name type: readOnly: true type: string description: Resource type location: type: string description: Resource location tags: type: object additionalProperties: type: string description: Resource tags systemData: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData readOnly: true description: Resource information. x-ms-azure-resource: true ServiceDescription: discriminator: ServiceKind description: A ServiceDescription contains all of the information necessary to create a service. required: - ServiceKind - ServiceName - ServiceTypeName - PartitionDescription properties: ServiceKind: $ref: '#/definitions/ServiceKind' description: The service kind. ApplicationName: $ref: '#/definitions/ApplicationName' description: The name of the application, including the 'fabric:' URI scheme. ServiceName: $ref: '#/definitions/ServiceName' description: The full name of the service with 'fabric:' URI scheme. ServiceTypeName: $ref: '#/definitions/ServiceTypeName' description: Name of the service type as specified in the service manifest. InitializationData: $ref: '#/definitions/ByteArray' description: The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created. PartitionDescription: $ref: '#/definitions/PartitionSchemeDescription' description: The partition description as an object. PlacementConstraints: type: string description: 'The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".' CorrelationScheme: $ref: '#/definitions/CorrelationSchemeList' description: The correlation scheme. ServiceLoadMetrics: $ref: '#/definitions/ServiceLoadMetricsList' description: The service load metrics. ServicePlacementPolicies: $ref: '#/definitions/ServicePlacementPoliciesList' description: The service placement policies. DefaultMoveCost: $ref: '#/definitions/MoveCost' description: The move cost for the service. IsDefaultMoveCostSpecified: type: boolean description: Indicates if the DefaultMoveCost property is specified. ServicePackageActivationMode: $ref: '#/definitions/ServicePackageActivationMode' description: The activation mode of service package to be used for a service. ServiceDnsName: type: string description: The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster. ScalingPolicies: $ref: '#/definitions/ScalingPolicyDescriptionList' description: Scaling policies for this service. TagsRequiredToPlace: $ref: '#/definitions/NodeTagsDescription' description: Tags for placement of this service. TagsRequiredToRun: $ref: '#/definitions/NodeTagsDescription' description: Tags for running of this service. ServiceName: type: string description: The full name of the service with 'fabric:' URI scheme. ServiceCorrelationDescription: description: Creates a particular correlation between services. required: - Scheme - ServiceName properties: Scheme: $ref: '#/definitions/ServiceCorrelationScheme' description: The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName. ServiceName: $ref: '#/definitions/ServiceName' description: The name of the service that the correlation relationship is established with. TrackingCorrelationContext: type: object description: The tracking correlation context. properties: operationType: type: string description: The operation type for correlation context. operationName: type: string description: The operation name for correlation context. propertyName: type: string description: The name of the correlation property. value: type: string description: The template expression for correlation context property value. BatchErrorMessage: type: object description: An error message received in an Azure Batch error response. properties: lang: type: string description: The language code of the error message. value: type: string description: The text of the message. ContainerLabel: description: Describes a container label. type: object properties: name: description: The name of the container label. type: string value: description: The value of the container label. type: string required: - name - value ResourceRequirements: description: This type describes the resource requirements for a container or a service. type: object properties: requests: $ref: '#/definitions/ResourceRequests' description: Describes the requested resources for a given container. limits: $ref: '#/definitions/ResourceLimits' description: Describes the maximum limits on the resources for a given container. required: - requests Identity: type: object properties: principalId: readOnly: true type: string description: The principal ID of resource identity. tenantId: readOnly: true type: string description: The tenant ID of resource. type: type: string description: The identity type. enum: - SystemAssigned - UserAssigned - SystemAssigned, UserAssigned - None x-ms-enum: name: ResourceIdentityType modelAsString: false userAssignedIdentities: type: object additionalProperties: $ref: '#/definitions/userAssignedResourceIdentity' description: 'The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}''.' description: Identity for the resource. 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 ServiceId: type: string description: 'The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "\~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1\~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.' Status: description: The JIT status. enum: - NotSpecified - Elevate - Remove type: string x-ms-enum: name: Status modelAsString: true ApplicationPatchable: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ApplicationProperties' description: The managed application properties. plan: $ref: '#/definitions/PlanPatchable' description: The plan information. kind: type: string description: The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. pattern: ^[-\w\._,\(\)]+$ identity: $ref: '#/definitions/Identity' description: The identity of the resource. allOf: - $ref: '#/definitions/GenericResource' description: Information about managed application. TrackingEventDefinition: type: object description: The tracking event definition. properties: operationType: type: string description: The operation type. operationName: type: string description: The operation name. properties: type: object description: The properties to be collected for event. additionalProperties: $ref: '#/definitions/object' ManagedIdentityTokenResult: properties: value: type: array items: $ref: '#/definitions/ManagedIdentityToken' description: The array of managed identity tokens. description: The array of managed identity tokens. JitApprovalMode: description: The Jit approval mode. enum: - NotSpecified - AutoApprove - ManualApprove type: string x-ms-enum: name: JitApprovalMode modelAsString: true Resource_2: description: The resource model definition for Azure Resource Manager resource. properties: id: readOnly: true type: string description: Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} x-ms-mutability: - read name: readOnly: true type: string description: The name of the resource x-ms-mutability: - read type: readOnly: true type: string description: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. x-ms-mutability: - read location: type: string x-ms-mutability: - read - create description: The geo-location where the resource lives x-ms-azure-resource: true ScalingMechanismKind: type: string description: Enumerates the ways that a service can be scaled. enum: - Invalid - PartitionInstanceCount - AddRemoveIncrementalNamedPartition x-ms-enum: name: ScalingMechanismKind modelAsString: true values: - value: Invalid description: Indicates the scaling mechanism is invalid. All Service Fabric enumerations have the invalid type. The value is zero. - value: PartitionInstanceCount description: Indicates a mechanism for scaling where new instances are added or removed from a partition. The value is 1. - value: AddRemoveIncrementalNamedPartition description: Indicates a mechanism for scaling where new named partitions are added or removed from a service. The value is 2. MoveCost: type: string description: Specifies the move cost for the service. enum: - Zero - Low - Medium - High - VeryHigh x-ms-enum: name: MoveCost modelAsString: true values: - value: Zero description: Zero move cost. This value is zero. - value: Low description: Specifies the move cost of the service as Low. The value is 1. - value: Medium description: Specifies the move cost of the service as Medium. The value is 2. - value: High description: Specifies the move cost of the service as High. The value is 3. - value: VeryHigh description: Specifies the move cost of the service as VeryHigh. The value is 4. TrackingProfileDefinition: type: object description: The tracking profile for the business process properties: $schema: type: string description: The tracking definition schema uri. businessProcess: $ref: '#/definitions/BusinessProcessReference' description: The business process reference. trackingDefinitions: type: object description: The tracking definitions. additionalProperties: $ref: '#/definitions/FlowTrackingDefinition' BusinessProcessIdentifier: type: object description: The properties of business process identifier. properties: propertyName: type: string description: The property name of the business process identifier. propertyType: type: string description: The property type of the business process identifier. ManagedProxyResource: description: The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags. This proxy resource is explicitly created or updated by including it in the parent resource. properties: id: readOnly: true type: string description: Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} x-ms-mutability: - read name: type: string description: The name of the resource x-ms-mutability: - read - create - update type: readOnly: true type: string description: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. x-ms-mutability: - read x-ms-azure-resource: true ServicePackageActivationMode: type: string description: The activation mode of service package to be used for a Service Fabric service. This is specified at the time of creating the Service. enum: - SharedProcess - ExclusiveProcess x-ms-enum: name: ServicePackageActivationMode modelAsString: true values: - value: SharedProcess description: This is the default activation mode. With this activation mode, replicas or instances from different partition(s) of service, on a given node, will share same activation of service package on a node. The value is zero. - value: ExclusiveProcess description: With this activation mode, each replica or instance of service, on a given node, will have its own dedicated activation of service package on a node. The value is 1. ApplicationPackageContact: type: object properties: contactName: type: string description: The contact name. email: type: string description: The contact email. phone: type: string description: The contact phone number. required: - email - phone description: The application package contact information. ApplicationResourceDescription: description: This type describes an application resource. allOf: - $ref: '#/definitions/TrackedResource' properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ApplicationResourceProperties' description: This type describes properties of an application resource. required: - properties ApplicationUpdate: type: object description: The type used for update operations of the Application. properties: tags: type: object description: Resource tags. additionalProperties: type: string properties: $ref: '#/definitions/ApplicationUpdateProperties' x-ms-client-flatten: true ApplicationUpdateProperties: type: object description: The updatable properties of the Application. properties: description: type: string description: The description of the resource. trackingDataStores: type: object description: The tracking data stores. additionalProperties: $ref: '#/definitions/TrackingDataStore' Sku: type: object properties: name: type: string description: The SKU name. tier: type: string description: The SKU tier. size: type: string description: The SKU size. family: type: string description: The SKU family. model: type: string description: The SKU model. capacity: type: integer format: int32 description: The SKU capacity. required: - name description: SKU for the resource. BatchApplication: type: object description: Contains information about an application in an Azure Batch Account. properties: id: type: string description: A string that uniquely identifies the application within the Account. displayName: type: string description: The display name for the application. versions: type: array description: The list of available versions of the application. items: type: string required: - id - displayName - versions ServiceCorrelationScheme: type: string description: The service correlation scheme. enum: - Invalid - Affinity - AlignedAffinity - NonAlignedAffinity x-ms-enum: name: ServiceCorrelationScheme modelAsString: true values: - value: Invalid description: An invalid correlation scheme. Cannot be used. The value is zero. - value: Affinity description: Indicates that this service has an affinity relationship with another service. Provided for backwards compatibility, consider preferring the Aligned or NonAlignedAffinity options. The value is 1. - value: AlignedAffinity description: Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 2. - value: NonAlignedAffinity description: Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 3. PartitionSchemeDescription: discriminator: PartitionScheme description: Describes how the service is partitioned. required: - PartitionScheme properties: PartitionScheme: $ref: '#/definitions/PartitionScheme' description: Specifies how the service is partitioned. ServiceLoadMetricsList: type: array items: $ref: '#/definitions/ServiceLoadMetricDescription' description: The service load metrics is given as an array of ServiceLoadMetricDescription objects. ListBusinessProcessDevelopmentArtifactsResponse: type: object description: The business process development artifact get collection response. properties: value: type: array description: The list of the business process development artifact. items: $ref: '#/definitions/SaveOrGetBusinessProcessDevelopmentArtifactResponse' x-ms-identifiers: [] required: - value ApplicationProperties: type: object properties: managedResourceGroupId: type: string description: The managed resource group Id. applicationDefinitionId: type: string description: The fully qualified path of managed application definition Id. parameters: type: object description: Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string. outputs: readOnly: true type: object description: Name and value pairs that define the managed application outputs. provisioningState: readOnly: true $ref: '#/definitions/ProvisioningState' description: The managed application provisioning state. billingDetails: readOnly: true $ref: '#/definitions/ApplicationBillingDetailsDefinition' description: The managed application billing details. jitAccessPolicy: $ref: '#/definitions/ApplicationJitAccessPolicy' description: The managed application Jit access policy. publisherTenantId: type: string description: The publisher tenant Id. readOnly: true authorizations: description: The read-only authorizations property that is retrieved from the application package. type: array items: $ref: '#/definitions/ApplicationAuthorization' x-ms-identifiers: - principalId - roleDefinitionId readOnly: true managementMode: $ref: '#/definitions/ApplicationManagementMode' description: The managed application management mode. readOnly: true customerSupport: $ref: '#/definitions/ApplicationPackageContact' description: The read-only customer support property that is retrieved from the application package. readOnly: true supportUrls: $ref: '#/definitions/ApplicationPackageSupportUrls' description: The read-only support URLs property that is retrieved from the application package. readOnly: true artifacts: description: The collection of managed application artifacts. type: array items: $ref: '#/definitions/ApplicationArtifact' x-ms-identifiers: - name - uri readOnly: true createdBy: readOnly: true $ref: '#/definitions/ApplicationClientDetails' description: The client entity that created the JIT request. updatedBy: readOnly: true $ref: '#/definitions/ApplicationClientDetails' description: The client entity that last updated the JIT request. description: The managed application properties. BusinessProcessDevelopmentArtifactProperties: type: object description: The properties of business process development artifact. properties: description: type: string description: The description of the business process. identifier: $ref: '#/definitions/BusinessProcessIdentifier' description: The business process identifier. businessProcessStages: type: object description: The business process stages. additionalProperties: $ref: '#/definitions/BusinessProcessStage' businessProcessMapping: type: object description: The business process mapping. additionalProperties: $ref: '#/definitions/BusinessProcessMappingItem' trackingProfiles: type: object description: The tracking profile for the business process. additionalProperties: $ref: '#/definitions/TrackingProfileDefinition' DiagnosticsSinkProperties: description: Properties of a DiagnosticsSink. type: object discriminator: kind properties: kind: $ref: '#/definitions/DiagnosticsSinkKind' description: The kind of DiagnosticsSink. name: description: Name of the sink. This value is referenced by DiagnosticsReferenceDescription type: string description: description: A description of the sink. type: string required: - kind SaveOrValidateBusinessProcessDevelopmentArtifactRequest: type: object description: The business process development artifact save or validate request. properties: name: type: string description: The name of the business process development artifact. properties: $ref: '#/definitions/BusinessProcessDevelopmentArtifactProperties' description: The properties of the business process development artifact. required: - name Application: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ApplicationProperties' description: The managed application properties. plan: $ref: '#/definitions/Plan' description: The plan information. kind: type: string description: The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog. pattern: ^[-\w\._,\(\)]+$ identity: $ref: '#/definitions/Identity' description: The identity of the resource. required: - properties - kind allOf: - $ref: '#/definitions/GenericResource' description: Information about managed application. TrackedResource: description: The resource model definition for Azure Resource Manager tracked top-level resource. allOf: - $ref: '#/definitions/Resource_2' properties: tags: type: object additionalProperties: type: string x-ms-mutability: - read - create - update description: Resource tags. location: type: string x-ms-mutability: - read - create description: The geo-location where the resource lives required: - location ScalingTriggerDescription: discriminator: Kind description: Describes the trigger for performing a scaling operation. required: - Kind properties: Kind: $ref: '#/definitions/ScalingTriggerKind' description: Specifies the kind of scaling trigger DiagnosticsSinkKind: type: string description: The kind of DiagnosticsSink. enum: - Invalid - AzureInternalMonitoringPipeline x-ms-enum: name: DiagnosticsSinkKind modelAsString: true values: - value: Invalid description: Indicates an invalid sink kind. All Service Fabric enumerations have the invalid type. - value: AzureInternalMonitoringPipeline description: Diagnostics settings for Geneva. ApplicationName: type: string description: The name of the application, including the 'fabric:' URI scheme. SaveOrGetBusinessProcessDevelopmentArtifactResponse: type: object description: The business process development artifact save or get response. properties: name: type: string description: The name of the business process development artifact. systemData: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/systemData description: The system data of the business process development artifact. properties: $ref: '#/definitions/BusinessProcessDevelopmentArtifactProperties' description: The properties of the business process development artifact. required: - name EndpointProperties: description: Describes a container endpoint. type: object properties: name: description: The name of the endpoint. type: string port: description: Port used by the container. type: integer required: - name ApplicationProperties_2: type: object description: The properties of application. properties: provisioningState: $ref: '#/definitions/ProvisioningState_2' description: The status of the last operation. readOnly: true description: type: string description: The description of the resource. trackingDataStores: type: object description: The tracking data stores. additionalProperties: $ref: '#/definitions/TrackingDataStore' required: - trackingDataStores UserAssignedIdentity: type: string description: The fully qualified resource id of user assigned identity. PagedServiceInfoList: description: The list of services in the cluster for an application. 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 service information. items: $ref: '#/definitions/ServiceInfo' ServiceResourceProperties: description: This type describes properties of a service resource. allOf: - $ref: '#/definitions/ServiceReplicaProperties' - type: object properties: description: description: User readable description of the service. type: string replicaCount: type: integer description: The number of replicas of the service to create. Defaults to 1 if not specified. healthState: $ref: '#/definitions/HealthState' description: The health state of a resource such as Application, Service, or Network. status: readOnly: true type: string description: Represents the status of the service. enum: - Unknown - Active - Upgrading - Deleting - Creating - Failed x-ms-enum: name: ServiceResourceStatus modelAsString: true ContainerInstanceView: description: Runtime information of a container instance. type: object properties: restartCount: type: integer description: The number of times the container has been restarted. currentState: $ref: '#/definitions/ContainerState' description: Current container instance state. previousState: $ref: '#/definitions/ContainerState' description: Previous container instance state. events: description: The events of this container instance. type: array items: $ref: '#/definitions/ContainerEvent' ServiceFromTemplateDescription: description: Defines description for creating a Service Fabric service from a template defined in the application manifest. required: - ApplicationName - ServiceName - ServiceTypeName properties: ApplicationName: $ref: '#/definitions/ApplicationName' description: The name of the application, including the 'fabric:' URI scheme. ServiceName: $ref: '#/definitions/ServiceName' description: The full name of the service with 'fabric:' URI scheme. ServiceTypeName: $ref: '#/definitions/ServiceTypeName' description: Name of the service type as specified in the service manifest. InitializationData: $ref: '#/definitions/ByteArray' description: The initialization data for the newly created service instance. ServicePackageActivationMode: $ref: '#/definitions/ServicePackageActivationMode' description: The activation mode of service package to be used for a service. ServiceDnsName: type: string description: The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster. ResourceRequests: description: 'This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits. ' type: object properties: memoryInGB: description: The memory request in GB for this container. type: number format: double cpu: description: Requested number of CPU cores. At present, only full cores are supported. type: number format: double required: - memoryInGB - cpu SubStatus: description: The sub status. enum: - NotSpecified - Approved - Denied - Failed - Expired - Timeout type: string x-ms-enum: name: Substatus modelAsString: true ServiceStatus: type: string description: The status of the application. enum: - Unknown - Active - Upgrading - Deleting - Creating - Failed x-ms-enum: name: ServiceStatus modelAsString: true values: - value: Unknown description: Indicates the service status is unknown. The value is zero. - value: Active description: Indicates the service status is active. The value is 1. - value: Upgrading description: Indicates the service is upgrading. The value is 2. - value: Deleting description: Indicates the service is being deleted. The value is 3. - value: Creating description: Indicates the service is being created. The value is 4. - value: Failed description: Indicates creation or deletion was terminated due to persistent failures. Another create/delete request can be accepted. The value is 5. Application_2: type: object description: An integration application under space. properties: properties: $ref: '#/definitions/ApplicationProperties_2' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource ServiceLoadMetricDescription: description: Specifies a metric to load balance a service during runtime. required: - Name properties: Name: type: string description: The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case-sensitive. Weight: $ref: '#/definitions/ServiceLoadMetricWeight' description: The service load metric relative weight, compared to other metrics configured for this service, as a number. PrimaryDefaultLoad: type: integer description: Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica. SecondaryDefaultLoad: type: integer description: Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica. AuxiliaryDefaultLoad: type: integer description: Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is an Auxiliary replica. DefaultLoad: type: integer description: Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. ApplicationManagementMode: description: The management mode. enum: - NotSpecified - Unmanaged - Managed type: string x-ms-enum: name: ApplicationManagementMode modelAsString: true ServiceReplicaProperties: description: Describes the properties of a service replica. type: object properties: osType: type: string description: 'The Operating system type required by the code in service. ' enum: - Linux - Windows x-ms-enum: name: OperatingSystemTypes modelAsString: true codePackages: description: 'Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.). ' type: array items: $ref: '#/definitions/ContainerCodePackageProperties' networkRefs: type: array description: The names of the private networks that this service needs to be part of. items: $ref: '#/definitions/NetworkRef' diagnostics: $ref: '#/definitions/DiagnosticsRef' description: Reference to sinks in DiagnosticsDescription. required: - osType - codePackages ProvisioningState: description: Provisioning status of the managed application. readOnly: true enum: - NotSpecified - Accepted - Running - Deleting - Deleted - Canceled - Failed - Succeeded - Updating type: string x-ms-enum: name: ProvisioningState modelAsString: true ErrorErrorModel: description: Error model information properties: code: type: string message: type: string description: Error message. innerError: type: string details: type: array description: List of error message details. items: $ref: '#/definitions/ErrorDetailsModel' required: - code ByteArray: description: Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255. type: array items: type: integer BatchErrorDetail: type: object description: An item of additional information included in an Azure Batch error response. properties: key: type: string description: An identifier specifying the meaning of the Value property. value: type: string description: The additional information included with the error response. parameters: ApplicationResourceDescriptionRequiredBodyParam: name: applicationResourceDescription in: body description: Description for creating an application resource. required: true x-ms-parameter-location: method schema: $ref: '#/definitions/ApplicationResourceDescription' ServiceTypeNameOptionalQueryParam: name: ServiceTypeName in: query x-ms-parameter-location: method type: string required: false description: The service type name used to filter the services to query for. 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. Azure.Core.TopQueryParameter: name: top in: query description: The number of result items to return. required: false type: integer format: int32 x-ms-parameter-location: method Azure.Core.SelectQueryParameter: name: select in: query description: Select the specified fields to be included in the response. required: false type: array items: type: string collectionFormat: multi x-ms-parameter-location: method Azure.Core.SkipQueryParameter: name: skip in: query description: The number of result items to skip. required: false type: integer format: int32 default: 0 x-ms-parameter-location: method ServiceIdRequiredPathParam: name: serviceId in: path x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string required: true description: 'The identity of the service. This ID is typically the full name of the service without the ''fabric:'' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.' Azure.Core.Foundations.ApiVersionParameter: name: api-version in: query description: The API version to use for this operation. required: true type: string minLength: 1 x-ms-parameter-location: method x-ms-client-name: apiVersion 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. ApplicationNameRequiredPathParam: name: applicationName in: path x-ms-parameter-location: method x-ms-skip-url-encoding: true type: string required: true description: The identity of the application. ResourceGroupNameRequiredPathParam: name: resourceGroupName in: path description: Azure resource group name required: true type: string x-ms-parameter-location: method ServiceDescriptionRequiredBodyParam: name: ServiceDescription in: body description: The information necessary to create a service. required: true x-ms-parameter-location: method schema: $ref: '#/definitions/ServiceDescription' Azure.Core.OrderByQueryParameter: name: orderby in: query description: Expressions that specify the order of returned results. required: false type: array items: type: string collectionFormat: multi x-ms-parameter-location: method 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.' subscriptionIdRequiredPathParam: name: subscriptionId in: path description: The customer subscription identifier required: true type: string api-versionRequiredQueryParam: name: api-version in: query type: string enum: - 2018-07-01-preview default: 2018-07-01-preview description: The version of the API. This parameter is required and its value must be `2018-07-01-preview`. required: true x-ms-enum: name: 2018-07-01-preview modelAsString: true values: - value: 2018-07-01-preview description: The `2018-07-01-preview` version of the API. Azure.Core.FilterQueryParameter: name: filter in: query description: Filter the result list using the given expression. required: false type: string x-ms-parameter-location: method ApplicationNameParameter: name: applicationName in: path required: true type: string description: The name of the managed application. minLength: 3 maxLength: 64 x-ms-parameter-location: method Azure.Core.MaxPageSizeQueryParameter: name: maxpagesize in: query description: The maximum number of result items per page. required: false type: integer format: int32 x-ms-parameter-location: method 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. Azure.Core.ExpandQueryParameter: name: expand in: query description: Expand the indicated resources into the response. required: false type: array items: type: string collectionFormat: multi x-ms-parameter-location: method CreateServiceFromTemplateRequiredBodyParam: name: ServiceFromTemplateDescription in: body description: Describes the service that needs to be created from the template defined in the application manifest. required: true x-ms-parameter-location: method schema: $ref: '#/definitions/ServiceFromTemplateDescription' x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'