API Evangelist conversational phrasing for Microsoft Azure Service Fabric Client Cluster API

# 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 Service Fabric Client Cluster API
  version: 1.0.0
extends: openapi/microsoft-azure-cluster-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 25
- target: $.paths['/$/GetClusterManifest'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Service Fabric cluster manifest
      effect: read
      questions:
      - 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?
      instructions:
      - text: Download the Service Fabric cluster manifest.
      - text: Fetch the cluster manifest XML using API version {api_version}.
        slots:
          api_version: query.api-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/GetClusterHealth'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the health of a Service Fabric cluster
      effect: read
      questions:
      - Is my Service Fabric cluster healthy right now?
      - Can I filter cluster health so only nodes in an Error state come back?
      - Can I leave health statistics out of the cluster health result?
      instructions:
      - text: Show me the overall health state of my Service Fabric cluster.
      - text: Get cluster health, returning only nodes matching health filter {nodes_filter}.
        slots:
          nodes_filter: query.NodesHealthStateFilter
      - text: 'Check cluster health and include system application health statistics: {include_system}.'
        slots:
          include_system: query.IncludeSystemApplicationHealthStatistics
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/GetClusterHealth'].post
  update:
    x-apievangelist-phrasing:
      intent: Evaluate cluster health with a custom policy
      effect: read
      questions:
      - 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?
      instructions:
      - text: Evaluate Service Fabric cluster health using the health policies {policies}.
        slots:
          policies: body.ClusterHealthPolicies
      - text: Assess the cluster against policies {policies} and list only applications matching filter {apps_filter}.
        slots:
          policies: body.ClusterHealthPolicies
          apps_filter: query.ApplicationsHealthStateFilter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/GetClusterHealthChunk'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the aggregated cluster health chunk
      effect: read
      questions:
      - 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?
      instructions:
      - text: Get the aggregated health chunk of the cluster with no entity detail.
      - text: Return the cluster health chunk rollup, timing out after {timeout} seconds.
        slots:
          timeout: query.timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/GetClusterHealthChunk'].post
  update:
    x-apievangelist-phrasing:
      intent: Query cluster health chunks with advanced filters
      effect: read
      questions:
      - 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?
      instructions:
      - text: Query cluster health chunks using the query description {query}.
        slots:
          query: body.ClusterHealthChunkQueryDescription
      - text: Expand the health chunk to the nodes and applications selected in {query}.
        slots:
          query: body.ClusterHealthChunkQueryDescription
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/ReportClusterHealth'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a health report on the cluster
      effect: write
      questions:
      - 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?
      instructions:
      - text: Send the health report {health_info} for the cluster.
        slots:
          health_info: body.HealthInformation
      - text: 'Report {health_info} on the cluster and flush it immediately: {immediate}.'
        slots:
          health_info: body.HealthInformation
          immediate: query.Immediate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/GetProvisionedCodeVersions'].get
  update:
    x-apievangelist-phrasing:
      intent: List provisioned fabric code versions
      effect: read
      questions:
      - Which Service Fabric runtime code versions are provisioned in my cluster?
      - Is a particular fabric code version already provisioned?
      instructions:
      - text: List the fabric code versions provisioned in the cluster.
      - text: Check whether fabric code version {code_version} is provisioned.
        slots:
          code_version: query.CodeVersion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/GetProvisionedConfigVersions'].get
  update:
    x-apievangelist-phrasing:
      intent: List provisioned fabric config versions
      effect: read
      questions:
      - Which cluster config versions have been provisioned in Service Fabric?
      - Can I check if one specific fabric config version is provisioned?
      instructions:
      - text: List the fabric config versions provisioned in the cluster.
      - text: Confirm that fabric config version {config_version} is provisioned.
        slots:
          config_version: query.ConfigVersion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/GetUpgradeProgress'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cluster upgrade progress
      effect: read
      questions:
      - How far along is the current cluster upgrade?
      - What was the final state of the last cluster upgrade if none is running?
      instructions:
      - text: Show me the progress of the ongoing cluster upgrade.
      - text: Report the cluster upgrade status, giving up after {timeout} seconds.
        slots:
          timeout: query.timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/GetClusterConfiguration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get standalone cluster configuration
      effect: read
      questions:
      - What is the configuration of my Service Fabric standalone cluster?
      - Which configuration API version do I need to read a standalone cluster's config?
      instructions:
      - text: Get the standalone cluster configuration for configuration API version {config_api_version}.
        slots:
          config_api_version: query.ConfigurationApiVersion
      - text: Read the node types and security settings of my standalone cluster using config API {config_api_version}.
        slots:
          config_api_version: query.ConfigurationApiVersion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/GetClusterConfigurationUpgradeStatus'].get
  update:
    x-apievangelist-phrasing:
      intent: Get standalone config upgrade status
      effect: read
      questions:
      - Is the configuration upgrade on my standalone cluster finished?
      - What are the details of the standalone cluster configuration upgrade in progress?
      instructions:
      - text: Check the configuration upgrade status of the standalone cluster.
      - text: Get standalone cluster config upgrade details with API version {api_version}.
        slots:
          api_version: query.api-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/GetUpgradeOrchestrationServiceState'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Upgrade Orchestration Service state
      effect: read
      questions:
      - What service state is the Upgrade Orchestration Service holding?
      - Can support read the internal state of the Service Fabric upgrade orchestrator?
      instructions:
      - text: Read the Upgrade Orchestration Service state.
      - text: Fetch the upgrade orchestrator's service state within {timeout} seconds.
        slots:
          timeout: query.timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/SetUpgradeOrchestrationServiceState'].post
  update:
    x-apievangelist-phrasing:
      intent: Update Upgrade Orchestration Service state
      effect: write
      questions:
      - Can I overwrite the Upgrade Orchestration Service state for a support case?
      - Is there a call to set the upgrade orchestrator's service state?
      instructions:
      - text: Set the Upgrade Orchestration Service state to {state}.
        slots:
          state: body.UpgradeOrchestrationServiceState
      - text: Replace the orchestrator service state with {state} as directed by support.
        slots:
          state: body.UpgradeOrchestrationServiceState
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/Provision'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision fabric code or config packages
      effect: write
      questions:
      - How do I provision a new Service Fabric code package before upgrading?
      - Can I validate and provision a cluster manifest file in one step?
      instructions:
      - text: Provision the fabric packages described in {provision}.
        slots:
          provision: body.ProvisionFabricDescription
      - text: Validate and provision the code and config packages from {provision}.
        slots:
          provision: body.ProvisionFabricDescription
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/Unprovision'].post
  update:
    x-apievangelist-phrasing:
      intent: Unprovision fabric code or config packages
      effect: destructive
      questions:
      - Can I unprovision an old fabric code version separately from its config?
      - How do I remove provisioned Service Fabric packages I no longer need?
      instructions:
      - text: Unprovision the fabric packages listed in {unprovision}.
        slots:
          unprovision: body.UnprovisionFabricDescription
      - text: Remove the provisioned code or config version given in {unprovision}.
        slots:
          unprovision: body.UnprovisionFabricDescription
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/RollbackUpgrade'].post
  update:
    x-apievangelist-phrasing:
      intent: Roll back a cluster upgrade
      effect: destructive
      questions:
      - 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?
      instructions:
      - text: Roll back the current cluster upgrade.
      - text: Revert the in-progress cluster code or config upgrade within {timeout} seconds.
        slots:
          timeout: query.timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/MoveToNextUpgradeDomain'].post
  update:
    x-apievangelist-phrasing:
      intent: Move cluster upgrade to next upgrade domain
      effect: write
      questions:
      - How do I move a manual cluster upgrade on to the next upgrade domain?
      - Can I resume an unmonitored cluster upgrade domain by domain?
      instructions:
      - text: Move the cluster upgrade on to upgrade domain {resume}.
        slots:
          resume: body.ResumeClusterUpgradeDescription
      - text: Resume the cluster upgrade with the next-domain description {resume}.
        slots:
          resume: body.ResumeClusterUpgradeDescription
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/Upgrade'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a cluster code or config upgrade
      effect: write
      questions:
      - 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?
      instructions:
      - text: Start the cluster upgrade using the parameters in {upgrade}.
        slots:
          upgrade: body.StartClusterUpgradeDescription
      - text: Kick off a code or config version upgrade of the cluster with {upgrade}.
        slots:
          upgrade: body.StartClusterUpgradeDescription
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/StartClusterConfigurationUpgrade'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a standalone cluster config upgrade
      effect: write
      questions:
      - 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?
      instructions:
      - text: Start upgrading the standalone cluster configuration with {config_upgrade}.
        slots:
          config_upgrade: body.ClusterConfigurationUpgradeDescription
      - text: Apply the new standalone cluster config from {config_upgrade}.
        slots:
          config_upgrade: body.ClusterConfigurationUpgradeDescription
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/UpdateUpgrade'].post
  update:
    x-apievangelist-phrasing:
      intent: Update parameters of a running cluster upgrade
      effect: write
      questions:
      - 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?
      instructions:
      - text: Update the running cluster upgrade with parameters {update}.
        slots:
          update: body.UpdateClusterUpgradeDescription
      - text: Change the in-progress upgrade's policy to {update}.
        slots:
          update: body.UpdateClusterUpgradeDescription
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/GetAadMetadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Azure AD metadata for cluster connections
      effect: read
      questions:
      - 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?
      instructions:
      - text: Get the Azure AD metadata for a secured cluster connection.
      - text: Fetch the cluster's AAD sign-in metadata using API version {api_version}.
        slots:
          api_version: query.api-version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/GetClusterVersion'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current cluster runtime version
      effect: read
      questions:
      - What Service Fabric version is my cluster running?
      - Which version is reported while an upgrade is between the current and target runtime?
      instructions:
      - text: Tell me the current Service Fabric cluster version.
      - text: Get the cluster runtime version with a {timeout} second timeout.
        slots:
          timeout: query.timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/GetLoadInformation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cluster load and capacity metrics
      effect: read
      questions:
      - How loaded is my Service Fabric cluster across its capacity metrics?
      - Which metrics have load or capacity defined in the cluster?
      instructions:
      - text: Show the load information for every metric in the cluster.
      - text: Retrieve cluster load and capacity figures, timing out after {timeout} seconds.
        slots:
          timeout: query.timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/ToggleVerboseServicePlacementHealthReporting'].post
  update:
    x-apievangelist-phrasing:
      intent: Toggle verbose service placement health reports
      effect: write
      questions:
      - Can I get detailed health reports when replicas cannot be placed?
      - How do I turn off verbose placement health reporting?
      instructions:
      - text: Set verbose service placement health reporting to {enabled}.
        slots:
          enabled: query.Enabled
      - text: 'Turn detailed replica placement health reports on or off: {enabled}.'
        slots:
          enabled: query.Enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/$/ValidateUpgrade'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a cluster upgrade without starting it
      effect: read
      questions:
      - Can I check the impact of a cluster upgrade before actually starting it?
      - Will my proposed code or config upgrade pass validation?
      instructions:
      - text: Validate the upgrade parameters {upgrade} and assess their impact without upgrading.
        slots:
          upgrade: body.StartClusterUpgradeDescription
      - text: Dry-run the cluster upgrade described in {upgrade}.
        slots:
          upgrade: body.StartClusterUpgradeDescription
      method: generated
      generated: '2026-09-26'