Share via

Service Fabric cluster listed by resource groups

  • Article

Gets the list of Service Fabric cluster resources created in the specified resource group.

Gets all Service Fabric cluster resources created or in the process of being created in the resource group.

Request

Method Request URI
GET /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters?api-version=2018-02-01

Parameters

Name Type Required Location
resourceGroupName string Yes Path
subscriptionId string Yes Path
api-version string Yes Query

resourceGroupName

Type: string
Required: Yes

The name of the resource group.

subscriptionId

Type: string
Required: Yes

The customer subscription identifier.

api-version

Type: string
Required: Yes
Default: 2018-02-01

The version of the Service Fabric resource provider API. This is a required parameter and it's value must be "2018-02-01" for this specification.

Responses

HTTP Status Code Description Response Schema
200 (OK) The operation completed successfully.
 ClusterListResult
All other status codes The detailed error response.
 ErrorModel

Examples

List cluster by resource group

Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters?api-version=2018-02-01

200 Response

Body
{
  "value": [
    {
      "type": "Microsoft.ServiceFabric/clusters",
      "location": "eastus",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster",
      "name": "myCluster",
      "tags": {},
      "etag": "W/\"636462502169240745\"",
      "properties": {
        "provisioningState": "Succeeded",
        "clusterId": "92584666-9889-4ae8-8d02-91902923d37f",
        "clusterCodeVersion": "6.1.480.9494",
        "clusterState": "WaitingForNodes",
        "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080",
        "clusterEndpoint": "https://eastus.servicefabric.azure.com",
        "certificateCommonNames": {
          "commonNames": [
            {
              "certificateCommonName": "abc.com",
              "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622"
            }
          ],
          "x509StoreName": "My"
        },
        "clientCertificateThumbprints": [
          {
            "isAdmin": false,
            "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A"
          }
        ],
        "clientCertificateCommonNames": [
          {
            "isAdmin": true,
            "certificateCommonName": "abc.com",
            "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A"
          }
        ],
        "fabricSettings": [
          {
            "name": "UpgradeService",
            "parameters": [
              {
                "name": "AppPollIntervalInSeconds",
                "value": "60"
              }
            ]
          }
        ],
        "upgradeDescription": {
          "forceRestart": false,
          "upgradeReplicaSetCheckTimeout": "00:10:00",
          "healthCheckWaitDuration": "00:00:30",
          "healthCheckStableDuration": "00:00:30",
          "healthCheckRetryTimeout": "00:05:00",
          "upgradeTimeout": "01:00:00",
          "upgradeDomainTimeout": "00:15:00",
          "healthPolicy": {
            "maxPercentUnhealthyNodes": "0",
            "maxPercentUnhealthyApplications": "0",
            "applicationHealthPolicies": {
              "fabric:/myApp1": {
                "defaultServiceTypeHealthPolicy": {
                  "maxPercentUnhealthyServices": "0"
                },
                "serviceTypeHealthPolicies": {
                  "myServiceType1": {
                    "maxPercentUnhealthyServices": "100"
                  }
                }
              }
            }
          },
          "deltaHealthPolicy": {
            "maxPercentDeltaUnhealthyNodes": "0",
            "maxPercentUpgradeDomainDeltaUnhealthyNodes": "0",
            "maxPercentDeltaUnhealthyApplications": "0",
            "applicationDeltaHealthPolicies": {
              "fabric:/myApp1": {
                "defaultServiceTypeDeltaHealthPolicy": {
                  "maxPercentDeltaUnhealthyServices": "0"
                },
                "serviceTypeDeltaHealthPolicies": {
                  "myServiceType1": {
                    "maxPercentDeltaUnhealthyServices": "0"
                  }
                }
              }
            }
          }
        },
        "diagnosticsStorageAccountConfig": {
          "storageAccountName": "diag",
          "protectedAccountKeyName": "StorageAccountKey1",
          "blobEndpoint": "https://diag.blob.core.windows.net/",
          "queueEndpoint": "https://diag.queue.core.windows.net/",
          "tableEndpoint": "https://diag.table.core.windows.net/"
        },
        "nodeTypes": [
          {
            "name": "nt1vm",
            "clientConnectionEndpointPort": "19000",
            "httpGatewayEndpointPort": "19007",
            "applicationPorts": {
              "startPort": "20000",
              "endPort": "30000"
            },
            "ephemeralPorts": {
              "startPort": "49000",
              "endPort": "64000"
            },
            "isPrimary": true,
            "vmInstanceCount": "5",
            "durabilityLevel": "Bronze"
          }
        ],
        "vmImage": "Windows",
        "azureActiveDirectory": {
          "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c",
          "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae",
          "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75"
        },
        "reliabilityLevel": "Silver",
        "reverseProxyCertificateCommonNames": {
          "commonNames": [
            {
              "certificateCommonName": "abc.com",
              "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622"
            }
          ],
          "x509StoreName": "My"
        },
        "upgradeMode": "Manual",
        "availableClusterVersions": [
          {
            "codeVersion": "6.1.480.9494",
            "supportExpiryUtc": "2018-06-15T23:59:59.9999999",
            "environment": "Windows"
          }
        ],
        "addOnFeatures": [
          "RepairManager",
          "DnsService",
          "BackupRestoreService",
          "ResourceMonitorService"
        ]
      }
    },
    {
      "type": "Microsoft.ServiceFabric/clusters",
      "location": "eastus",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster2",
      "name": "myCluster2",
      "tags": {},
      "etag": "W/\"636462502164040075\"",
      "properties": {
        "provisioningState": "Succeeded",
        "clusterId": "2747e469-b24e-4039-8a0a-46151419523f",
        "clusterCodeVersion": "6.1.187.1",
        "clusterState": "WaitingForNodes",
        "managementEndpoint": "http://myCluster2.eastus.cloudapp.azure.com:19080",
        "clusterEndpoint": "https://eastus.servicefabric.azure.com",
        "clientCertificateThumbprints": [],
        "clientCertificateCommonNames": [],
        "fabricSettings": [
          {
            "name": "UpgradeService",
            "parameters": [
              {
                "name": "AppPollIntervalInSeconds",
                "value": "60"
              }
            ]
          }
        ],
        "upgradeDescription": {
          "forceRestart": false,
          "upgradeReplicaSetCheckTimeout": "00:10:00",
          "healthCheckWaitDuration": "00:00:30",
          "healthCheckStableDuration": "00:00:30",
          "healthCheckRetryTimeout": "00:05:00",
          "upgradeTimeout": "01:00:00",
          "upgradeDomainTimeout": "00:15:00",
          "healthPolicy": {
            "maxPercentUnhealthyNodes": "0",
            "maxPercentUnhealthyApplications": "0"
          },
          "deltaHealthPolicy": {
            "maxPercentDeltaUnhealthyNodes": "0",
            "maxPercentUpgradeDomainDeltaUnhealthyNodes": "0",
            "maxPercentDeltaUnhealthyApplications": "0"
          }
        },
        "diagnosticsStorageAccountConfig": {
          "storageAccountName": "diag",
          "protectedAccountKeyName": "StorageAccountKey1",
          "blobEndpoint": "https://diag.blob.core.windows.net/",
          "queueEndpoint": "https://diag.queue.core.windows.net/",
          "tableEndpoint": "https://diag.table.core.windows.net/"
        },
        "nodeTypes": [
          {
            "name": "nt1vm",
            "clientConnectionEndpointPort": "19000",
            "httpGatewayEndpointPort": "19007",
            "applicationPorts": {
              "startPort": "20000",
              "endPort": "30000"
            },
            "ephemeralPorts": {
              "startPort": "49000",
              "endPort": "64000"
            },
            "isPrimary": true,
            "vmInstanceCount": "5",
            "durabilityLevel": "Bronze"
          }
        ],
        "vmImage": "Ubuntu",
        "reliabilityLevel": "Silver",
        "upgradeMode": "Manual",
        "availableClusterVersions": [
          {
            "codeVersion": "6.1.187.1",
            "supportExpiryUtc": "2018-06-15T23:59:59.9999999",
            "environment": "Linux"
          }
        ],
        "addonFeatures": [
          "RepairManager"
        ]
      }
    }
  ],
  "nextLink": ""
}