npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@datafire/azure_servicefabric

v5.0.0

Published

DataFire integration for Service Fabric Client APIs

Downloads

5

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

datafiredatafire

Keywords

Readme

@datafire/azure_servicefabric

Client library for Service Fabric Client APIs

Installation and Usage

npm install --save @datafire/azure_servicefabric
let azure_servicefabric = require('@datafire/azure_servicefabric').create();

.then(data => {
  console.log(data);
});

Description

Service Fabric REST Client APIs allows management of Service Fabric clusters, applications and services.

Actions

CancelRepairTask

This API supports the Service Fabric platform; it is not meant to be used directly from your code.

azure_servicefabric.CancelRepairTask({
  "api-version": "",
  "RepairTaskCancelDescription": null
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • RepairTaskCancelDescription required RepairTaskCancelDescription

Output

CreateRepairTask

For clusters that have the Repair Manager Service configured, this API provides a way to create repair tasks that run automatically or manually. For repair tasks that run automatically, an appropriate repair executor must be running for each repair action to run automatically. These are currently only available in specially-configured Azure Cloud Services.

To create a manual repair task, provide the set of impacted node names and the expected impact. When the state of the created repair task changes to approved, you can safely perform repair actions on those nodes.

This API supports the Service Fabric platform; it is not meant to be used directly from your code.

azure_servicefabric.CreateRepairTask({
  "api-version": "",
  "RepairTask": null
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • RepairTask required RepairTask

Output

DeleteRepairTask

This API supports the Service Fabric platform; it is not meant to be used directly from your code.

azure_servicefabric.DeleteRepairTask({
  "api-version": "",
  "RepairTaskDeleteDescription": null
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • RepairTaskDeleteDescription required RepairTaskDeleteDescription

Output

Output schema unknown

ForceApproveRepairTask

This API supports the Service Fabric platform; it is not meant to be used directly from your code.

azure_servicefabric.ForceApproveRepairTask({
  "api-version": "",
  "RepairTaskApproveDescription": null
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • RepairTaskApproveDescription required RepairTaskApproveDescription

Output

GetAadMetadata

Gets the Azure Active Directory metadata used for secured connection to cluster. This API is not supposed to be called separately. It provides information needed to set up an Azure Active Directory secured connection with a Service Fabric cluster.

azure_servicefabric.GetAadMetadata({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • timeout integer: 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.

Output

GetClusterConfiguration

The cluster configuration contains properties of the cluster that include different node types on the cluster, security configurations, fault, and upgrade domain topologies, etc.

azure_servicefabric.GetClusterConfiguration({
  "api-version": "",
  "ConfigurationApiVersion": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • ConfigurationApiVersion required string: The API version of the Standalone cluster json configuration.
    • timeout integer: 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.

Output

GetClusterConfigurationUpgradeStatus

Get the cluster configuration upgrade status details of a Service Fabric standalone cluster.

azure_servicefabric.GetClusterConfigurationUpgradeStatus({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • timeout integer: 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.

Output

GetClusterHealth

Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state. Similarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.

azure_servicefabric.GetClusterHealth({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • NodesHealthStateFilter integer: Allows filtering of the node health state objects returned in the result of cluster health query
    • ApplicationsHealthStateFilter integer: Allows filtering of the application health state objects returned in the result of cluster health
    • EventsHealthStateFilter integer: Allows filtering the collection of HealthEvent objects returned based on health state.
    • ExcludeHealthStatistics boolean: Indicates whether the health statistics should be returned as part of the query result. False by default.
    • IncludeSystemApplicationHealthStatistics boolean: Indicates whether the health statistics should include the fabric:/System application health statistics. False by default.
    • timeout integer: 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.

Output

GetClusterHealthUsingPolicy

Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state. Similarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state. Use ClusterHealthPolicies to override the health policies used to evaluate the health.

azure_servicefabric.GetClusterHealthUsingPolicy({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • NodesHealthStateFilter integer: Allows filtering of the node health state objects returned in the result of cluster health query
    • ApplicationsHealthStateFilter integer: Allows filtering of the application health state objects returned in the result of cluster health
    • EventsHealthStateFilter integer: Allows filtering the collection of HealthEvent objects returned based on health state.
    • ExcludeHealthStatistics boolean: Indicates whether the health statistics should be returned as part of the query result. False by default.
    • IncludeSystemApplicationHealthStatistics boolean: Indicates whether the health statistics should include the fabric:/System application health statistics. False by default.
    • ClusterHealthPolicies ClusterHealthPolicies
    • timeout integer: 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.

Output

GetClusterHealthChunk

Gets the health of a Service Fabric cluster using health chunks. Includes the aggregated health state of the cluster, but none of the cluster entities. To expand the cluster health and get the health state of all or some of the entities, use the POST URI and specify the cluster health chunk query description.

azure_servicefabric.GetClusterHealthChunk({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • timeout integer: 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.

Output

GetClusterHealthChunkUsingPolicyAndAdvancedFilters

Gets the health of a Service Fabric cluster using health chunks. The health evaluation is done based on the input cluster health chunk query description. The query description allows users to specify health policies for evaluating the cluster and its children. Users can specify very flexible filters to select which cluster entities to return. The selection can be done based on the entities health state and based on the hierarchy. The query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return only services that are in Error or Warning, and all partitions and replicas for one of these services.

azure_servicefabric.GetClusterHealthChunkUsingPolicyAndAdvancedFilters({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • ClusterHealthChunkQueryDescription ClusterHealthChunkQueryDescription
    • timeout integer: 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.

Output

GetClusterManifest

Get the Service Fabric cluster manifest. The cluster manifest contains properties of the cluster that include different node types on the cluster, security configurations, fault, and upgrade domain topologies, etc.

These properties are specified as part of the ClusterConfig.JSON file while deploying a stand-alone cluster. However, most of the information in the cluster manifest is generated internally by service fabric during cluster deployment in other deployment scenarios (e.g. when using Azure portal).

The contents of the cluster manifest are for informational purposes only and users are not expected to take a dependency on the format of the file contents or its interpretation.

azure_servicefabric.GetClusterManifest({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • timeout integer: 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.

Output

GetClusterVersion

If a cluster upgrade is happening, then this API will return the lowest (older) version of the current and target cluster runtime versions.

azure_servicefabric.GetClusterVersion({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.4): The version of the API. This parameter is required and its value must be '6.4'.
    • timeout integer: 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.

Output

GetClusterLoad

Retrieves the load information of a Service Fabric cluster for all the metrics that have load or capacity defined.

azure_servicefabric.GetClusterLoad({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • timeout integer: 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.

Output

GetProvisionedFabricCodeVersionInfoList

Gets a list of information about fabric code versions that are provisioned in the cluster. The parameter CodeVersion can be used to optionally filter the output to only that particular version.

azure_servicefabric.GetProvisionedFabricCodeVersionInfoList({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • CodeVersion string: The product version of Service Fabric.
    • timeout integer: 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.

Output

GetProvisionedFabricConfigVersionInfoList

Gets a list of information about fabric config versions that are provisioned in the cluster. The parameter ConfigVersion can be used to optionally filter the output to only that particular version.

azure_servicefabric.GetProvisionedFabricConfigVersionInfoList({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • ConfigVersion string: The config version of Service Fabric.
    • timeout integer: 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.

Output

GetRepairTaskList

This API supports the Service Fabric platform; it is not meant to be used directly from your code.

azure_servicefabric.GetRepairTaskList({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • TaskIdFilter string: The repair task ID prefix to be matched.
    • StateFilter integer: A bitwise-OR of the following values, specifying which task states should be included in the result list.
    • ExecutorFilter string: The name of the repair executor whose claimed tasks should be included in the list.

Output

GetUpgradeOrchestrationServiceState

Get the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.

azure_servicefabric.GetUpgradeOrchestrationServiceState({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • timeout integer: 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.

Output

GetClusterUpgradeProgress

Gets the current progress of the ongoing cluster upgrade. If no upgrade is currently in progress, get the last state of the previous cluster upgrade.

azure_servicefabric.GetClusterUpgradeProgress({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • timeout integer: 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.

Output

InvokeInfrastructureCommand

For clusters that have one or more instances of the Infrastructure Service configured, this API provides a way to send infrastructure-specific commands to a particular instance of the Infrastructure Service.

Available commands and their corresponding response formats vary depending upon the infrastructure on which the cluster is running.

This API supports the Service Fabric platform; it is not meant to be used directly from your code.

azure_servicefabric.InvokeInfrastructureCommand({
  "api-version": "",
  "Command": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • Command required string: The text of the command to be invoked. The content of the command is infrastructure-specific.
    • ServiceId string: The identity of the infrastructure service. This is the full name of the infrastructure service without the 'fabric:' URI scheme. This parameter required only for the cluster that has more than one instance of infrastructure service running.
    • timeout integer: 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.

Output

InvokeInfrastructureQuery

For clusters that have one or more instances of the Infrastructure Service configured, this API provides a way to send infrastructure-specific queries to a particular instance of the Infrastructure Service.

Available commands and their corresponding response formats vary depending upon the infrastructure on which the cluster is running.

This API supports the Service Fabric platform; it is not meant to be used directly from your code.

azure_servicefabric.InvokeInfrastructureQuery({
  "api-version": "",
  "Command": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • Command required string: The text of the command to be invoked. The content of the command is infrastructure-specific.
    • ServiceId string: The identity of the infrastructure service. This is the full name of the infrastructure service without the 'fabric:' URI scheme. This parameter required only for the cluster that has more than one instance of infrastructure service running.
    • timeout integer: 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.

Output

ResumeClusterUpgrade

Make the cluster code or configuration upgrade move on to the next upgrade domain if appropriate.

azure_servicefabric.ResumeClusterUpgrade({
  "api-version": "",
  "ResumeClusterUpgradeDescription": null
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • ResumeClusterUpgradeDescription required ResumeClusterUpgradeDescription
    • timeout integer: 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.

Output

Output schema unknown

ProvisionCluster

Validate and provision the code or configuration packages of a Service Fabric cluster.

azure_servicefabric.ProvisionCluster({
  "api-version": "",
  "ProvisionFabricDescription": null
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • ProvisionFabricDescription required ProvisionFabricDescription
    • timeout integer: 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.

Output

Output schema unknown

RecoverAllPartitions

This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.

azure_servicefabric.RecoverAllPartitions({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • timeout integer: 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.

Output

Output schema unknown

RecoverSystemPartitions

Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.

azure_servicefabric.RecoverSystemPartitions({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • timeout integer: 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.

Output

Output schema unknown

ReportClusterHealth

Sends a health report on a Service Fabric cluster. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway node, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, run GetClusterHealth and check that the report appears in the HealthEvents section.

azure_servicefabric.ReportClusterHealth({
  "api-version": "",
  "HealthInformation": null
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • HealthInformation required HealthInformation
    • Immediate boolean: A flag that indicates whether the report should be sent immediately.
    • timeout integer: 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.

Output

Output schema unknown

RollbackClusterUpgrade

Roll back the code or configuration upgrade of a Service Fabric cluster.

azure_servicefabric.RollbackClusterUpgrade({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • timeout integer: 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.

Output

Output schema unknown

SetUpgradeOrchestrationServiceState

Update the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.

azure_servicefabric.SetUpgradeOrchestrationServiceState({
  "api-version": "",
  "UpgradeOrchestrationServiceState": null
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • UpgradeOrchestrationServiceState required UpgradeOrchestrationServiceState
    • timeout integer: 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.

Output

StartClusterConfigurationUpgrade

Validate the supplied configuration upgrade parameters and start upgrading the cluster configuration if the parameters are valid.

azure_servicefabric.StartClusterConfigurationUpgrade({
  "api-version": "",
  "ClusterConfigurationUpgradeDescription": null
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • ClusterConfigurationUpgradeDescription required ClusterConfigurationUpgradeDescription
    • timeout integer: 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.

Output

Output schema unknown

ToggleVerboseServicePlacementHealthReporting

If verbosity is set to true, then detailed health reports will be generated when replicas cannot be placed or dropped. If verbosity is set to false, then no health reports will be generated when replicas cannot be placed or dropped.

azure_servicefabric.ToggleVerboseServicePlacementHealthReporting({
  "api-version": "",
  "Enabled": true
}, context)

Input

  • input object
    • api-version required string (values: 6.4): The version of the API. This parameter is required and its value must be '6.4'.
    • Enabled required boolean: The verbosity of service placement health reporting.
    • timeout integer: 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.

Output

Output schema unknown

UnprovisionCluster

It is supported to unprovision code and configuration separately.

azure_servicefabric.UnprovisionCluster({
  "api-version": "",
  "UnprovisionFabricDescription": null
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • UnprovisionFabricDescription required UnprovisionFabricDescription
    • timeout integer: 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.

Output

Output schema unknown

UpdateRepairExecutionState

This API supports the Service Fabric platform; it is not meant to be used directly from your code.

azure_servicefabric.UpdateRepairExecutionState({
  "api-version": "",
  "RepairTask": null
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • RepairTask required RepairTask

Output

UpdateRepairTaskHealthPolicy

This API supports the Service Fabric platform; it is not meant to be used directly from your code.

azure_servicefabric.UpdateRepairTaskHealthPolicy({
  "api-version": "",
  "RepairTaskUpdateHealthPolicyDescription": null
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • RepairTaskUpdateHealthPolicyDescription required RepairTaskUpdateHealthPolicyDescription

Output

UpdateClusterUpgrade

Update the upgrade parameters used during a Service Fabric cluster upgrade.

azure_servicefabric.UpdateClusterUpgrade({
  "api-version": "",
  "UpdateClusterUpgradeDescription": null
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • UpdateClusterUpgradeDescription required UpdateClusterUpgradeDescription
    • timeout integer: 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.

Output

Output schema unknown

StartClusterUpgrade

Validate the supplied upgrade parameters and start upgrading the code or configuration version of a Service Fabric cluster if the parameters are valid.

azure_servicefabric.StartClusterUpgrade({
  "api-version": "",
  "StartClusterUpgradeDescription": null
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • StartClusterUpgradeDescription required StartClusterUpgradeDescription
    • timeout integer: 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.

Output

Output schema unknown

GetApplicationTypeInfoList

Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. Each version of an application type is returned as one application type. The response includes the name, version, status, and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. For example, if there are 10 application types but a page only fits the first three application types, or if max results is set to 3, then three is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.

azure_servicefabric.GetApplicationTypeInfoList({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • ApplicationTypeDefinitionKindFilter integer: Used to filter on ApplicationTypeDefinitionKind which is the mechanism used to define a Service Fabric application type.
    • ExcludeApplicationParameters boolean: The flag that specifies whether application parameters will be excluded from the result.
    • ContinuationToken string: 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.
    • MaxResults integer: The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
    • timeout integer: 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.

Output

ProvisionApplicationType

Provisions a Service Fabric application type with the cluster. The provision is required before any new applications can be instantiated. The provision operation can be performed either on the application package specified by the relativePathInImageStore, or by using the URI of the external '.sfpkg'.

azure_servicefabric.ProvisionApplicationType({
  "api-version": "",
  "ProvisionApplicationTypeDescriptionBaseRequiredBodyParam": null
}, context)

Input

  • input object
    • api-version required string (values: 6.2): The version of the API. This parameter is required and its value must be '6.2'.
    • ProvisionApplicationTypeDescriptionBaseRequiredBodyParam required ProvisionApplicationTypeDescriptionBase
    • timeout integer: 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.

Output

Output schema unknown

GetApplicationTypeInfoListByName

Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. These results are of application types whose name match exactly the one specified as the parameter, and which comply with the given query parameters. All versions of the application type matching the application type name are returned, with each version returned as one application type. The response includes the name, version, status, and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. For example, if there are 10 application types but a page only fits the first three application types, or if max results is set to 3, then three is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.

azure_servicefabric.GetApplicationTypeInfoListByName({
  "api-version": "",
  "applicationTypeName": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • applicationTypeName required string: The name of the application type.
    • ApplicationTypeVersion string: The version of the application type.
    • ExcludeApplicationParameters boolean: The flag that specifies whether application parameters will be excluded from the result.
    • ContinuationToken string: 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.
    • MaxResults integer: The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
    • timeout integer: 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.

Output

GetApplicationManifest

The response contains the application manifest XML as a string.

azure_servicefabric.GetApplicationManifest({
  "api-version": "",
  "applicationTypeName": "",
  "ApplicationTypeVersion": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • applicationTypeName required string: The name of the application type.
    • ApplicationTypeVersion required string: The version of the application type.
    • timeout integer: 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.

Output

GetServiceManifest

Gets the manifest describing a service type. The response contains the service manifest XML as a string.

azure_servicefabric.GetServiceManifest({
  "api-version": "",
  "applicationTypeName": "",
  "ApplicationTypeVersion": "",
  "ServiceManifestName": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • applicationTypeName required string: The name of the application type.
    • ApplicationTypeVersion required string: The version of the application type.
    • ServiceManifestName required string: The name of a service manifest registered as part of an application type in a Service Fabric cluster.
    • timeout integer: 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.

Output

GetServiceTypeInfoList

Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned.

azure_servicefabric.GetServiceTypeInfoList({
  "api-version": "",
  "applicationTypeName": "",
  "ApplicationTypeVersion": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • applicationTypeName required string: The name of the application type.
    • ApplicationTypeVersion required string: The version of the application type.
    • timeout integer: 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.

Output

GetServiceTypeInfoByName

Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned. A 204 response is returned if the specified service type is not found in the cluster.

azure_servicefabric.GetServiceTypeInfoByName({
  "api-version": "",
  "applicationTypeName": "",
  "ApplicationTypeVersion": "",
  "serviceTypeName": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • applicationTypeName required string: The name of the application type.
    • ApplicationTypeVersion required string: The version of the application type.
    • serviceTypeName required string: Specifies the name of a Service Fabric service type.
    • timeout integer: 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.

Output

UnprovisionApplicationType

This operation can only be performed if all application instances of the application type have been deleted. Once the application type is unregistered, no new application instances can be created for this particular application type.

azure_servicefabric.UnprovisionApplicationType({
  "api-version": "",
  "applicationTypeName": "",
  "UnprovisionApplicationTypeDescriptionInfo": null
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • applicationTypeName required string: The name of the application type.
    • UnprovisionApplicationTypeDescriptionInfo required UnprovisionApplicationTypeDescriptionInfo
    • timeout integer: 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.

Output

Output schema unknown

GetApplicationInfoList

Gets the information about the applications that were created or in the process of being created in the Service Fabric cluster and match the specified filters. The response includes the name, type, status, parameters, and other details about the application. If the applications do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. Filters ApplicationTypeName and ApplicationDefinitionKindFilter cannot be specified at the same time.

azure_servicefabric.GetApplicationInfoList({
  "api-version": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.1): The version of the API. This parameter is required and its value must be '6.1'.
    • ApplicationDefinitionKindFilter integer: Used to filter on ApplicationDefinitionKind, which is the mechanism used to define a Service Fabric application.
    • ApplicationTypeName string: The application type name used to filter the applications to query for. This value should not contain the application type version.
    • ExcludeApplicationParameters boolean: The flag that specifies whether application parameters will be excluded from the result.
    • ContinuationToken string: 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.
    • MaxResults integer: The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
    • timeout integer: 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.

Output

CreateApplication

Creates a Service Fabric application using the specified description.

azure_servicefabric.CreateApplication({
  "api-version": "",
  "ApplicationDescription": null
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • ApplicationDescription required ApplicationDescription
    • timeout integer: 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.

Output

Output schema unknown

GetApplicationInfo

Returns the information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, type, status, parameters, and other details about the application.

azure_servicefabric.GetApplicationInfo({
  "api-version": "",
  "applicationId": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • applicationId required string: The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.
    • ExcludeApplicationParameters boolean: The flag that specifies whether application parameters will be excluded from the result.
    • timeout integer: 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.

Output

DeleteApplication

An application must be created before it can be deleted. Deleting an application will delete all services that are part of that application. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if a service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the application and all of its services.

azure_servicefabric.DeleteApplication({
  "api-version": "",
  "applicationId": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • applicationId required string: The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.
    • ForceRemove boolean: Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas.
    • timeout integer: 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.

Output

Output schema unknown

DisableApplicationBackup

Disables periodic backup of Service Fabric application which was previously enabled.

azure_servicefabric.DisableApplicationBackup({
  "applicationId": "",
  "api-version": ""
}, context)

Input

  • input object
    • applicationId required string: The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.
    • api-version required string (values: 6.4): The version of the API. This parameter is required and its value must be '6.4'.
    • timeout integer: 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.
    • DisableBackupDescription DisableBackupDescription

Output

Output schema unknown

EnableApplicationBackup

Enables periodic backup of stateful partitions which are part of this Service Fabric application. Each partition is backed up individually as per the specified backup policy description. Note only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.

azure_servicefabric.EnableApplicationBackup({
  "applicationId": "",
  "EnableBackupDescription": null,
  "api-version": ""
}, context)

Input

  • input object
    • applicationId required string: The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.
    • EnableBackupDescription required EnableBackupDescription
    • api-version required string (values: 6.4): The version of the API. This parameter is required and its value must be '6.4'.
    • timeout integer: 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.

Output

Output schema unknown

GetApplicationBackupConfigurationInfo

Gets the Service Fabric backup configuration information for the application and the services and partitions under this application.

azure_servicefabric.GetApplicationBackupConfigurationInfo({
  "applicationId": "",
  "api-version": ""
}, context)

Input

  • input object
    • applicationId required string: The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.
    • api-version required string (values: 6.4): The version of the API. This parameter is required and its value must be '6.4'.
    • ContinuationToken string: 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.
    • MaxResults integer: The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
    • timeout integer: 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.

Output

GetApplicationBackupList

Returns a list of backups available for every partition in this Service Fabric application. The server enumerates all the backups available at the backup location configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition.

azure_servicefabric.GetApplicationBackupList({
  "applicationId": "",
  "api-version": ""
}, context)

Input

  • input object
    • applicationId required string: The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.
    • api-version required string (values: 6.4): The version of the API. This parameter is required and its value must be '6.4'.
    • timeout integer: 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.
    • Latest boolean: Specifies whether to get only the most recent backup available for a partition for the specified time range.
    • StartDateTimeFilter string: Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated.
    • EndDateTimeFilter string: Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup.
    • ContinuationToken string: 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.
    • MaxResults integer: The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.

Output

GetApplicationHealth

Returns the heath state of the service fabric application. The response reports either Ok, Error or Warning health state. If the entity is not found in the health store, it will return Error.

azure_servicefabric.GetApplicationHealth({
  "applicationId": "",
  "api-version": ""
}, context)

Input

  • input object
    • applicationId required string: The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • EventsHealthStateFilter integer: Allows filtering the collection of HealthEvent objects returned based on health state.
    • DeployedApplicationsHealthStateFilter integer: Allows filtering of the deployed applications health state objects returned in the result of application health query based on their health state.
    • ServicesHealthStateFilter integer: Allows filtering of the services health state objects returned in the result of services health query based on their health state.
    • ExcludeHealthStatistics boolean: Indicates whether the health statistics should be returned as part of the query result. False by default.
    • timeout integer: 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.

Output

GetApplicationHealthUsingPolicy

Gets the health of a Service Fabric application. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicies to override the health policies used to evaluate the health.

azure_servicefabric.GetApplicationHealthUsingPolicy({
  "applicationId": "",
  "api-version": ""
}, context)

Input

  • input object
    • applicationId required string: The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • EventsHealthStateFilter integer: Allows filtering the collection of HealthEvent objects returned based on health state.
    • DeployedApplicationsHealthStateFilter integer: Allows filtering of the deployed applications health state objects returned in the result of application health query based on their health state.
    • ServicesHealthStateFilter integer: Allows filtering of the services health state objects returned in the result of services health query based on their health state.
    • ExcludeHealthStatistics boolean: Indicates whether the health statistics should be returned as part of the query result. False by default.
    • ApplicationHealthPolicy ApplicationHealthPolicy
    • timeout integer: 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.

Output

GetApplicationLoadInfo

Returns the load information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, minimum nodes, maximum nodes, the number of nodes the application is occupying currently, and application load metric information about the application.

azure_servicefabric.GetApplicationLoadInfo({
  "api-version": "",
  "applicationId": ""
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • applicationId required string: The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.
    • timeout integer: 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.

Output

GetServiceInfoList

Returns the information about all services belonging to the application specified by the application ID.

azure_servicefabric.GetServiceInfoList({
  "applicationId": "",
  "api-version": ""
}, context)

Input

  • input object
    • applicationId required string: The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.
    • ServiceTypeName string: The service type name used to filter the services to query for.
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • ContinuationToken string: 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.
    • timeout integer: 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.

Output

CreateService

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.

azure_servicefabric.CreateService({
  "api-version": "",
  "applicationId": "",
  "ServiceDescription": null
}, context)

Input

  • input object
    • api-version required string (values: 6.0): The version of the API. This parameter is required and its value must be '6.0'.
    • applicationId required string: The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.
    • ServiceDescription required ServiceDescription
    • timeout integer: 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.

Output

Output schema unknown

CreateServiceFromTemplate

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.

azure_servicefabric.CreateServiceFromTemplate({
  "api-version": "",
  "applicationId": "",
  "ServiceFromTemplateDescription":