Microsoft.ServiceFabric (preview:2025-03-01)

2025/11/10 • 3 updated methods

ManagedClusters_Update (updated)
Description :  Update the tags of of a Service Fabric managed cluster resource with the specified name.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagedClusters_Update",
  "$responses": {
    "@added_90dfec953f7f44f4a24285616b9d6eba": {
      "#status": "202",
      "$headers": [
        {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        },
        {
          "#name": "location",
          "Description": "The Location header contains the URL where the status of the long running operation can be checked.",
          "Type": "string"
        }
      ],
      "$schema": {
        "Description": "The managed cluster resource",
        "Type": "object",
        "$properties": [
          {
            "#name": "properties",
            "Description": "The managed cluster resource properties",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "dnsName",
                "Description": "The cluster dns name.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "fqdn",
                "Description": "The fully qualified domain name associated with the public load balancer of the cluster.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "ipv4Address",
                "Description": "The IPv4 address associated with the public load balancer of the cluster.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "clusterId",
                "Description": "A service generated unique identifier for the cluster resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "clusterState",
                "Description": "The current state of the cluster.",
                "Enum": [
                  [
                    "WaitingForNodes",
                    "Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it."
                  ],
                  [
                    "Deploying",
                    "Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up."
                  ],
                  [
                    "BaselineUpgrade",
                    "Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time."
                  ],
                  [
                    "Upgrading",
                    "Indicates that the cluster is being upgraded with the user provided configuration."
                  ],
                  [
                    "UpgradeFailed",
                    "Indicates that the last upgrade for the cluster has failed."
                  ],
                  [
                    "Ready",
                    "Indicates that the cluster is in a stable state."
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "clusterCertificateThumbprints",
                "Description": "List of thumbprints of the cluster certificates.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "clientConnectionPort",
                "Description": "The port used for client connections to the cluster.",
                "Format": "int32",
                "Required": false,
                "Type": "integer"
              },
              {
                "#name": "httpGatewayConnectionPort",
                "Description": "The port used for HTTP connections to the cluster.",
                "Format": "int32",
                "Required": false,
                "Type": "integer"
              },
              {
                "#name": "adminUserName",
                "Description": "VM admin user name.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "adminPassword",
                "Description": "VM admin user password.",
                "Format": "password",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "loadBalancingRules",
                "Description": "Load balancing rules that are applied to the public load balancer of the cluster.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Describes a load balancing rule.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "frontendPort",
                      "Description": "The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534.",
                      "Format": "int32",
                      "Required": true,
                      "Type": "integer"
                    },
                    {
                      "#name": "backendPort",
                      "Description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.",
                      "Format": "int32",
                      "Required": true,
                      "Type": "integer"
                    },
                    {
                      "#name": "protocol",
                      "Description": "The reference to the transport protocol used by the load balancing rule.",
                      "Enum": [
                        [
                          "tcp",
                          "Transport protocol is TCP."
                        ],
                        [
                          "udp",
                          "Transport protocol is UDP."
                        ]
                      ],
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "probePort",
                      "Description": "The prob port used by the load balancing rule. Acceptable values are between 1 and 65535.",
                      "Format": "int32",
                      "Required": false,
                      "Type": "integer"
                    },
                    {
                      "#name": "probeProtocol",
                      "Description": "the reference to the load balancer probe used by the load balancing rule.",
                      "Enum": [
                        [
                          "tcp",
                          "Probe protocol is TCP."
                        ],
                        [
                          "http",
                          "Probe protocol is HTTP."
                        ],
                        [
                          "https",
                          "Probe protocol is HTTPS."
                        ]
                      ],
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "probeRequestPath",
                      "Description": "The probe request path. Only supported for HTTP/HTTPS probes.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "loadDistribution",
                      "Description": "The load distribution policy for this rule.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "allowRdpAccess",
                "Description": "Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false.",
                "Required": false,
                "Type": "boolean"
              },
              {
                "#name": "networkSecurityRules",
                "Description": "Custom Network Security Rules that are applied to the Virtual Network of the cluster.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Describes a network security rule.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": "Network security rule name.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "description",
                      "Description": "Network security rule description.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "protocol",
                      "Description": "Network protocol this rule applies to.",
                      "Enum": [
                        [
                          "http",
                          "Protocol applies to HTTP."
                        ],
                        [
                          "https",
                          "Protocol applies to HTTPS."
                        ],
                        [
                          "tcp",
                          "Protocol applies to TCP."
                        ],
                        [
                          "udp",
                          "Protocol applies to UDP."
                        ],
                        [
                          "icmp",
                          "Protocol applies to ICMP."
                        ],
                        [
                          "ah",
                          "Protocol applies to AH."
                        ],
                        [
                          "esp",
                          "Protocol applies to ESP."
                        ]
                      ],
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "sourceAddressPrefixes",
                      "Description": "The CIDR or source IP ranges.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    },
                    {
                      "#name": "destinationAddressPrefixes",
                      "Description": "The destination address prefixes. CIDR or destination IP ranges.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    },
                    {
                      "#name": "sourcePortRanges",
                      "Description": "The source port ranges.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    },
                    {
                      "#name": "destinationPortRanges",
                      "Description": "The destination port ranges.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    },
                    {
                      "#name": "sourceAddressPrefix",
                      "Description": "The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "destinationAddressPrefix",
                      "Description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "sourcePortRange",
                      "Description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "destinationPortRange",
                      "Description": "he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "access",
                      "Description": "The network traffic is allowed or denied.",
                      "Enum": [
                        [
                          "allow",
                          "The network traffic is allowed."
                        ],
                        [
                          "deny",
                          "The network traffic is denied."
                        ]
                      ],
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "priority",
                      "Description": "The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.",
                      "Format": "int32",
                      "Required": true,
                      "Type": "integer"
                    },
                    {
                      "#name": "direction",
                      "Description": "Network security rule direction.",
                      "Enum": [
                        [
                          "inbound",
                          "Inbound direction."
                        ],
                        [
                          "outbound",
                          "Outbound direction."
                        ]
                      ],
                      "Required": true,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "clients",
                "Description": "Client certificates that are allowed to manage the cluster.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Client certificate definition.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "isAdmin",
                      "Description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster.",
                      "Required": true,
                      "Type": "boolean"
                    },
                    {
                      "#name": "thumbprint",
                      "Description": "Certificate thumbprint.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "commonName",
                      "Description": "Certificate common name.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "issuerThumbprint",
                      "Description": "Issuer thumbprint for the certificate. Only used together with CommonName.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "azureActiveDirectory",
                "Description": "The AAD authentication settings of the cluster.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "tenantId",
                    "Description": "Azure active directory tenant id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "clusterApplication",
                    "Description": "Azure active directory cluster application id.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "clientApplication",
                    "Description": "Azure active directory client application id.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "fabricSettings",
                "Description": "The list of custom fabric settings to configure the cluster.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Describes a section in the fabric settings of the cluster.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": "The section name of the fabric settings.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "parameters",
                      "Description": "The collection of parameters in the section.",
                      "Required": true,
                      "Type": "array",
                      "$items": {
                        "Description": "Describes a parameter in fabric settings of the cluster.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "name",
                            "Description": "The parameter name of fabric setting.",
                            "Required": true,
                            "Type": "string"
                          },
                          {
                            "#name": "value",
                            "Description": "The parameter value of fabric setting.",
                            "Required": true,
                            "Type": "string"
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "provisioningState",
                "Description": "The provisioning state of the managed cluster resource.",
                "Enum": [
                  [
                    "None",
                    "The resource does not have a provisioning state."
                  ],
                  [
                    "Creating",
                    "The resource is being created."
                  ],
                  [
                    "Created",
                    "The resource is created."
                  ],
                  [
                    "Updating",
                    "The resource is being updated."
                  ],
                  [
                    "Succeeded",
                    "The resource provisioning has succeeded."
                  ],
                  [
                    "Failed",
                    "The resource provisioning has failed."
                  ],
                  [
                    "Canceled",
                    "The resource provisioning has been canceled."
                  ],
                  [
                    "Deleting",
                    "The resource is being deleted."
                  ],
                  [
                    "Deleted",
                    "The resource has been deleted."
                  ],
                  [
                    "Other",
                    "The resource provisioning state is a state other than the previously specified states."
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "clusterCodeVersion",
                "Description": "The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "clusterUpgradeMode",
                "Description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.",
                "Enum": [
                  [
                    "Automatic",
                    "The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available."
                  ],
                  [
                    "Manual",
                    "The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource."
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "clusterUpgradeCadence",
                "Description": "Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'.",
                "Enum": [
                  [
                    "Wave0",
                    "Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters."
                  ],
                  [
                    "Wave1",
                    "Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters."
                  ],
                  [
                    "Wave2",
                    "Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters."
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "addonFeatures",
                "Description": "List of add-on features to enable on the cluster.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Available cluster add-on features",
                  "Enum": [
                    [
                      "DnsService",
                      "Dns service"
                    ],
                    [
                      "BackupRestoreService",
                      "Backup and restore service"
                    ],
                    [
                      "ResourceMonitorService",
                      "Resource monitor service"
                    ]
                  ],
                  "Type": "string"
                }
              },
              {
                "#name": "enableAutoOSUpgrade",
                "Description": "Enables automatic OS upgrade for node types created using OS images with version 'latest'. The default value for this setting is false.",
                "Required": false,
                "Type": "boolean"
              },
              {
                "#name": "zonalResiliency",
                "Description": "Indicates if the cluster has zone resiliency.",
                "Required": false,
                "Type": "boolean"
              },
              {
                "#name": "applicationTypeVersionsCleanupPolicy",
                "Description": "The policy used to clean up unused versions.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "maxUnusedVersionsToKeep",
                    "Description": "Number of unused versions per application type to keep.",
                    "Format": "int32",
                    "Required": true,
                    "Type": "integer"
                  }
                ]
              },
              {
                "#name": "enableIpv6",
                "Description": "Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false.",
                "Required": false,
                "Type": "boolean"
              },
              {
                "#name": "subnetId",
                "Description": "If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "ipTags",
                "Description": "The list of IP tags associated with the default public IP address of the cluster.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The IP tag associated with the public IP address.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "ipTagType",
                      "Description": "IP tag type. Example: FirstPartyUsage.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "tag",
                      "Description": "IP tag associated with the public IP. Example: SQL, Storage etc.",
                      "Required": true,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "ipv6Address",
                "Description": "IPv6 address for the cluster if IPv6 is enabled.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "enableServicePublicIP",
                "Description": "Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster.",
                "Required": false,
                "Type": "boolean"
              },
              {
                "#name": "auxiliarySubnets",
                "Description": "Auxiliary subnets for the cluster.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Describes a Subnet.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": "Subnet name.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "enableIpv6",
                      "Description": "Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster.",
                      "Required": false,
                      "Type": "boolean"
                    },
                    {
                      "#name": "privateEndpointNetworkPolicies",
                      "Description": "Enable or Disable apply network policies on private end point in the subnet.",
                      "Enum": [
                        [
                          "enabled",
                          "Enable apply network policies on private end point in the subnet."
                        ],
                        [
                          "disabled",
                          "Disable apply network policies on private end point in the subnet."
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "privateLinkServiceNetworkPolicies",
                      "Description": "Enable or Disable apply network policies on private link service in the subnet.",
                      "Enum": [
                        [
                          "enabled",
                          "Enable apply network policies on private link service in the subnet."
                        ],
                        [
                          "disabled",
                          "Disable apply network policies on private link service in the subnet."
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "networkSecurityGroupId",
                      "Description": "Full resource id for the network security group.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "serviceEndpoints",
                "Description": "Service endpoints for subnets in the cluster.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The service endpoint properties.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "service",
                      "Description": "The type of the endpoint service.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "locations",
                      "Description": "A list of locations.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    }
                  ]
                }
              },
              {
                "#name": "zonalUpdateMode",
                "Description": "Indicates the update mode for Cross Az clusters.",
                "Enum": [
                  [
                    "Standard",
                    "The cluster will use 5 upgrade domains for Cross Az Node types."
                  ],
                  [
                    "Fast",
                    "The cluster will use a maximum of 3 upgrade domains per zone instead of 5 for Cross Az Node types for faster deployments."
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "useCustomVnet",
                "Description": "For new clusters, this parameter indicates that it uses Bring your own VNet, but the subnet is specified at node type level; and for such clusters, the subnetId property is required for node types.",
                "Required": false,
                "Type": "boolean"
              },
              {
                "#name": "publicIPPrefixId",
                "Description": "Specify the resource id of a public IPv4 prefix that the load balancer will allocate a public IPv4 address from. This setting cannot be changed once the cluster is created.",
                "Format": "arm-id",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "publicIPv6PrefixId",
                "Description": "Specify the resource id of a public IPv6 prefix that the load balancer will allocate a public IPv6 address from. This setting cannot be changed once the cluster is created.",
                "Format": "arm-id",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "ddosProtectionPlanId",
                "Description": "Specify the resource id of a DDoS network protection plan that will be associated with the virtual network of the cluster.",
                "Format": "arm-id",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "upgradeDescription",
                "Description": "The policy to use when upgrading the cluster.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "forceRestart",
                    "Description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).",
                    "Required": false,
                    "Type": "boolean"
                  },
                  {
                    "#name": "healthPolicy",
                    "Description": "The cluster health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade.",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "maxPercentUnhealthyNodes",
                        "Description": "The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n\nIn large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.",
                        "Format": "int32",
                        "Required": true,
                        "Type": "integer"
                      },
                      {
                        "#name": "maxPercentUnhealthyApplications",
                        "Description": "The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap.\nThe computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.",
                        "Format": "int32",
                        "Required": true,
                        "Type": "integer"
                      }
                    ]
                  },
                  {
                    "#name": "deltaHealthPolicy",
                    "Description": "The cluster delta health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade.",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "maxPercentDeltaUnhealthyNodes",
                        "Description": "The maximum allowed percentage of nodes health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.",
                        "Format": "int32",
                        "Required": true,
                        "Type": "integer"
                      },
                      {
                        "#name": "maxPercentUpgradeDomainDeltaUnhealthyNodes",
                        "Description": "The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits.",
                        "Format": "int32",
                        "Required": false,
                        "Type": "integer"
                      },
                      {
                        "#name": "maxPercentDeltaUnhealthyApplications",
                        "Description": "The maximum allowed percentage of applications health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this.\nNOTE: This value will overwrite the value specified in properties.UpgradeDescription.HealthPolicy.MaxPercentUnhealthyApplications",
                        "Format": "int32",
                        "Required": false,
                        "Type": "integer"
                      }
                    ]
                  },
                  {
                    "#name": "monitoringPolicy",
                    "Description": "The cluster monitoring policy describes the parameters for monitoring an upgrade in Monitored mode.",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "healthCheckWaitDuration",
                        "Description": "The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.",
                        "Format": "duration-constant",
                        "Required": true,
                        "Type": "string"
                      },
                      {
                        "#name": "healthCheckStableDuration",
                        "Description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.",
                        "Format": "duration-constant",
                        "Required": true,
                        "Type": "string"
                      },
                      {
                        "#name": "healthCheckRetryTimeout",
                        "Description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.",
                        "Format": "duration-constant",
                        "Required": true,
                        "Type": "string"
                      },
                      {
                        "#name": "upgradeTimeout",
                        "Description": "The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.",
                        "Format": "duration-constant",
                        "Required": true,
                        "Type": "string"
                      },
                      {
                        "#name": "upgradeDomainTimeout",
                        "Description": "The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.",
                        "Format": "duration-constant",
                        "Required": true,
                        "Type": "string"
                      }
                    ]
                  },
                  {
                    "#name": "upgradeReplicaSetCheckTimeout",
                    "Description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues.\nWhen this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues.\nThe timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.\nThis value must be between 00:00:00 and 49710.06:28:15 (unsigned 32 bit integer for seconds)",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              {
                "#name": "httpGatewayTokenAuthConnectionPort",
                "Description": "The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint.",
                "Format": "int32",
                "Required": false,
                "Type": "integer"
              },
              {
                "#name": "enableHttpGatewayExclusiveAuthMode",
                "Description": "If true, token-based authentication is not allowed on the HttpGatewayEndpoint. This is required to support TLS versions 1.3 and above. If token-based authentication is used, HttpGatewayTokenAuthConnectionPort must be defined.",
                "Required": false,
                "Type": "boolean"
              },
              {
                "#name": "autoGeneratedDomainNameLabelScope",
                "Description": "This property is the entry point to using a public CA cert for your cluster cert. It specifies the level of reuse allowed for the custom FQDN created, matching the subject of the public CA cert.",
                "Enum": [
                  [
                    "TenantReuse",
                    "TenantReuse allows for the same hash to be created if the resource is created in the same Tenant with the same resource name."
                  ],
                  [
                    "SubscriptionReuse",
                    "SubscriptionReuse allows for the same hash to be created if the resource is created in the same Subscription with the same resource name."
                  ],
                  [
                    "ResourceGroupReuse",
                    "ResourceGroupReuse allows for the same hash to be created if the resource is created in the same Resource Group with the same resource name."
                  ],
                  [
                    "NoReuse",
                    "NoReuse will create a new hash regardless of the Subscription, Resource Group, Tenant and Resource name."
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "allocatedOutboundPorts",
                "Description": "The number of outbound ports allocated for SNAT for each node in the backend pool of the default load balancer. The default value is 0 which provides dynamic port allocation based on pool size.",
                "Format": "int32",
                "Required": false,
                "Type": "integer"
              },
              {
                "#name": "VMImage",
                "Description": "The VM image the node types are configured with. This property controls the Service Fabric component packages to be used for the cluster. Allowed values are: 'Windows'. The default value is 'Windows'.",
                "Required": false,
                "Type": "string"
              }
            ]
          },
          {
            "#name": "etag",
            "Description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.\",",
            "Required": false,
            "Type": "string"
          },
          {
            "#name": "sku",
            "Description": "The sku of the managed cluster",
            "Required": true,
            "Type": "object",
            "$properties": [
              {
                "#name": "name",
                "Description": "Sku Name.",
                "Enum": [
                  [
                    "Basic",
                    "Basic requires a minimum of 3 nodes and allows only 1 node type."
                  ],
                  [
                    "Standard",
                    "Requires a minimum of 5 nodes and allows 1 or more node type."
                  ]
                ],
                "Required": true,
                "Type": "string"
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The managed cluster resource updated tags. ,
Required: True ,
}
{
tags:
{
Description: Managed cluster update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: The fully qualified domain name associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. ,
Deploying: Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. ,
BaselineUpgrade: Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. ,
Upgrading: Indicates that the cluster is being upgraded with the user provided configuration. ,
UpgradeFailed: Indicates that the last upgrade for the cluster has failed. ,
Ready: Indicates that the cluster is in a stable state. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprints:
{
Description: List of thumbprints of the cluster certificates. ,
Required: False ,
}
[
string ,
]
,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for HTTP connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: VM admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: VM admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Load balancing rules that are applied to the public load balancer of the cluster. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: Transport protocol is TCP. ,
udp: Transport protocol is UDP. ,
}
,
Required: True ,
}
enum ,
probePort:
{
Description: The prob port used by the load balancing rule. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: Probe protocol is TCP. ,
http: Probe protocol is HTTP. ,
https: Probe protocol is HTTPS. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
loadDistribution:
{
Description: The load distribution policy for this rule. ,
Required: False ,
}
string ,
}
,
]
,
allowRdpAccess:
{
Description: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. ,
Required: False ,
}
boolean ,
networkSecurityRules:
{
Description: Custom Network Security Rules that are applied to the Virtual Network of the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: Protocol applies to HTTP. ,
https: Protocol applies to HTTPS. ,
tcp: Protocol applies to TCP. ,
udp: Protocol applies to UDP. ,
icmp: Protocol applies to ICMP. ,
ah: Protocol applies to AH. ,
esp: Protocol applies to ESP. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
sourceAddressPrefix:
{
Description: The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ,
Required: False ,
}
string ,
destinationAddressPrefix:
{
Description: The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. ,
Required: False ,
}
string ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: The network traffic is allowed. ,
deny: The network traffic is denied. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: Inbound direction. ,
outbound: Outbound direction. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clients:
{
Description: Client certificates that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: The resource does not have a provisioning state. ,
Creating: The resource is being created. ,
Created: The resource is created. ,
Updating: The resource is being updated. ,
Succeeded: The resource provisioning has succeeded. ,
Failed: The resource provisioning has failed. ,
Canceled: The resource provisioning has been canceled. ,
Deleting: The resource is being deleted. ,
Deleted: The resource has been deleted. ,
Other: The resource provisioning state is a state other than the previously specified states. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterUpgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
clusterUpgradeCadence:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
addonFeatures:
{
Description: List of add-on features to enable on the cluster. ,
Required: False ,
}
[
string ,
]
,
enableAutoOSUpgrade:
{
Description: Enables automatic OS upgrade for node types created using OS images with version 'latest'. The default value for this setting is false. ,
Required: False ,
}
boolean ,
zonalResiliency:
{
Description: Indicates if the cluster has zone resiliency. ,
Required: False ,
}
boolean ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
enableIpv6:
{
Description: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. ,
Required: False ,
}
boolean ,
subnetId:
{
Description: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. ,
Required: False ,
}
string ,
ipTags:
{
Description: The list of IP tags associated with the default public IP address of the cluster. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: True ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: True ,
}
string ,
}
,
]
,
ipv6Address:
{
Description: IPv6 address for the cluster if IPv6 is enabled. ,
Required: False ,
}
string ,
enableServicePublicIP:
{
Description: Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster. ,
Required: False ,
}
boolean ,
auxiliarySubnets:
{
Description: Auxiliary subnets for the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Subnet name. ,
Required: True ,
}
string ,
enableIpv6:
{
Description: Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster. ,
Required: False ,
}
boolean ,
privateEndpointNetworkPolicies:
{
Description: Enable or Disable apply network policies on private end point in the subnet. ,
Enum:
{
enabled: Enable apply network policies on private end point in the subnet. ,
disabled: Disable apply network policies on private end point in the subnet. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceNetworkPolicies:
{
Description: Enable or Disable apply network policies on private link service in the subnet. ,
Enum:
{
enabled: Enable apply network policies on private link service in the subnet. ,
disabled: Disable apply network policies on private link service in the subnet. ,
}
,
Required: False ,
}
enum ,
networkSecurityGroupId:
{
Description: Full resource id for the network security group. ,
Required: False ,
}
string ,
}
,
]
,
serviceEndpoints:
{
Description: Service endpoints for subnets in the cluster. ,
Required: False ,
}
[
{
service:
{
Description: The type of the endpoint service. ,
Required: True ,
}
string ,
locations:
{
Description: A list of locations. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
zonalUpdateMode:
{
Description: Indicates the update mode for Cross Az clusters. ,
Enum:
{
Standard: The cluster will use 5 upgrade domains for Cross Az Node types. ,
Fast: The cluster will use a maximum of 3 upgrade domains per zone instead of 5 for Cross Az Node types for faster deployments. ,
}
,
Required: False ,
}
enum ,
useCustomVnet:
{
Description: For new clusters, this parameter indicates that it uses Bring your own VNet, but the subnet is specified at node type level; and for such clusters, the subnetId property is required for node types. ,
Required: False ,
}
boolean ,
publicIPPrefixId:
{
Description: Specify the resource id of a public IPv4 prefix that the load balancer will allocate a public IPv4 address from. This setting cannot be changed once the cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
publicIPv6PrefixId:
{
Description: Specify the resource id of a public IPv6 prefix that the load balancer will allocate a public IPv6 address from. This setting cannot be changed once the cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
ddosProtectionPlanId:
{
Description: Specify the resource id of a DDoS network protection plan that will be associated with the virtual network of the cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
forceRestart:
{
Description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). ,
Required: False ,
}
boolean ,
healthPolicy:
{
Description: The cluster health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade. ,
Required: False ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. NOTE: This value will overwrite the value specified in properties.UpgradeDescription.HealthPolicy.MaxPercentUnhealthyApplications ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
monitoringPolicy:
{
Description: The cluster monitoring policy describes the parameters for monitoring an upgrade in Monitored mode. ,
Required: False ,
}
{
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Format: duration-constant ,
Required: True ,
}
string ,
}
,
upgradeReplicaSetCheckTimeout:
{
Description: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. This value must be between 00:00:00 and 49710.06:28:15 (unsigned 32 bit integer for seconds) ,
Required: False ,
}
string ,
}
,
httpGatewayTokenAuthConnectionPort:
{
Description: The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
enableHttpGatewayExclusiveAuthMode:
{
Description: If true, token-based authentication is not allowed on the HttpGatewayEndpoint. This is required to support TLS versions 1.3 and above. If token-based authentication is used, HttpGatewayTokenAuthConnectionPort must be defined. ,
Required: False ,
}
boolean ,
autoGeneratedDomainNameLabelScope:
{
Description: This property is the entry point to using a public CA cert for your cluster cert. It specifies the level of reuse allowed for the custom FQDN created, matching the subject of the public CA cert. ,
Enum:
{
TenantReuse: TenantReuse allows for the same hash to be created if the resource is created in the same Tenant with the same resource name. ,
SubscriptionReuse: SubscriptionReuse allows for the same hash to be created if the resource is created in the same Subscription with the same resource name. ,
ResourceGroupReuse: ResourceGroupReuse allows for the same hash to be created if the resource is created in the same Resource Group with the same resource name. ,
NoReuse: NoReuse will create a new hash regardless of the Subscription, Resource Group, Tenant and Resource name. ,
}
,
Required: False ,
}
enum ,
allocatedOutboundPorts:
{
Description: The number of outbound ports allocated for SNAT for each node in the backend pool of the default load balancer. The default value is 0 which provides dynamic port allocation based on pool size. ,
Format: int32 ,
Required: False ,
}
integer ,
VMImage:
{
Description: The VM image the node types are configured with. This property controls the Service Fabric component packages to be used for the cluster. Allowed values are: 'Windows'. The default value is 'Windows'. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", ,
Required: False ,
}
string ,
sku:
{
Description: The sku of the managed cluster ,
Required: True ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: Basic requires a minimum of 3 nodes and allows only 1 node type. ,
Standard: Requires a minimum of 5 nodes and allows 1 or more node type. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}
,
$schema:
{
Description: The managed cluster resource ,
}
{
properties:
{
Description: The managed cluster resource properties ,
Required: False ,
}
{
dnsName:
{
Description: The cluster dns name. ,
Required: True ,
}
string ,
fqdn:
{
Description: The fully qualified domain name associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address associated with the public load balancer of the cluster. ,
Required: False ,
}
string ,
clusterId:
{
Description: A service generated unique identifier for the cluster resource. ,
Required: False ,
}
string ,
clusterState:
{
Description: The current state of the cluster. ,
Enum:
{
WaitingForNodes: Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. ,
Deploying: Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up. ,
BaselineUpgrade: Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time. ,
Upgrading: Indicates that the cluster is being upgraded with the user provided configuration. ,
UpgradeFailed: Indicates that the last upgrade for the cluster has failed. ,
Ready: Indicates that the cluster is in a stable state. ,
}
,
Required: False ,
}
enum ,
clusterCertificateThumbprints:
{
Description: List of thumbprints of the cluster certificates. ,
Required: False ,
}
[
string ,
]
,
clientConnectionPort:
{
Description: The port used for client connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
httpGatewayConnectionPort:
{
Description: The port used for HTTP connections to the cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
adminUserName:
{
Description: VM admin user name. ,
Required: True ,
}
string ,
adminPassword:
{
Description: VM admin user password. ,
Format: password ,
Required: False ,
}
string ,
loadBalancingRules:
{
Description: Load balancing rules that are applied to the public load balancer of the cluster. ,
Required: False ,
}
[
{
frontendPort:
{
Description: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. ,
Format: int32 ,
Required: True ,
}
integer ,
backendPort:
{
Description: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: The reference to the transport protocol used by the load balancing rule. ,
Enum:
{
tcp: Transport protocol is TCP. ,
udp: Transport protocol is UDP. ,
}
,
Required: True ,
}
enum ,
probePort:
{
Description: The prob port used by the load balancing rule. Acceptable values are between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
probeProtocol:
{
Description: the reference to the load balancer probe used by the load balancing rule. ,
Enum:
{
tcp: Probe protocol is TCP. ,
http: Probe protocol is HTTP. ,
https: Probe protocol is HTTPS. ,
}
,
Required: True ,
}
enum ,
probeRequestPath:
{
Description: The probe request path. Only supported for HTTP/HTTPS probes. ,
Required: False ,
}
string ,
loadDistribution:
{
Description: The load distribution policy for this rule. ,
Required: False ,
}
string ,
}
,
]
,
allowRdpAccess:
{
Description: Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false. ,
Required: False ,
}
boolean ,
networkSecurityRules:
{
Description: Custom Network Security Rules that are applied to the Virtual Network of the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: Protocol applies to HTTP. ,
https: Protocol applies to HTTPS. ,
tcp: Protocol applies to TCP. ,
udp: Protocol applies to UDP. ,
icmp: Protocol applies to ICMP. ,
ah: Protocol applies to AH. ,
esp: Protocol applies to ESP. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
sourceAddressPrefix:
{
Description: The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ,
Required: False ,
}
string ,
destinationAddressPrefix:
{
Description: The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. ,
Required: False ,
}
string ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: The network traffic is allowed. ,
deny: The network traffic is denied. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: Inbound direction. ,
outbound: Outbound direction. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
clients:
{
Description: Client certificates that are allowed to manage the cluster. ,
Required: False ,
}
[
{
isAdmin:
{
Description: Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. ,
Required: True ,
}
boolean ,
thumbprint:
{
Description: Certificate thumbprint. ,
Required: False ,
}
string ,
commonName:
{
Description: Certificate common name. ,
Required: False ,
}
string ,
issuerThumbprint:
{
Description: Issuer thumbprint for the certificate. Only used together with CommonName. ,
Required: False ,
}
string ,
}
,
]
,
azureActiveDirectory:
{
Description: The AAD authentication settings of the cluster. ,
Required: False ,
}
{
tenantId:
{
Description: Azure active directory tenant id. ,
Required: False ,
}
string ,
clusterApplication:
{
Description: Azure active directory cluster application id. ,
Required: False ,
}
string ,
clientApplication:
{
Description: Azure active directory client application id. ,
Required: False ,
}
string ,
}
,
fabricSettings:
{
Description: The list of custom fabric settings to configure the cluster. ,
Required: False ,
}
[
{
name:
{
Description: The section name of the fabric settings. ,
Required: True ,
}
string ,
parameters:
{
Description: The collection of parameters in the section. ,
Required: True ,
}
[
{
name:
{
Description: The parameter name of fabric setting. ,
Required: True ,
}
string ,
value:
{
Description: The parameter value of fabric setting. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the managed cluster resource. ,
Enum:
{
None: The resource does not have a provisioning state. ,
Creating: The resource is being created. ,
Created: The resource is created. ,
Updating: The resource is being updated. ,
Succeeded: The resource provisioning has succeeded. ,
Failed: The resource provisioning has failed. ,
Canceled: The resource provisioning has been canceled. ,
Deleting: The resource is being deleted. ,
Deleted: The resource has been deleted. ,
Other: The resource provisioning state is a state other than the previously specified states. ,
}
,
Required: False ,
}
enum ,
clusterCodeVersion:
{
Description: The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**. ,
Required: False ,
}
string ,
clusterUpgradeMode:
{
Description: The upgrade mode of the cluster when new Service Fabric runtime version is available. ,
Enum:
{
Automatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available. ,
Manual: The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource. ,
}
,
Required: False ,
}
enum ,
clusterUpgradeCadence:
{
Description: Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'. ,
Enum:
{
Wave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. ,
Wave1: Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters. ,
Wave2: Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters. ,
}
,
Required: False ,
}
enum ,
addonFeatures:
{
Description: List of add-on features to enable on the cluster. ,
Required: False ,
}
[
string ,
]
,
enableAutoOSUpgrade:
{
Description: Enables automatic OS upgrade for node types created using OS images with version 'latest'. The default value for this setting is false. ,
Required: False ,
}
boolean ,
zonalResiliency:
{
Description: Indicates if the cluster has zone resiliency. ,
Required: False ,
}
boolean ,
applicationTypeVersionsCleanupPolicy:
{
Description: The policy used to clean up unused versions. ,
Required: False ,
}
{
maxUnusedVersionsToKeep:
{
Description: Number of unused versions per application type to keep. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
enableIpv6:
{
Description: Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false. ,
Required: False ,
}
boolean ,
subnetId:
{
Description: If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created. ,
Required: False ,
}
string ,
ipTags:
{
Description: The list of IP tags associated with the default public IP address of the cluster. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: True ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: True ,
}
string ,
}
,
]
,
ipv6Address:
{
Description: IPv6 address for the cluster if IPv6 is enabled. ,
Required: False ,
}
string ,
enableServicePublicIP:
{
Description: Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster. ,
Required: False ,
}
boolean ,
auxiliarySubnets:
{
Description: Auxiliary subnets for the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Subnet name. ,
Required: True ,
}
string ,
enableIpv6:
{
Description: Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster. ,
Required: False ,
}
boolean ,
privateEndpointNetworkPolicies:
{
Description: Enable or Disable apply network policies on private end point in the subnet. ,
Enum:
{
enabled: Enable apply network policies on private end point in the subnet. ,
disabled: Disable apply network policies on private end point in the subnet. ,
}
,
Required: False ,
}
enum ,
privateLinkServiceNetworkPolicies:
{
Description: Enable or Disable apply network policies on private link service in the subnet. ,
Enum:
{
enabled: Enable apply network policies on private link service in the subnet. ,
disabled: Disable apply network policies on private link service in the subnet. ,
}
,
Required: False ,
}
enum ,
networkSecurityGroupId:
{
Description: Full resource id for the network security group. ,
Required: False ,
}
string ,
}
,
]
,
serviceEndpoints:
{
Description: Service endpoints for subnets in the cluster. ,
Required: False ,
}
[
{
service:
{
Description: The type of the endpoint service. ,
Required: True ,
}
string ,
locations:
{
Description: A list of locations. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
zonalUpdateMode:
{
Description: Indicates the update mode for Cross Az clusters. ,
Enum:
{
Standard: The cluster will use 5 upgrade domains for Cross Az Node types. ,
Fast: The cluster will use a maximum of 3 upgrade domains per zone instead of 5 for Cross Az Node types for faster deployments. ,
}
,
Required: False ,
}
enum ,
useCustomVnet:
{
Description: For new clusters, this parameter indicates that it uses Bring your own VNet, but the subnet is specified at node type level; and for such clusters, the subnetId property is required for node types. ,
Required: False ,
}
boolean ,
publicIPPrefixId:
{
Description: Specify the resource id of a public IPv4 prefix that the load balancer will allocate a public IPv4 address from. This setting cannot be changed once the cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
publicIPv6PrefixId:
{
Description: Specify the resource id of a public IPv6 prefix that the load balancer will allocate a public IPv6 address from. This setting cannot be changed once the cluster is created. ,
Format: arm-id ,
Required: False ,
}
string ,
ddosProtectionPlanId:
{
Description: Specify the resource id of a DDoS network protection plan that will be associated with the virtual network of the cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
upgradeDescription:
{
Description: The policy to use when upgrading the cluster. ,
Required: False ,
}
{
forceRestart:
{
Description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). ,
Required: False ,
}
boolean ,
healthPolicy:
{
Description: The cluster health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade. ,
Required: False ,
}
{
maxPercentUnhealthyNodes:
{
Description: The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyApplications:
{
Description: The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
deltaHealthPolicy:
{
Description: The cluster delta health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade. ,
Required: False ,
}
{
maxPercentDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUpgradeDomainDeltaUnhealthyNodes:
{
Description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPercentDeltaUnhealthyApplications:
{
Description: The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. NOTE: This value will overwrite the value specified in properties.UpgradeDescription.HealthPolicy.MaxPercentUnhealthyApplications ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
monitoringPolicy:
{
Description: The cluster monitoring policy describes the parameters for monitoring an upgrade in Monitored mode. ,
Required: False ,
}
{
healthCheckWaitDuration:
{
Description: The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. ,
Format: duration-constant ,
Required: True ,
}
string ,
}
,
upgradeReplicaSetCheckTimeout:
{
Description: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. This value must be between 00:00:00 and 49710.06:28:15 (unsigned 32 bit integer for seconds) ,
Required: False ,
}
string ,
}
,
httpGatewayTokenAuthConnectionPort:
{
Description: The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
enableHttpGatewayExclusiveAuthMode:
{
Description: If true, token-based authentication is not allowed on the HttpGatewayEndpoint. This is required to support TLS versions 1.3 and above. If token-based authentication is used, HttpGatewayTokenAuthConnectionPort must be defined. ,
Required: False ,
}
boolean ,
autoGeneratedDomainNameLabelScope:
{
Description: This property is the entry point to using a public CA cert for your cluster cert. It specifies the level of reuse allowed for the custom FQDN created, matching the subject of the public CA cert. ,
Enum:
{
TenantReuse: TenantReuse allows for the same hash to be created if the resource is created in the same Tenant with the same resource name. ,
SubscriptionReuse: SubscriptionReuse allows for the same hash to be created if the resource is created in the same Subscription with the same resource name. ,
ResourceGroupReuse: ResourceGroupReuse allows for the same hash to be created if the resource is created in the same Resource Group with the same resource name. ,
NoReuse: NoReuse will create a new hash regardless of the Subscription, Resource Group, Tenant and Resource name. ,
}
,
Required: False ,
}
enum ,
allocatedOutboundPorts:
{
Description: The number of outbound ports allocated for SNAT for each node in the backend pool of the default load balancer. The default value is 0 which provides dynamic port allocation based on pool size. ,
Format: int32 ,
Required: False ,
}
integer ,
VMImage:
{
Description: The VM image the node types are configured with. This property controls the Service Fabric component packages to be used for the cluster. Allowed values are: 'Windows'. The default value is 'Windows'. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", ,
Required: False ,
}
string ,
sku:
{
Description: The sku of the managed cluster ,
Required: True ,
}
{
name:
{
Description: Sku Name. ,
Enum:
{
Basic: Basic requires a minimum of 3 nodes and allows only 1 node type. ,
Standard: Requires a minimum of 5 nodes and allows 1 or more node type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Applications_Update (updated)
Description :  Updates an application resource of a given managed cluster.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Applications_Update",
  "Description": {
    "new": "Updates an application resource of a given managed cluster.",
    "old": "Updates the tags of an application resource of a given managed cluster."
  },
  "$responses": {
    "@added_a7cf42d664574d938527d519de7f15bd": {
      "#status": "202",
      "$headers": [
        {
          "#name": "azure-asyncoperation",
          "Description": "A link to the status monitor",
          "Type": "string"
        },
        {
          "#name": "location",
          "Description": "The Location header contains the URL where the status of the long running operation can be checked.",
          "Type": "string"
        }
      ],
      "$schema": {
        "Description": "The application resource.",
        "Type": "object",
        "$properties": [
          {
            "#name": "properties",
            "Description": "The application resource properties.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "managedIdentities",
                "Description": "List of user assigned identities for the application, each mapped to a friendly name.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "User assigned identity for the application.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "name",
                      "Description": "The friendly name of user assigned identity.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "principalId",
                      "Description": "The principal id of user assigned identity.",
                      "Required": true,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "#name": "provisioningState",
                "Description": "The current deployment or provisioning state, which only appears in the response",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "version",
                "Description": "The version of the application type as defined in the application manifest.\nThis name must be the full Arm Resource ID for the referenced application type version.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "parameters",
                "Description": "List of application parameters with overridden values from their default values specified in the application manifest.",
                "Required": false,
                "Type": "object"
              },
              {
                "#name": "upgradePolicy",
                "Description": "Describes the policy for a monitored application upgrade.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "applicationHealthPolicy",
                    "Description": "Defines a health policy used to evaluate the health of an application or one of its children entities.",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "considerWarningAsError",
                        "Description": "Indicates whether warnings are treated with the same severity as errors.",
                        "Required": true,
                        "Type": "boolean"
                      },
                      {
                        "#name": "maxPercentUnhealthyDeployedApplications",
                        "Description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.",
                        "Format": "int32",
                        "Required": true,
                        "Type": "integer"
                      },
                      {
                        "#name": "defaultServiceTypeHealthPolicy",
                        "Description": "The health policy used by default to evaluate the health of a service type.",
                        "Required": false,
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "maxPercentUnhealthyServices",
                            "Description": "The maximum allowed percentage of unhealthy services.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.\nThe computation rounds up to tolerate one failure on small numbers of services.",
                            "Format": "int32",
                            "Required": true,
                            "Type": "integer"
                          },
                          {
                            "#name": "maxPercentUnhealthyPartitionsPerService",
                            "Description": "The maximum allowed percentage of unhealthy partitions per service.\n\nThe percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error.\nIf the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service.\nThe computation rounds up to tolerate one failure on small numbers of partitions.",
                            "Format": "int32",
                            "Required": true,
                            "Type": "integer"
                          },
                          {
                            "#name": "maxPercentUnhealthyReplicasPerPartition",
                            "Description": "The maximum allowed percentage of unhealthy replicas per partition.\n\nThe percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error.\nIf the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition.\nThe computation rounds up to tolerate one failure on small numbers of replicas.",
                            "Format": "int32",
                            "Required": true,
                            "Type": "integer"
                          }
                        ]
                      },
                      {
                        "#name": "serviceTypeHealthPolicyMap",
                        "Description": "The map with service type health policy per service type name. The map is empty by default.",
                        "Required": false,
                        "Type": "object"
                      }
                    ]
                  },
                  {
                    "#name": "forceRestart",
                    "Description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).",
                    "Required": false,
                    "Type": "boolean"
                  },
                  {
                    "#name": "rollingUpgradeMonitoringPolicy",
                    "Description": "The policy used for monitoring the application upgrade",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "failureAction",
                        "Description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.",
                        "Enum": [
                          [
                            "Rollback",
                            "Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails."
                          ],
                          [
                            "Manual",
                            "Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically."
                          ]
                        ],
                        "Required": true,
                        "Type": "string"
                      },
                      {
                        "#name": "healthCheckWaitDuration",
                        "Description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\".",
                        "Format": "duration-constant",
                        "Required": true,
                        "Type": "string"
                      },
                      {
                        "#name": "healthCheckStableDuration",
                        "Description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\".",
                        "Format": "duration-constant",
                        "Required": true,
                        "Type": "string"
                      },
                      {
                        "#name": "healthCheckRetryTimeout",
                        "Description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\".",
                        "Format": "duration-constant",
                        "Required": true,
                        "Type": "string"
                      },
                      {
                        "#name": "upgradeTimeout",
                        "Description": "The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\".",
                        "Format": "duration-constant",
                        "Required": true,
                        "Type": "string"
                      },
                      {
                        "#name": "upgradeDomainTimeout",
                        "Description": "The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\".",
                        "Format": "duration-constant",
                        "Required": true,
                        "Type": "string"
                      }
                    ]
                  },
                  {
                    "#name": "instanceCloseDelayDuration",
                    "Description": "Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description.",
                    "Format": "int64",
                    "Required": false,
                    "Type": "integer"
                  },
                  {
                    "#name": "upgradeMode",
                    "Description": "The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto.",
                    "Enum": [
                      [
                        "Monitored",
                        "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding."
                      ],
                      [
                        "UnmonitoredAuto",
                        "The upgrade will proceed automatically without performing any health monitoring."
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "upgradeReplicaSetCheckTimeout",
                    "Description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). Unit is in seconds.",
                    "Format": "int64",
                    "Required": false,
                    "Type": "integer"
                  },
                  {
                    "#name": "recreateApplication",
                    "Description": "Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed.",
                    "Required": false,
                    "Type": "boolean"
                  }
                ]
              }
            ]
          },
          {
            "#name": "tags",
            "Description": "Resource tags.",
            "Required": false,
            "Type": "object"
          },
          {
            "#name": "identity",
            "Description": "Describes the managed identities for an Azure resource.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "principalId",
                "Description": "The principal id of the managed identity. This property will only be provided for a system assigned identity.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "tenantId",
                "Description": "The tenant id of the managed identity. This property will only be provided for a system assigned identity.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "type",
                "Description": "The type of managed identity for the resource.",
                "Enum": [
                  [
                    "None",
                    "Indicates that no identity is associated with the resource."
                  ],
                  [
                    "SystemAssigned",
                    "Indicates that system assigned identity is associated with the resource."
                  ],
                  [
                    "UserAssigned",
                    "Indicates that user assigned identity is associated with the resource."
                  ],
                  [
                    "SystemAssigned, UserAssigned",
                    "Indicates that both system assigned and user assigned identity are associated with the resource."
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "userAssignedIdentities",
                "Description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
                "Required": false,
                "Type": "object"
              }
            ]
          },
          {
            "#name": "location",
            "Description": "The geo-location where the resource lives",
            "Required": false,
            "Type": "string"
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/applications/{applicationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
applicationName:
{
Description: The name of the application resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The application resource updated tags. ,
Required: True ,
}
{
tags:
{
Description: Application update parameters ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
managedIdentities:
{
Description: List of user assigned identities for the application, each mapped to a friendly name. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name of user assigned identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal id of user assigned identity. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
version:
{
Description: The version of the application type as defined in the application manifest. This name must be the full Arm Resource ID for the referenced application type version. ,
Required: False ,
}
string ,
parameters:
{
Description: List of application parameters with overridden values from their default values specified in the application manifest. ,
Required: False ,
}
object ,
upgradePolicy:
{
Description: Describes the policy for a monitored application upgrade. ,
Required: False ,
}
{
applicationHealthPolicy:
{
Description: Defines a health policy used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
{
considerWarningAsError:
{
Description: Indicates whether warnings are treated with the same severity as errors. ,
Required: True ,
}
boolean ,
maxPercentUnhealthyDeployedApplications:
{
Description: The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. ,
Format: int32 ,
Required: True ,
}
integer ,
defaultServiceTypeHealthPolicy:
{
Description: The health policy used by default to evaluate the health of a service type. ,
Required: False ,
}
{
maxPercentUnhealthyServices:
{
Description: The maximum allowed percentage of unhealthy services. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyPartitionsPerService:
{
Description: The maximum allowed percentage of unhealthy partitions per service. The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyReplicasPerPartition:
{
Description: The maximum allowed percentage of unhealthy replicas per partition. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
serviceTypeHealthPolicyMap:
{
Description: The map with service type health policy per service type name. The map is empty by default. ,
Required: False ,
}
object ,
}
,
forceRestart:
{
Description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). ,
Required: False ,
}
boolean ,
rollingUpgradeMonitoringPolicy:
{
Description: The policy used for monitoring the application upgrade ,
Required: False ,
}
{
failureAction:
{
Description: The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. ,
Enum:
{
Rollback: Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails. ,
Manual: Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically. ,
}
,
Required: True ,
}
enum ,
healthCheckWaitDuration:
{
Description: The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
}
,
instanceCloseDelayDuration:
{
Description: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. ,
Format: int64 ,
Required: False ,
}
integer ,
upgradeMode:
{
Description: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. ,
Enum:
{
Monitored: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. ,
UnmonitoredAuto: The upgrade will proceed automatically without performing any health monitoring. ,
}
,
Required: False ,
}
enum ,
upgradeReplicaSetCheckTimeout:
{
Description: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). Unit is in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
recreateApplication:
{
Description: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. ,
Required: False ,
}
boolean ,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Describes the managed identities for an Azure resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the managed identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the managed identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of managed identity for the resource. ,
Enum:
{
None: Indicates that no identity is associated with the resource. ,
SystemAssigned: Indicates that system assigned identity is associated with the resource. ,
UserAssigned: Indicates that user assigned identity is associated with the resource. ,
SystemAssigned, UserAssigned: Indicates that both system assigned and user assigned identity are associated with the resource. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}
,
$schema:
{
Description: The application resource. ,
}
{
properties:
{
Description: The application resource properties. ,
Required: False ,
}
{
managedIdentities:
{
Description: List of user assigned identities for the application, each mapped to a friendly name. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name of user assigned identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal id of user assigned identity. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The current deployment or provisioning state, which only appears in the response ,
Required: False ,
}
string ,
version:
{
Description: The version of the application type as defined in the application manifest. This name must be the full Arm Resource ID for the referenced application type version. ,
Required: False ,
}
string ,
parameters:
{
Description: List of application parameters with overridden values from their default values specified in the application manifest. ,
Required: False ,
}
object ,
upgradePolicy:
{
Description: Describes the policy for a monitored application upgrade. ,
Required: False ,
}
{
applicationHealthPolicy:
{
Description: Defines a health policy used to evaluate the health of an application or one of its children entities. ,
Required: False ,
}
{
considerWarningAsError:
{
Description: Indicates whether warnings are treated with the same severity as errors. ,
Required: True ,
}
boolean ,
maxPercentUnhealthyDeployedApplications:
{
Description: The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. ,
Format: int32 ,
Required: True ,
}
integer ,
defaultServiceTypeHealthPolicy:
{
Description: The health policy used by default to evaluate the health of a service type. ,
Required: False ,
}
{
maxPercentUnhealthyServices:
{
Description: The maximum allowed percentage of unhealthy services. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyPartitionsPerService:
{
Description: The maximum allowed percentage of unhealthy partitions per service. The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. ,
Format: int32 ,
Required: True ,
}
integer ,
maxPercentUnhealthyReplicasPerPartition:
{
Description: The maximum allowed percentage of unhealthy replicas per partition. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
serviceTypeHealthPolicyMap:
{
Description: The map with service type health policy per service type name. The map is empty by default. ,
Required: False ,
}
object ,
}
,
forceRestart:
{
Description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). ,
Required: False ,
}
boolean ,
rollingUpgradeMonitoringPolicy:
{
Description: The policy used for monitoring the application upgrade ,
Required: False ,
}
{
failureAction:
{
Description: The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. ,
Enum:
{
Rollback: Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails. ,
Manual: Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically. ,
}
,
Required: True ,
}
enum ,
healthCheckWaitDuration:
{
Description: The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckStableDuration:
{
Description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
healthCheckRetryTimeout:
{
Description: The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeTimeout:
{
Description: The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
upgradeDomainTimeout:
{
Description: The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". ,
Format: duration-constant ,
Required: True ,
}
string ,
}
,
instanceCloseDelayDuration:
{
Description: Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. ,
Format: int64 ,
Required: False ,
}
integer ,
upgradeMode:
{
Description: The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. ,
Enum:
{
Monitored: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. ,
UnmonitoredAuto: The upgrade will proceed automatically without performing any health monitoring. ,
}
,
Required: False ,
}
enum ,
upgradeReplicaSetCheckTimeout:
{
Description: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). Unit is in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
recreateApplication:
{
Description: Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. ,
Required: False ,
}
boolean ,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Describes the managed identities for an Azure resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the managed identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant id of the managed identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of managed identity for the resource. ,
Enum:
{
None: Indicates that no identity is associated with the resource. ,
SystemAssigned: Indicates that system assigned identity is associated with the resource. ,
UserAssigned: Indicates that user assigned identity is associated with the resource. ,
SystemAssigned, UserAssigned: Indicates that both system assigned and user assigned identity are associated with the resource. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NodeTypes_Update (updated)
Description :  Update the configuration of a node type of a given managed cluster, only updating tags or capacity.
Reference :  Link ¶

⚶ Changes

{
  "#id": "NodeTypes_Update",
  "Description": {
    "new": "Update the configuration of a node type of a given managed cluster, only updating tags or capacity.",
    "old": "Update the configuration of a node type of a given managed cluster, only updating tags."
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster resource. ,
Required: True ,
}
string ,
nodeTypeName:
{
Description: The name of the node type. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to update the node type configuration. ,
Required: True ,
}
{
tags:
{
Description: Node type update parameters ,
Required: False ,
}
object ,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. Name is internally generated and is used in auto-scale scenarios. Property does not allow to be changed to other values than generated. To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type. Possible Values: **Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type. If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The node type properties ,
Required: False ,
}
{
isPrimary:
{
Description: Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created. ,
Required: True ,
}
boolean ,
vmInstanceCount:
{
Description: The number of nodes in the node type. **Values:** -1 - Use when auto scale rules are configured or sku.capacity is defined 0 - Not supported >0 - Use for manual scale. ,
Format: int32 ,
Required: True ,
}
integer ,
dataDiskSizeGB:
{
Description: Disk size for the managed disk attached to the vms on the node type in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dataDiskType:
{
Description: Managed data disk type. Specifies the storage account type for the managed disk ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
PremiumV2_LRS: Premium SSD V2 locally redundant storage. Best for production and performance sensitive workloads that consistently require low latency and high IOPS and throughput. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for production workloads that need storage resiliency against zone failures. ,
}
,
Required: False ,
}
enum ,
dataDiskLetter:
{
Description: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. ,
Required: False ,
}
string ,
placementProperties:
{
Description: The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run. ,
Required: False ,
}
object ,
capacities:
{
Description: The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has. ,
Required: False ,
}
object ,
applicationPorts:
{
Description: The range of ports from which cluster assigned port to Service Fabric applications. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
ephemeralPorts:
{
Description: The range of ephemeral ports that nodes in this node type should be configured with. ,
Required: False ,
}
{
startPort:
{
Description: Starting port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
endPort:
{
Description: End port of a range of ports ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vmSize:
{
Description: The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3. ,
Required: False ,
}
string ,
vmImagePublisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
vmImageOffer:
{
Description: The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
vmImageSku:
{
Description: The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter. ,
Required: False ,
}
string ,
vmImageVersion:
{
Description: The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
vmSecrets:
{
Description: The secrets to install in the virtual machines. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: True ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: True ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). ,
Required: True ,
}
string ,
certificateStore:
{
Description: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name {UppercaseThumbprint}.crt for the X509 certificate file and {UppercaseThumbprint}.prv for private key. Both of these files are .pem formatted. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
vmExtensions:
{
Description: Set of extensions that should be installed onto the virtual machines. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: True ,
}
string ,
properties:
{
Description: Describes the properties of a Virtual Machine Scale Set Extension. ,
Required: True ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: True ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
string ,
forceUpdateTag:
{
Description: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
provisionAfterExtensions:
{
Description: Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
setupOrder:
{
Description: Indicates the setup order for the extension. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
vmManagedIdentity:
{
Description: Identities to assign to the virtual machine scale set under the node type. ,
Required: False ,
}
{
userAssignedIdentities:
{
Description: The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
string ,
]
,
}
,
isStateless:
{
Description: Indicates if the node type can only host Stateless workloads. ,
Required: False ,
}
boolean ,
multiplePlacementGroups:
{
Description: Indicates if scale set associated with the node type can be composed of multiple placement groups. ,
Required: False ,
}
boolean ,
frontendConfigurations:
{
Description: Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created. ,
Required: False ,
}
[
{
ipAddressType:
{
Description: The IP address type of this frontend configuration. If omitted the default value is IPv4. ,
Enum:
{
IPv4: IPv4 address type. ,
IPv6: IPv6 address type. ,
}
,
Required: False ,
}
enum ,
loadBalancerBackendAddressPoolId:
{
Description: The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
loadBalancerInboundNatPoolId:
{
Description: The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
applicationGatewayBackendAddressPoolId:
{
Description: The resource Id of application gateway backend address pool. The format of the resource Id is '/subscriptions//resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}'. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRules:
{
Description: The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations. ,
Required: False ,
}
[
{
name:
{
Description: Network security rule name. ,
Required: True ,
}
string ,
description:
{
Description: Network security rule description. ,
Required: False ,
}
string ,
protocol:
{
Description: Network protocol this rule applies to. ,
Enum:
{
http: Protocol applies to HTTP. ,
https: Protocol applies to HTTPS. ,
tcp: Protocol applies to TCP. ,
udp: Protocol applies to UDP. ,
icmp: Protocol applies to ICMP. ,
ah: Protocol applies to AH. ,
esp: Protocol applies to ESP. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefixes:
{
Description: The CIDR or source IP ranges. ,
Required: False ,
}
[
string ,
]
,
destinationAddressPrefixes:
{
Description: The destination address prefixes. CIDR or destination IP ranges. ,
Required: False ,
}
[
string ,
]
,
sourcePortRanges:
{
Description: The source port ranges. ,
Required: False ,
}
[
string ,
]
,
destinationPortRanges:
{
Description: The destination port ranges. ,
Required: False ,
}
[
string ,
]
,
sourceAddressPrefix:
{
Description: The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ,
Required: False ,
}
string ,
destinationAddressPrefix:
{
Description: The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. ,
Required: False ,
}
string ,
sourcePortRange:
{
Description: The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
destinationPortRange:
{
Description: he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. ,
Required: False ,
}
string ,
access:
{
Description: The network traffic is allowed or denied. ,
Enum:
{
allow: The network traffic is allowed. ,
deny: The network traffic is denied. ,
}
,
Required: True ,
}
enum ,
priority:
{
Description: The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. ,
Format: int32 ,
Required: True ,
}
integer ,
direction:
{
Description: Network security rule direction. ,
Enum:
{
inbound: Inbound direction. ,
outbound: Outbound direction. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
additionalDataDisks:
{
Description: Additional managed data disks. ,
Required: False ,
}
[
{
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. Lun 0 is reserved for the service fabric data disk. ,
Format: int32 ,
Required: True ,
}
integer ,
diskSizeGB:
{
Description: Disk size for each vm in the node type in GBs. ,
Format: int32 ,
Required: True ,
}
integer ,
diskType:
{
Description: Managed data disk type. Specifies the storage account type for the managed disk ,
Enum:
{
Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. ,
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test. ,
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads. ,
PremiumV2_LRS: Premium SSD V2 locally redundant storage. Best for production and performance sensitive workloads that consistently require low latency and high IOPS and throughput. ,
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures. ,
Premium_ZRS: Premium SSD zone redundant storage. Best for production workloads that need storage resiliency against zone failures. ,
}
,
Required: True ,
}
enum ,
diskLetter:
{
Description: Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. ,
Required: True ,
}
string ,
}
,
]
,
enableEncryptionAtHost:
{
Description: Enable or disable the Host Encryption for the virtual machines on the node type. This will enable the encryption for all the disks including Resource/Temp disk at host itself. Default: The Encryption at host will be disabled unless this property is set to true for the resource. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state of the node type resource. ,
Enum:
{
None: The resource does not have a provisioning state. ,
Creating: The resource is being created. ,
Created: The resource is created. ,
Updating: The resource is being updated. ,
Succeeded: The resource provisioning has succeeded. ,
Failed: The resource provisioning has failed. ,
Canceled: The resource provisioning has been canceled. ,
Deleting: The resource is being deleted. ,
Deleted: The resource has been deleted. ,
Other: The resource provisioning state is a state other than the previously specified states. ,
}
,
Required: False ,
}
enum ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
useDefaultPublicLoadBalancer:
{
Description: Specifies whether the use public load balancer. If not specified and the node type doesn't have its own frontend configuration, it will be attached to the default load balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is true, then the frontend has to be an Internal Load Balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is false or not set, then the custom load balancer must include a public load balancer to provide outbound connectivity. ,
Required: False ,
}
boolean ,
useTempDataDisk:
{
Description: Specifies whether to use the temporary disk for the service fabric data root, in which case no managed data disk will be attached and the temporary disk will be used. It is only allowed for stateless node types. ,
Required: False ,
}
boolean ,
enableOverProvisioning:
{
Description: Specifies whether the node type should be overprovisioned. It is only allowed for stateless node types. ,
Required: False ,
}
boolean ,
zones:
{
Description: Specifies the availability zones where the node type would span across. If the cluster is not spanning across availability zones, initiates az migration for the cluster. ,
Required: False ,
}
[
string ,
]
,
isSpotVM:
{
Description: Indicates whether the node type will be Spot Virtual Machines. Azure will allocate the VMs if there is capacity available and the VMs can be evicted at any time. ,
Required: False ,
}
boolean ,
hostGroupId:
{
Description: Specifies the full host group resource Id. This property is used for deploying on azure dedicated hosts. ,
Required: False ,
}
string ,
useEphemeralOSDisk:
{
Description: Indicates whether to use ephemeral os disk. The sku selected on the vmSize property needs to support this feature. ,
Required: False ,
}
boolean ,
spotRestoreTimeout:
{
Description: Indicates the time duration after which the platform will not try to restore the VMSS SPOT instances specified as ISO 8601. ,
Required: False ,
}
string ,
evictionPolicy:
{
Description: Specifies the eviction policy for virtual machines in a SPOT node type. Default is Delete. ,
Enum:
{
Delete: Eviction policy will be Delete for SPOT vms. ,
Deallocate: Eviction policy will be Deallocate for SPOT vms. ,
}
,
Required: False ,
}
enum ,
vmImageResourceId:
{
Description: Indicates the resource id of the vm image. This parameter is used for custom vm image. ,
Format: arm-id ,
Required: False ,
}
string ,
subnetId:
{
Description: Indicates the resource id of the subnet for the node type. ,
Format: arm-id ,
Required: False ,
}
string ,
vmSetupActions:
{
Description: Specifies the actions to be performed on the vms before bootstrapping the service fabric runtime. ,
Required: False ,
}
[
string ,
]
,
securityType:
{
Description: Specifies the security type of the nodeType. Supported values include Standard, TrustedLaunch and ConfidentialVM. ,
Enum:
{
TrustedLaunch: Trusted Launch is a security type that secures generation 2 virtual machines. ,
Standard: Standard is the default security type for all machines. ,
ConfidentialVM: ConfidentialVM provides hardware-based encryption, trusted execution environment (TEE) and isolation of the VM memory & CPU from host. ,
}
,
Required: False ,
}
enum ,
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs. ,
Enum:
{
DiskWithVMGuestState: For encryption of the managed disk along with VMGuestState blob. ,
VMGuestStateOnly: For encryption of just the VMGuestState blob. ,
}
,
Required: False ,
}
enum ,
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch and ConfidentialVM SecurityType. ,
Required: False ,
}
boolean ,
enableNodePublicIP:
{
Description: Specifies whether each node is allocated its own public IPv4 address. This is only supported on secondary node types with custom Load Balancers. ,
Required: False ,
}
boolean ,
enableNodePublicIPv6:
{
Description: Specifies whether each node is allocated its own public IPv6 address. This is only supported on secondary node types with custom Load Balancers. ,
Required: False ,
}
boolean ,
vmSharedGalleryImageId:
{
Description: Indicates the resource id of the vm shared galleries image. This parameter is used for custom vm image. ,
Format: arm-id ,
Required: False ,
}
string ,
natGatewayId:
{
Description: Specifies the resource id of a NAT Gateway to attach to the subnet of this node type. Node type must use custom load balancer. ,
Format: arm-id ,
Required: False ,
}
string ,
natConfigurations:
{
Description: Specifies the NAT configuration on default public Load Balancer for the node type. This is only supported for node types use the default public Load Balancer. ,
Required: False ,
}
[
{
backendPort:
{
Description: The internal port for the NAT configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
frontendPortRangeStart:
{
Description: The port range start for the external endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
frontendPortRangeEnd:
{
Description: The port range end for the external endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
vmImagePlan:
{
Description: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
product:
{
Description: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
}
,
serviceArtifactReferenceId:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. ,
Format: arm-id ,
Required: False ,
}
string ,
dscpConfigurationId:
{
Description: Specifies the resource id of the DSCP configuration to apply to the node type network interface. ,
Format: arm-id ,
Required: False ,
}
string ,
additionalNetworkInterfaceConfigurations:
{
Description: Specifies the settings for any additional secondary network interfaces to attach to the node type. ,
Required: False ,
}
[
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
enableAcceleratedNetworking:
{
Description: Specifies whether the network interface is accelerated networking-enabled. ,
Required: False ,
}
boolean ,
dscpConfiguration:
{
Description: Specifies the DSCP configuration to apply to the network interface. ,
Required: False ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
ipConfigurations:
{
Description: Specifies the IP configurations of the network interface. ,
Required: True ,
}
[
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
applicationGatewayBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of application gateways. A node type can reference backend address pools of multiple application gateways. Multiple node types cannot use the same application gateway. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerBackendAddressPools:
{
Description: Specifies an array of references to backend address pools of load balancers. A node type can reference backend address pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
loadBalancerInboundNatPools:
{
Description: Specifies an array of references to inbound Nat pools of the load balancers. A node type can reference inbound nat pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
]
,
subnet:
{
Description: Specifies the subnet of the network interface. ,
Required: False ,
}
{
id:
{
Description: Azure resource identifier. ,
Required: False ,
}
string ,
}
,
privateIPAddressVersion:
{
Description: Specifies whether the IP configuration's private IP is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: The IP configuration's private IP is IPv4. ,
IPv6: The IP configuration's private IP is IPv6. ,
}
,
Required: False ,
}
enum ,
publicIPAddressConfiguration:
{
Description: The public IP address configuration of the network interface. ,
Required: False ,
}
{
name:
{
Description: Name of the network interface. ,
Required: True ,
}
string ,
ipTags:
{
Description: Specifies the list of IP tags associated with the public IP address. ,
Required: False ,
}
[
{
ipTagType:
{
Description: IP tag type. Example: FirstPartyUsage. ,
Required: True ,
}
string ,
tag:
{
Description: IP tag associated with the public IP. Example: SQL, Storage etc. ,
Required: True ,
}
string ,
}
,
]
,
publicIPAddressVersion:
{
Description: Specifies whether the IP configuration's public IP is IPv4 or IPv6. Default is IPv4. ,
Enum:
{
IPv4: The IP configuration's public IP is IPv4. ,
IPv6: The IP configuration's public IP is IPv6. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
]
,
computerNamePrefix:
{
Description: Specifies the computer name prefix. Limited to 9 characters. If specified, allows for a longer name to be specified for the node type name. ,
Required: False ,
}
string ,
vmApplications:
{
Description: Specifies the gallery applications that should be made available to the underlying VMSS. ,
Required: False ,
}
[
{
configurationReference:
{
Description: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided. ,
Format: uri ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the underlying VMSS. ,
Required: False ,
}
boolean ,
order:
{
Description: Optional, Specifies the order in which the packages have to be installed. ,
Format: int32 ,
Required: False ,
}
integer ,
packageReferenceId:
{
Description: Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}. ,
Format: arm-id ,
Required: True ,
}
string ,
vmGalleryTags:
{
Description: Optional, Specifies a passthrough value for more generic context. Accepts a JSON-formatted string e.g. '{"Tag1":"Value1","Tag2":"Value2"}'. ,
Required: False ,
}
string ,
treatFailureAsDeploymentFailure:
{
Description: Optional, If true, any failure for any operation in the VmApplication will fail the deployment. ,
Required: False ,
}
boolean ,
}
,
]
,
zoneBalance:
{
Description: Setting this to true allows stateless node types to scale out without equal distribution across zones. ,
Required: False ,
}
boolean ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
sku:
{
Description: The node type sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. Name is internally generated and is used in auto-scale scenarios. Property does not allow to be changed to other values than generated. To avoid deployment errors please omit the property. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the node type. Possible Values: **Standard** ,
Required: False ,
}
string ,
capacity:
{
Description: The number of nodes in the node type. If present in request it will override properties.vmInstanceCount. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}