{"openapi":"3.0.0","info":{"description":"Azure Service Fabric Resource Provider API Client","title":"ServiceFabricManagementClient","version":"2019-03-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2019-03-01-preview/cluster.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"servicefabric-cluster","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.ServiceFabric/operations":{"get":{"description":"Get the list of available Service Fabric resource provider API operations.","operationId":"Operations_List","parameters":[{"description":"The version of the Service Fabric resource provider API","in":"query","name":"api-version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationListResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}},"summary":"Lists all of the available Service Fabric resource provider API operations.","tags":["Operations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/clusters":{"get":{"description":"Gets all Service Fabric cluster resources created or in the process of being created in the subscription.","operationId":"Clusters_List","parameters":[{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"}],"responses":{"200":{"description":"The operation completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterListResult"},"examples":{"List clusters":{"$ref":"#/components/examples/List_clusters"}}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}},"summary":"Gets the list of Service Fabric cluster resources created in the specified subscription.","tags":["Cluster"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions":{"get":{"description":"Gets all available code versions for Service Fabric cluster resources by location.","operationId":"ClusterVersions_List","parameters":[{"$ref":"#/components/parameters/locationForClusterCodeVersions"},{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"}],"responses":{"200":{"description":"The operation completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterCodeVersionsListResult"},"examples":{"List cluster versions":{"$ref":"#/components/examples/List_cluster_versions"}}}}}},"summary":"Gets the list of Service Fabric cluster code versions available for the specified location.","tags":["ClusterVersion"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions/{clusterVersion}":{"get":{"description":"Gets information about an available Service Fabric cluster code version.","operationId":"ClusterVersions_Get","parameters":[{"$ref":"#/components/parameters/locationForClusterCodeVersions"},{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/clusterVersion"}],"responses":{"200":{"description":"The operation completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterCodeVersionsListResult"},"examples":{"Get cluster version":{"$ref":"#/components/examples/Get_cluster_version"}}}}}},"summary":"Gets information about a Service Fabric cluster code version available in the specified location.","tags":["ClusterVersion"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions":{"get":{"description":"Gets all available code versions for Service Fabric cluster resources by environment.","operationId":"ClusterVersions_ListByEnvironment","parameters":[{"$ref":"#/components/parameters/locationForClusterCodeVersions"},{"$ref":"#/components/parameters/environment"},{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"}],"responses":{"200":{"description":"The operation completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterCodeVersionsListResult"},"examples":{"List cluster versions by environment":{"$ref":"#/components/examples/List_cluster_versions_by_environment"}}}}}},"summary":"Gets the list of Service Fabric cluster code versions available for the specified environment.","tags":["ClusterVersion"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions/{clusterVersion}":{"get":{"description":"Gets information about an available Service Fabric cluster code version by environment.","operationId":"ClusterVersions_GetByEnvironment","parameters":[{"$ref":"#/components/parameters/locationForClusterCodeVersions"},{"$ref":"#/components/parameters/environment"},{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/clusterVersion"}],"responses":{"200":{"description":"The operation completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterCodeVersionsListResult"},"examples":{"Get cluster version by environment":{"$ref":"#/components/examples/Get_cluster_version_by_environment"}}}}}},"summary":"Gets information about a Service Fabric cluster code version available for the specified environment.","tags":["ClusterVersion"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}":{"delete":{"description":"Delete a Service Fabric cluster resource with the specified name.","operationId":"Clusters_Delete","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/clusterNameParameter"},{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"}],"responses":{"200":{"description":"The operation completed successfully."},"204":{"description":"The resource was not found."},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}},"summary":"Deletes a Service Fabric cluster resource.","tags":["Cluster"]},"get":{"description":"Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.","operationId":"Clusters_Get","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/clusterNameParameter"},{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"}],"responses":{"200":{"description":"The operation completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cluster"},"examples":{"Get a cluster":{"$ref":"#/components/examples/Get_a_cluster"}}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}},"summary":"Gets a Service Fabric cluster resource.","tags":["Cluster"]},"patch":{"description":"Update the configuration of a Service Fabric cluster resource with the specified name.","operationId":"Clusters_Update","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/clusterNameParameter"},{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterUpdateParameters"}}},"description":"The parameters which contains the property value and property name which used to update the cluster configuration.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"The operation completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cluster"},"examples":{"Patch a cluster":{"$ref":"#/components/examples/Patch_a_cluster"}}}}},"202":{"description":"The request was accepted and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cluster"},"examples":{"Patch a cluster":{"$ref":"#/components/examples/Patch_a_cluster"}}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}},"summary":"Updates the configuration of a Service Fabric cluster resource.","tags":["Cluster"],"x-ms-long-running-operation":true},"put":{"description":"Create or update a Service Fabric cluster resource with the specified name.","operationId":"Clusters_Create","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/clusterNameParameter"},{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cluster"}}},"description":"The cluster resource.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"The operation completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cluster"},"examples":{"Put a cluster with maximum parameters":{"$ref":"#/components/examples/Put_a_cluster_with_maximum_parameters"},"Put a cluster with minimum parameters":{"$ref":"#/components/examples/Put_a_cluster_with_minimum_parameters"}}}}},"202":{"description":"The request was accepted and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cluster"},"examples":{"Put a cluster with maximum parameters":{"$ref":"#/components/examples/Put_a_cluster_with_maximum_parameters"},"Put a cluster with minimum parameters":{"$ref":"#/components/examples/Put_a_cluster_with_minimum_parameters"}}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}},"summary":"Creates or updates a Service Fabric cluster resource.","tags":["Cluster"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters":{"get":{"description":"Gets all Service Fabric cluster resources created or in the process of being created in the resource group.","operationId":"Clusters_ListByResourceGroup","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/subscriptionId"}],"responses":{"200":{"description":"The operation completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterListResult"},"examples":{"List cluster by resource group":{"$ref":"#/components/examples/List_cluster_by_resource_group"}}}}},"default":{"description":"The detailed error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}}},"summary":"Gets the list of Service Fabric cluster resources created in the specified resource group.","tags":["Cluster"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_clusters":{"value":{"nextLink":"","value":[{"etag":"W/\"636462502169240745\"","id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster","location":"eastus","name":"myCluster","properties":{"addOnFeatures":["RepairManager","DnsService","BackupRestoreService","ResourceMonitorService"],"availableClusterVersions":[{"codeVersion":"6.1.480.9494","environment":"Windows","supportExpiryUtc":"2018-06-15T23:59:59.9999999"}],"azureActiveDirectory":{"clientApplication":"d151ad89-4bce-4ae8-b3d1-1dc79679fa75","clusterApplication":"5886372e-7bf4-4878-a497-8098aba608ae","tenantId":"6abcc6a0-8666-43f1-87b8-172cf86a9f9c"},"certificateCommonNames":{"commonNames":[{"certificateCommonName":"abc.com","certificateIssuerThumbprint":"12599211F8F14C90AFA9532AD79A6F2CA1C00622"}],"x509StoreName":"My"},"clientCertificateCommonNames":[{"certificateCommonName":"abc.com","certificateIssuerThumbprint":"5F3660C715EBBDA31DB1FFDCF508302348DE8E7A","isAdmin":true}],"clientCertificateThumbprints":[{"certificateThumbprint":"5F3660C715EBBDA31DB1FFDCF508302348DE8E7A","isAdmin":false}],"clusterCodeVersion":"6.1.480.9494","clusterEndpoint":"https://eastus.servicefabric.azure.com","clusterId":"92584666-9889-4ae8-8d02-91902923d37f","clusterState":"WaitingForNodes","diagnosticsStorageAccountConfig":{"blobEndpoint":"https://diag.blob.core.windows.net/","protectedAccountKeyName":"StorageAccountKey1","queueEndpoint":"https://diag.queue.core.windows.net/","storageAccountName":"diag","tableEndpoint":"https://diag.table.core.windows.net/"},"fabricSettings":[{"name":"UpgradeService","parameters":[{"name":"AppPollIntervalInSeconds","value":"60"}]}],"managementEndpoint":"https://myCluster.eastus.cloudapp.azure.com:19080","nodeTypes":[{"applicationPorts":{"endPort":30000,"startPort":20000},"clientConnectionEndpointPort":19000,"durabilityLevel":"Bronze","ephemeralPorts":{"endPort":64000,"startPort":49000},"httpGatewayEndpointPort":19007,"isPrimary":true,"name":"nt1vm","vmInstanceCount":5}],"provisioningState":"Succeeded","reliabilityLevel":"Silver","reverseProxyCertificateCommonNames":{"commonNames":[{"certificateCommonName":"abc.com","certificateIssuerThumbprint":"12599211F8F14C90AFA9532AD79A6F2CA1C00622"}],"x509StoreName":"My"},"upgradeDescription":{"deltaHealthPolicy":{"applicationDeltaHealthPolicies":{"fabric:/myApp1":{"defaultServiceTypeDeltaHealthPolicy":{"maxPercentDeltaUnhealthyServices":0},"serviceTypeDeltaHealthPolicies":{"myServiceType1":{"maxPercentDeltaUnhealthyServices":0}}}},"maxPercentDeltaUnhealthyApplications":0,"maxPercentDeltaUnhealthyNodes":0,"maxPercentUpgradeDomainDeltaUnhealthyNodes":0},"forceRestart":false,"healthCheckRetryTimeout":"00:05:00","healthCheckStableDuration":"00:00:30","healthCheckWaitDuration":"00:00:30","healthPolicy":{"applicationHealthPolicies":{"fabric:/myApp1":{"defaultServiceTypeHealthPolicy":{"maxPercentUnhealthyServices":0},"serviceTypeHealthPolicies":{"myServiceType1":{"maxPercentUnhealthyServices":100}}}},"maxPercentUnhealthyApplications":0,"maxPercentUnhealthyNodes":0},"upgradeDomainTimeout":"00:15:00","upgradeReplicaSetCheckTimeout":"00:10:00","upgradeTimeout":"01:00:00"},"upgradeMode":"Manual","vmImage":"Windows"},"tags":{},"type":"Microsoft.ServiceFabric/clusters"},{"etag":"W/\"636462502164040075\"","id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster2","location":"eastus","name":"myCluster2","properties":{"addOnFeatures":["RepairManager"],"availableClusterVersions":[{"codeVersion":"6.1.187.1","environment":"Linux","supportExpiryUtc":"2018-06-15T23:59:59.9999999"}],"clientCertificateCommonNames":[],"clientCertificateThumbprints":[],"clusterCodeVersion":"6.1.187.1","clusterEndpoint":"https://eastus.servicefabric.azure.com","clusterId":"2747e469-b24e-4039-8a0a-46151419523f","clusterState":"WaitingForNodes","diagnosticsStorageAccountConfig":{"blobEndpoint":"https://diag.blob.core.windows.net/","protectedAccountKeyName":"StorageAccountKey1","queueEndpoint":"https://diag.queue.core.windows.net/","storageAccountName":"diag","tableEndpoint":"https://diag.table.core.windows.net/"},"fabricSettings":[{"name":"UpgradeService","parameters":[{"name":"AppPollIntervalInSeconds","value":"60"}]}],"managementEndpoint":"http://myCluster2.eastus.cloudapp.azure.com:19080","nodeTypes":[{"applicationPorts":{"endPort":30000,"startPort":20000},"clientConnectionEndpointPort":19000,"durabilityLevel":"Bronze","ephemeralPorts":{"endPort":64000,"startPort":49000},"httpGatewayEndpointPort":19007,"isPrimary":true,"name":"nt1vm","vmInstanceCount":5}],"provisioningState":"Succeeded","reliabilityLevel":"Silver","upgradeDescription":{"deltaHealthPolicy":{"maxPercentDeltaUnhealthyApplications":0,"maxPercentDeltaUnhealthyNodes":0,"maxPercentUpgradeDomainDeltaUnhealthyNodes":0},"forceRestart":false,"healthCheckRetryTimeout":"00:05:00","healthCheckStableDuration":"00:00:30","healthCheckWaitDuration":"00:00:30","healthPolicy":{"maxPercentUnhealthyApplications":0,"maxPercentUnhealthyNodes":0},"upgradeDomainTimeout":"00:15:00","upgradeReplicaSetCheckTimeout":"00:10:00","upgradeTimeout":"01:00:00"},"upgradeMode":"Manual","vmImage":"Ubuntu"},"tags":{},"type":"Microsoft.ServiceFabric/clusters"}]}},"List_cluster_versions":{"value":{"value":[{"id":"subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494","name":"6.1.480.9494","properties":{"codeVersion":"6.1.480.9494","environment":"Windows","supportExpiryUtc":"2018-06-15T23:59:59.9999999"},"type":"Microsoft.ServiceFabric/locations/environments/clusterVersions"},{"id":"subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Linux/clusterVersions/6.1.187.1","name":"6.1.187.1","properties":{"codeVersion":"6.1.187.1","environment":"Linux","supportExpiryUtc":"2018-06-15T23:59:59.9999999"},"type":"Microsoft.ServiceFabric/locations/environments/clusterVersions"}]}},"Get_cluster_version":{"value":{"value":[{"id":"subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494","name":"6.1.480.9494","properties":{"codeVersion":"6.1.480.9494","environment":"Windows","supportExpiryUtc":"2018-06-15T23:59:59.9999999"},"type":"Microsoft.ServiceFabric/locations/environments/clusterVersions"}]}},"List_cluster_versions_by_environment":{"value":{"value":[{"id":"subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494","name":"6.1.480.9494","properties":{"codeVersion":"6.1.480.9494","environment":"Windows","supportExpiryUtc":"2018-06-15T23:59:59.9999999"},"type":"Microsoft.ServiceFabric/locations/environments/clusterVersions"}]}},"Get_cluster_version_by_environment":{"value":{"value":[{"id":"subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494","name":"6.1.480.9494","properties":{"codeVersion":"6.1.480.9494","environment":"Windows","supportExpiryUtc":"2018-06-15T23:59:59.9999999"},"type":"Microsoft.ServiceFabric/locations/environments/clusterVersions"}]}},"Get_a_cluster":{"value":{"etag":"W/\"636462502169240745\"","id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster","location":"eastus","name":"myCluster","properties":{"addOnFeatures":["RepairManager","DnsService","BackupRestoreService","ResourceMonitorService"],"availableClusterVersions":[{"codeVersion":"6.1.480.9494","environment":"Windows","supportExpiryUtc":"2018-06-15T23:59:59.9999999"}],"azureActiveDirectory":{"clientApplication":"d151ad89-4bce-4ae8-b3d1-1dc79679fa75","clusterApplication":"5886372e-7bf4-4878-a497-8098aba608ae","tenantId":"6abcc6a0-8666-43f1-87b8-172cf86a9f9c"},"certificateCommonNames":{"commonNames":[{"certificateCommonName":"abc.com","certificateIssuerThumbprint":"12599211F8F14C90AFA9532AD79A6F2CA1C00622"}],"x509StoreName":"My"},"clientCertificateCommonNames":[{"certificateCommonName":"abc.com","certificateIssuerThumbprint":"5F3660C715EBBDA31DB1FFDCF508302348DE8E7A","isAdmin":true}],"clientCertificateThumbprints":[{"certificateThumbprint":"5F3660C715EBBDA31DB1FFDCF508302348DE8E7A","isAdmin":true}],"clusterCodeVersion":"6.1.480.9494","clusterEndpoint":"https://eastus.servicefabric.azure.com","clusterId":"92584666-9889-4ae8-8d02-91902923d37f","clusterState":"WaitingForNodes","diagnosticsStorageAccountConfig":{"blobEndpoint":"https://diag.blob.core.windows.net/","protectedAccountKeyName":"StorageAccountKey1","queueEndpoint":"https://diag.queue.core.windows.net/","storageAccountName":"diag","tableEndpoint":"https://diag.table.core.windows.net/"},"fabricSettings":[{"name":"UpgradeService","parameters":[{"name":"AppPollIntervalInSeconds","value":"60"}]}],"managementEndpoint":"https://myCluster.eastus.cloudapp.azure.com:19080","nodeTypes":[{"applicationPorts":{"endPort":30000,"startPort":20000},"clientConnectionEndpointPort":19000,"durabilityLevel":"Bronze","ephemeralPorts":{"endPort":64000,"startPort":49000},"httpGatewayEndpointPort":19007,"isPrimary":true,"name":"nt1vm","vmInstanceCount":5}],"provisioningState":"Succeeded","reliabilityLevel":"Silver","reverseProxyCertificateCommonNames":{"commonNames":[{"certificateCommonName":"abc.com","certificateIssuerThumbprint":"12599211F8F14C90AFA9532AD79A6F2CA1C00622"}],"x509StoreName":"My"},"upgradeDescription":{"deltaHealthPolicy":{"applicationDeltaHealthPolicies":{"fabric:/myApp1":{"defaultServiceTypeDeltaHealthPolicy":{"maxPercentDeltaUnhealthyServices":0},"serviceTypeDeltaHealthPolicies":{"myServiceType1":{"maxPercentDeltaUnhealthyServices":0}}}},"maxPercentDeltaUnhealthyApplications":0,"maxPercentDeltaUnhealthyNodes":0,"maxPercentUpgradeDomainDeltaUnhealthyNodes":0},"forceRestart":false,"healthCheckRetryTimeout":"00:05:00","healthCheckStableDuration":"00:00:30","healthCheckWaitDuration":"00:00:30","healthPolicy":{"applicationHealthPolicies":{"fabric:/myApp1":{"defaultServiceTypeHealthPolicy":{"maxPercentUnhealthyServices":0},"serviceTypeHealthPolicies":{"myServiceType1":{"maxPercentUnhealthyServices":100}}}},"maxPercentUnhealthyApplications":0,"maxPercentUnhealthyNodes":0},"upgradeDomainTimeout":"00:15:00","upgradeReplicaSetCheckTimeout":"00:10:00","upgradeTimeout":"01:00:00"},"upgradeMode":"Manual","vmImage":"Windows"},"tags":{},"type":"Microsoft.ServiceFabric/clusters"}},"Patch_a_cluster":{"value":{"etag":"W/\"636462502169240744\"","id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster","location":"eastus","name":"myCluster","properties":{"availableClusterVersions":[{"codeVersion":"6.1.480.9494","environment":"Windows","supportExpiryUtc":"2018-06-15T23:59:59.9999999"}],"certificateCommonNames":{"commonNames":[{"certificateCommonName":"abc.com","certificateIssuerThumbprint":"12599211F8F14C90AFA9532AD79A6F2CA1C00622"}],"x509StoreName":"My"},"clientCertificateCommonNames":[],"clientCertificateThumbprints":[],"clusterCodeVersion":"6.1.480.9494","clusterEndpoint":"https://eastus.servicefabric.azure.com","clusterId":"92584666-9889-4ae8-8d02-91902923d37f","clusterState":"WaitingForNodes","diagnosticsStorageAccountConfig":{"blobEndpoint":"https://diag.blob.core.windows.net/","protectedAccountKeyName":"StorageAccountKey1","queueEndpoint":"https://diag.queue.core.windows.net/","storageAccountName":"diag","tableEndpoint":"https://diag.table.core.windows.net/"},"eventStoreServiceEnabled":true,"fabricSettings":[{"name":"UpgradeService","parameters":[{"name":"AppPollIntervalInSeconds","value":"60"}]}],"managementEndpoint":"http://myCluster.eastus.cloudapp.azure.com:19080","nodeTypes":[{"applicationPorts":{"endPort":30000,"startPort":20000},"clientConnectionEndpointPort":19000,"durabilityLevel":"Bronze","ephemeralPorts":{"endPort":64000,"startPort":49000},"httpGatewayEndpointPort":19007,"isPrimary":true,"name":"nt1vm","vmInstanceCount":5},{"applicationPorts":{"endPort":2000,"startPort":1000},"clientConnectionEndpointPort":0,"durabilityLevel":"Bronze","ephemeralPorts":{"endPort":4000,"startPort":3000},"httpGatewayEndpointPort":0,"isPrimary":false,"name":"testnt1","vmInstanceCount":3}],"provisioningState":"Succeeded","reliabilityLevel":"Bronze","upgradeDescription":{"deltaHealthPolicy":{"maxPercentDeltaUnhealthyApplications":0,"maxPercentDeltaUnhealthyNodes":0,"maxPercentUpgradeDomainDeltaUnhealthyNodes":0},"forceRestart":false,"healthCheckRetryTimeout":"00:05:00","healthCheckStableDuration":"00:00:30","healthCheckWaitDuration":"00:00:30","healthPolicy":{"maxPercentUnhealthyApplications":0,"maxPercentUnhealthyNodes":0},"upgradeDomainTimeout":"00:15:00","upgradeReplicaSetCheckTimeout":"00:10:00","upgradeTimeout":"01:00:00"},"upgradeMode":"Automatic"},"tags":{"a":"b"},"type":"Microsoft.ServiceFabric/clusters"}},"Put_a_cluster_with_maximum_parameters":{"value":{"etag":"W/\"636462502169240745\"","id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster","location":"eastus","name":"myCluster","properties":{"addOnFeatures":["RepairManager","DnsService","BackupRestoreService","ResourceMonitorService"],"availableClusterVersions":[{"codeVersion":"6.1.480.9494","environment":"Windows","supportExpiryUtc":"2018-06-15T23:59:59.9999999"}],"azureActiveDirectory":{"clientApplication":"d151ad89-4bce-4ae8-b3d1-1dc79679fa75","clusterApplication":"5886372e-7bf4-4878-a497-8098aba608ae","tenantId":"6abcc6a0-8666-43f1-87b8-172cf86a9f9c"},"certificateCommonNames":{"commonNames":[{"certificateCommonName":"abc.com","certificateIssuerThumbprint":"12599211F8F14C90AFA9532AD79A6F2CA1C00622"}],"x509StoreName":"My"},"clientCertificateCommonNames":[{"certificateCommonName":"abc.com","certificateIssuerThumbprint":"5F3660C715EBBDA31DB1FFDCF508302348DE8E7A","isAdmin":true}],"clientCertificateThumbprints":[{"certificateThumbprint":"5F3660C715EBBDA31DB1FFDCF508302348DE8E7A","isAdmin":false}],"clusterCodeVersion":"6.1.480.9494","clusterEndpoint":"https://eastus.servicefabric.azure.com","clusterId":"92584666-9889-4ae8-8d02-91902923d37f","clusterState":"WaitingForNodes","diagnosticsStorageAccountConfig":{"blobEndpoint":"https://diag.blob.core.windows.net/","protectedAccountKeyName":"StorageAccountKey1","queueEndpoint":"https://diag.queue.core.windows.net/","storageAccountName":"diag","tableEndpoint":"https://diag.table.core.windows.net/"},"eventStoreServiceEnabled":true,"fabricSettings":[{"name":"UpgradeService","parameters":[{"name":"AppPollIntervalInSeconds","value":"60"}]}],"managementEndpoint":"https://myCluster.eastus.cloudapp.azure.com:19080","nodeTypes":[{"applicationPorts":{"endPort":30000,"startPort":20000},"clientConnectionEndpointPort":19000,"durabilityLevel":"Bronze","ephemeralPorts":{"endPort":64000,"startPort":49000},"httpGatewayEndpointPort":19007,"isPrimary":true,"name":"nt1vm","vmInstanceCount":5}],"provisioningState":"Succeeded","reliabilityLevel":"Silver","reverseProxyCertificateCommonNames":{"commonNames":[{"certificateCommonName":"abc.com","certificateIssuerThumbprint":"12599211F8F14C90AFA9532AD79A6F2CA1C00622"}],"x509StoreName":"My"},"upgradeDescription":{"deltaHealthPolicy":{"applicationDeltaHealthPolicies":{"fabric:/myApp1":{"defaultServiceTypeDeltaHealthPolicy":{"maxPercentDeltaUnhealthyServices":0},"serviceTypeDeltaHealthPolicies":{"myServiceType1":{"maxPercentDeltaUnhealthyServices":0}}}},"maxPercentDeltaUnhealthyApplications":0,"maxPercentDeltaUnhealthyNodes":0,"maxPercentUpgradeDomainDeltaUnhealthyNodes":0},"forceRestart":true,"healthCheckRetryTimeout":"00:05:00","healthCheckStableDuration":"00:00:30","healthCheckWaitDuration":"00:00:30","healthPolicy":{"applicationHealthPolicies":{"fabric:/myApp1":{"defaultServiceTypeHealthPolicy":{"maxPercentUnhealthyServices":0},"serviceTypeHealthPolicies":{"myServiceType1":{"maxPercentUnhealthyServices":100}}}},"maxPercentUnhealthyApplications":0,"maxPercentUnhealthyNodes":0},"upgradeDomainTimeout":"00:15:00","upgradeReplicaSetCheckTimeout":"00:10:00","upgradeTimeout":"00:15:00"},"upgradeMode":"Manual","vmImage":"Windows"},"tags":{},"type":"Microsoft.ServiceFabric/clusters"}},"Put_a_cluster_with_minimum_parameters":{"value":{"etag":"W/\"636462502169240743\"","id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster","location":"eastus","name":"myCluster","properties":{"availableClusterVersions":[{"codeVersion":"6.1.480.9494","environment":"Windows","supportExpiryUtc":"2018-06-15T23:59:59.9999999"}],"clientCertificateCommonNames":[],"clientCertificateThumbprints":[],"clusterCodeVersion":"6.1.480.9494","clusterEndpoint":"https://eastus.servicefabric.azure.com","clusterId":"92584666-9889-4ae8-8d02-91902923d37f","clusterState":"WaitingForNodes","diagnosticsStorageAccountConfig":{"blobEndpoint":"https://diag.blob.core.windows.net/","protectedAccountKeyName":"StorageAccountKey1","queueEndpoint":"https://diag.queue.core.windows.net/","storageAccountName":"diag","tableEndpoint":"https://diag.table.core.windows.net/"},"fabricSettings":[{"name":"UpgradeService","parameters":[{"name":"AppPollIntervalInSeconds","value":"60"}]}],"managementEndpoint":"http://myCluster.eastus.cloudapp.azure.com:19080","nodeTypes":[{"applicationPorts":{"endPort":30000,"startPort":20000},"clientConnectionEndpointPort":19000,"durabilityLevel":"Bronze","ephemeralPorts":{"endPort":64000,"startPort":49000},"httpGatewayEndpointPort":19007,"isPrimary":true,"name":"nt1vm","vmInstanceCount":5}],"provisioningState":"Succeeded","reliabilityLevel":"Silver","upgradeDescription":{"deltaHealthPolicy":{"maxPercentDeltaUnhealthyApplications":0,"maxPercentDeltaUnhealthyNodes":0,"maxPercentUpgradeDomainDeltaUnhealthyNodes":0},"forceRestart":false,"healthCheckRetryTimeout":"00:45:00","healthCheckStableDuration":"00:05:00","healthCheckWaitDuration":"00:05:00","healthPolicy":{"maxPercentUnhealthyApplications":100,"maxPercentUnhealthyNodes":100},"upgradeDomainTimeout":"02:00:00","upgradeReplicaSetCheckTimeout":"10675199.02:48:05.4775807","upgradeTimeout":"12:00:00"},"upgradeMode":"Automatic"},"tags":{},"type":"Microsoft.ServiceFabric/clusters"}},"List_cluster_by_resource_group":{"value":{"nextLink":"","value":[{"etag":"W/\"636462502169240745\"","id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster","location":"eastus","name":"myCluster","properties":{"addOnFeatures":["RepairManager","DnsService","BackupRestoreService","ResourceMonitorService"],"availableClusterVersions":[{"codeVersion":"6.1.480.9494","environment":"Windows","supportExpiryUtc":"2018-06-15T23:59:59.9999999"}],"azureActiveDirectory":{"clientApplication":"d151ad89-4bce-4ae8-b3d1-1dc79679fa75","clusterApplication":"5886372e-7bf4-4878-a497-8098aba608ae","tenantId":"6abcc6a0-8666-43f1-87b8-172cf86a9f9c"},"certificateCommonNames":{"commonNames":[{"certificateCommonName":"abc.com","certificateIssuerThumbprint":"12599211F8F14C90AFA9532AD79A6F2CA1C00622"}],"x509StoreName":"My"},"clientCertificateCommonNames":[{"certificateCommonName":"abc.com","certificateIssuerThumbprint":"5F3660C715EBBDA31DB1FFDCF508302348DE8E7A","isAdmin":true}],"clientCertificateThumbprints":[{"certificateThumbprint":"5F3660C715EBBDA31DB1FFDCF508302348DE8E7A","isAdmin":false}],"clusterCodeVersion":"6.1.480.9494","clusterEndpoint":"https://eastus.servicefabric.azure.com","clusterId":"92584666-9889-4ae8-8d02-91902923d37f","clusterState":"WaitingForNodes","diagnosticsStorageAccountConfig":{"blobEndpoint":"https://diag.blob.core.windows.net/","protectedAccountKeyName":"StorageAccountKey1","queueEndpoint":"https://diag.queue.core.windows.net/","storageAccountName":"diag","tableEndpoint":"https://diag.table.core.windows.net/"},"fabricSettings":[{"name":"UpgradeService","parameters":[{"name":"AppPollIntervalInSeconds","value":"60"}]}],"managementEndpoint":"https://myCluster.eastus.cloudapp.azure.com:19080","nodeTypes":[{"applicationPorts":{"endPort":30000,"startPort":20000},"clientConnectionEndpointPort":19000,"durabilityLevel":"Bronze","ephemeralPorts":{"endPort":64000,"startPort":49000},"httpGatewayEndpointPort":19007,"isPrimary":true,"name":"nt1vm","vmInstanceCount":5}],"provisioningState":"Succeeded","reliabilityLevel":"Silver","reverseProxyCertificateCommonNames":{"commonNames":[{"certificateCommonName":"abc.com","certificateIssuerThumbprint":"12599211F8F14C90AFA9532AD79A6F2CA1C00622"}],"x509StoreName":"My"},"upgradeDescription":{"deltaHealthPolicy":{"applicationDeltaHealthPolicies":{"fabric:/myApp1":{"defaultServiceTypeDeltaHealthPolicy":{"maxPercentDeltaUnhealthyServices":0},"serviceTypeDeltaHealthPolicies":{"myServiceType1":{"maxPercentDeltaUnhealthyServices":0}}}},"maxPercentDeltaUnhealthyApplications":0,"maxPercentDeltaUnhealthyNodes":0,"maxPercentUpgradeDomainDeltaUnhealthyNodes":0},"forceRestart":false,"healthCheckRetryTimeout":"00:05:00","healthCheckStableDuration":"00:00:30","healthCheckWaitDuration":"00:00:30","healthPolicy":{"applicationHealthPolicies":{"fabric:/myApp1":{"defaultServiceTypeHealthPolicy":{"maxPercentUnhealthyServices":0},"serviceTypeHealthPolicies":{"myServiceType1":{"maxPercentUnhealthyServices":100}}}},"maxPercentUnhealthyApplications":0,"maxPercentUnhealthyNodes":0},"upgradeDomainTimeout":"00:15:00","upgradeReplicaSetCheckTimeout":"00:10:00","upgradeTimeout":"01:00:00"},"upgradeMode":"Manual","vmImage":"Windows"},"tags":{},"type":"Microsoft.ServiceFabric/clusters"},{"etag":"W/\"636462502164040075\"","id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster2","location":"eastus","name":"myCluster2","properties":{"addOnFeatures":["RepairManager"],"availableClusterVersions":[{"codeVersion":"6.1.187.1","environment":"Linux","supportExpiryUtc":"2018-06-15T23:59:59.9999999"}],"clientCertificateCommonNames":[],"clientCertificateThumbprints":[],"clusterCodeVersion":"6.1.187.1","clusterEndpoint":"https://eastus.servicefabric.azure.com","clusterId":"2747e469-b24e-4039-8a0a-46151419523f","clusterState":"WaitingForNodes","diagnosticsStorageAccountConfig":{"blobEndpoint":"https://diag.blob.core.windows.net/","protectedAccountKeyName":"StorageAccountKey1","queueEndpoint":"https://diag.queue.core.windows.net/","storageAccountName":"diag","tableEndpoint":"https://diag.table.core.windows.net/"},"fabricSettings":[{"name":"UpgradeService","parameters":[{"name":"AppPollIntervalInSeconds","value":"60"}]}],"managementEndpoint":"http://myCluster2.eastus.cloudapp.azure.com:19080","nodeTypes":[{"applicationPorts":{"endPort":30000,"startPort":20000},"clientConnectionEndpointPort":19000,"durabilityLevel":"Bronze","ephemeralPorts":{"endPort":64000,"startPort":49000},"httpGatewayEndpointPort":19007,"isPrimary":true,"name":"nt1vm","vmInstanceCount":5}],"provisioningState":"Succeeded","reliabilityLevel":"Silver","upgradeDescription":{"deltaHealthPolicy":{"maxPercentDeltaUnhealthyApplications":0,"maxPercentDeltaUnhealthyNodes":0,"maxPercentUpgradeDomainDeltaUnhealthyNodes":0},"forceRestart":false,"healthCheckRetryTimeout":"00:05:00","healthCheckStableDuration":"00:00:30","healthCheckWaitDuration":"00:00:30","healthPolicy":{"maxPercentUnhealthyApplications":0,"maxPercentUnhealthyNodes":0},"upgradeDomainTimeout":"00:15:00","upgradeReplicaSetCheckTimeout":"00:10:00","upgradeTimeout":"01:00:00"},"upgradeMode":"Manual","vmImage":"Ubuntu"},"tags":{},"type":"Microsoft.ServiceFabric/clusters"}]}}},"parameters":{"api-version":{"description":"The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2019-03-01-preview\" for this specification.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string","enum":["2019-03-01-preview"],"default":"2019-03-01-preview"},"examples":{"List clusters":{"value":"2019-03-01-preview"},"List cluster versions":{"value":"2019-03-01-preview"},"Get cluster version":{"value":"2019-03-01-preview"},"List cluster versions by environment":{"value":"2019-03-01-preview"},"Get cluster version by environment":{"value":"2019-03-01-preview"},"Delete a cluster":{"value":"2019-03-01-preview"},"Get a cluster":{"value":"2019-03-01-preview"},"Patch a cluster":{"value":"2019-03-01-preview"},"Put a cluster with maximum parameters":{"value":"2019-03-01-preview"},"Put a cluster with minimum parameters":{"value":"2019-03-01-preview"},"List cluster by resource group":{"value":"2019-03-01-preview"}}},"clusterNameParameter":{"description":"The name of the cluster resource.","in":"path","name":"clusterName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Delete a cluster":{"value":"myCluster"},"Get a cluster":{"value":"myCluster"},"Patch a cluster":{"value":"myCluster"},"Put a cluster with maximum parameters":{"value":"myCluster"},"Put a cluster with minimum parameters":{"value":"myCluster"}}},"clusterVersion":{"description":"The cluster code version.","in":"path","name":"clusterVersion","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get cluster version":{"value":"6.1.480.9494"},"Get cluster version by environment":{"value":"6.1.480.9494"}}},"environment":{"description":"The operating system of the cluster. The default means all.","in":"path","name":"environment","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","enum":["Windows","Linux"]},"examples":{"List cluster versions by environment":{"value":"Windows"},"Get cluster version by environment":{"value":"Windows"}}},"locationForClusterCodeVersions":{"description":"The location for the cluster code versions. This is different from cluster location.","in":"path","name":"location","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"List cluster versions":{"value":"eastus"},"Get cluster version":{"value":"eastus"},"List cluster versions by environment":{"value":"eastus"},"Get cluster version by environment":{"value":"eastus"}}},"resourceGroupNameParameter":{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Delete a cluster":{"value":"resRg"},"Get a cluster":{"value":"resRg"},"Patch a cluster":{"value":"resRg"},"Put a cluster with maximum parameters":{"value":"resRg"},"Put a cluster with minimum parameters":{"value":"resRg"},"List cluster by resource group":{"value":"resRg"}}},"subscriptionId":{"description":"The customer subscription identifier.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"List clusters":{"value":"00000000-0000-0000-0000-000000000000"},"List cluster versions":{"value":"00000000-0000-0000-0000-000000000000"},"Get cluster version":{"value":"00000000-0000-0000-0000-000000000000"},"List cluster versions by environment":{"value":"00000000-0000-0000-0000-000000000000"},"Get cluster version by environment":{"value":"00000000-0000-0000-0000-000000000000"},"Delete a cluster":{"value":"00000000-0000-0000-0000-000000000000"},"Get a cluster":{"value":"00000000-0000-0000-0000-000000000000"},"Patch a cluster":{"value":"00000000-0000-0000-0000-000000000000"},"Put a cluster with maximum parameters":{"value":"00000000-0000-0000-0000-000000000000"},"Put a cluster with minimum parameters":{"value":"00000000-0000-0000-0000-000000000000"},"List cluster by resource group":{"value":"00000000-0000-0000-0000-000000000000"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"AddOnFeatures":{"description":"Available cluster add-on features","enum":["RepairManager","DnsService","BackupRestoreService","ResourceMonitorService"],"type":"string"},"ApplicationDeltaHealthPolicy":{"description":"Defines a delta health policy used to evaluate the health of an application or one of its child entities when upgrading the cluster.\n","properties":{"defaultServiceTypeDeltaHealthPolicy":{"$ref":"#/components/schemas/ServiceTypeDeltaHealthPolicy"},"serviceTypeDeltaHealthPolicies":{"$ref":"#/components/schemas/ServiceTypeDeltaHealthPolicyMap"}},"type":"object"},"ApplicationDeltaHealthPolicyMap":{"additionalProperties":{"$ref":"#/components/schemas/ApplicationDeltaHealthPolicy"},"description":"Defines a map that contains specific application delta health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationDeltaHealthPolicy used to evaluate the application health when upgrading the cluster.\nThe application name should include the 'fabric:' URI scheme.\nThe map is empty by default.\n","type":"object"},"ApplicationHealthPolicy":{"description":"Defines a health policy used to evaluate the health of an application or one of its children entities.\n","properties":{"defaultServiceTypeHealthPolicy":{"$ref":"#/components/schemas/ServiceTypeHealthPolicy"},"serviceTypeHealthPolicies":{"$ref":"#/components/schemas/ServiceTypeHealthPolicyMap"}},"type":"object"},"ApplicationHealthPolicyMap":{"additionalProperties":{"$ref":"#/components/schemas/ApplicationHealthPolicy"},"description":"Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nThe application name should include the 'fabric:' URI scheme.\nThe map is empty by default.\n","type":"object"},"AvailableOperationDisplay":{"description":"Operation supported by the Service Fabric resource provider","properties":{"description":{"description":"Operation description","type":"string"},"operation":{"description":"The operation that can be performed.","type":"string"},"provider":{"description":"The name of the provider.","type":"string"},"resource":{"description":"The resource on which the operation is performed","type":"string"}}},"AzureActiveDirectory":{"description":"The settings to enable AAD authentication on the cluster.","properties":{"clientApplication":{"description":"Azure active directory client application id.","type":"string"},"clusterApplication":{"description":"Azure active directory cluster application id.","type":"string"},"tenantId":{"description":"Azure active directory tenant id.","type":"string"}}},"CertificateDescription":{"description":"Describes the certificate details.","properties":{"thumbprint":{"description":"Thumbprint of the primary certificate.","type":"string"},"thumbprintSecondary":{"description":"Thumbprint of the secondary certificate.","type":"string"},"x509StoreName":{"$ref":"#/components/schemas/StoreName"}},"required":["thumbprint"]},"ClientCertificateCommonName":{"description":"Describes the client certificate details using common name.","properties":{"certificateCommonName":{"description":"The common name of the client certificate.","type":"string"},"certificateIssuerThumbprint":{"description":"The issuer thumbprint of the client certificate.","type":"string"},"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.","type":"boolean"}},"required":["certificateCommonName","isAdmin","certificateIssuerThumbprint"]},"ClientCertificateThumbprint":{"description":"Describes the client certificate details using thumbprint.","properties":{"certificateThumbprint":{"description":"The thumbprint of the client certificate.","type":"string"},"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.","type":"boolean"}},"required":["certificateThumbprint","isAdmin"]},"Cluster":{"allOf":[{"description":"The cluster resource properties"},{"$ref":"#/components/schemas/Resource"},{"properties":{"properties":{"$ref":"#/components/schemas/ClusterProperties"}},"type":"object"}],"description":"The cluster resource\n","type":"object"},"ClusterCodeVersionsListResult":{"description":"The list results of the Service Fabric runtime versions.","properties":{"nextLink":{"description":"The URL to use for getting the next set of results.","type":"string"},"value":{"items":{"$ref":"#/components/schemas/ClusterCodeVersionsResult"},"type":"array"}}},"ClusterCodeVersionsResult":{"description":"The result of the Service Fabric runtime versions","properties":{"id":{"description":"The identification of the result","type":"string"},"name":{"description":"The name of the result","type":"string"},"properties":{"$ref":"#/components/schemas/ClusterVersionDetails"},"type":{"description":"The result resource type","type":"string"}}},"ClusterEnvironment":{"description":"Cluster operating system, the default will be Windows","enum":["Windows","Linux"],"type":"string"},"ClusterHealthPolicy":{"description":"Defines a health policy used to evaluate the health of the cluster or of a cluster node.\n","properties":{"applicationHealthPolicies":{"$ref":"#/components/schemas/ApplicationHealthPolicyMap"},"maxPercentUnhealthyApplications":{"default":0,"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.\n","maximum":100,"minimum":0,"type":"integer"},"maxPercentUnhealthyNodes":{"default":0,"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.\n","maximum":100,"minimum":0,"type":"integer"}},"type":"object"},"ClusterListResult":{"description":"Cluster list results","properties":{"nextLink":{"description":"The URL to use for getting the next set of results.","type":"string"},"value":{"items":{"$ref":"#/components/schemas/Cluster"},"type":"array"}}},"ClusterProperties":{"description":"Describes the cluster resource properties.","properties":{"addOnFeatures":{"description":"The list of add-on features to enable in the cluster.","items":{"$ref":"#/components/schemas/AddOnFeatures"},"type":"array"},"availableClusterVersions":{"description":"The Service Fabric runtime versions available for this cluster.","items":{"$ref":"#/components/schemas/ClusterVersionDetails"},"readOnly":true,"type":"array"},"azureActiveDirectory":{"$ref":"#/components/schemas/AzureActiveDirectory"},"certificate":{"$ref":"#/components/schemas/CertificateDescription"},"certificateCommonNames":{"$ref":"#/components/schemas/ServerCertificateCommonNames"},"clientCertificateCommonNames":{"description":"The list of client certificates referenced by common name that are allowed to manage the cluster.","items":{"$ref":"#/components/schemas/ClientCertificateCommonName"},"type":"array"},"clientCertificateThumbprints":{"description":"The list of client certificates referenced by thumbprint that are allowed to manage the cluster.","items":{"$ref":"#/components/schemas/ClientCertificateThumbprint"},"type":"array"},"clusterCodeVersion":{"description":"The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** 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**.","type":"string"},"clusterEndpoint":{"description":"The Azure Resource Provider endpoint. A system service in the cluster connects to this  endpoint.","readOnly":true,"type":"string"},"clusterId":{"description":"A service generated unique identifier for the cluster resource.","readOnly":true,"type":"string"},"clusterState":{"$ref":"#/components/schemas/ClusterState"},"diagnosticsStorageAccountConfig":{"$ref":"#/components/schemas/DiagnosticsStorageAccountConfig"},"eventStoreServiceEnabled":{"description":"Indicates if the event store service is enabled.","type":"boolean"},"fabricSettings":{"description":"The list of custom fabric settings to configure the cluster.","items":{"$ref":"#/components/schemas/SettingsSectionDescription"},"type":"array"},"managementEndpoint":{"description":"The http management endpoint of the cluster.","type":"string"},"nodeTypes":{"description":"The list of node types in the cluster.","items":{"$ref":"#/components/schemas/NodeTypeDescription"},"type":"array"},"provisioningState":{"description":"The provisioning state of the cluster resource.","enum":["Updating","Succeeded","Failed","Canceled"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"ProvisioningState"}},"reliabilityLevel":{"$ref":"#/components/schemas/ReliabilityLevel"},"reverseProxyCertificate":{"$ref":"#/components/schemas/CertificateDescription"},"reverseProxyCertificateCommonNames":{"$ref":"#/components/schemas/ServerCertificateCommonNames"},"upgradeDescription":{"$ref":"#/components/schemas/ClusterUpgradePolicy"},"upgradeMode":{"$ref":"#/components/schemas/UpgradeMode"},"vmImage":{"description":"The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used.","type":"string"}},"required":["managementEndpoint","nodeTypes"]},"ClusterPropertiesUpdateParameters":{"description":"Describes the cluster resource properties that can be updated during PATCH operation.","properties":{"addOnFeatures":{"description":"The list of add-on features to enable in the cluster.","items":{"$ref":"#/components/schemas/AddOnFeatures"},"type":"array"},"certificate":{"$ref":"#/components/schemas/CertificateDescription"},"certificateCommonNames":{"$ref":"#/components/schemas/ServerCertificateCommonNames"},"clientCertificateCommonNames":{"description":"The list of client certificates referenced by common name that are allowed to manage the cluster. This will overwrite the existing list.","items":{"$ref":"#/components/schemas/ClientCertificateCommonName"},"type":"array"},"clientCertificateThumbprints":{"description":"The list of client certificates referenced by thumbprint that are allowed to manage the cluster. This will overwrite the existing list.","items":{"$ref":"#/components/schemas/ClientCertificateThumbprint"},"type":"array"},"clusterCodeVersion":{"description":"The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** 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**.","type":"string"},"eventStoreServiceEnabled":{"description":"Indicates if the event store service is enabled.","type":"boolean"},"fabricSettings":{"description":"The list of custom fabric settings to configure the cluster. This will overwrite the existing list.","items":{"$ref":"#/components/schemas/SettingsSectionDescription"},"type":"array"},"nodeTypes":{"description":"The list of node types in the cluster. This will overwrite the existing list.","items":{"$ref":"#/components/schemas/NodeTypeDescription"},"type":"array"},"reliabilityLevel":{"$ref":"#/components/schemas/ReliabilityLevel"},"reverseProxyCertificate":{"$ref":"#/components/schemas/CertificateDescription"},"upgradeDescription":{"$ref":"#/components/schemas/ClusterUpgradePolicy"},"upgradeMode":{"$ref":"#/components/schemas/UpgradeMode"}}},"ClusterState":{"description":"The current state of the cluster.\n\n  - 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.\n  - 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.\n  - 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.\n  - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration.\n  - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate.\n  - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'.\n  - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version.\n  - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider.\n  - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted.\n  - Ready - Indicates that the cluster is in a stable state.\n","enum":["WaitingForNodes","Deploying","BaselineUpgrade","UpdatingUserConfiguration","UpdatingUserCertificate","UpdatingInfrastructure","EnforcingClusterVersion","UpgradeServiceUnreachable","AutoScale","Ready"],"type":"string"},"ClusterUpdateParameters":{"description":"Cluster update request","properties":{"properties":{"$ref":"#/components/schemas/ClusterPropertiesUpdateParameters"},"tags":{"additionalProperties":{"type":"string"},"description":"Cluster update parameters","type":"object"}}},"ClusterUpgradeDeltaHealthPolicy":{"description":"Describes the delta health policies for the cluster upgrade.","properties":{"applicationDeltaHealthPolicies":{"$ref":"#/components/schemas/ApplicationDeltaHealthPolicyMap"},"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.\n","maximum":100,"minimum":0,"type":"integer"},"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.\n","maximum":100,"minimum":0,"type":"integer"},"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.\n","maximum":100,"minimum":0,"type":"integer"}},"required":["maxPercentDeltaUnhealthyApplications","maxPercentDeltaUnhealthyNodes","maxPercentUpgradeDomainDeltaUnhealthyNodes"]},"ClusterUpgradePolicy":{"description":"Describes the policy used when upgrading the cluster.","properties":{"deltaHealthPolicy":{"$ref":"#/components/schemas/ClusterUpgradeDeltaHealthPolicy"},"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).","type":"boolean"},"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.","type":"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.","type":"string"},"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.","type":"string"},"healthPolicy":{"$ref":"#/components/schemas/ClusterHealthPolicy"},"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.","type":"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.","type":"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.","type":"string"}},"required":["healthCheckRetryTimeout","healthCheckStableDuration","healthCheckWaitDuration","healthPolicy","upgradeDomainTimeout","upgradeReplicaSetCheckTimeout","upgradeTimeout"]},"ClusterVersionDetails":{"description":"The detail of the Service Fabric runtime version result","properties":{"codeVersion":{"description":"The Service Fabric runtime version of the cluster.","type":"string"},"environment":{"$ref":"#/components/schemas/ClusterEnvironment"},"supportExpiryUtc":{"description":"The date of expiry of support of the version.","type":"string"}}},"DiagnosticsStorageAccountConfig":{"description":"The storage account information for storing Service Fabric diagnostic logs.","properties":{"blobEndpoint":{"description":"The blob endpoint of the azure storage account.","type":"string"},"protectedAccountKeyName":{"description":"The protected diagnostics storage key name.","type":"string"},"queueEndpoint":{"description":"The queue endpoint of the azure storage account.","type":"string"},"storageAccountName":{"description":"The Azure storage account name.","type":"string"},"tableEndpoint":{"description":"The table endpoint of the azure storage account.","type":"string"}},"required":["blobEndpoint","protectedAccountKeyName","queueEndpoint","storageAccountName","tableEndpoint"]},"DurabilityLevel":{"description":"The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity).\n\n  - Bronze - No privileges. This is the default.\n  - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD.\n  - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc.\n","enum":["Bronze","Silver","Gold"],"type":"string"},"EndpointRangeDescription":{"description":"Port range details","properties":{"endPort":{"description":"End port of a range of ports","type":"integer"},"startPort":{"description":"Starting port of a range of ports","type":"integer"}},"required":["endPort","startPort"]},"ErrorModel":{"description":"The structure of the error.","properties":{"error":{"$ref":"#/components/schemas/ErrorModelError"}}},"ErrorModelError":{"description":"The error details.","properties":{"code":{"description":"The error code.","type":"string"},"message":{"description":"The error message.","type":"string"}}},"NodeTypeDescription":{"description":"Describes a node type in the cluster, each node type represents sub set of nodes in the cluster.","properties":{"applicationPorts":{"$ref":"#/components/schemas/EndpointRangeDescription"},"capacities":{"additionalProperties":{"description":"Capacity tag value","type":"string"},"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.","type":"object"},"clientConnectionEndpointPort":{"description":"The TCP cluster management endpoint port.","type":"integer"},"durabilityLevel":{"$ref":"#/components/schemas/DurabilityLevel"},"ephemeralPorts":{"$ref":"#/components/schemas/EndpointRangeDescription"},"httpGatewayEndpointPort":{"description":"The HTTP cluster management endpoint port.","type":"integer"},"isPrimary":{"description":"The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters.","type":"boolean"},"name":{"description":"The name of the node type.","type":"string"},"placementProperties":{"additionalProperties":{"description":"Placement tag value","type":"string"},"description":"The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.","type":"object"},"reverseProxyEndpointPort":{"description":"The endpoint used by reverse proxy.","type":"integer"},"vmInstanceCount":{"description":"The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource.","maximum":2147483647,"minimum":1,"type":"integer"}},"required":["clientConnectionEndpointPort","httpGatewayEndpointPort","isPrimary","name","vmInstanceCount"]},"OperationListResult":{"description":"Describes the result of the request to list Service Fabric resource provider operations.","properties":{"nextLink":{"description":"URL to get the next set of operation list results if there are any.","readOnly":true,"type":"string"},"value":{"description":"List of operations supported by the Service Fabric resource provider.","items":{"$ref":"#/components/schemas/OperationResult"},"type":"array"}}},"OperationResult":{"description":"Available operation list result","properties":{"display":{"$ref":"#/components/schemas/AvailableOperationDisplay"},"name":{"description":"The name of the operation.","type":"string"},"nextLink":{"description":"The URL to use for getting the next set of results.","type":"string"},"origin":{"description":"Origin result","type":"string"}}},"ReliabilityLevel":{"description":"The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity).\n\n  - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.\n  - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.\n  - Silver - Run the System services with a target replica set count of 5.\n  - Gold - Run the System services with a target replica set count of 7.\n  - Platinum - Run the System services with a target replica set count of 9.\n","enum":["None","Bronze","Silver","Gold","Platinum"],"type":"string"},"Resource":{"description":"The resource model definition.","properties":{"etag":{"description":"Azure resource etag.","readOnly":true,"type":"string"},"id":{"description":"Azure resource identifier.","readOnly":true,"type":"string"},"location":{"description":"Azure resource location.","type":"string","x-ms-mutability":["create","read"]},"name":{"description":"Azure resource name.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"Azure resource tags.","type":"object"},"type":{"description":"Azure resource type.","readOnly":true,"type":"string"}},"required":["location"],"x-ms-azure-resource":true},"ServerCertificateCommonName":{"description":"Describes the server certificate details using common name.","properties":{"certificateCommonName":{"description":"The common name of the server certificate.","type":"string"},"certificateIssuerThumbprint":{"description":"The issuer thumbprint of the server certificate.","type":"string"}},"required":["certificateCommonName","certificateIssuerThumbprint"]},"ServerCertificateCommonNames":{"description":"Describes a list of server certificates referenced by common name that are used to secure the cluster.","properties":{"commonNames":{"description":"The list of server certificates referenced by common name that are used to secure the cluster.","items":{"$ref":"#/components/schemas/ServerCertificateCommonName"},"type":"array"},"x509StoreName":{"$ref":"#/components/schemas/StoreName"}}},"ServiceTypeDeltaHealthPolicy":{"description":"Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.\n","properties":{"maxPercentDeltaUnhealthyServices":{"default":0,"description":"The maximum allowed percentage of services health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the services at the beginning of upgrade and the state of the services 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.\n","maximum":100,"minimum":0,"type":"integer"}},"type":"object"},"ServiceTypeDeltaHealthPolicyMap":{"additionalProperties":{"$ref":"#/components/schemas/ServiceTypeDeltaHealthPolicy"},"description":"Defines a map that contains specific delta health policies for different service types.\nEach entry specifies as key the service type name and as value a ServiceTypeDeltaHealthPolicy used to evaluate the service health when upgrading the cluster.\nThe map is empty by default.\n","type":"object"},"ServiceTypeHealthPolicy":{"description":"Represents the health policy used to evaluate the health of services belonging to a service type.\n","properties":{"maxPercentUnhealthyServices":{"default":0,"description":"The maximum percentage of services allowed to be unhealthy before your application is considered in error.\n","maximum":100,"minimum":0,"type":"integer"}},"type":"object"},"ServiceTypeHealthPolicyMap":{"additionalProperties":{"$ref":"#/components/schemas/ServiceTypeHealthPolicy"},"description":"Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n","type":"object"},"SettingsParameterDescription":{"description":"Describes a parameter in fabric settings of the cluster.","properties":{"name":{"description":"The parameter name of fabric setting.","type":"string"},"value":{"description":"The parameter value of fabric setting.","type":"string"}},"required":["name","value"]},"SettingsSectionDescription":{"description":"Describes a section in the fabric settings of the cluster.","properties":{"name":{"description":"The section name of the fabric settings.","type":"string"},"parameters":{"description":"The collection of parameters in the section.","items":{"$ref":"#/components/schemas/SettingsParameterDescription"},"type":"array"}},"required":["name","parameters"]},"StoreName":{"description":"The local certificate store location.","enum":["AddressBook","AuthRoot","CertificateAuthority","Disallowed","My","Root","TrustedPeople","TrustedPublisher"],"type":"string"},"UpgradeMode":{"description":"The upgrade mode of the cluster when new Service Fabric runtime version is available.\n\n  - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.\n  - 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.\n","enum":["Automatic","Manual"],"type":"string"}}}}