{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/microsoft-azure-service-fabric/json-schema/microsoft-azure-service-fabric-managed-cluster-schema.json", "title": "ManagedCluster", "description": "The managed cluster resource", "x-generated": "2026-11-05", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/microsoft-azure-service-fabric-managed-clusters-api-openapi.yml#/components/schemas/ManagedCluster", "type": "object", "properties": { "properties": { "$ref": "#/$defs/ManagedClusterProperties" }, "etag": { "type": "string", "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.\",", "readOnly": true }, "sku": { "$ref": "#/$defs/Sku" } }, "required": [ "sku" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" } ], "$defs": { "Access": { "type": "string", "description": "The network traffic is allowed or denied.", "enum": [ "allow", "deny" ], "x-ms-enum": { "name": "Access", "modelAsString": true, "values": [ { "name": "allow", "value": "allow", "description": "The network traffic is allowed." }, { "name": "deny", "value": "deny", "description": "The network traffic is denied." } ] } }, "ApplicationTypeVersionsCleanupPolicy": { "type": "object", "description": "The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3.", "properties": { "maxUnusedVersionsToKeep": { "type": "integer", "format": "int32", "description": "Number of unused versions per application type to keep.", "minimum": 0 } }, "required": [ "maxUnusedVersionsToKeep" ] }, "AutoGeneratedDomainNameLabelScope": { "type": "string", "description": "This enum is the entrypoint to using a certificate from a public CA for your cluster. This property was introduced to solve the\ndomain squatting problem with new domains. A domain name will be generated in the following format: {clustername}.{hash}.{regionname}.sfmcdomain.\nThe hash portion comes from Azure DNS' Deterministic Name Library. The library creates a hash using the cluster's Tenant, Subscription, Resource Group\nand Resource Name using the AutoGeneratedDomainNameLabelScope/reuse policy chosen.", "enum": [ "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", "NoReuse" ], "x-ms-enum": { "name": "AutoGeneratedDomainNameLabelScope", "modelAsString": true, "values": [ { "name": "TenantReuse", "value": "TenantReuse", "description": "TenantReuse allows for the same hash to be created if the resource is created in the same Tenant with the same resource name." }, { "name": "SubscriptionReuse", "value": "SubscriptionReuse", "description": "SubscriptionReuse allows for the same hash to be created if the resource is created in the same Subscription with the same resource name." }, { "name": "ResourceGroupReuse", "value": "ResourceGroupReuse", "description": "ResourceGroupReuse allows for the same hash to be created if the resource is created in the same Resource Group with the same resource name." }, { "name": "NoReuse", "value": "NoReuse", "description": "NoReuse will create a new hash regardless of the Subscription, Resource Group, Tenant and Resource name." } ] } }, "AzureActiveDirectory": { "type": "object", "description": "The settings to enable AAD authentication on the cluster.", "properties": { "tenantId": { "type": "string", "description": "Azure active directory tenant id." }, "clusterApplication": { "type": "string", "description": "Azure active directory cluster application id." }, "clientApplication": { "type": "string", "description": "Azure active directory client application id." } } }, "ClientCertificate": { "type": "object", "description": "Client certificate definition.", "properties": { "isAdmin": { "type": "boolean", "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." }, "thumbprint": { "type": "string", "description": "Certificate thumbprint." }, "commonName": { "type": "string", "description": "Certificate common name." }, "issuerThumbprint": { "type": "string", "description": "Issuer thumbprint for the certificate. Only used together with CommonName." } }, "required": [ "isAdmin" ] }, "ClusterHealthPolicy": { "type": "object", "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.", "properties": { "maxPercentUnhealthyNodes": { "type": "integer", "format": "int32", "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.", "default": 0, "minimum": 0, "maximum": 100 }, "maxPercentUnhealthyApplications": { "type": "integer", "format": "int32", "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.", "default": 0, "minimum": 0, "maximum": 100 } }, "required": [ "maxPercentUnhealthyNodes", "maxPercentUnhealthyApplications" ] }, "ClusterMonitoringPolicy": { "type": "object", "description": "Describes the monitoring policies for the cluster upgrade.", "properties": { "healthCheckWaitDuration": { "type": "string", "format": "duration-constant", "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." }, "healthCheckStableDuration": { "type": "string", "format": "duration-constant", "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." }, "healthCheckRetryTimeout": { "type": "string", "format": "duration-constant", "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." }, "upgradeTimeout": { "type": "string", "format": "duration-constant", "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." }, "upgradeDomainTimeout": { "type": "string", "format": "duration-constant", "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." } }, "required": [ "healthCheckWaitDuration", "healthCheckStableDuration", "healthCheckRetryTimeout", "upgradeTimeout", "upgradeDomainTimeout" ] }, "ClusterState": { "type": "string", "description": "The current state of the cluster.", "enum": [ "WaitingForNodes", "Deploying", "BaselineUpgrade", "Upgrading", "UpgradeFailed", "Ready" ], "x-ms-enum": { "name": "ClusterState", "modelAsString": true, "values": [ { "name": "WaitingForNodes", "value": "WaitingForNodes", "description": "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." }, { "name": "Deploying", "value": "Deploying", "description": "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." }, { "name": "BaselineUpgrade", "value": "BaselineUpgrade", "description": "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." }, { "name": "Upgrading", "value": "Upgrading", "description": "Indicates that the cluster is being upgraded with the user provided configuration." }, { "name": "UpgradeFailed", "value": "UpgradeFailed", "description": "Indicates that the last upgrade for the cluster has failed." }, { "name": "Ready", "value": "Ready", "description": "Indicates that the cluster is in a stable state." } ] } }, "ClusterUpgradeCadence": { "type": "string", "description": "Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0.", "enum": [ "Wave0", "Wave1", "Wave2" ], "x-ms-enum": { "name": "ClusterUpgradeCadence", "modelAsString": true, "values": [ { "name": "Wave0", "value": "Wave0", "description": "Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters." }, { "name": "Wave1", "value": "Wave1", "description": "Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters." }, { "name": "Wave2", "value": "Wave2", "description": "Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters." } ] } }, "ClusterUpgradeDeltaHealthPolicy": { "type": "object", "description": "Describes the delta health policies for the cluster upgrade.", "properties": { "maxPercentDeltaUnhealthyNodes": { "type": "integer", "format": "int32", "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.", "minimum": 0, "maximum": 100 }, "maxPercentUpgradeDomainDeltaUnhealthyNodes": { "type": "integer", "format": "int32", "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.", "minimum": 0, "maximum": 100 }, "maxPercentDeltaUnhealthyApplications": { "type": "integer", "format": "int32", "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", "minimum": 0, "maximum": 100 } }, "required": [ "maxPercentDeltaUnhealthyNodes" ] }, "ClusterUpgradePolicy": { "type": "object", "description": "Describes the policy used when upgrading the cluster.", "properties": { "forceRestart": { "type": "boolean", "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).", "default": false }, "healthPolicy": { "$ref": "#/$defs/ClusterHealthPolicy" }, "deltaHealthPolicy": { "$ref": "#/$defs/ClusterUpgradeDeltaHealthPolicy" }, "monitoringPolicy": { "$ref": "#/$defs/ClusterMonitoringPolicy" }, "upgradeReplicaSetCheckTimeout": { "type": "string", "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)" } } }, "Direction": { "type": "string", "description": "Network security rule direction.", "enum": [ "inbound", "outbound" ], "x-ms-enum": { "name": "Direction", "modelAsString": true, "values": [ { "name": "inbound", "value": "inbound", "description": "Inbound direction." }, { "name": "outbound", "value": "outbound", "description": "Outbound direction." } ] } }, "IpTag": { "type": "object", "description": "The IP tag associated with the public IP address.", "properties": { "ipTagType": { "type": "string", "description": "IP tag type. Example: FirstPartyUsage." }, "tag": { "type": "string", "description": "IP tag associated with the public IP. Example: SQL, Storage etc." } }, "required": [ "ipTagType", "tag" ] }, "LoadBalancingRule": { "type": "object", "description": "Describes a load balancing rule.", "properties": { "frontendPort": { "type": "integer", "format": "int32", "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.", "minimum": 1, "maximum": 65534 }, "backendPort": { "type": "integer", "format": "int32", "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.", "minimum": 1, "maximum": 65534 }, "protocol": { "$ref": "#/$defs/Protocol" }, "probePort": { "type": "integer", "format": "int32", "description": "The prob port used by the load balancing rule. Acceptable values are between 1 and 65535.", "minimum": 1, "maximum": 65534 }, "probeProtocol": { "$ref": "#/$defs/ProbeProtocol" }, "probeRequestPath": { "type": "string", "description": "The probe request path. Only supported for HTTP/HTTPS probes." }, "loadDistribution": { "type": "string", "description": "The load distribution policy for this rule." } }, "required": [ "frontendPort", "backendPort", "protocol", "probeProtocol" ] }, "ManagedClusterAddOnFeature": { "type": "string", "description": "Available cluster add-on features", "enum": [ "DnsService", "BackupRestoreService", "ResourceMonitorService" ], "x-ms-enum": { "name": "ManagedClusterAddOnFeature", "modelAsString": true, "values": [ { "name": "DnsService", "value": "DnsService", "description": "Dns service" }, { "name": "BackupRestoreService", "value": "BackupRestoreService", "description": "Backup and restore service" }, { "name": "ResourceMonitorService", "value": "ResourceMonitorService", "description": "Resource monitor service" } ] } }, "ManagedClusterProperties": { "type": "object", "description": "Describes the managed cluster resource properties.", "properties": { "dnsName": { "type": "string", "description": "The cluster dns name." }, "fqdn": { "type": "string", "description": "The fully qualified domain name associated with the public load balancer of the cluster.", "readOnly": true }, "ipv4Address": { "type": "string", "description": "The IPv4 address associated with the public load balancer of the cluster.", "readOnly": true }, "clusterId": { "type": "string", "description": "A service generated unique identifier for the cluster resource.", "readOnly": true }, "clusterState": { "$ref": "#/$defs/ClusterState" }, "clusterCertificateThumbprints": { "type": "array", "description": "List of thumbprints of the cluster certificates.", "items": { "type": "string" }, "readOnly": true }, "clientConnectionPort": { "type": "integer", "format": "int32", "description": "The port used for client connections to the cluster.", "default": 19000 }, "httpGatewayConnectionPort": { "type": "integer", "format": "int32", "description": "The port used for HTTP connections to the cluster.", "default": 19080 }, "adminUserName": { "type": "string", "description": "VM admin user name." }, "adminPassword": { "type": "string", "format": "password", "description": "VM admin user password.", "x-ms-secret": true }, "loadBalancingRules": { "type": "array", "description": "Load balancing rules that are applied to the public load balancer of the cluster.", "items": { "$ref": "#/$defs/LoadBalancingRule" }, "x-ms-identifiers": [] }, "allowRdpAccess": { "type": "boolean", "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." }, "networkSecurityRules": { "type": "array", "description": "Custom Network Security Rules that are applied to the Virtual Network of the cluster.", "items": { "$ref": "#/$defs/NetworkSecurityRule" }, "x-ms-identifiers": [] }, "clients": { "type": "array", "description": "Client certificates that are allowed to manage the cluster.", "items": { "$ref": "#/$defs/ClientCertificate" }, "x-ms-identifiers": [] }, "azureActiveDirectory": { "$ref": "#/$defs/AzureActiveDirectory" }, "fabricSettings": { "type": "array", "description": "The list of custom fabric settings to configure the cluster.", "items": { "$ref": "#/$defs/SettingsSectionDescription" }, "x-ms-identifiers": [] }, "provisioningState": { "$ref": "#/$defs/ManagedResourceProvisioningState" }, "clusterCodeVersion": { "type": "string", "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**." }, "clusterUpgradeMode": { "type": "string", "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.", "default": "Automatic", "enum": [ "Automatic", "Manual" ], "x-ms-enum": { "name": "ClusterUpgradeMode", "modelAsString": true, "values": [ { "name": "Automatic", "value": "Automatic", "description": "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." }, { "name": "Manual", "value": "Manual", "description": "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." } ] } }, "clusterUpgradeCadence": { "$ref": "#/$defs/ClusterUpgradeCadence" }, "addonFeatures": { "type": "array", "description": "List of add-on features to enable on the cluster.", "items": { "$ref": "#/$defs/ManagedClusterAddOnFeature" } }, "enableAutoOSUpgrade": { "type": "boolean", "description": "Enables automatic OS upgrade for node types created using OS images with version 'latest'. The default value for this setting is false." }, "zonalResiliency": { "type": "boolean", "description": "Indicates if the cluster has zone resiliency.", "default": false }, "applicationTypeVersionsCleanupPolicy": { "$ref": "#/$defs/ApplicationTypeVersionsCleanupPolicy" }, "enableIpv6": { "type": "boolean", "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." }, "subnetId": { "type": "string", "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." }, "ipTags": { "type": "array", "description": "The list of IP tags associated with the default public IP address of the cluster.", "items": { "$ref": "#/$defs/IpTag" }, "x-ms-identifiers": [] }, "ipv6Address": { "type": "string", "description": "IPv6 address for the cluster if IPv6 is enabled.", "readOnly": true }, "enableServicePublicIP": { "type": "boolean", "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." }, "auxiliarySubnets": { "type": "array", "description": "Auxiliary subnets for the cluster.", "items": { "$ref": "#/$defs/Subnet" }, "x-ms-identifiers": [] }, "serviceEndpoints": { "type": "array", "description": "Service endpoints for subnets in the cluster.", "items": { "$ref": "#/$defs/ServiceEndpoint" }, "x-ms-identifiers": [] }, "zonalUpdateMode": { "$ref": "#/$defs/ZonalUpdateMode" }, "useCustomVnet": { "type": "boolean", "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." }, "publicIPPrefixId": { "type": "string", "format": "arm-id", "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.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Network/publicIPPrefixes" } ] } }, "publicIPv6PrefixId": { "type": "string", "format": "arm-id", "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.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Network/publicIPPrefixes" } ] } }, "ddosProtectionPlanId": { "type": "string", "format": "arm-id", "description": "Specify the resource id of a DDoS network protection plan that will be associated with the virtual network of the cluster.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Network/ddosProtectionPlans" } ] } }, "upgradeDescription": { "$ref": "#/$defs/ClusterUpgradePolicy" }, "httpGatewayTokenAuthConnectionPort": { "type": "integer", "format": "int32", "description": "The port used for token-auth based HTTPS connections to the cluster. Cannot be set to the same port as HttpGatewayEndpoint." }, "enableHttpGatewayExclusiveAuthMode": { "type": "boolean", "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." }, "autoGeneratedDomainNameLabelScope": { "$ref": "#/$defs/AutoGeneratedDomainNameLabelScope" }, "allocatedOutboundPorts": { "type": "integer", "format": "int32", "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." }, "VMImage": { "type": "string", "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'.", "default": "Windows" }, "enableOutboundOnlyNodeTypes": { "type": "boolean", "description": "Enable the creation of node types with only outbound traffic enabled. If set, a separate load balancer backend pool will be created for node types with inbound traffic enabled. Can only be set at the time of cluster creation." }, "skipManagedNsgAssignment": { "type": "boolean", "description": "Determines whether to skip the assignment of the managed network security group (SF-NSG) to the cluster subnet when using a bring-your-own virtual network (BYOVNET) configuration. The default value is false." } }, "required": [ "dnsName", "adminUserName" ] }, "ManagedResourceProvisioningState": { "type": "string", "description": "The provisioning state of the managed resource.", "enum": [ "None", "Creating", "Created", "Updating", "Succeeded", "Failed", "Canceled", "Deleting", "Deleted", "Other" ], "x-ms-enum": { "name": "ManagedResourceProvisioningState", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "The resource does not have a provisioning state." }, { "name": "Creating", "value": "Creating", "description": "The resource is being created." }, { "name": "Created", "value": "Created", "description": "The resource is created." }, { "name": "Updating", "value": "Updating", "description": "The resource is being updated." }, { "name": "Succeeded", "value": "Succeeded", "description": "The resource provisioning has succeeded." }, { "name": "Failed", "value": "Failed", "description": "The resource provisioning has failed." }, { "name": "Canceled", "value": "Canceled", "description": "The resource provisioning has been canceled." }, { "name": "Deleting", "value": "Deleting", "description": "The resource is being deleted." }, { "name": "Deleted", "value": "Deleted", "description": "The resource has been deleted." }, { "name": "Other", "value": "Other", "description": "The resource provisioning state is a state other than the previously specified states." } ] }, "readOnly": true }, "NetworkSecurityRule": { "type": "object", "description": "Describes a network security rule.", "properties": { "name": { "type": "string", "description": "Network security rule name." }, "description": { "type": "string", "description": "Network security rule description." }, "protocol": { "$ref": "#/$defs/NsgProtocol" }, "sourceAddressPrefixes": { "type": "array", "description": "The CIDR or source IP ranges.", "items": { "type": "string" } }, "destinationAddressPrefixes": { "type": "array", "description": "The destination address prefixes. CIDR or destination IP ranges.", "items": { "type": "string" } }, "sourcePortRanges": { "type": "array", "description": "The source port ranges.", "items": { "type": "string" } }, "destinationPortRanges": { "type": "array", "description": "The destination port ranges.", "items": { "type": "string" } }, "sourceAddressPrefix": { "type": "string", "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." }, "destinationAddressPrefix": { "type": "string", "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." }, "sourcePortRange": { "type": "string", "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." }, "destinationPortRange": { "type": "string", "description": "he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." }, "access": { "$ref": "#/$defs/Access" }, "priority": { "type": "integer", "format": "int32", "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.", "minimum": 1000, "maximum": 3000 }, "direction": { "$ref": "#/$defs/Direction" } }, "required": [ "name", "protocol", "access", "priority", "direction" ] }, "NsgProtocol": { "type": "string", "description": "Network protocol this rule applies to.", "enum": [ "http", "https", "tcp", "udp", "icmp", "ah", "esp" ], "x-ms-enum": { "name": "NsgProtocol", "modelAsString": true, "values": [ { "name": "http", "value": "http", "description": "Protocol applies to HTTP." }, { "name": "https", "value": "https", "description": "Protocol applies to HTTPS." }, { "name": "tcp", "value": "tcp", "description": "Protocol applies to TCP." }, { "name": "udp", "value": "udp", "description": "Protocol applies to UDP." }, { "name": "icmp", "value": "icmp", "description": "Protocol applies to ICMP." }, { "name": "ah", "value": "ah", "description": "Protocol applies to AH." }, { "name": "esp", "value": "esp", "description": "Protocol applies to ESP." } ] } }, "PrivateEndpointNetworkPolicies": { "type": "string", "description": "Enable or Disable apply network policies on private end point in the subnet.", "enum": [ "enabled", "disabled" ], "x-ms-enum": { "name": "PrivateEndpointNetworkPolicies", "modelAsString": true, "values": [ { "name": "enabled", "value": "enabled", "description": "Enable apply network policies on private end point in the subnet." }, { "name": "disabled", "value": "disabled", "description": "Disable apply network policies on private end point in the subnet." } ] } }, "PrivateLinkServiceNetworkPolicies": { "type": "string", "description": "Enable or Disable apply network policies on private link service in the subnet.", "enum": [ "enabled", "disabled" ], "x-ms-enum": { "name": "PrivateLinkServiceNetworkPolicies", "modelAsString": true, "values": [ { "name": "enabled", "value": "enabled", "description": "Enable apply network policies on private link service in the subnet." }, { "name": "disabled", "value": "disabled", "description": "Disable apply network policies on private link service in the subnet." } ] } }, "ProbeProtocol": { "type": "string", "description": "The reference to the load balancer probe used by the load balancing rule.", "enum": [ "tcp", "http", "https" ], "x-ms-enum": { "name": "ProbeProtocol", "modelAsString": true, "values": [ { "name": "tcp", "value": "tcp", "description": "Probe protocol is TCP." }, { "name": "http", "value": "http", "description": "Probe protocol is HTTP." }, { "name": "https", "value": "https", "description": "Probe protocol is HTTPS." } ] } }, "Protocol": { "type": "string", "description": "The reference to the transport protocol used by the load balancing rule.", "enum": [ "tcp", "udp" ], "x-ms-enum": { "name": "Protocol", "modelAsString": true, "values": [ { "name": "tcp", "value": "tcp", "description": "Transport protocol is TCP." }, { "name": "udp", "value": "udp", "description": "Transport protocol is UDP." } ] } }, "ServiceEndpoint": { "type": "object", "description": "The service endpoint properties.", "properties": { "service": { "type": "string", "description": "The type of the endpoint service." }, "locations": { "type": "array", "description": "A list of locations.", "items": { "type": "string" } }, "networkIdentifier": { "type": "string", "format": "arm-id", "description": "Specifies the resource id of the service endpoint to be used in the cluster.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Network/publicIPAddresses" } ] } } }, "required": [ "service" ] }, "SettingsParameterDescription": { "type": "object", "description": "Describes a parameter in fabric settings of the cluster.", "properties": { "name": { "type": "string", "description": "The parameter name of fabric setting." }, "value": { "type": "string", "description": "The parameter value of fabric setting." } }, "required": [ "name", "value" ] }, "SettingsSectionDescription": { "type": "object", "description": "Describes a section in the fabric settings of the cluster.", "properties": { "name": { "type": "string", "description": "The section name of the fabric settings." }, "parameters": { "type": "array", "description": "The collection of parameters in the section.", "items": { "$ref": "#/$defs/SettingsParameterDescription" }, "x-ms-identifiers": [ "name" ] } }, "required": [ "name", "parameters" ] }, "Sku": { "type": "object", "description": "Service Fabric managed cluster Sku definition", "properties": { "name": { "$ref": "#/$defs/SkuName" } }, "required": [ "name" ] }, "SkuName": { "type": "string", "description": "Sku Name.", "enum": [ "Basic", "Standard" ], "x-ms-enum": { "name": "SkuName", "modelAsString": true, "values": [ { "name": "Basic", "value": "Basic", "description": "Basic requires a minimum of 3 nodes and allows only 1 node type." }, { "name": "Standard", "value": "Standard", "description": "Requires a minimum of 5 nodes and allows 1 or more node type." } ] } }, "Subnet": { "type": "object", "description": "Describes a Subnet.", "properties": { "name": { "type": "string", "description": "Subnet name." }, "enableIpv6": { "type": "boolean", "description": "Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster." }, "privateEndpointNetworkPolicies": { "$ref": "#/$defs/PrivateEndpointNetworkPolicies" }, "privateLinkServiceNetworkPolicies": { "$ref": "#/$defs/PrivateLinkServiceNetworkPolicies" }, "networkSecurityGroupId": { "type": "string", "description": "Full resource id for the network security group." } }, "required": [ "name" ] }, "ZonalUpdateMode": { "type": "string", "description": "Indicates the update mode for Cross Az clusters.", "enum": [ "Standard", "Fast" ], "x-ms-enum": { "name": "ZonalUpdateMode", "modelAsString": true, "values": [ { "name": "Standard", "value": "Standard", "description": "The cluster will use 5 upgrade domains for Cross Az Node types." }, { "name": "Fast", "value": "Fast", "description": "The cluster will use a maximum of 3 upgrade domains per zone instead of 5 for Cross Az Node types for faster deployments." } ] } } } }