Microsoft.ServiceFabric (preview:2024-11-01)

2025/04/23 • 4 updated methods

NodeTypes_ListByManagedClusters (updated)
Description Gets all Node types of the specified managed cluster.
Reference Link ¶

⚶ Changes

{
  "#id": "NodeTypes_ListByManagedClusters",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "securityType",
                "Description": {
                  "new": "Specifies the security type of the nodeType. Supported values include Standard, TrustedLaunch and ConfidentialVM.",
                  "old": "Specifies the security type of the nodeType. Only Standard and TrustedLaunch are currently supported"
                },
                "Enum": {
                  "new": [
                    [
                      "TrustedLaunch",
                      "Trusted Launch is a security type that secures generation 2 virtual machines."
                    ],
                    [
                      "Standard",
                      "Standard is the default security type for all machines."
                    ],
                    [
                      "ConfidentialVM",
                      "ConfidentialVM provides hardware-based encryption, trusted execution environment (TEE) and isolation of the VM memory & CPU from host."
                    ]
                  ],
                  "old": [
                    [
                      "TrustedLaunch",
                      "Trusted Launch is a security type that secures generation 2 virtual machines."
                    ],
                    [
                      "Standard",
                      "Standard is the default security type for all machines."
                    ]
                  ]
                }
              },
              {
                "@added_7df11f5970b646f2ba9df60e94132d64": {
                  "#name": "securityEncryptionType",
                  "Description": "Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs.",
                  "Enum": [
                    [
                      "DiskWithVMGuestState",
                      "For encryption of the managed disk along with VMGuestState blob."
                    ],
                    [
                      "VMGuestStateOnly",
                      "For encryption of just the VMGuestState blob."
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "#name": "secureBootEnabled",
                "Description": {
                  "new": "Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch and ConfidentialVM SecurityType.",
                  "old": "Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch SecurityType"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
isPrimary: boolean ,
vmInstanceCount: integer ,
dataDiskSizeGB: integer ,
dataDiskType: enum ,
dataDiskLetter: string ,
placementProperties: object ,
capacities: object ,
applicationPorts:
{
startPort: integer ,
endPort: integer ,
}
,
ephemeralPorts:
{
startPort: integer ,
endPort: integer ,
}
,
vmSize: string ,
vmImagePublisher: string ,
vmImageOffer: string ,
vmImageSku: string ,
vmImageVersion: string ,
vmSecrets:
[
{
sourceVault:
{
id: string ,
}
,
vaultCertificates:
[
{
certificateUrl: string ,
certificateStore: string ,
}
,
]
,
}
,
]
,
vmExtensions:
[
{
name: string ,
properties:
{
publisher: string ,
type: string ,
typeHandlerVersion: string ,
autoUpgradeMinorVersion: boolean ,
settings: object ,
protectedSettings: object ,
forceUpdateTag: string ,
provisionAfterExtensions:
[
string ,
]
,
provisioningState: string ,
enableAutomaticUpgrade: boolean ,
setupOrder:
[
string ,
]
,
}
,
}
,
]
,
vmManagedIdentity:
{
userAssignedIdentities:
[
string ,
]
,
}
,
isStateless: boolean ,
multiplePlacementGroups: boolean ,
frontendConfigurations:
[
{
ipAddressType: enum ,
loadBalancerBackendAddressPoolId: string ,
loadBalancerInboundNatPoolId: string ,
applicationGatewayBackendAddressPoolId: string ,
}
,
]
,
networkSecurityRules:
[
{
name: string ,
description: string ,
protocol: enum ,
sourceAddressPrefixes:
[
string ,
]
,
destinationAddressPrefixes:
[
string ,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
sourceAddressPrefix: string ,
destinationAddressPrefix: string ,
sourcePortRange: string ,
destinationPortRange: string ,
access: enum ,
priority: integer ,
direction: enum ,
}
,
]
,
additionalDataDisks:
[
{
lun: integer ,
diskSizeGB: integer ,
diskType: enum ,
diskLetter: string ,
}
,
]
,
enableEncryptionAtHost: boolean ,
provisioningState: enum ,
enableAcceleratedNetworking: boolean ,
useDefaultPublicLoadBalancer: boolean ,
useTempDataDisk: boolean ,
enableOverProvisioning: boolean ,
zones:
[
string ,
]
,
isSpotVM: boolean ,
hostGroupId: string ,
useEphemeralOSDisk: boolean ,
spotRestoreTimeout: string ,
evictionPolicy: enum ,
vmImageResourceId: string ,
subnetId: string ,
vmSetupActions:
[
string ,
]
,
securityType: enum ,
securityEncryptionType: enum ,
secureBootEnabled: boolean ,
enableNodePublicIP: boolean ,
enableNodePublicIPv6: boolean ,
vmSharedGalleryImageId: string ,
natGatewayId: string ,
natConfigurations:
[
{
backendPort: integer ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
}
,
]
,
vmImagePlan:
{
name: string ,
product: string ,
promotionCode: string ,
publisher: string ,
}
,
serviceArtifactReferenceId: string ,
dscpConfigurationId: string ,
additionalNetworkInterfaceConfigurations:
[
{
name: string ,
enableAcceleratedNetworking: boolean ,
dscpConfiguration:
{
id: string ,
}
,
ipConfigurations:
[
{
name: string ,
applicationGatewayBackendAddressPools:
[
{
id: string ,
}
,
]
,
loadBalancerBackendAddressPools:
[
{
id: string ,
}
,
]
,
loadBalancerInboundNatPools:
[
{
id: string ,
}
,
]
,
subnet:
{
id: string ,
}
,
privateIPAddressVersion: enum ,
publicIPAddressConfiguration:
{
name: string ,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
publicIPAddressVersion: enum ,
}
,
}
,
]
,
}
,
]
,
computerNamePrefix: string ,
vmApplications:
[
{
configurationReference: string ,
enableAutomaticUpgrade: boolean ,
order: integer ,
packageReferenceId: string ,
vmGalleryTags: string ,
treatFailureAsDeploymentFailure: boolean ,
}
,
]
,
}
,
tags: object ,
sku:
{
name: string ,
tier: string ,
capacity: integer ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NodeTypes_Get (updated)
Description Get a Service Fabric node type of a given managed cluster.
Reference Link ¶

⚶ Changes

{
  "#id": "NodeTypes_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "securityType",
            "Description": {
              "new": "Specifies the security type of the nodeType. Supported values include Standard, TrustedLaunch and ConfidentialVM.",
              "old": "Specifies the security type of the nodeType. Only Standard and TrustedLaunch are currently supported"
            },
            "Enum": {
              "new": [
                [
                  "TrustedLaunch",
                  "Trusted Launch is a security type that secures generation 2 virtual machines."
                ],
                [
                  "Standard",
                  "Standard is the default security type for all machines."
                ],
                [
                  "ConfidentialVM",
                  "ConfidentialVM provides hardware-based encryption, trusted execution environment (TEE) and isolation of the VM memory & CPU from host."
                ]
              ],
              "old": [
                [
                  "TrustedLaunch",
                  "Trusted Launch is a security type that secures generation 2 virtual machines."
                ],
                [
                  "Standard",
                  "Standard is the default security type for all machines."
                ]
              ]
            }
          },
          {
            "@added_032fb5dffbe648e78c6283175327d7e5": {
              "#name": "securityEncryptionType",
              "Description": "Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs.",
              "Enum": [
                [
                  "DiskWithVMGuestState",
                  "For encryption of the managed disk along with VMGuestState blob."
                ],
                [
                  "VMGuestStateOnly",
                  "For encryption of just the VMGuestState blob."
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "#name": "secureBootEnabled",
            "Description": {
              "new": "Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch and ConfidentialVM SecurityType.",
              "old": "Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch SecurityType"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
nodeTypeName: string ,
}

⚐ Response (200)

{
properties:
{
isPrimary: boolean ,
vmInstanceCount: integer ,
dataDiskSizeGB: integer ,
dataDiskType: enum ,
dataDiskLetter: string ,
placementProperties: object ,
capacities: object ,
applicationPorts:
{
startPort: integer ,
endPort: integer ,
}
,
ephemeralPorts:
{
startPort: integer ,
endPort: integer ,
}
,
vmSize: string ,
vmImagePublisher: string ,
vmImageOffer: string ,
vmImageSku: string ,
vmImageVersion: string ,
vmSecrets:
[
{
sourceVault:
{
id: string ,
}
,
vaultCertificates:
[
{
certificateUrl: string ,
certificateStore: string ,
}
,
]
,
}
,
]
,
vmExtensions:
[
{
name: string ,
properties:
{
publisher: string ,
type: string ,
typeHandlerVersion: string ,
autoUpgradeMinorVersion: boolean ,
settings: object ,
protectedSettings: object ,
forceUpdateTag: string ,
provisionAfterExtensions:
[
string ,
]
,
provisioningState: string ,
enableAutomaticUpgrade: boolean ,
setupOrder:
[
string ,
]
,
}
,
}
,
]
,
vmManagedIdentity:
{
userAssignedIdentities:
[
string ,
]
,
}
,
isStateless: boolean ,
multiplePlacementGroups: boolean ,
frontendConfigurations:
[
{
ipAddressType: enum ,
loadBalancerBackendAddressPoolId: string ,
loadBalancerInboundNatPoolId: string ,
applicationGatewayBackendAddressPoolId: string ,
}
,
]
,
networkSecurityRules:
[
{
name: string ,
description: string ,
protocol: enum ,
sourceAddressPrefixes:
[
string ,
]
,
destinationAddressPrefixes:
[
string ,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
sourceAddressPrefix: string ,
destinationAddressPrefix: string ,
sourcePortRange: string ,
destinationPortRange: string ,
access: enum ,
priority: integer ,
direction: enum ,
}
,
]
,
additionalDataDisks:
[
{
lun: integer ,
diskSizeGB: integer ,
diskType: enum ,
diskLetter: string ,
}
,
]
,
enableEncryptionAtHost: boolean ,
provisioningState: enum ,
enableAcceleratedNetworking: boolean ,
useDefaultPublicLoadBalancer: boolean ,
useTempDataDisk: boolean ,
enableOverProvisioning: boolean ,
zones:
[
string ,
]
,
isSpotVM: boolean ,
hostGroupId: string ,
useEphemeralOSDisk: boolean ,
spotRestoreTimeout: string ,
evictionPolicy: enum ,
vmImageResourceId: string ,
subnetId: string ,
vmSetupActions:
[
string ,
]
,
securityType: enum ,
securityEncryptionType: enum ,
secureBootEnabled: boolean ,
enableNodePublicIP: boolean ,
enableNodePublicIPv6: boolean ,
vmSharedGalleryImageId: string ,
natGatewayId: string ,
natConfigurations:
[
{
backendPort: integer ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
}
,
]
,
vmImagePlan:
{
name: string ,
product: string ,
promotionCode: string ,
publisher: string ,
}
,
serviceArtifactReferenceId: string ,
dscpConfigurationId: string ,
additionalNetworkInterfaceConfigurations:
[
{
name: string ,
enableAcceleratedNetworking: boolean ,
dscpConfiguration:
{
id: string ,
}
,
ipConfigurations:
[
{
name: string ,
applicationGatewayBackendAddressPools:
[
{
id: string ,
}
,
]
,
loadBalancerBackendAddressPools:
[
{
id: string ,
}
,
]
,
loadBalancerInboundNatPools:
[
{
id: string ,
}
,
]
,
subnet:
{
id: string ,
}
,
privateIPAddressVersion: enum ,
publicIPAddressConfiguration:
{
name: string ,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
publicIPAddressVersion: enum ,
}
,
}
,
]
,
}
,
]
,
computerNamePrefix: string ,
vmApplications:
[
{
configurationReference: string ,
enableAutomaticUpgrade: boolean ,
order: integer ,
packageReferenceId: string ,
vmGalleryTags: string ,
treatFailureAsDeploymentFailure: boolean ,
}
,
]
,
}
,
tags: object ,
sku:
{
name: string ,
tier: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
NodeTypes_CreateOrUpdate (updated)
Description Create or update a Service Fabric node type of a given managed cluster.
Reference Link ¶

⚶ Changes

{
  "#id": "NodeTypes_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "properties": [
          {
            "#name": "securityType",
            "Description": {
              "new": "Specifies the security type of the nodeType. Supported values include Standard, TrustedLaunch and ConfidentialVM.",
              "old": "Specifies the security type of the nodeType. Only Standard and TrustedLaunch are currently supported"
            },
            "Enum": {
              "new": [
                [
                  "TrustedLaunch",
                  "Trusted Launch is a security type that secures generation 2 virtual machines."
                ],
                [
                  "Standard",
                  "Standard is the default security type for all machines."
                ],
                [
                  "ConfidentialVM",
                  "ConfidentialVM provides hardware-based encryption, trusted execution environment (TEE) and isolation of the VM memory & CPU from host."
                ]
              ],
              "old": [
                [
                  "TrustedLaunch",
                  "Trusted Launch is a security type that secures generation 2 virtual machines."
                ],
                [
                  "Standard",
                  "Standard is the default security type for all machines."
                ]
              ]
            }
          },
          {
            "@added_36e6e1e679084dcb8f50d3bc2121849d": {
              "#name": "securityEncryptionType",
              "Description": "Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs.",
              "Enum": [
                [
                  "DiskWithVMGuestState",
                  "For encryption of the managed disk along with VMGuestState blob."
                ],
                [
                  "VMGuestStateOnly",
                  "For encryption of just the VMGuestState blob."
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "#name": "secureBootEnabled",
            "Description": {
              "new": "Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch and ConfidentialVM SecurityType.",
              "old": "Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch SecurityType"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "securityType",
            "Description": {
              "new": "Specifies the security type of the nodeType. Supported values include Standard, TrustedLaunch and ConfidentialVM.",
              "old": "Specifies the security type of the nodeType. Only Standard and TrustedLaunch are currently supported"
            },
            "Enum": {
              "new": [
                [
                  "TrustedLaunch",
                  "Trusted Launch is a security type that secures generation 2 virtual machines."
                ],
                [
                  "Standard",
                  "Standard is the default security type for all machines."
                ],
                [
                  "ConfidentialVM",
                  "ConfidentialVM provides hardware-based encryption, trusted execution environment (TEE) and isolation of the VM memory & CPU from host."
                ]
              ],
              "old": [
                [
                  "TrustedLaunch",
                  "Trusted Launch is a security type that secures generation 2 virtual machines."
                ],
                [
                  "Standard",
                  "Standard is the default security type for all machines."
                ]
              ]
            }
          },
          {
            "@added_de50a1786b7244d2a4e65c01d407ca1d": {
              "#name": "securityEncryptionType",
              "Description": "Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs.",
              "Enum": [
                [
                  "DiskWithVMGuestState",
                  "For encryption of the managed disk along with VMGuestState blob."
                ],
                [
                  "VMGuestStateOnly",
                  "For encryption of just the VMGuestState blob."
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "#name": "secureBootEnabled",
            "Description": {
              "new": "Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch and ConfidentialVM SecurityType.",
              "old": "Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch SecurityType"
            }
          }
        ]
      }
    },
    "202": {
      "$properties": {
        "properties": [
          {
            "#name": "securityType",
            "Description": {
              "new": "Specifies the security type of the nodeType. Supported values include Standard, TrustedLaunch and ConfidentialVM.",
              "old": "Specifies the security type of the nodeType. Only Standard and TrustedLaunch are currently supported"
            },
            "Enum": {
              "new": [
                [
                  "TrustedLaunch",
                  "Trusted Launch is a security type that secures generation 2 virtual machines."
                ],
                [
                  "Standard",
                  "Standard is the default security type for all machines."
                ],
                [
                  "ConfidentialVM",
                  "ConfidentialVM provides hardware-based encryption, trusted execution environment (TEE) and isolation of the VM memory & CPU from host."
                ]
              ],
              "old": [
                [
                  "TrustedLaunch",
                  "Trusted Launch is a security type that secures generation 2 virtual machines."
                ],
                [
                  "Standard",
                  "Standard is the default security type for all machines."
                ]
              ]
            }
          },
          {
            "@added_09f8c7e2efb84a68aa0edc5198fa5497": {
              "#name": "securityEncryptionType",
              "Description": "Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs.",
              "Enum": [
                [
                  "DiskWithVMGuestState",
                  "For encryption of the managed disk along with VMGuestState blob."
                ],
                [
                  "VMGuestStateOnly",
                  "For encryption of just the VMGuestState blob."
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "#name": "secureBootEnabled",
            "Description": {
              "new": "Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch and ConfidentialVM SecurityType.",
              "old": "Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch SecurityType"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
nodeTypeName: string ,
parameters:
{
properties:
{
isPrimary: boolean ,
vmInstanceCount: integer ,
dataDiskSizeGB: integer ,
dataDiskType: enum ,
dataDiskLetter: string ,
placementProperties: object ,
capacities: object ,
applicationPorts:
{
startPort: integer ,
endPort: integer ,
}
,
ephemeralPorts:
{
startPort: integer ,
endPort: integer ,
}
,
vmSize: string ,
vmImagePublisher: string ,
vmImageOffer: string ,
vmImageSku: string ,
vmImageVersion: string ,
vmSecrets:
[
{
sourceVault:
{
id: string ,
}
,
vaultCertificates:
[
{
certificateUrl: string ,
certificateStore: string ,
}
,
]
,
}
,
]
,
vmExtensions:
[
{
name: string ,
properties:
{
publisher: string ,
type: string ,
typeHandlerVersion: string ,
autoUpgradeMinorVersion: boolean ,
settings: object ,
protectedSettings: object ,
forceUpdateTag: string ,
provisionAfterExtensions:
[
string ,
]
,
provisioningState: string ,
enableAutomaticUpgrade: boolean ,
setupOrder:
[
string ,
]
,
}
,
}
,
]
,
vmManagedIdentity:
{
userAssignedIdentities:
[
string ,
]
,
}
,
isStateless: boolean ,
multiplePlacementGroups: boolean ,
frontendConfigurations:
[
{
ipAddressType: enum ,
loadBalancerBackendAddressPoolId: string ,
loadBalancerInboundNatPoolId: string ,
applicationGatewayBackendAddressPoolId: string ,
}
,
]
,
networkSecurityRules:
[
{
name: string ,
description: string ,
protocol: enum ,
sourceAddressPrefixes:
[
string ,
]
,
destinationAddressPrefixes:
[
string ,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
sourceAddressPrefix: string ,
destinationAddressPrefix: string ,
sourcePortRange: string ,
destinationPortRange: string ,
access: enum ,
priority: integer ,
direction: enum ,
}
,
]
,
additionalDataDisks:
[
{
lun: integer ,
diskSizeGB: integer ,
diskType: enum ,
diskLetter: string ,
}
,
]
,
enableEncryptionAtHost: boolean ,
provisioningState: enum ,
enableAcceleratedNetworking: boolean ,
useDefaultPublicLoadBalancer: boolean ,
useTempDataDisk: boolean ,
enableOverProvisioning: boolean ,
zones:
[
string ,
]
,
isSpotVM: boolean ,
hostGroupId: string ,
useEphemeralOSDisk: boolean ,
spotRestoreTimeout: string ,
evictionPolicy: enum ,
vmImageResourceId: string ,
subnetId: string ,
vmSetupActions:
[
string ,
]
,
securityType: enum ,
securityEncryptionType: enum ,
secureBootEnabled: boolean ,
enableNodePublicIP: boolean ,
enableNodePublicIPv6: boolean ,
vmSharedGalleryImageId: string ,
natGatewayId: string ,
natConfigurations:
[
{
backendPort: integer ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
}
,
]
,
vmImagePlan:
{
name: string ,
product: string ,
promotionCode: string ,
publisher: string ,
}
,
serviceArtifactReferenceId: string ,
dscpConfigurationId: string ,
additionalNetworkInterfaceConfigurations:
[
{
name: string ,
enableAcceleratedNetworking: boolean ,
dscpConfiguration:
{
id: string ,
}
,
ipConfigurations:
[
{
name: string ,
applicationGatewayBackendAddressPools:
[
{
id: string ,
}
,
]
,
loadBalancerBackendAddressPools:
[
{
id: string ,
}
,
]
,
loadBalancerInboundNatPools:
[
{
id: string ,
}
,
]
,
subnet:
{
id: string ,
}
,
privateIPAddressVersion: enum ,
publicIPAddressConfiguration:
{
name: string ,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
publicIPAddressVersion: enum ,
}
,
}
,
]
,
}
,
]
,
computerNamePrefix: string ,
vmApplications:
[
{
configurationReference: string ,
enableAutomaticUpgrade: boolean ,
order: integer ,
packageReferenceId: string ,
vmGalleryTags: string ,
treatFailureAsDeploymentFailure: boolean ,
}
,
]
,
}
,
tags: object ,
sku:
{
name: string ,
tier: string ,
capacity: integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
isPrimary: boolean ,
vmInstanceCount: integer ,
dataDiskSizeGB: integer ,
dataDiskType: enum ,
dataDiskLetter: string ,
placementProperties: object ,
capacities: object ,
applicationPorts:
{
startPort: integer ,
endPort: integer ,
}
,
ephemeralPorts:
{
startPort: integer ,
endPort: integer ,
}
,
vmSize: string ,
vmImagePublisher: string ,
vmImageOffer: string ,
vmImageSku: string ,
vmImageVersion: string ,
vmSecrets:
[
{
sourceVault:
{
id: string ,
}
,
vaultCertificates:
[
{
certificateUrl: string ,
certificateStore: string ,
}
,
]
,
}
,
]
,
vmExtensions:
[
{
name: string ,
properties:
{
publisher: string ,
type: string ,
typeHandlerVersion: string ,
autoUpgradeMinorVersion: boolean ,
settings: object ,
protectedSettings: object ,
forceUpdateTag: string ,
provisionAfterExtensions:
[
string ,
]
,
provisioningState: string ,
enableAutomaticUpgrade: boolean ,
setupOrder:
[
string ,
]
,
}
,
}
,
]
,
vmManagedIdentity:
{
userAssignedIdentities:
[
string ,
]
,
}
,
isStateless: boolean ,
multiplePlacementGroups: boolean ,
frontendConfigurations:
[
{
ipAddressType: enum ,
loadBalancerBackendAddressPoolId: string ,
loadBalancerInboundNatPoolId: string ,
applicationGatewayBackendAddressPoolId: string ,
}
,
]
,
networkSecurityRules:
[
{
name: string ,
description: string ,
protocol: enum ,
sourceAddressPrefixes:
[
string ,
]
,
destinationAddressPrefixes:
[
string ,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
sourceAddressPrefix: string ,
destinationAddressPrefix: string ,
sourcePortRange: string ,
destinationPortRange: string ,
access: enum ,
priority: integer ,
direction: enum ,
}
,
]
,
additionalDataDisks:
[
{
lun: integer ,
diskSizeGB: integer ,
diskType: enum ,
diskLetter: string ,
}
,
]
,
enableEncryptionAtHost: boolean ,
provisioningState: enum ,
enableAcceleratedNetworking: boolean ,
useDefaultPublicLoadBalancer: boolean ,
useTempDataDisk: boolean ,
enableOverProvisioning: boolean ,
zones:
[
string ,
]
,
isSpotVM: boolean ,
hostGroupId: string ,
useEphemeralOSDisk: boolean ,
spotRestoreTimeout: string ,
evictionPolicy: enum ,
vmImageResourceId: string ,
subnetId: string ,
vmSetupActions:
[
string ,
]
,
securityType: enum ,
securityEncryptionType: enum ,
secureBootEnabled: boolean ,
enableNodePublicIP: boolean ,
enableNodePublicIPv6: boolean ,
vmSharedGalleryImageId: string ,
natGatewayId: string ,
natConfigurations:
[
{
backendPort: integer ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
}
,
]
,
vmImagePlan:
{
name: string ,
product: string ,
promotionCode: string ,
publisher: string ,
}
,
serviceArtifactReferenceId: string ,
dscpConfigurationId: string ,
additionalNetworkInterfaceConfigurations:
[
{
name: string ,
enableAcceleratedNetworking: boolean ,
dscpConfiguration:
{
id: string ,
}
,
ipConfigurations:
[
{
name: string ,
applicationGatewayBackendAddressPools:
[
{
id: string ,
}
,
]
,
loadBalancerBackendAddressPools:
[
{
id: string ,
}
,
]
,
loadBalancerInboundNatPools:
[
{
id: string ,
}
,
]
,
subnet:
{
id: string ,
}
,
privateIPAddressVersion: enum ,
publicIPAddressConfiguration:
{
name: string ,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
publicIPAddressVersion: enum ,
}
,
}
,
]
,
}
,
]
,
computerNamePrefix: string ,
vmApplications:
[
{
configurationReference: string ,
enableAutomaticUpgrade: boolean ,
order: integer ,
packageReferenceId: string ,
vmGalleryTags: string ,
treatFailureAsDeploymentFailure: boolean ,
}
,
]
,
}
,
tags: object ,
sku:
{
name: string ,
tier: string ,
capacity: integer ,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation: string ,
location: string ,
}
,
$schema:
{
properties:
{
isPrimary: boolean ,
vmInstanceCount: integer ,
dataDiskSizeGB: integer ,
dataDiskType: enum ,
dataDiskLetter: string ,
placementProperties: object ,
capacities: object ,
applicationPorts:
{
startPort: integer ,
endPort: integer ,
}
,
ephemeralPorts:
{
startPort: integer ,
endPort: integer ,
}
,
vmSize: string ,
vmImagePublisher: string ,
vmImageOffer: string ,
vmImageSku: string ,
vmImageVersion: string ,
vmSecrets:
[
{
sourceVault:
{
id: string ,
}
,
vaultCertificates:
[
{
certificateUrl: string ,
certificateStore: string ,
}
,
]
,
}
,
]
,
vmExtensions:
[
{
name: string ,
properties:
{
publisher: string ,
type: string ,
typeHandlerVersion: string ,
autoUpgradeMinorVersion: boolean ,
settings: object ,
protectedSettings: object ,
forceUpdateTag: string ,
provisionAfterExtensions:
[
string ,
]
,
provisioningState: string ,
enableAutomaticUpgrade: boolean ,
setupOrder:
[
string ,
]
,
}
,
}
,
]
,
vmManagedIdentity:
{
userAssignedIdentities:
[
string ,
]
,
}
,
isStateless: boolean ,
multiplePlacementGroups: boolean ,
frontendConfigurations:
[
{
ipAddressType: enum ,
loadBalancerBackendAddressPoolId: string ,
loadBalancerInboundNatPoolId: string ,
applicationGatewayBackendAddressPoolId: string ,
}
,
]
,
networkSecurityRules:
[
{
name: string ,
description: string ,
protocol: enum ,
sourceAddressPrefixes:
[
string ,
]
,
destinationAddressPrefixes:
[
string ,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
sourceAddressPrefix: string ,
destinationAddressPrefix: string ,
sourcePortRange: string ,
destinationPortRange: string ,
access: enum ,
priority: integer ,
direction: enum ,
}
,
]
,
additionalDataDisks:
[
{
lun: integer ,
diskSizeGB: integer ,
diskType: enum ,
diskLetter: string ,
}
,
]
,
enableEncryptionAtHost: boolean ,
provisioningState: enum ,
enableAcceleratedNetworking: boolean ,
useDefaultPublicLoadBalancer: boolean ,
useTempDataDisk: boolean ,
enableOverProvisioning: boolean ,
zones:
[
string ,
]
,
isSpotVM: boolean ,
hostGroupId: string ,
useEphemeralOSDisk: boolean ,
spotRestoreTimeout: string ,
evictionPolicy: enum ,
vmImageResourceId: string ,
subnetId: string ,
vmSetupActions:
[
string ,
]
,
securityType: enum ,
securityEncryptionType: enum ,
secureBootEnabled: boolean ,
enableNodePublicIP: boolean ,
enableNodePublicIPv6: boolean ,
vmSharedGalleryImageId: string ,
natGatewayId: string ,
natConfigurations:
[
{
backendPort: integer ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
}
,
]
,
vmImagePlan:
{
name: string ,
product: string ,
promotionCode: string ,
publisher: string ,
}
,
serviceArtifactReferenceId: string ,
dscpConfigurationId: string ,
additionalNetworkInterfaceConfigurations:
[
{
name: string ,
enableAcceleratedNetworking: boolean ,
dscpConfiguration:
{
id: string ,
}
,
ipConfigurations:
[
{
name: string ,
applicationGatewayBackendAddressPools:
[
{
id: string ,
}
,
]
,
loadBalancerBackendAddressPools:
[
{
id: string ,
}
,
]
,
loadBalancerInboundNatPools:
[
{
id: string ,
}
,
]
,
subnet:
{
id: string ,
}
,
privateIPAddressVersion: enum ,
publicIPAddressConfiguration:
{
name: string ,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
publicIPAddressVersion: enum ,
}
,
}
,
]
,
}
,
]
,
computerNamePrefix: string ,
vmApplications:
[
{
configurationReference: string ,
enableAutomaticUpgrade: boolean ,
order: integer ,
packageReferenceId: string ,
vmGalleryTags: string ,
treatFailureAsDeploymentFailure: boolean ,
}
,
]
,
}
,
tags: object ,
sku:
{
name: string ,
tier: string ,
capacity: integer ,
}
,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "NodeTypes_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "securityType",
            "Description": {
              "new": "Specifies the security type of the nodeType. Supported values include Standard, TrustedLaunch and ConfidentialVM.",
              "old": "Specifies the security type of the nodeType. Only Standard and TrustedLaunch are currently supported"
            },
            "Enum": {
              "new": [
                [
                  "TrustedLaunch",
                  "Trusted Launch is a security type that secures generation 2 virtual machines."
                ],
                [
                  "Standard",
                  "Standard is the default security type for all machines."
                ],
                [
                  "ConfidentialVM",
                  "ConfidentialVM provides hardware-based encryption, trusted execution environment (TEE) and isolation of the VM memory & CPU from host."
                ]
              ],
              "old": [
                [
                  "TrustedLaunch",
                  "Trusted Launch is a security type that secures generation 2 virtual machines."
                ],
                [
                  "Standard",
                  "Standard is the default security type for all machines."
                ]
              ]
            }
          },
          {
            "@added_d6f005f8fee64faebe5a5ebe6c225e3b": {
              "#name": "securityEncryptionType",
              "Description": "Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob and VMGuestStateOnly for encryption of just the VMGuestState blob. Note: It can be set for only Confidential VMs.",
              "Enum": [
                [
                  "DiskWithVMGuestState",
                  "For encryption of the managed disk along with VMGuestState blob."
                ],
                [
                  "VMGuestStateOnly",
                  "For encryption of just the VMGuestState blob."
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "#name": "secureBootEnabled",
            "Description": {
              "new": "Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch and ConfidentialVM SecurityType.",
              "old": "Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch SecurityType"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
nodeTypeName: string ,
parameters:
{
tags: object ,
sku:
{
name: string ,
tier: string ,
capacity: integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
isPrimary: boolean ,
vmInstanceCount: integer ,
dataDiskSizeGB: integer ,
dataDiskType: enum ,
dataDiskLetter: string ,
placementProperties: object ,
capacities: object ,
applicationPorts:
{
startPort: integer ,
endPort: integer ,
}
,
ephemeralPorts:
{
startPort: integer ,
endPort: integer ,
}
,
vmSize: string ,
vmImagePublisher: string ,
vmImageOffer: string ,
vmImageSku: string ,
vmImageVersion: string ,
vmSecrets:
[
{
sourceVault:
{
id: string ,
}
,
vaultCertificates:
[
{
certificateUrl: string ,
certificateStore: string ,
}
,
]
,
}
,
]
,
vmExtensions:
[
{
name: string ,
properties:
{
publisher: string ,
type: string ,
typeHandlerVersion: string ,
autoUpgradeMinorVersion: boolean ,
settings: object ,
protectedSettings: object ,
forceUpdateTag: string ,
provisionAfterExtensions:
[
string ,
]
,
provisioningState: string ,
enableAutomaticUpgrade: boolean ,
setupOrder:
[
string ,
]
,
}
,
}
,
]
,
vmManagedIdentity:
{
userAssignedIdentities:
[
string ,
]
,
}
,
isStateless: boolean ,
multiplePlacementGroups: boolean ,
frontendConfigurations:
[
{
ipAddressType: enum ,
loadBalancerBackendAddressPoolId: string ,
loadBalancerInboundNatPoolId: string ,
applicationGatewayBackendAddressPoolId: string ,
}
,
]
,
networkSecurityRules:
[
{
name: string ,
description: string ,
protocol: enum ,
sourceAddressPrefixes:
[
string ,
]
,
destinationAddressPrefixes:
[
string ,
]
,
sourcePortRanges:
[
string ,
]
,
destinationPortRanges:
[
string ,
]
,
sourceAddressPrefix: string ,
destinationAddressPrefix: string ,
sourcePortRange: string ,
destinationPortRange: string ,
access: enum ,
priority: integer ,
direction: enum ,
}
,
]
,
additionalDataDisks:
[
{
lun: integer ,
diskSizeGB: integer ,
diskType: enum ,
diskLetter: string ,
}
,
]
,
enableEncryptionAtHost: boolean ,
provisioningState: enum ,
enableAcceleratedNetworking: boolean ,
useDefaultPublicLoadBalancer: boolean ,
useTempDataDisk: boolean ,
enableOverProvisioning: boolean ,
zones:
[
string ,
]
,
isSpotVM: boolean ,
hostGroupId: string ,
useEphemeralOSDisk: boolean ,
spotRestoreTimeout: string ,
evictionPolicy: enum ,
vmImageResourceId: string ,
subnetId: string ,
vmSetupActions:
[
string ,
]
,
securityType: enum ,
securityEncryptionType: enum ,
secureBootEnabled: boolean ,
enableNodePublicIP: boolean ,
enableNodePublicIPv6: boolean ,
vmSharedGalleryImageId: string ,
natGatewayId: string ,
natConfigurations:
[
{
backendPort: integer ,
frontendPortRangeStart: integer ,
frontendPortRangeEnd: integer ,
}
,
]
,
vmImagePlan:
{
name: string ,
product: string ,
promotionCode: string ,
publisher: string ,
}
,
serviceArtifactReferenceId: string ,
dscpConfigurationId: string ,
additionalNetworkInterfaceConfigurations:
[
{
name: string ,
enableAcceleratedNetworking: boolean ,
dscpConfiguration:
{
id: string ,
}
,
ipConfigurations:
[
{
name: string ,
applicationGatewayBackendAddressPools:
[
{
id: string ,
}
,
]
,
loadBalancerBackendAddressPools:
[
{
id: string ,
}
,
]
,
loadBalancerInboundNatPools:
[
{
id: string ,
}
,
]
,
subnet:
{
id: string ,
}
,
privateIPAddressVersion: enum ,
publicIPAddressConfiguration:
{
name: string ,
ipTags:
[
{
ipTagType: string ,
tag: string ,
}
,
]
,
publicIPAddressVersion: enum ,
}
,
}
,
]
,
}
,
]
,
computerNamePrefix: string ,
vmApplications:
[
{
configurationReference: string ,
enableAutomaticUpgrade: boolean ,
order: integer ,
packageReferenceId: string ,
vmGalleryTags: string ,
treatFailureAsDeploymentFailure: boolean ,
}
,
]
,
}
,
tags: object ,
sku:
{
name: string ,
tier: string ,
capacity: integer ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}