Service Fabric Resource Manager REST API Reference
Service Fabric is a distributed systems platform that makes it easy to package, deploy, and manage scalable and reliable microservices.
A Service Fabric cluster is a network-connected set of virtual or physical machines into which your microservices are deployed and managed. Service Fabric Resource Manager APIs allow you to create and manage Service Fabric clusters in Azure.
Following is a list of Service Fabric Resource Manager REST APIs.
Cluster APIs
| Name | Description |
|---|---|
| Get | Gets a Service Fabric cluster resource. |
| Create | Creates or updates a Service Fabric cluster resource. |
| Update | Updates the configuration of a Service Fabric cluster resource. |
| Delete | Deletes a Service Fabric cluster resource. |
| List By Resource Group | Gets the list of Service Fabric cluster resources created in the specified resource group. |
| List | Gets the list of Service Fabric cluster resources created in the specified subscription. |
ClusterVersion APIs
| Name | Description |
|---|---|
| Get | Gets information about a Service Fabric cluster code version available in the specified location. |
| Get By Environment | Gets information about a Service Fabric cluster code version available for the specified environment. |
| List | Gets the list of Service Fabric cluster code versions available for the specified location. |
| List By Environment | Gets the list of Service Fabric cluster code versions available for the specified environment. |
Operations APIs
| Name | Description |
|---|---|
| List | Lists all of the available Service Fabric resource provider API operations. |
Models
| Name | Description |
|---|---|
| AddOnFeatures enum | The available cluster add-on features. - RepairManager - The Service Fabric Repair Manager service. - DnsService - The Service Fabric DNS service. - BackupRestoreService - The Service Fabric Backup and Restore service. - ResourceMonitorService - The Service Fabric Resource Monitor service. |
| ApplicationDeltaHealthPolicy | Defines a delta health policy used to evaluate the health of an application or one of its child entities when upgrading the cluster. |
| ApplicationHealthPolicy | Defines a health policy used to evaluate the health of an application or one of its children entities. |
| AvailableOperationDisplay | Operation supported by the Service Fabric resource provider |
| AzureActiveDirectory | The settings to enable AAD authentication on the cluster. |
| CertificateDescription | Describes the certificate details. |
| ClientCertificateCommonName | Describes the client certificate details using common name. |
| ClientCertificateThumbprint | Describes the client certificate details using thumbprint. |
| Cluster | The cluster resource |
| ClusterCodeVersionsListResult | The list results of the Service Fabric runtime versions. |
| ClusterCodeVersionsResult | The result of the Service Fabric runtime versions |
| ClusterHealthPolicy | Defines a health policy used to evaluate the health of the cluster or of a cluster node. |
| ClusterListResult | Cluster list results |
| ClusterProperties | Describes the cluster resource properties. |
| ClusterPropertiesUpdateParameters | Describes the cluster resource properties that can be updated during PATCH operation. |
| ClusterUpdateParameters | Cluster update request |
| ClusterUpgradeDeltaHealthPolicy | Describes the delta health policies for the cluster upgrade. |
| ClusterUpgradePolicy | Describes the policy used when upgrading the cluster. |
| ClusterVersionDetails | The detail of the Service Fabric runtime version result |
| DiagnosticsStorageAccountConfig | The storage account information for storing Service Fabric diagnostic logs. |
| EndpointRangeDescription | Port range details |
| ErrorModel | The structure of the error. |
| ErrorModelError | The error details. |
| NodeTypeDescription | Describes a node type in the cluster, each node type represents sub set of nodes in the cluster. |
| OperationListResult | Describes the result of the request to list Service Fabric resource provider operations. |
| OperationResult | Available operation list result |
| ProvisioningState enum | Possible values include: 'Updating', 'Succeeded', 'Failed', 'Canceled' |
| Resource | The resource model definition. |
| ServerCertificateCommonName | Describes the server certificate details using common name. |
| ServerCertificateCommonNames | Describes a list of server certificates referenced by common name that are used to secure the cluster. |
| ServiceTypeDeltaHealthPolicy | Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster. |
| ServiceTypeHealthPolicy | Represents the health policy used to evaluate the health of services belonging to a service type. |
| SettingsParameterDescription | Describes a parameter in fabric settings of the cluster. |
| SettingsSectionDescription | Describes a section in the fabric settings of the cluster. |