Microsoft Azure · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Microsoft Azure Application API
36 actions
36 updates
phrasing
extends
openapi/microsoft-azure-application-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Microsoft Azure's API. It is a proposal applied on top of the contract, not a document Microsoft Azure publishes.
What the actions change
x-apievangelist-phrasing
Targets 36 · first 16 shown; the file carries all of them
$.info
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}'].patch
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}'].patch
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications'].get
$.paths['/{tenantID}/applications'].get
$.paths['/{tenantID}/applications'].post
$.paths['/{tenantID}/deletedApplications/{applicationObjectId}'].delete
$.paths['/{tenantID}/applications/{applicationObjectId}'].get
$.paths['/{tenantID}/applications/{applicationObjectId}'].delete
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Microsoft Azure Application API
version: 1.0.0
extends: openapi/microsoft-azure-application-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 35
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}'].get
update:
x-apievangelist-phrasing:
intent: Get an application in a Batch account
effect: read
questions:
- What information does Azure Batch hold about one application in my Batch account?
- Can I look up a single Batch account application by its name?
instructions:
- text: Get Batch application {applicationName} in account {accountName}.
slots:
applicationName: path.applicationName
accountName: path.accountName
- text: Show details of app {applicationName} from Batch account {accountName} in resource group {resourceGroupName}.
slots:
applicationName: path.applicationName
accountName: path.accountName
resourceGroupName: path.resourceGroupName
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}'].put
update:
x-apievangelist-phrasing:
intent: Add an application to a Batch account
effect: write
questions:
- How do I add a new application to my Azure Batch account?
- Can I set properties like a display name when adding an application to a Batch account?
instructions:
- text: Add application {applicationName} to Batch account {accountName}.
slots:
applicationName: path.applicationName
accountName: path.accountName
- text: Create Batch app {applicationName} in account {accountName} with properties {properties}.
slots:
applicationName: path.applicationName
accountName: path.accountName
properties: requestBody.properties
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an application from a Batch account
effect: destructive
questions:
- How do I remove an application I no longer need from a Batch account?
- Is deleting a Batch account application permanent?
instructions:
- text: Delete Batch application {applicationName} from account {accountName}.
slots:
applicationName: path.applicationName
accountName: path.accountName
- text: Remove app {applicationName} out of Batch account {accountName} in resource group {resourceGroupName}.
slots:
applicationName: path.applicationName
accountName: path.accountName
resourceGroupName: path.resourceGroupName
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}'].patch
update:
x-apievangelist-phrasing:
intent: Update a Batch application's settings
effect: write
questions:
- How do I change the settings of an existing application in my Batch account?
- Can I patch just some properties of a Batch application?
instructions:
- text: Update the settings of Batch application {applicationName} in account {accountName}.
slots:
applicationName: path.applicationName
accountName: path.accountName
- text: Patch Batch app {applicationName} (account {accountName}, group {resourceGroupName}, subscription {subscriptionId}) with new properties.
slots:
applicationName: path.applicationName
accountName: path.accountName
resourceGroupName: path.resourceGroupName
subscriptionId: path.subscriptionId
method: generated
generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications'].get
update:
x-apievangelist-phrasing:
intent: List applications in a Batch account
effect: read
questions:
- Which applications are registered in my Azure Batch account?
- Can I cap how many Batch applications come back in one response?
instructions:
- text: List every application in Batch account {accountName}.
slots:
accountName: path.accountName
- text: Show up to {maxresults} apps from Batch account {accountName} in resource group {resourceGroupName}, subscription {subscriptionId}.
slots:
maxresults: query.maxresults
accountName: path.accountName
resourceGroupName: path.resourceGroupName
subscriptionId: path.subscriptionId
method: generated
generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}'].get
update:
x-apievangelist-phrasing:
intent: Get a virtual desktop application
effect: read
questions:
- How do I look up one published app in an Azure Virtual Desktop application group?
- What properties does a RemoteApp in my application group have?
instructions:
- text: Get the virtual desktop app {applicationName} in application group {applicationGroupName}.
slots:
applicationName: path.applicationName
applicationGroupName: path.applicationGroupName
- text: Show RemoteApp {applicationName} from desktop application group {applicationGroupName}.
slots:
applicationName: path.applicationName
applicationGroupName: path.applicationGroupName
method: generated
generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}'].put
update:
x-apievangelist-phrasing:
intent: Publish an app in a virtual desktop application group
effect: write
questions:
- How do I publish a new RemoteApp into an Azure Virtual Desktop application group?
- Can I replace an existing virtual desktop app's properties by publishing it again?
instructions:
- text: Publish RemoteApp {applicationName} in application group {applicationGroupName} with properties {properties}.
slots:
applicationName: path.applicationName
applicationGroupName: path.applicationGroupName
properties: requestBody.properties
- text: Create or replace virtual desktop app {applicationName} in desktop group {applicationGroupName}.
slots:
applicationName: path.applicationName
applicationGroupName: path.applicationGroupName
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}'].delete
update:
x-apievangelist-phrasing:
intent: Remove a virtual desktop app from a group
effect: destructive
questions:
- How do I unpublish a RemoteApp from an Azure Virtual Desktop application group?
- Can I take a single app out of a desktop application group without deleting the group?
instructions:
- text: Remove RemoteApp {applicationName} from application group {applicationGroupName}.
slots:
applicationName: path.applicationName
applicationGroupName: path.applicationGroupName
- text: Unpublish virtual desktop app {applicationName} in group {applicationGroupName}.
slots:
applicationName: path.applicationName
applicationGroupName: path.applicationGroupName
method: generated
generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}'].patch
update:
x-apievangelist-phrasing:
intent: Update a virtual desktop application
effect: write
questions:
- Can I change the tags on a RemoteApp already published in a desktop application group?
- Is it possible to patch only some properties of an Azure Virtual Desktop app?
instructions:
- text: Update the tags on RemoteApp {applicationName} in application group {applicationGroupName} to {tags}.
slots:
applicationName: path.applicationName
applicationGroupName: path.applicationGroupName
tags: requestBody.tags
- text: Patch published desktop app {applicationName} in group {applicationGroupName} with properties {properties}.
slots:
applicationName: path.applicationName
applicationGroupName: path.applicationGroupName
properties: requestBody.properties
method: generated
generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications'].get
update:
x-apievangelist-phrasing:
intent: List apps in a virtual desktop application group
effect: read
questions:
- Which RemoteApps are published in my Azure Virtual Desktop application group?
- Can I page through desktop group apps in descending order?
instructions:
- text: List the RemoteApps in application group {applicationGroupName}.
slots:
applicationGroupName: path.applicationGroupName
- text: Show {pageSize} apps per page from desktop application group {applicationGroupName}.
slots:
pageSize: query.pageSize
applicationGroupName: path.applicationGroupName
method: generated
generated: '2026-09-26'
- target: $.paths['/{tenantID}/applications'].get
update:
x-apievangelist-phrasing:
intent: List directory app registrations
effect: read
questions:
- How do I list the app registrations in my Azure AD tenant?
- Can I filter directory applications by display name or app ID?
instructions:
- text: List app registrations in tenant {tenantID}.
slots:
tenantID: path.tenantID
- text: Find directory applications in tenant {tenantID} matching filter {filter}.
slots:
tenantID: path.tenantID
filter: query.$filter
method: generated
generated: '2026-09-26'
- target: $.paths['/{tenantID}/applications'].post
update:
x-apievangelist-phrasing:
intent: Register a new directory application
effect: write
questions:
- How do I create an app registration in an Azure AD tenant?
- Can I set reply URLs and sign-in audience when registering an app?
instructions:
- text: Register a new application named {displayName} in tenant {tenantID}.
slots:
displayName: requestBody.displayName
tenantID: path.tenantID
- text: Create app registration {displayName} in tenant {tenantID} with reply URLs {replyUrls}.
slots:
displayName: requestBody.displayName
tenantID: path.tenantID
replyUrls: requestBody.replyUrls
method: generated
generated: '2026-09-26'
- target: $.paths['/{tenantID}/deletedApplications/{applicationObjectId}'].delete
update:
x-apievangelist-phrasing:
intent: Permanently purge a deleted app registration
effect: destructive
questions:
- Can I permanently erase an app registration that's already in the deleted items?
- How do I hard-delete a soft-deleted directory application so it can't be restored?
instructions:
- text: Permanently purge deleted application {applicationObjectId} from tenant {tenantID}.
slots:
applicationObjectId: path.applicationObjectId
tenantID: path.tenantID
- text: Hard-delete the soft-deleted app {applicationObjectId} in tenant {tenantID}.
slots:
applicationObjectId: path.applicationObjectId
tenantID: path.tenantID
method: generated
generated: '2026-09-26'
- target: $.paths['/{tenantID}/applications/{applicationObjectId}'].get
update:
x-apievangelist-phrasing:
intent: Get a directory app registration by object ID
effect: read
questions:
- How do I fetch one Azure AD app registration using its object ID?
- What reply URLs and permissions does a specific directory application have?
instructions:
- text: Get app registration {applicationObjectId} in tenant {tenantID}.
slots:
applicationObjectId: path.applicationObjectId
tenantID: path.tenantID
- text: Show the directory application with object ID {applicationObjectId}.
slots:
applicationObjectId: path.applicationObjectId
method: generated
generated: '2026-10-01'
- target: $.paths['/{tenantID}/applications/{applicationObjectId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a directory app registration
effect: destructive
questions:
- How do I delete a live Azure AD app registration by object ID?
- Does deleting an app registration move it to deleted items rather than purging it?
instructions:
- text: Delete app registration {applicationObjectId} from tenant {tenantID}.
slots:
applicationObjectId: path.applicationObjectId
tenantID: path.tenantID
- text: Remove the active directory application {applicationObjectId}.
slots:
applicationObjectId: path.applicationObjectId
method: generated
generated: '2026-10-01'
- target: $.paths['/{tenantID}/applications/{applicationObjectId}'].patch
update:
x-apievangelist-phrasing:
intent: Update a directory app registration
effect: write
questions:
- Can I change the display name of an existing Azure AD app registration?
- How do I add reply URLs to an app registration I already created?
instructions:
- text: Rename app registration {applicationObjectId} in tenant {tenantID} to {displayName}.
slots:
applicationObjectId: path.applicationObjectId
tenantID: path.tenantID
displayName: requestBody.displayName
- text: Set reply URLs {replyUrls} on existing app registration {applicationObjectId}.
slots:
replyUrls: requestBody.replyUrls
applicationObjectId: path.applicationObjectId
method: generated
generated: '2026-10-01'
- target: $.paths['/Applications/$/Create'].post
update:
x-apievangelist-phrasing:
intent: Create a Service Fabric application
effect: write
questions:
- How do I create an application instance in a Service Fabric cluster?
- What do I need to describe to deploy a new Service Fabric application?
instructions:
- text: Create a Service Fabric application from description {ApplicationDescription}.
slots:
ApplicationDescription: body.ApplicationDescription
- text: 'Deploy a new application to my Service Fabric cluster using this description: {ApplicationDescription}.'
slots:
ApplicationDescription: body.ApplicationDescription
method: generated
generated: '2026-09-26'
- target: $.paths['/Applications/{applicationId}/$/Delete'].post
update:
x-apievangelist-phrasing:
intent: Delete a Service Fabric application
effect: destructive
questions:
- Does deleting a Service Fabric application also remove all of its services?
- Can I force-remove a Service Fabric application whose replicas won't close gracefully?
instructions:
- text: Delete Service Fabric application {applicationId}.
slots:
applicationId: path.applicationId
- text: Force-remove Service Fabric application {applicationId}, skipping graceful shutdown ({ForceRemove}).
slots:
applicationId: path.applicationId
ForceRemove: query.ForceRemove
method: generated
generated: '2026-09-26'
- target: $.paths['/Applications/{applicationId}/$/GetLoadInformation'].get
update:
x-apievangelist-phrasing:
intent: Get load information for a Service Fabric app
effect: read
questions:
- How much load is a Service Fabric application putting on the cluster?
- Can I see minimum and maximum nodes and load metrics for one application?
instructions:
- text: Get load information for Service Fabric application {applicationId}.
slots:
applicationId: path.applicationId
- text: Show node counts and load metrics reported for app {applicationId}.
slots:
applicationId: path.applicationId
method: generated
generated: '2026-09-26'
- target: $.paths['/Applications'].get
update:
x-apievangelist-phrasing:
intent: List applications in a Service Fabric cluster
effect: read
questions:
- Which applications have been created in my Service Fabric cluster?
- Can I filter Service Fabric applications by application type name?
instructions:
- text: List all applications in the Service Fabric cluster.
- text: List Service Fabric applications of type {ApplicationTypeName}, at most {MaxResults} per page.
slots:
ApplicationTypeName: query.ApplicationTypeName
MaxResults: query.MaxResults
method: generated
generated: '2026-09-26'
- target: $.paths['/Applications/{applicationId}'].get
update:
x-apievangelist-phrasing:
intent: Get a Service Fabric application's details
effect: read
questions:
- What type, status and parameters does a specific Service Fabric application have?
- Can I read one cluster application's info without its parameter list?
instructions:
- text: Get details of Service Fabric application {applicationId}.
slots:
applicationId: path.applicationId
- text: Show type and status of cluster app {applicationId}, excluding parameters ({ExcludeApplicationParameters}).
slots:
applicationId: path.applicationId
ExcludeApplicationParameters: query.ExcludeApplicationParameters
method: generated
generated: '2026-09-26'
- target: $.paths['/Applications/{applicationId}/$/GetHealth'].get
update:
x-apievangelist-phrasing:
intent: Check a Service Fabric application's health
effect: read
questions:
- Is my Service Fabric application healthy, in warning, or in error?
- Can I filter health events on a cluster application by health state?
instructions:
- text: Check the health of Service Fabric application {applicationId}.
slots:
applicationId: path.applicationId
- text: Get health state of app {applicationId} showing only events matching filter {EventsHealthStateFilter}.
slots:
applicationId: path.applicationId
EventsHealthStateFilter: query.EventsHealthStateFilter
method: generated
generated: '2026-09-26'
- target: $.paths['/Applications/{applicationId}/$/GetHealth'].post
update:
x-apievangelist-phrasing:
intent: Evaluate app health with a custom policy
effect: read
questions:
- Can I evaluate a Service Fabric application's health against my own health policy?
- How do I override the default health policy when checking an application?
instructions:
- text: Evaluate health of Service Fabric app {applicationId} using policy {ApplicationHealthPolicy}.
slots:
applicationId: path.applicationId
ApplicationHealthPolicy: body.ApplicationHealthPolicy
- text: Re-check application {applicationId} health with an overridden health policy.
slots:
applicationId: path.applicationId
method: generated
generated: '2026-09-26'
- target: $.paths['/Applications/{applicationId}/$/ReportHealth'].post
update:
x-apievangelist-phrasing:
intent: Report health for a Service Fabric application
effect: write
questions:
- How do I send a custom health report about a Service Fabric application?
- Can a health report be sent immediately instead of batched by the gateway?
instructions:
- text: Report health {HealthInformation} for Service Fabric application {applicationId}.
slots:
HealthInformation: body.HealthInformation
applicationId: path.applicationId
- text: 'Send an immediate health report for app {applicationId} with this info: {HealthInformation}.'
slots:
applicationId: path.applicationId
HealthInformation: body.HealthInformation
method: generated
generated: '2026-09-26'
- target: $.paths['/Applications/{applicationId}/$/Upgrade'].post
update:
x-apievangelist-phrasing:
intent: Start upgrading a Service Fabric application
effect: write
questions:
- How do I roll out a new version of a Service Fabric application?
- Are application parameters kept when I start an application upgrade?
instructions:
- text: Start upgrading Service Fabric application {applicationId} with {ApplicationUpgradeDescription}.
slots:
applicationId: path.applicationId
ApplicationUpgradeDescription: body.ApplicationUpgradeDescription
- text: Kick off a version upgrade of app {applicationId}.
slots:
applicationId: path.applicationId
method: generated
generated: '2026-09-26'
- target: $.paths['/Applications/{applicationId}/$/GetUpgradeProgress'].get
update:
x-apievangelist-phrasing:
intent: Get application upgrade progress
effect: read
questions:
- How far along is the current upgrade of my Service Fabric application?
- What details help debug health issues during an application upgrade?
instructions:
- text: Show upgrade progress for Service Fabric application {applicationId}.
slots:
applicationId: path.applicationId
- text: Get the state of the latest upgrade of app {applicationId}.
slots:
applicationId: path.applicationId
method: generated
generated: '2026-09-26'
- target: $.paths['/Applications/{applicationId}/$/UpdateUpgrade'].post
update:
x-apievangelist-phrasing:
intent: Change parameters of an in-progress upgrade
effect: write
questions:
- Can I fix the parameters of an application upgrade that's already running?
- How do I unstick an application upgrade that was started with the wrong settings?
instructions:
- text: Change the running upgrade of application {applicationId} to use {ApplicationUpgradeUpdateDescription}.
slots:
applicationId: path.applicationId
ApplicationUpgradeUpdateDescription: body.ApplicationUpgradeUpdateDescription
- text: Adjust in-flight upgrade settings for Service Fabric app {applicationId}.
slots:
applicationId: path.applicationId
method: generated
generated: '2026-09-26'
- target: $.paths['/Applications/{applicationId}/$/Update'].post
update:
x-apievangelist-phrasing:
intent: Update a Service Fabric application instance
effect: write
questions:
- Which properties of a Service Fabric application can I change after creation?
- How do I update an existing application instance without upgrading it?
instructions:
- text: Update Service Fabric application instance {applicationId} with {ApplicationUpdateDescription}.
slots:
applicationId: path.applicationId
ApplicationUpdateDescription: body.ApplicationUpdateDescription
- text: Modify the capacity settings of cluster app {applicationId}.
slots:
applicationId: path.applicationId
method: generated
generated: '2026-09-26'
- target: $.paths['/Applications/{applicationId}/$/MoveToNextUpgradeDomain'].post
update:
x-apievangelist-phrasing:
intent: Move a manual upgrade to the next domain
effect: write
questions:
- How do I continue an unmonitored manual upgrade to the next upgrade domain?
- Why is my manual application upgrade waiting after finishing one upgrade domain?
instructions:
- text: Resume the manual upgrade of application {applicationId} in the next upgrade domain.
slots:
applicationId: path.applicationId
- text: Proceed app {applicationId} upgrade to domain {ResumeApplicationUpgradeDescription}.
slots:
applicationId: path.applicationId
ResumeApplicationUpgradeDescription: body.ResumeApplicationUpgradeDescription
method: generated
generated: '2026-09-26'
- target: $.paths['/Applications/{applicationId}/$/RollbackUpgrade'].post
update:
x-apievangelist-phrasing:
intent: Roll back an in-progress application upgrade
effect: destructive
questions:
- Can I roll back a Service Fabric application upgrade that's still rolling forward?
- How do I revert my application to the previous version mid-upgrade?
instructions:
- text: Roll back the current upgrade of Service Fabric application {applicationId}.
slots:
applicationId: path.applicationId
- text: Revert app {applicationId} to its previous version by cancelling the upgrade.
slots:
applicationId: path.applicationId
method: generated
generated: '2026-09-26'
- target: $.paths['/Nodes/{nodeName}/$/GetApplications'].get
update:
x-apievangelist-phrasing:
intent: List applications deployed on a node
effect: read
questions:
- Which applications are deployed on a particular Service Fabric node?
- Can I include health state when listing a node's deployed applications?
instructions:
- text: List applications deployed on node {nodeName}.
slots:
nodeName: path.nodeName
- text: Show apps on Service Fabric node {nodeName} with health state included ({IncludeHealthState}).
slots:
nodeName: path.nodeName
IncludeHealthState: query.IncludeHealthState
method: generated
generated: '2026-09-26'
- target: $.paths['/Nodes/{nodeName}/$/GetApplications/{applicationId}'].get
update:
x-apievangelist-phrasing:
intent: Get an application deployed on a node
effect: read
questions:
- How do I see the status of one application on a specific cluster node?
- Is a given app active, activating or still downloading on this node?
instructions:
- text: Get deployed application {applicationId} on node {nodeName}.
slots:
applicationId: path.applicationId
nodeName: path.nodeName
- text: Show the deployment status of app {applicationId} on Service Fabric node {nodeName}.
slots:
applicationId: path.applicationId
nodeName: path.nodeName
method: generated
generated: '2026-09-26'
- target: $.paths['/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth'].get
update:
x-apievangelist-phrasing:
intent: Check health of an app deployed on a node
effect: read
questions:
- Is an application healthy on one particular Service Fabric node?
- Can I filter deployed service package health for an app on a node?
instructions:
- text: Check health of application {applicationId} deployed on node {nodeName}.
slots:
applicationId: path.applicationId
nodeName: path.nodeName
- text: Get node {nodeName} health for app {applicationId}, filtering service packages by {DeployedServicePackagesHealthStateFilter}.
slots:
nodeName: path.nodeName
applicationId: path.applicationId
DeployedServicePackagesHealthStateFilter: query.DeployedServicePackagesHealthStateFilter
method: generated
generated: '2026-09-26'
- target: $.paths['/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth'].post
update:
x-apievangelist-phrasing:
intent: Evaluate a node's app health with a policy
effect: read
questions:
- Can I apply a custom health policy when checking an app on a single node?
- How do I evaluate a deployed application's health on a node with overridden rules?
instructions:
- text: Evaluate health of app {applicationId} on node {nodeName} using policy {ApplicationHealthPolicy}.
slots:
applicationId: path.applicationId
nodeName: path.nodeName
ApplicationHealthPolicy: body.ApplicationHealthPolicy
- text: Assess deployed app {applicationId} on node {nodeName} against a custom health policy.
slots:
applicationId: path.applicationId
nodeName: path.nodeName
method: generated
generated: '2026-09-26'
- target: $.paths['/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/ReportHealth'].post
update:
x-apievangelist-phrasing:
intent: Report health for an app on a node
effect: write
questions:
- How do I report a health problem for an application on one specific node?
- Where does a deployed-application health report go once I send it?
instructions:
- text: Report health {HealthInformation} for app {applicationId} deployed on node {nodeName}.
slots:
HealthInformation: body.HealthInformation
applicationId: path.applicationId
nodeName: path.nodeName
- text: Post a node-level health report for application {applicationId} on {nodeName}.
slots:
applicationId: path.applicationId
nodeName: path.nodeName
method: generated
generated: '2026-09-26'
Work with this as data
Every overlay here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/microsoft-azure-application-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.