Share via

Update Service Fabric cluster resource

  • Article

Updates the configuration of a Service Fabric cluster resource.

Update the configuration of a Service Fabric cluster resource with the specified name.

Request

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

Parameters

Name Type Required Location
resourceGroupName string Yes Path
clusterName string Yes Path
subscriptionId string Yes Path
api-version string Yes Query
parameters ClusterUpdateParameters Yes Body

resourceGroupName

Type: string
Required: Yes

The name of the resource group.

clusterName

Type: string
Required: Yes

The name of the cluster resource.

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.

parameters

Type: ClusterUpdateParameters
Required: Yes

The parameters which contains the property value and property name which used to update the cluster configuration.

Responses

HTTP Status Code Description Response Schema
200 (OK) The operation completed successfully.
 Cluster
202 (Accepted) The request was accepted and the operation will complete asynchronously.
 Cluster
All other status codes The detailed error response.
 ErrorModel

Examples

Patch a cluster

Request

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster?api-version=2018-02-01
Body
{
  "type": "Microsoft.ServiceFabric/clusters",
  "location": "eastus",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster",
  "name": "myCluster",
  "tags": {
    "a": "b"
  },
  "properties": {
    "nodeTypes": [
      {
        "name": "nt1vm",
        "clientConnectionEndpointPort": "19000",
        "httpGatewayEndpointPort": "19007",
        "applicationPorts": {
          "startPort": "20000",
          "endPort": "30000"
        },
        "ephemeralPorts": {
          "startPort": "49000",
          "endPort": "64000"
        },
        "isPrimary": true,
        "vmInstanceCount": "5",
        "durabilityLevel": "Bronze"
      },
      {
        "name": "testnt1",
        "clientConnectionEndpointPort": "0",
        "httpGatewayEndpointPort": "0",
        "applicationPorts": {
          "startPort": "1000",
          "endPort": "2000"
        },
        "ephemeralPorts": {
          "startPort": "3000",
          "endPort": "4000"
        },
        "isPrimary": false,
        "vmInstanceCount": "3",
        "durabilityLevel": "Bronze"
      }
    ],
    "reliabilityLevel": "Bronze",
    "upgradeMode": "Default"
  }
}

202 Response

Headers
Retry-After: 10
Location: http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2018-02-01
Body
{
  "type": "Microsoft.ServiceFabric/clusters",
  "location": "eastus",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster",
  "name": "myCluster",
  "tags": {
    "a": "b"
  },
  "etag": "W/\"636462502169240744\"",
  "properties": {
    "provisioningState": "Succeeded",
    "clusterId": "92584666-9889-4ae8-8d02-91902923d37f",
    "clusterCodeVersion": "6.1.480.9494",
    "clusterState": "WaitingForNodes",
    "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080",
    "clusterEndpoint": "https://eastus.servicefabric.azure.com",
    "certificateCommonNames": {
      "commonNames": [
        {
          "certificateCommonName": "abc.com",
          "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622"
        }
      ],
      "x509StoreName": "My"
    },
    "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"
      },
      {
        "name": "testnt1",
        "clientConnectionEndpointPort": "0",
        "httpGatewayEndpointPort": "0",
        "applicationPorts": {
          "startPort": "1000",
          "endPort": "2000"
        },
        "ephemeralPorts": {
          "startPort": "3000",
          "endPort": "4000"
        },
        "isPrimary": false,
        "vmInstanceCount": "3",
        "durabilityLevel": "Bronze"
      }
    ],
    "reliabilityLevel": "Bronze",
    "upgradeMode": "Automatic",
    "availableClusterVersions": [
      {
        "codeVersion": "6.1.480.9494",
        "supportExpiryUtc": "2018-06-15T23:59:59.9999999",
        "environment": "Windows"
      }
    ]
  }
}