Microsoft Azure Cluster API

The Cluster API from Microsoft Azure — 23 operation(s) for cluster.

Documentation GitHub OpenAPI

Operations 25

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /$/GetClusterManifest Get the Service Fabric cluster manifest · Microsoft Azure Get The Service Fabric Cluster Manifest #

Ask an LLM

“What node types and security settings are defined in my Service Fabric cluster manifest?”

“Where can I see the fault and upgrade domain topology of my cluster as XML?”

Tell an agent

Download the Service Fabric cluster manifest.

Fetch the cluster manifest XML using API version {api_version}.

GET /$/GetClusterHealth Check the health of a Service Fabric cluster · Microsoft Azure Gets The Health Of A Service Fabric Cluster #

Ask an LLM

“Is my Service Fabric cluster healthy right now?”

“Can I filter cluster health so only nodes in an Error state come back?”

Tell an agent

Show me the overall health state of my Service Fabric cluster.

Get cluster health, returning only nodes matching health filter {nodes_filter}.

POST /$/GetClusterHealth Evaluate cluster health with a custom policy · Microsoft Azure Gets The Health Of A Service Fabric Cluster Using The Specified… #

Ask an LLM

“How can I evaluate cluster health against my own application health policy map?”

“Can I pass custom health policies instead of the ones in the cluster manifest?”

Tell an agent

Evaluate Service Fabric cluster health using the health policies {policies}.

Assess the cluster against policies {policies} and list only applications matching filter {apps_filter}.

GET /$/GetClusterHealthChunk Get the aggregated cluster health chunk · Microsoft Azure Gets The Health Of A Service Fabric Cluster Using Health Chunks #

Ask an LLM

“What is the aggregated health state of my cluster without any of its entities?”

“Is there a lightweight health chunk call that returns just the cluster's rollup state?”

Tell an agent

Get the aggregated health chunk of the cluster with no entity detail.

Return the cluster health chunk rollup, timing out after {timeout} seconds.

POST /$/GetClusterHealthChunk Query cluster health chunks with advanced filters · Microsoft Azure Gets The Health Of A Service Fabric Cluster Using Health Chunks #

Ask an LLM

“Can I expand the cluster health chunk to include specific nodes and applications?”

“How do I get health chunks for only certain applications using a query description?”

Tell an agent

Query cluster health chunks using the query description {query}.

Expand the health chunk to the nodes and applications selected in {query}.

POST /$/ReportClusterHealth Send a health report on the cluster · Microsoft Azure Sends A Health Report On The Service Fabric Cluster #

Ask an LLM

“Can I report a custom health event against my Service Fabric cluster?”

“Can I force a cluster health report to be sent immediately instead of batched?”

Tell an agent

Send the health report {health_info} for the cluster.

Report {health_info} on the cluster and flush it immediately: {immediate}.

GET /$/GetProvisionedCodeVersions List provisioned fabric code versions · Microsoft Azure Gets A List Of Fabric Code Versions That Are Provisioned In A… #

Ask an LLM

“Which Service Fabric runtime code versions are provisioned in my cluster?”

“Is a particular fabric code version already provisioned?”

Tell an agent

List the fabric code versions provisioned in the cluster.

Check whether fabric code version {code_version} is provisioned.

GET /$/GetProvisionedConfigVersions List provisioned fabric config versions · Microsoft Azure Gets A List Of Fabric Config Versions That Are Provisioned In A… #

Ask an LLM

“Which cluster config versions have been provisioned in Service Fabric?”

“Can I check if one specific fabric config version is provisioned?”

Tell an agent

List the fabric config versions provisioned in the cluster.

Confirm that fabric config version {config_version} is provisioned.

GET /$/GetUpgradeProgress Get cluster upgrade progress · Microsoft Azure Gets The Progress Of The Current Cluster Upgrade #

Ask an LLM

“How far along is the current cluster upgrade?”

“What was the final state of the last cluster upgrade if none is running?”

Tell an agent

Show me the progress of the ongoing cluster upgrade.

Report the cluster upgrade status, giving up after {timeout} seconds.

GET /$/GetClusterConfiguration Get standalone cluster configuration · Microsoft Azure Get The Service Fabric Standalone Cluster Configuration #

Ask an LLM

“What is the configuration of my Service Fabric standalone cluster?”

“Which configuration API version do I need to read a standalone cluster's config?”

Tell an agent

Get the standalone cluster configuration for configuration API version {config_api_version}.

Read the node types and security settings of my standalone cluster using config API {config_api_version}.

GET /$/GetClusterConfigurationUpgradeStatus Get standalone config upgrade status · Microsoft Azure Get The Cluster Configuration Upgrade Status Of A Service… #

Ask an LLM

“Is the configuration upgrade on my standalone cluster finished?”

“What are the details of the standalone cluster configuration upgrade in progress?”

Tell an agent

Check the configuration upgrade status of the standalone cluster.

Get standalone cluster config upgrade details with API version {api_version}.

GET /$/GetUpgradeOrchestrationServiceState Get Upgrade Orchestration Service state · Microsoft Azure Get The Service State Of Service Fabric Upgrade Orchestration… #

Ask an LLM

“What service state is the Upgrade Orchestration Service holding?”

“Can support read the internal state of the Service Fabric upgrade orchestrator?”

Tell an agent

Read the Upgrade Orchestration Service state.

Fetch the upgrade orchestrator's service state within {timeout} seconds.

POST /$/SetUpgradeOrchestrationServiceState Update Upgrade Orchestration Service state · Microsoft Azure Update The Service State Of Service Fabric Upgrade… #

Ask an LLM

“Can I overwrite the Upgrade Orchestration Service state for a support case?”

“Is there a call to set the upgrade orchestrator's service state?”

Tell an agent

Set the Upgrade Orchestration Service state to {state}.

Replace the orchestrator service state with {state} as directed by support.

POST /$/Provision Provision fabric code or config packages · Microsoft Azure Provision The Code Or Configuration Packages Of A Service… #

Ask an LLM

“How do I provision a new Service Fabric code package before upgrading?”

“Can I validate and provision a cluster manifest file in one step?”

Tell an agent

Provision the fabric packages described in {provision}.

Validate and provision the code and config packages from {provision}.

POST /$/Unprovision Unprovision fabric code or config packages · Microsoft Azure Unprovision The Code Or Configuration Packages Of A Service… #

Ask an LLM

“Can I unprovision an old fabric code version separately from its config?”

“How do I remove provisioned Service Fabric packages I no longer need?”

Tell an agent destructive · confirm first

Unprovision the fabric packages listed in {unprovision}.

Remove the provisioned code or config version given in {unprovision}.

POST /$/RollbackUpgrade Roll back a cluster upgrade · Microsoft Azure Roll Back The Upgrade Of A Service Fabric Cluster #

Ask an LLM

“Can I roll back a Service Fabric cluster upgrade that is going badly?”

“What happens to the code or config upgrade when I roll it back?”

Tell an agent destructive · confirm first

Roll back the current cluster upgrade.

Revert the in-progress cluster code or config upgrade within {timeout} seconds.

POST /$/MoveToNextUpgradeDomain Move cluster upgrade to next upgrade domain · Microsoft Azure Make The Cluster Upgrade Move On To The Next Upgrade Domain #

Ask an LLM

“How do I move a manual cluster upgrade on to the next upgrade domain?”

“Can I resume an unmonitored cluster upgrade domain by domain?”

Tell an agent

Move the cluster upgrade on to upgrade domain {resume}.

Resume the cluster upgrade with the next-domain description {resume}.

POST /$/Upgrade Start a cluster code or config upgrade · Microsoft Azure Start Upgrading The Code Or Configuration Version Of A Service… #

Ask an LLM

“How do I start upgrading my Service Fabric cluster to a new runtime version?”

“Will the cluster upgrade start if my upgrade parameters are invalid?”

Tell an agent

Start the cluster upgrade using the parameters in {upgrade}.

Kick off a code or config version upgrade of the cluster with {upgrade}.

POST /$/StartClusterConfigurationUpgrade Start a standalone cluster config upgrade · Microsoft Azure Start Upgrading The Configuration Of A Service Fabric… #

Ask an LLM

“How do I push a new cluster configuration JSON to my standalone cluster?”

“Can I upgrade just the configuration of a standalone Service Fabric cluster?”

Tell an agent

Start upgrading the standalone cluster configuration with {config_upgrade}.

Apply the new standalone cluster config from {config_upgrade}.

POST /$/UpdateUpgrade Update parameters of a running cluster upgrade · Microsoft Azure Update The Upgrade Parameters Of A Service Fabric Cluster… #

Ask an LLM

“Can I change the health check settings of a cluster upgrade that is already running?”

“How do I switch an in-flight cluster upgrade's mode or timeouts?”

Tell an agent

Update the running cluster upgrade with parameters {update}.

Change the in-progress upgrade's policy to {update}.

GET /$/GetAadMetadata Get Azure AD metadata for cluster connections · Microsoft Azure Gets The Azure Active Directory Metadata Used For Secured… #

Ask an LLM

“What Azure Active Directory metadata do I need to connect securely to my cluster?”

“Where do I find the AAD tenant and client details a cluster expects?”

Tell an agent

Get the Azure AD metadata for a secured cluster connection.

Fetch the cluster's AAD sign-in metadata using API version {api_version}.

GET /$/GetClusterVersion Get the current cluster runtime version · Microsoft Azure Get The Current Service Fabric Cluster Version #

Ask an LLM

“What Service Fabric version is my cluster running?”

“Which version is reported while an upgrade is between the current and target runtime?”

Tell an agent

Tell me the current Service Fabric cluster version.

Get the cluster runtime version with a {timeout} second timeout.

GET /$/GetLoadInformation Get cluster load and capacity metrics · Microsoft Azure Gets The Load Of A Service Fabric Cluster #

Ask an LLM

“How loaded is my Service Fabric cluster across its capacity metrics?”

“Which metrics have load or capacity defined in the cluster?”

Tell an agent

Show the load information for every metric in the cluster.

Retrieve cluster load and capacity figures, timing out after {timeout} seconds.

POST /$/ToggleVerboseServicePlacementHealthReporting Toggle verbose service placement health reports · Microsoft Azure Changes The Verbosity Of Service Placement Health Reporting #

Ask an LLM

“Can I get detailed health reports when replicas cannot be placed?”

“How do I turn off verbose placement health reporting?”

Tell an agent

Set verbose service placement health reporting to {enabled}.

Turn detailed replica placement health reports on or off: {enabled}.

POST /$/ValidateUpgrade Validate a cluster upgrade without starting it · Microsoft Azure Validate And Assess The Impact Of A Code Or Configuration… #

Ask an LLM

“Can I check the impact of a cluster upgrade before actually starting it?”

“Will my proposed code or config upgrade pass validation?”

Tell an agent

Validate the upgrade parameters {upgrade} and assess their impact without upgrading.

Dry-run the cluster upgrade described in {upgrade}.

Microsoft Azure Cluster API

Operations 25

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification