Fleets - Get

Service:: Azure Compute Fleet

API Version:: 2024-05-01-preview

Get a Fleet

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{fleetName}?api-version=2024-05-01-preview

URI Parameters

Name	In	Required	Type	Description
fleetName	path	True	string pattern: ^[^_\W][\w\-._]{0,79}(?	The name of the Compute Fleet
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	Fleet	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Fleets_Get

Sample request

GET https://management.azure.com/subscriptions/1DC2F28C-A625-4B0E-9748-9885A3C9E9EB/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet?api-version=2024-05-01-preview


/**
 * Samples for Fleets GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Get.json
     */
    /**
     * Sample code: Fleets_Get.
     * 
     * @param manager Entry point to ComputeFleetManager.
     */
    public static void fleetsGet(com.azure.resourcemanager.computefleet.ComputeFleetManager manager) {
        manager.fleets().getByResourceGroupWithResponse("rgazurefleet", "testFleet", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ComputeFleet.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ComputeFleet;

// Generated from example definition: specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Get.json
// this example is just showing the usage of "Fleets_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ComputeFleetResource created on azure
// for more information of creating ComputeFleetResource, please refer to the document of ComputeFleetResource
string subscriptionId = "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB";
string resourceGroupName = "rgazurefleet";
string fleetName = "testFleet";
ResourceIdentifier computeFleetResourceId = ComputeFleetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, fleetName);
ComputeFleetResource computeFleet = client.GetComputeFleetResource(computeFleetResourceId);

// invoke the operation
ComputeFleetResource result = await computeFleet.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ComputeFleetData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "properties": {
    "provisioningState": "Creating",
    "spotPriorityProfile": {
      "capacity": 20,
      "minCapacity": 10,
      "maxPricePerVM": 0.00865,
      "evictionPolicy": "Delete",
      "allocationStrategy": "PriceCapacityOptimized",
      "maintain": true
    },
    "regularPriorityProfile": {
      "capacity": 20,
      "minCapacity": 10,
      "allocationStrategy": "LowestPrice"
    },
    "vmSizesProfile": [
      {
        "name": "Standard_d1_v2",
        "rank": 19225
      }
    ],
    "computeProfile": {
      "baseVirtualMachineProfile": {
        "osProfile": {
          "computerNamePrefix": "o",
          "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp",
          "windowsConfiguration": {
            "provisionVMAgent": true,
            "enableAutomaticUpdates": true,
            "timeZone": "hlyjiqcfksgrpjrct",
            "additionalUnattendContent": [
              {
                "passName": "OobeSystem",
                "componentName": "Microsoft-Windows-Shell-Setup",
                "settingName": "AutoLogon"
              }
            ],
            "patchSettings": {
              "patchMode": "Manual",
              "enableHotpatching": true,
              "assessmentMode": "ImageDefault",
              "automaticByPlatformSettings": {
                "rebootSetting": "Unknown",
                "bypassPlatformSafetyChecksOnUserSchedule": true
              }
            },
            "winRM": {
              "listeners": [
                {
                  "protocol": "Http",
                  "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName"
                }
              ]
            },
            "enableVMAgentPlatformUpdates": true
          },
          "linuxConfiguration": {
            "disablePasswordAuthentication": true,
            "ssh": {
              "publicKeys": [
                {
                  "path": "kmqz",
                  "keyData": "kivgsubusvpprwqaqpjcmhsv"
                }
              ]
            },
            "provisionVMAgent": true,
            "patchSettings": {
              "patchMode": "ImageDefault",
              "assessmentMode": "ImageDefault",
              "automaticByPlatformSettings": {
                "rebootSetting": "Unknown",
                "bypassPlatformSafetyChecksOnUserSchedule": true
              }
            },
            "enableVMAgentPlatformUpdates": true
          },
          "secrets": [
            {
              "sourceVault": {
                "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}"
              },
              "vaultCertificates": [
                {
                  "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName",
                  "certificateStore": "nlxrwavpzhueffxsshlun"
                }
              ]
            }
          ],
          "allowExtensionOperations": true,
          "requireGuestProvisionSignal": true
        },
        "storageProfile": {
          "imageReference": {
            "publisher": "mqxgwbiyjzmxavhbkd",
            "offer": "isxgumkarlkomp",
            "sku": "eojmppqcrnpmxirtp",
            "version": "wvpcqefgtmqdgltiuz",
            "exactVersion": "zjbntmiskjexlr",
            "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx",
            "communityGalleryImageId": "vlqe",
            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}"
          },
          "osDisk": {
            "name": "wfttw",
            "caching": "None",
            "writeAcceleratorEnabled": true,
            "createOption": "FromImage",
            "diffDiskSettings": {
              "option": "Local",
              "placement": "CacheDisk"
            },
            "diskSizeGB": 14,
            "osType": "Windows",
            "image": {
              "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd"
            },
            "vhdContainers": [
              "tkzcwddtinkfpnfklatw"
            ],
            "managedDisk": {
              "storageAccountType": "Standard_LRS",
              "diskEncryptionSet": {
                "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}"
              },
              "securityProfile": {
                "securityEncryptionType": "VMGuestStateOnly",
                "diskEncryptionSet": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}"
                }
              }
            },
            "deleteOption": "Delete"
          },
          "dataDisks": [
            {
              "name": "eogiykmdmeikswxmigjws",
              "lun": 14,
              "caching": "None",
              "writeAcceleratorEnabled": true,
              "createOption": "FromImage",
              "diskSizeGB": 6,
              "managedDisk": {
                "storageAccountType": "Standard_LRS",
                "diskEncryptionSet": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}"
                },
                "securityProfile": {
                  "securityEncryptionType": "VMGuestStateOnly",
                  "diskEncryptionSet": {
                    "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}"
                  }
                }
              },
              "diskIOPSReadWrite": 27,
              "diskMBpsReadWrite": 2,
              "deleteOption": "Delete"
            }
          ],
          "diskControllerType": "uzb"
        },
        "networkProfile": {
          "healthProbe": {
            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}"
          },
          "networkInterfaceConfigurations": [
            {
              "name": "i",
              "properties": {
                "primary": true,
                "enableAcceleratedNetworking": true,
                "disableTcpStateTracking": true,
                "enableFpga": true,
                "networkSecurityGroup": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}"
                },
                "dnsSettings": {
                  "dnsServers": [
                    "nxmmfolhclsesu"
                  ]
                },
                "ipConfigurations": [
                  {
                    "name": "oezqhkidfhyywlfzwuotilrpbqnjg",
                    "properties": {
                      "subnet": {
                        "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
                      },
                      "primary": true,
                      "publicIPAddressConfiguration": {
                        "name": "fvpqf",
                        "properties": {
                          "idleTimeoutInMinutes": 9,
                          "dnsSettings": {
                            "domainNameLabel": "ukrddzvmorpmfsczjwtbvp",
                            "domainNameLabelScope": "TenantReuse"
                          },
                          "ipTags": [
                            {
                              "ipTagType": "sddgsoemnzgqizale",
                              "tag": "wufmhrjsakbiaetyara"
                            }
                          ],
                          "publicIPPrefix": {
                            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}"
                          },
                          "publicIPAddressVersion": "IPv4",
                          "deleteOption": "Delete"
                        },
                        "sku": {
                          "name": "Basic",
                          "tier": "Regional"
                        }
                      },
                      "privateIPAddressVersion": "IPv4",
                      "applicationGatewayBackendAddressPools": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}"
                        }
                      ],
                      "applicationSecurityGroups": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}"
                        }
                      ],
                      "loadBalancerBackendAddressPools": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}"
                        }
                      ],
                      "loadBalancerInboundNatPools": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}"
                        }
                      ]
                    }
                  }
                ],
                "enableIPForwarding": true,
                "deleteOption": "Delete",
                "auxiliaryMode": "None",
                "auxiliarySku": "None"
              }
            }
          ],
          "networkApiVersion": "2020-11-01"
        },
        "securityProfile": {
          "uefiSettings": {
            "secureBootEnabled": true,
            "vTpmEnabled": true
          },
          "encryptionAtHost": true,
          "securityType": "TrustedLaunch",
          "encryptionIdentity": {
            "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}"
          },
          "proxyAgentSettings": {
            "enabled": true,
            "mode": "Audit",
            "keyIncarnationId": 20
          }
        },
        "diagnosticsProfile": {
          "bootDiagnostics": {
            "enabled": true,
            "storageUri": "http://myStorageAccountName.blob.core.windows.net"
          }
        },
        "extensionProfile": {
          "extensions": [
            {
              "name": "bndxuxx",
              "type": "cmeam",
              "properties": {
                "forceUpdateTag": "yhgxw",
                "publisher": "kpxtirxjfprhs",
                "type": "pgjilctjjwaa",
                "typeHandlerVersion": "zevivcoilxmbwlrihhhibq",
                "autoUpgradeMinorVersion": true,
                "enableAutomaticUpgrade": true,
                "settings": {},
                "provisioningState": "Succeeded",
                "provisionAfterExtensions": [
                  "nftzosroolbcwmpupujzqwqe"
                ],
                "suppressFailures": true,
                "protectedSettingsFromKeyVault": {
                  "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName",
                  "sourceVault": {
                    "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}"
                  }
                }
              },
              "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}"
            }
          ],
          "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil"
        },
        "licenseType": "v",
        "scheduledEventsProfile": {
          "terminateNotificationProfile": {
            "notBeforeTimeout": "iljppmmw",
            "enable": true
          },
          "osImageNotificationProfile": {
            "notBeforeTimeout": "olbpadmevekyczfokodtfprxti",
            "enable": true
          }
        },
        "userData": "s",
        "capacityReservation": {
          "capacityReservationGroup": {
            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}"
          }
        },
        "applicationProfile": {
          "galleryApplications": [
            {
              "tags": "eyrqjbib",
              "order": 5,
              "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}",
              "treatFailureAsDeploymentFailure": true,
              "enableAutomaticUpgrade": true
            }
          ]
        },
        "hardwareProfile": {
          "vmSizeProperties": {
            "vCPUsAvailable": 16,
            "vCPUsPerCore": 23
          }
        },
        "serviceArtifactReference": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}"
        },
        "securityPostureReference": {
          "id": "mubredelfbshboaxrsxiajihahaa",
          "excludeExtensions": [
            "{securityPostureVMExtensionName}"
          ],
          "isOverridable": true
        },
        "timeCreated": "2024-04-29T21:51:44.043Z"
      },
      "computeApiVersion": "2023-07-01",
      "platformFaultDomainCount": 1
    },
    "timeCreated": "2024-07-10T00:16:34.8590555+00:00",
    "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28"
  },
  "zones": [
    "zone1",
    "zone2"
  ],
  "identity": {
    "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c",
    "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c",
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "key9851": {
        "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c",
        "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c"
      }
    }
  },
  "tags": {
    "key3518": "luvrnuvsgdpbuofdskkcoqhfh"
  },
  "plan": {
    "name": "jwgrcrnrtfoxn",
    "publisher": "iozjbiqqckqm",
    "product": "cgopbyvdyqikahwyxfpzwaqk",
    "promotionCode": "naglezezplcaruqogtxnuizslqnnbr",
    "version": "wa"
  },
  "location": "westus",
  "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet",
  "name": "testFleet",
  "type": "Microsoft.AzureFleet/fleets",
  "systemData": {
    "createdBy": "rowegentrpoajsv",
    "createdByType": "User",
    "createdAt": "2024-04-29T21:51:44.043Z",
    "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-04-29T21:51:44.043Z"
  }
}

Definitions

Name	Description
AdditionalUnattendContent	Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.
ApiEntityReference	The API entity reference.
ApplicationProfile	Contains the list of gallery applications that should be made available to the VM/VMSS
BaseVirtualMachineProfile	Describes the base virtual machine profile for fleet
BootDiagnostics	Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.
CachingTypes	Specifies the caching requirements.
CapacityReservationProfile	The parameters of a capacity reservation Profile.
ComputeProfile	Compute Profile to use for running user's workloads.
createdByType	The type of identity that created the resource.
DeleteOptions	Specify what happens to the network interface when the VM is deleted
DiagnosticsProfile	Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
DiffDiskOptions	Specifies the ephemeral disk option for operating system disk.
DiffDiskPlacement	Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements Minimum api-version for NvmeDisk: 2024-03-01.
DiffDiskSettings	Describes the parameters of ephemeral disk settings that can be specified for operating system disk. Note: The ephemeral disk settings can only be specified for managed disk.
DiskControllerTypes	Specifies the disk controller type configured for the VM and VirtualMachineScaleSet. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://learn.microsoft.com/en-us/azure/virtual-machines/generation-2), please check the HyperVGenerations capability returned as part of VM sku capabilities in the response of Microsoft.Compute SKUs api for the region contains V2 (https://learn.microsoft.com/rest/api/compute/resourceskus/list). For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes.
DiskCreateOptionTypes	Specifies how the virtual machine should be created.
DiskDeleteOptionTypes	Specifies the behavior of the managed disk when the VM gets deleted, for example whether the managed disk is deleted or detached. Supported values are: Delete. If this value is used, the managed disk is deleted when VM gets deleted. Detach. If this value is used, the managed disk is retained after VM gets deleted. Minimum api-version: 2021-03-01.
DiskEncryptionSetParameters	Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. Note: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.
DomainNameLabelScopeTypes	The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created
EncryptionIdentity	Specifies the Managed Identity used by ADE to get access token for keyvault operations.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
EvictionPolicy	Different kind of eviction policies
Fleet	An Compute Fleet resource
ImageReference	Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.
IPVersion	Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.
KeyVaultSecretReference	Describes a reference to Key Vault Secret
LinuxConfiguration	Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.
LinuxPatchAssessmentMode	Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
LinuxPatchSettings	Specifies settings related to VM Guest Patching on Linux.
LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
LinuxVMGuestPatchAutomaticByPlatformSettings	Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings.
LinuxVMGuestPatchMode	Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Mode	Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode.
NetworkApiVersion	specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'
NetworkInterfaceAuxiliaryMode	Specifies whether the Auxiliary mode is enabled for the Network Interface resource.
NetworkInterfaceAuxiliarySku	Specifies whether the Auxiliary sku is enabled for the Network Interface resource.
OperatingSystemTypes	This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux.
OSImageNotificationProfile	Specifies OS Image Scheduled Event related configurations.
PatchSettings	Specifies settings related to VM Guest Patching on Windows.
Plan	Plan for the resource.
ProtocolTypes	Specifies the protocol of WinRM listener. Possible values are: http, https.
ProvisioningState	The status of the current operation.
ProxyAgentSettings	Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01.
PublicIPAddressSku	Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.
PublicIPAddressSkuName	Specify public IP sku name.
PublicIPAddressSkuTier	Specify public IP sku tier
RegularPriorityAllocationStrategy	Regular VM Allocation strategy types for Compute Fleet
RegularPriorityProfile	Configuration Options for Regular instances in Compute Fleet.
ScheduledEventsProfile	Specifies Scheduled Event related configurations.
SecurityEncryptionTypes	Specifies the EncryptionType of the managed disk. Note: It can be set for only Confidential VMs.
SecurityPostureReference	Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01
SecurityProfile	Specifies the Security profile settings for the virtual machine or virtual machine scale set.
SecurityTypes	Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.
ServiceArtifactReference	Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01
SettingNames	Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.
SpotAllocationStrategy	Spot allocation strategy types for Compute Fleet
SpotPriorityProfile	Configuration Options for Spot instances in Compute Fleet.
SshConfiguration	SSH configuration for Linux based VMs running on Azure
SshPublicKey	Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.
StorageAccountTypes	Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://learn.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://learn.microsoft.com/azure/virtual-machines/linux/disks-types
SubResource	Describes SubResource
systemData	Metadata pertaining to creation and last modification of the resource.
TerminateNotificationProfile	Specifies Terminate Scheduled Event related configurations.
UefiSettings	Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.
UserAssignedIdentity	User assigned identity properties
VaultCertificate	Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.
VaultSecretGroup	Describes a set of certificates which are all in the same Key Vault.
VirtualHardDisk	Describes the uri of a disk.
VirtualMachineScaleSetDataDisk	Describes a virtual machine scale set data disk.
VirtualMachineScaleSetExtension	Describes a Virtual Machine Scale Set Extension.
VirtualMachineScaleSetExtensionProfile	Describes a virtual machine scale set extension profile.
VirtualMachineScaleSetExtensionProperties	Describes the properties of a Virtual Machine Scale Set Extension.
VirtualMachineScaleSetHardwareProfile	Specifies the hardware settings for the virtual machine scale set.
VirtualMachineScaleSetIPConfiguration	Describes a virtual machine scale set network profile's IP configuration.
VirtualMachineScaleSetIPConfigurationProperties	Describes a virtual machine scale set network profile's IP configuration properties.
VirtualMachineScaleSetIpTag	Contains the IP tag associated with the public IP address.
VirtualMachineScaleSetManagedDiskParameters	Describes the parameters of a ScaleSet managed disk.
VirtualMachineScaleSetNetworkConfiguration	Describes a virtual machine scale set network profile's network configurations.
VirtualMachineScaleSetNetworkConfigurationDnsSettings	Describes a virtual machines scale sets network configuration's DNS settings.
VirtualMachineScaleSetNetworkConfigurationProperties	Describes a virtual machine scale set network profile's IP configuration.
VirtualMachineScaleSetNetworkProfile	Describes a virtual machine scale set network profile.
VirtualMachineScaleSetOSDisk	Describes a virtual machine scale set operating system disk.
VirtualMachineScaleSetOSProfile	Describes a virtual machine scale set OS profile.
VirtualMachineScaleSetPublicIPAddressConfiguration	Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	Describes a virtual machines scale sets network configuration's DNS settings.
VirtualMachineScaleSetPublicIPAddressConfigurationProperties	Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
VirtualMachineScaleSetStorageProfile	Describes a virtual machine scale set storage profile.
VMDiskSecurityProfile	Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs.
VMGalleryApplication	Specifies the required information to reference a compute gallery application version
VmSizeProfile	Specifications about a VM Size. This will also contain the corresponding rank and weight in future.
VMSizeProperties	Specifies VM Size Property settings on the virtual machine.
WindowsConfiguration	Specifies Windows operating system settings on the virtual machine.
WindowsPatchAssessmentMode	Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.
WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
WindowsVMGuestPatchAutomaticByPlatformSettings	Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings.
WindowsVMGuestPatchMode	Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.
WinRMConfiguration	Describes Windows Remote Management configuration of the VM
WinRMListener	Describes Protocol and thumbprint of Windows Remote Management listener

AdditionalUnattendContent

Object

Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.

Name	Type	Description
componentName	enum: Microsoft-Windows-Shell-Setup	The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.
content	string (password)	Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.
passName	enum: OobeSystem	The pass name. Currently, the only allowable value is OobeSystem.
settingName	SettingNames	Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

ApiEntityReference

Object

The API entity reference.

Name	Type	Description
id	string (arm-id)	The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApplicationProfile

Object

Contains the list of gallery applications that should be made available to the VM/VMSS

Name	Type	Description
galleryApplications	VMGalleryApplication[]	Specifies the gallery applications that should be made available to the VM/VMSS

BaseVirtualMachineProfile

Object

Describes the base virtual machine profile for fleet

Name	Type	Description
applicationProfile	ApplicationProfile	Specifies the gallery applications that should be made available to the VM/VMSS
capacityReservation	CapacityReservationProfile	Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01.
diagnosticsProfile	DiagnosticsProfile	Specifies the boot diagnostic settings state.
extensionProfile	VirtualMachineScaleSetExtensionProfile	Specifies a collection of settings for extensions installed on virtual machines in the scale set.
hardwareProfile	VirtualMachineScaleSetHardwareProfile	Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01.
licenseType	string	Specifies that the image or disk that is being used was licensed on-premises. Possible values for Windows Server operating system are: Windows_Client Windows_Server Possible values for Linux Server operating system are: RHEL_BYOS (for RHEL) SLES_BYOS (for SUSE) For more information, see Azure Hybrid Use Benefit for Windows Server Azure Hybrid Use Benefit for Linux Server Minimum api-version: 2015-06-15
networkProfile	VirtualMachineScaleSetNetworkProfile	Specifies properties of the network interfaces of the virtual machines in the scale set.
osProfile	VirtualMachineScaleSetOSProfile	Specifies the operating system settings for the virtual machines in the scale set.
scheduledEventsProfile	ScheduledEventsProfile	Specifies Scheduled Event related configurations.
securityPostureReference	SecurityPostureReference	Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01
securityProfile	SecurityProfile	Specifies the Security related profile settings for the virtual machines in the scale set.
serviceArtifactReference	ServiceArtifactReference	Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01
storageProfile	VirtualMachineScaleSetStorageProfile	Specifies the storage settings for the virtual machine disks.
timeCreated	string (date-time)	Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. Minimum API version for this property is 2023-09-01. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00"
userData	string	UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01.

BootDiagnostics

Object

Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.

Name	Type	Description
enabled	boolean	Whether boot diagnostics should be enabled on the Virtual Machine.
storageUri	string (uri)	Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used.

CachingTypes

Enumeration

Specifies the caching requirements.

Value	Description
None	'None' is default for Standard Storage
ReadOnly	'ReadOnly' is default for Premium Storage
ReadWrite	'ReadWrite' is default for OS Disk

CapacityReservationProfile

Object

The parameters of a capacity reservation Profile.

Name	Type	Description
capacityReservationGroup	SubResource	Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details.

ComputeProfile

Object

Compute Profile to use for running user's workloads.

Name	Type	Description
baseVirtualMachineProfile	BaseVirtualMachineProfile	Base Virtual Machine Profile Properties to be specified according to "specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile"
computeApiVersion	string	Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines. The default value will be the latest supported computeApiVersion by Compute Fleet.
platformFaultDomainCount	integer (int32)	Specifies the number of fault domains to use when creating the underlying VMSS. A fault domain is a logical group of hardware within an Azure datacenter. VMs in the same fault domain share a common power source and network switch. If not specified, defaults to 1, which represents "Max Spreading" (using as many fault domains as possible). This property cannot be updated.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
Application
Key
ManagedIdentity
User

DeleteOptions

Enumeration

Specify what happens to the network interface when the VM is deleted

Value	Description
Delete	Delete Option
Detach	Detach Option

DiagnosticsProfile

Object

Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.

Name	Type	Description
bootDiagnostics	BootDiagnostics	Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.

DiffDiskOptions

Enumeration

Specifies the ephemeral disk option for operating system disk.

Value	Description
Local	Local Option.

DiffDiskPlacement

Enumeration

Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements Minimum api-version for NvmeDisk: 2024-03-01.

Value	Description
CacheDisk	CacheDisk option.
NvmeDisk	NvmeDisk option.
ResourceDisk	Resource Disk option.

DiffDiskSettings

Object

Describes the parameters of ephemeral disk settings that can be specified for operating system disk. Note: The ephemeral disk settings can only be specified for managed disk.

Name	Type	Description
option	DiffDiskOptions	Specifies the ephemeral disk settings for operating system disk.
placement	DiffDiskPlacement	Specifies the ephemeral disk placement for operating system disk. Possible values are: CacheDisk, ResourceDisk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk is used. Refer to the VM size documentation for Windows VM at https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk.

DiskControllerTypes

Enumeration

Specifies the disk controller type configured for the VM and VirtualMachineScaleSet. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://learn.microsoft.com/en-us/azure/virtual-machines/generation-2), please check the HyperVGenerations capability returned as part of VM sku capabilities in the response of Microsoft.Compute SKUs api for the region contains V2 (https://learn.microsoft.com/rest/api/compute/resourceskus/list). For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes.

Value	Description
NVMe	NVMe disk type
SCSI	SCSI disk type

DiskCreateOptionTypes

Enumeration

Specifies how the virtual machine should be created.

Value	Description
Attach	This value is used when you are using a specialized disk to create the virtual machine.
Copy	This value is used to create a data disk from a snapshot or another disk.
Empty	This value is used when creating an empty data disk.
FromImage	This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.
Restore	This value is used to create a data disk from a disk restore point.

DiskDeleteOptionTypes

Enumeration

Specifies the behavior of the managed disk when the VM gets deleted, for example whether the managed disk is deleted or detached. Supported values are: Delete. If this value is used, the managed disk is deleted when VM gets deleted. Detach. If this value is used, the managed disk is retained after VM gets deleted. Minimum api-version: 2021-03-01.

Value	Description
Delete	If this value is used, the managed disk is deleted when VM gets deleted.
Detach	If this value is used, the managed disk is retained after VM gets deleted.

DiskEncryptionSetParameters

Object

Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. Note: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.

Name	Type	Description
id	string (arm-id)	Resource Id

DomainNameLabelScopeTypes

Enumeration

The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created

Value	Description
NoReuse	NoReuse type
ResourceGroupReuse	ResourceGroupReuse type
SubscriptionReuse	SubscriptionReuse type
TenantReuse	TenantReuse type

EncryptionIdentity

Object

Specifies the Managed Identity used by ADE to get access token for keyvault operations.

Name	Type	Description
userAssignedIdentityResourceId	string (arm-id)	Specifies ARM Resource ID of one of the user identities associated with the VM.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

EvictionPolicy

Enumeration

Different kind of eviction policies

Value	Description
Deallocate	When evicted, the Spot VM will be deallocated/stopped
Delete	When evicted, the Spot VM will be deleted and the corresponding capacity will be updated to reflect this.

Fleet

Object

An Compute Fleet resource

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
name	string	The name of the resource
plan	Plan	Details of the resource plan.
properties.computeProfile	ComputeProfile	Compute Profile to use for running user's workloads.
properties.provisioningState	ProvisioningState	The status of the last operation.
properties.regularPriorityProfile	RegularPriorityProfile	Configuration Options for Regular instances in Compute Fleet.
properties.spotPriorityProfile	SpotPriorityProfile	Configuration Options for Spot instances in Compute Fleet.
properties.timeCreated	string (date-time)	Specifies the time at which the Compute Fleet is created.
properties.uniqueId	string	Specifies the ID which uniquely identifies a Compute Fleet.
properties.vmSizesProfile	VmSizeProfile[]	List of VM sizes supported for Compute Fleet
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
zones	string[]	Zones in which the Compute Fleet is available

ImageReference

Object

Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.

Name	Type	Description
communityGalleryImageId	string	Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.
exactVersion	string	Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'.
id	string (arm-id)	Resource Id
offer	string	Specifies the offer of the platform image or marketplace image used to create the virtual machine.
publisher	string	The image publisher.
sharedGalleryImageId	string	Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.
sku	string	The image SKU.
version	string	Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input.

IPVersion

Enumeration

Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.

Value	Description
IPv4	IPv4 version
IPv6	IPv6 version

KeyVaultSecretReference

Object

Describes a reference to Key Vault Secret

Name	Type	Description
secretUrl	string (uri)	The URL referencing a secret in a Key Vault.
sourceVault	SubResource	The relative URL of the Key Vault containing the secret.

LinuxConfiguration

Object

Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.

Name	Type	Description
disablePasswordAuthentication	boolean	Specifies whether password authentication should be disabled.
enableVMAgentPlatformUpdates	boolean	Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false.
patchSettings	LinuxPatchSettings	[Preview Feature] Specifies settings related to VM Guest Patching on Linux.
provisionVMAgent	boolean	Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
ssh	SshConfiguration	Specifies the ssh key configuration for a Linux OS.

LinuxPatchAssessmentMode

Enumeration

Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

ImageDefault - You control the timing of patch assessments on a virtual machine.

AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

Value	Description
AutomaticByPlatform	The platform will trigger periodic patch assessments.The property provisionVMAgent must be true.
ImageDefault	You control the timing of patch assessments on a virtual machine.

LinuxPatchSettings

Object

Specifies settings related to VM Guest Patching on Linux.

Name	Type	Description
assessmentMode	LinuxPatchAssessmentMode	Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.
patchMode	LinuxVMGuestPatchMode	Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: ImageDefault - The virtual machine's default patching configuration is used. AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Enumeration

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

Value	Description
Always	Always Reboot setting
IfRequired	IfRequired Reboot setting
Never	Never Reboot setting
Unknown	Unknown Reboot setting

LinuxVMGuestPatchAutomaticByPlatformSettings

Object

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings.

Name	Type	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	Enables customer to schedule patching without accidental upgrades
rebootSetting	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

LinuxVMGuestPatchMode

Enumeration

Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Value	Description
AutomaticByPlatform	The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true.
ImageDefault	The virtual machine's default patching configuration is used.

ManagedServiceIdentity

Object

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string (uuid)	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string (uuid)	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

ManagedServiceIdentityType

Enumeration

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Value	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

Mode

Enumeration

Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode.

Value	Description
Audit	Audit Mode
Enforce	Enforce Mode

NetworkApiVersion

Enumeration

specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'

Value	Description
2020-11-01	Initial version supported. Later versions are supported as well.

NetworkInterfaceAuxiliaryMode

Enumeration

Specifies whether the Auxiliary mode is enabled for the Network Interface resource.

Value	Description
AcceleratedConnections	AcceleratedConnections Mode
Floating	Floating Mode
None	None Mode

NetworkInterfaceAuxiliarySku

Enumeration

Specifies whether the Auxiliary sku is enabled for the Network Interface resource.

Value	Description
A1	A1 sku
A2	A2 sku
A4	A4 sku
A8	A8 sku
None	no sku

OperatingSystemTypes

Enumeration

This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux.

Value	Description
Linux	Linux OS type
Windows	Windows OS type

OSImageNotificationProfile

Object

Specifies OS Image Scheduled Event related configurations.

Name	Type	Description
enable	boolean	Specifies whether the OS Image Scheduled event is enabled or disabled.
notBeforeTimeout	string	Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must not exceed 15 minutes (PT15M)

PatchSettings

Object

Specifies settings related to VM Guest Patching on Windows.

Name	Type	Description
assessmentMode	WindowsPatchAssessmentMode	Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. Possible values are: ImageDefault - You control the timing of patch assessments on a virtual machine. AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
automaticByPlatformSettings	WindowsVMGuestPatchAutomaticByPlatformSettings	Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.
enableHotpatching	boolean	Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'.
patchMode	WindowsVMGuestPatchMode	Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. Possible values are: Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true

Plan

Object

Plan for the resource.

Name	Type	Description
name	string	A user defined name of the 3rd Party Artifact that is being procured.
product	string	The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
promotionCode	string	A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
publisher	string	The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
version	string	The version of the desired product/artifact.

ProtocolTypes

Enumeration

Specifies the protocol of WinRM listener. Possible values are: http, https.

Value	Description
Http	Http protocol
Https	Https protocol

ProvisioningState

Enumeration

The status of the current operation.

Value	Description
Canceled	Resource creation was canceled.
Creating	Initial creation in progress.
Deleting	Deletion in progress.
Failed	Resource creation failed.
Migrating	Resource is being migrated from one subscription or resource group to another.
Succeeded	Resource has been created.
Updating	Update in progress.

ProxyAgentSettings

Object

Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01.

Name	Type	Description
enabled	boolean	Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set.
keyIncarnationId	integer (int32)	Increase the value of this property allows user to reset the key used for securing communication channel between guest and host.
mode	Mode	Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode.

PublicIPAddressSku

Object

Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.

Name	Type	Description
name	PublicIPAddressSkuName	Specify public IP sku name
tier	PublicIPAddressSkuTier	Specify public IP sku tier

PublicIPAddressSkuName

Enumeration

Specify public IP sku name.

Value	Description
Basic	Basic sku name
Standard	Standard sku name

PublicIPAddressSkuTier

Enumeration

Specify public IP sku tier

Value	Description
Global	Global sku tier
Regional	Regional sku tier

RegularPriorityAllocationStrategy

Enumeration

Regular VM Allocation strategy types for Compute Fleet

Value	Description
LowestPrice	Default. VM sizes distribution will be determined to optimize for price.
Prioritized	VM sizes distribution will be determined to optimize for the 'priority' as specified for each vm size.

RegularPriorityProfile

Object

Configuration Options for Regular instances in Compute Fleet.

Name	Type	Description
allocationStrategy	RegularPriorityAllocationStrategy	Allocation strategy to follow when determining the VM sizes distribution for Regular VMs.
capacity	integer (int32) minimum: 0	Total capacity to achieve. It is currently in terms of number of VMs.
minCapacity	integer (int32) minimum: 0	Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself.

ScheduledEventsProfile

Object

Specifies Scheduled Event related configurations.

Name	Type	Description
osImageNotificationProfile	OSImageNotificationProfile	Specifies OS Image Scheduled Event related configurations.
terminateNotificationProfile	TerminateNotificationProfile	Specifies Terminate Scheduled Event related configurations.

SecurityEncryptionTypes

Enumeration

Specifies the EncryptionType of the managed disk. Note: It can be set for only Confidential VMs.

Value	Description
DiskWithVMGuestState	EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob.
NonPersistedTPM	EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob.
VMGuestStateOnly	EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob.

SecurityPostureReference

Object

Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01

Name	Type	Description
excludeExtensions	string[]	List of virtual machine extension names to exclude when applying the security posture.
id	string	The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}\|{major.*}\|latest
isOverridable	boolean	Whether the security posture can be overridden by the user.

SecurityProfile

Object

Specifies the Security profile settings for the virtual machine or virtual machine scale set.

Name	Type	Description
encryptionAtHost	boolean	This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource.
encryptionIdentity	EncryptionIdentity	Specifies the Managed Identity used by ADE to get access token for keyvault operations.
proxyAgentSettings	ProxyAgentSettings	Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01.
securityType	SecurityTypes	Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.
uefiSettings	UefiSettings	Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.

SecurityTypes

Enumeration

Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.

Value	Description
ConfidentialVM	ConfidentialVM security type
TrustedLaunch	TrustedLaunch security type

ServiceArtifactReference

Object

Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01

Name	Type	Description
id	string (arm-id)	The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

SettingNames

Enumeration

Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

Value	Description
AutoLogon	AutoLogon setting
FirstLogonCommands	FirstLogonCommands setting

SpotAllocationStrategy

Enumeration

Spot allocation strategy types for Compute Fleet

Value	Description
CapacityOptimized	VM sizes distribution will be determined to optimize for capacity.
LowestPrice	VM sizes distribution will be determined to optimize for price. Note: Capacity will still be considered here but will be given much less weight.
PriceCapacityOptimized	Default. VM sizes distribution will be determined to optimize for both price and capacity.

SpotPriorityProfile

Object

Configuration Options for Spot instances in Compute Fleet.

Name	Type	Description
allocationStrategy	SpotAllocationStrategy	Allocation strategy to follow when determining the VM sizes distribution for Spot VMs.
capacity	integer (int32) minimum: 0	Total capacity to achieve. It is currently in terms of number of VMs.
evictionPolicy	EvictionPolicy	Eviction Policy to follow when evicting Spot VMs.
maintain	boolean	Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs. If maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted) or update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity. Maintain is enabled by default.
maxPricePerVM	number (float)	Price per hour of each Spot VM will never exceed this.
minCapacity	integer (int32) minimum: 0	Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself.

SshConfiguration

Object

SSH configuration for Linux based VMs running on Azure

Name	Type	Description
publicKeys	SshPublicKey[]	The list of SSH public keys used to authenticate with linux based VMs.

SshPublicKey

Object

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

Name	Type	Description
keyData	string	SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path	string	Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys

StorageAccountTypes

Enumeration

Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://learn.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://learn.microsoft.com/azure/virtual-machines/linux/disks-types

Value	Description
PremiumV2_LRS	PremiumV2_LRS option.
Premium_LRS	Premium_LRS option.
Premium_ZRS	Premium_ZRS option.
StandardSSD_LRS	StandardSSD_LRS option.
StandardSSD_ZRS	StandardSSD_ZRS option.
Standard_LRS	Standard_LRS option.
UltraSSD_LRS	UltraSSD_LRS option.

SubResource

Object

Describes SubResource

Name	Type	Description
id	string (arm-id)	Resource Id

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

TerminateNotificationProfile

Object

Specifies Terminate Scheduled Event related configurations.

Name	Type	Description
enable	boolean	Specifies whether the Terminate Scheduled event is enabled or disabled.
notBeforeTimeout	string	Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M)

UefiSettings

Object

Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.

Name	Type	Description
secureBootEnabled	boolean	Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01.
vTpmEnabled	boolean	Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01.

UserAssignedIdentity

Object

User assigned identity properties

Name	Type	Description
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.

VaultCertificate

Object

Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.

Name	Type	Description
certificateStore	string	For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.
certificateUrl	string (uri)	This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"", "dataType":"pfx", "password":"" } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

VaultSecretGroup

Object

Describes a set of certificates which are all in the same Key Vault.

Name	Type	Description
sourceVault	SubResource	The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
vaultCertificates	VaultCertificate[]	The list of key vault references in SourceVault which contain certificates.

VirtualHardDisk

Object

Describes the uri of a disk.

Name	Type	Description
uri	string (uri)	Specifies the virtual hard disk's uri.

VirtualMachineScaleSetDataDisk

Object

Describes a virtual machine scale set data disk.

Name	Type	Description
caching	CachingTypes	Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
createOption	DiskCreateOptionTypes	The create option.
deleteOption	DiskDeleteOptionTypes	Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: Delete If this value is used, the data disk is deleted when the VMSS Flex VM is deleted. Detach If this value is used, the data disk is retained after VMSS Flex VM is deleted. The default value is set to Delete.
diskIOPSReadWrite	integer (int64)	Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.
diskMBpsReadWrite	integer (int64)	Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.
diskSizeGB	integer (int32)	Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
lun	integer (int32)	Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
managedDisk	VirtualMachineScaleSetManagedDiskParameters	The managed disk parameters.
name	string	The disk name.
writeAcceleratorEnabled	boolean	Specifies whether writeAccelerator should be enabled or disabled on the disk.

VirtualMachineScaleSetExtension

Object

Describes a Virtual Machine Scale Set Extension.

Name	Type	Description
id	string (arm-id)	Resource Id
name	string	The name of the extension.
properties	VirtualMachineScaleSetExtensionProperties	Describes the properties of a Virtual Machine Scale Set Extension.
type	string	Resource type

VirtualMachineScaleSetExtensionProfile

Object

Describes a virtual machine scale set extension profile.

Name	Type	Description
extensions	VirtualMachineScaleSetExtension[]	The virtual machine scale set child extension resources.
extensionsTimeBudget	string	Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01.

VirtualMachineScaleSetExtensionProperties

Object

Describes the properties of a Virtual Machine Scale Set Extension.

Name	Type	Description
autoUpgradeMinorVersion	boolean	Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
enableAutomaticUpgrade	boolean	Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
forceUpdateTag	string	If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
protectedSettings		The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
protectedSettingsFromKeyVault	KeyVaultSecretReference	The extensions protected settings that are passed by reference, and consumed from key vault
provisionAfterExtensions	string[]	Collection of extension names after which this extension needs to be provisioned.
provisioningState	string	The provisioning state, which only appears in the response.
publisher	string	The name of the extension handler publisher.
settings		Json formatted public settings for the extension.
suppressFailures	boolean	Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.
type	string	Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion	string	Specifies the version of the script handler.

VirtualMachineScaleSetHardwareProfile

Object

Specifies the hardware settings for the virtual machine scale set.

Name	Type	Description
vmSizeProperties	VMSizeProperties	Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in VM Customization for more details.

VirtualMachineScaleSetIPConfiguration

Object

Describes a virtual machine scale set network profile's IP configuration.

Name	Type	Description
name	string	The IP configuration name.
properties	VirtualMachineScaleSetIPConfigurationProperties	Describes a virtual machine scale set network profile's IP configuration properties.

VirtualMachineScaleSetIPConfigurationProperties

Object

Describes a virtual machine scale set network profile's IP configuration properties.

Name	Type	Description
applicationGatewayBackendAddressPools	SubResource[]	Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway.
applicationSecurityGroups	SubResource[]	Specifies an array of references to application security group.
loadBalancerBackendAddressPools	SubResource[]	Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer.
loadBalancerInboundNatPools	SubResource[]	Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer.
primary	boolean	Specifies the primary network interface in case the virtual machine has more than 1 network interface.
privateIPAddressVersion	IPVersion	Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.
publicIPAddressConfiguration	VirtualMachineScaleSetPublicIPAddressConfiguration	The publicIPAddressConfiguration.
subnet	ApiEntityReference	Specifies the identifier of the subnet.

VirtualMachineScaleSetIpTag

Object

Contains the IP tag associated with the public IP address.

Name	Type	Description
ipTagType	string	IP tag type. Example: FirstPartyUsage.
tag	string	IP tag associated with the public IP. Example: SQL, Storage etc.

VirtualMachineScaleSetManagedDiskParameters

Object

Describes the parameters of a ScaleSet managed disk.

Name	Type	Description
diskEncryptionSet	DiskEncryptionSetParameters	Specifies the customer managed disk encryption set resource id for the managed disk.
securityProfile	VMDiskSecurityProfile	Specifies the security profile for the managed disk.
storageAccountType	StorageAccountTypes	Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

VirtualMachineScaleSetNetworkConfiguration

Object

Describes a virtual machine scale set network profile's network configurations.

Name	Type	Description
name	string	The network configuration name.
properties	VirtualMachineScaleSetNetworkConfigurationProperties	Describes a virtual machine scale set network profile's IP configuration.

VirtualMachineScaleSetNetworkConfigurationDnsSettings

Object

Describes a virtual machines scale sets network configuration's DNS settings.

Name	Type	Description
dnsServers	string[]	List of DNS servers IP addresses

VirtualMachineScaleSetNetworkConfigurationProperties

Object

Describes a virtual machine scale set network profile's IP configuration.

Name	Type	Description
auxiliaryMode	NetworkInterfaceAuxiliaryMode	Specifies whether the Auxiliary mode is enabled for the Network Interface resource.
auxiliarySku	NetworkInterfaceAuxiliarySku	Specifies whether the Auxiliary sku is enabled for the Network Interface resource.
deleteOption	DeleteOptions	Specify what happens to the network interface when the VM is deleted
disableTcpStateTracking	boolean	Specifies whether the network interface is disabled for tcp state tracking.
dnsSettings	VirtualMachineScaleSetNetworkConfigurationDnsSettings	The dns settings to be applied on the network interfaces.
enableAcceleratedNetworking	boolean	Specifies whether the network interface is accelerated networking-enabled.
enableFpga	boolean	Specifies whether the network interface is FPGA networking-enabled.
enableIPForwarding	boolean	Whether IP forwarding enabled on this NIC.
ipConfigurations	VirtualMachineScaleSetIPConfiguration[]	Specifies the IP configurations of the network interface.
networkSecurityGroup	SubResource	The network security group.
primary	boolean	Specifies the primary network interface in case the virtual machine has more than 1 network interface.

VirtualMachineScaleSetNetworkProfile

Object

Describes a virtual machine scale set network profile.

Name	Type	Description
healthProbe	ApiEntityReference	A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'.
networkApiVersion	NetworkApiVersion	specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'
networkInterfaceConfigurations	VirtualMachineScaleSetNetworkConfiguration[]	The list of network configurations.

VirtualMachineScaleSetOSDisk

Object

Describes a virtual machine scale set operating system disk.

Name	Type	Description
caching	CachingTypes	Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
createOption	DiskCreateOptionTypes	Specifies how the virtual machines in the scale set should be created. The only allowed value is: FromImage. This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.
deleteOption	DiskDeleteOptionTypes	Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only). Possible values: Delete If this value is used, the OS disk is deleted when VMSS Flex VM is deleted. Detach If this value is used, the OS disk is retained after VMSS Flex VM is deleted. The default value is set to Delete. For an Ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for Ephemeral OS Disk.
diffDiskSettings	DiffDiskSettings	Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set.
diskSizeGB	integer (int32)	Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
image	VirtualHardDisk	Specifies information about the unmanaged user image to base the scale set on.
managedDisk	VirtualMachineScaleSetManagedDiskParameters	The managed disk parameters.
name	string	The disk name.
osType	OperatingSystemTypes	This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux.
vhdContainers	string[]	Specifies the container urls that are used to store operating system disks for the scale set.
writeAcceleratorEnabled	boolean	Specifies whether writeAccelerator should be enabled or disabled on the disk.

VirtualMachineScaleSetOSProfile

Object

Describes a virtual machine scale set OS profile.

Name	Type	Description
adminPassword	string (password)	Specifies the password of the administrator account. Minimum-length (Windows): 8 characters Minimum-length (Linux): 6 characters Max-length (Windows): 123 characters Max-length (Linux): 72 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension
adminUsername	string	Specifies the name of the administrator account. Windows-only restriction: Cannot end in "." Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters
allowExtensionOperations	boolean	Specifies whether extension operations should be allowed on the virtual machine scale set. This may only be set to False when no extensions are present on the virtual machine scale set.
computerNamePrefix	string	Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long.
customData	string (password)	Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation
linuxConfiguration	LinuxConfiguration	Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.
requireGuestProvisionSignal	boolean	Optional property which must either be set to True or omitted.
secrets	VaultSecretGroup[]	Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
windowsConfiguration	WindowsConfiguration	Specifies Windows operating system settings on the virtual machine.

VirtualMachineScaleSetPublicIPAddressConfiguration

Object

Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration

Name	Type	Description
name	string	The publicIP address configuration name.
properties	VirtualMachineScaleSetPublicIPAddressConfigurationProperties	Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
sku	PublicIPAddressSku	Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

Object

Describes a virtual machines scale sets network configuration's DNS settings.

Name	Type	Description
domainNameLabel	string	The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created
domainNameLabelScope	DomainNameLabelScopeTypes	The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created

VirtualMachineScaleSetPublicIPAddressConfigurationProperties

Object

Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration

Name	Type	Description
deleteOption	DeleteOptions	Specify what happens to the public IP when the VM is deleted
dnsSettings	VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings	The dns settings to be applied on the publicIP addresses .
idleTimeoutInMinutes	integer (int32)	The idle timeout of the public IP address.
ipTags	VirtualMachineScaleSetIpTag[]	The list of IP tags associated with the public IP address.
publicIPAddressVersion	IPVersion	Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.
publicIPPrefix	SubResource	The PublicIPPrefix from which to allocate publicIP addresses.

VirtualMachineScaleSetStorageProfile

Object

Describes a virtual machine scale set storage profile.

Name	Type	Description
dataDisks	VirtualMachineScaleSetDataDisk[]	Specifies the parameters that are used to add data disks to the virtual machines in the scale set. For more information about disks, see About disks and VHDs for Azure virtual machines.
diskControllerType	DiskControllerTypes	Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01
imageReference	ImageReference	Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations.
osDisk	VirtualMachineScaleSetOSDisk	Specifies information about the operating system disk used by the virtual machines in the scale set. For more information about disks, see About disks and VHDs for Azure virtual machines.

VMDiskSecurityProfile

Object

Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs.

Name	Type	Description
diskEncryptionSet	DiskEncryptionSetParameters	Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.
securityEncryptionType	SecurityEncryptionTypes	Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs.

VMGalleryApplication

Object

Specifies the required information to reference a compute gallery application version

Name	Type	Description
configurationReference	string	Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided
enableAutomaticUpgrade	boolean	If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS
order	integer (int32)	Optional, Specifies the order in which the packages have to be installed
packageReferenceId	string (arm-id)	Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}
tags	string	Optional, Specifies a passthrough value for more generic context.
treatFailureAsDeploymentFailure	boolean	Optional, If true, any failure for any operation in the VmApplication will fail the deployment

VmSizeProfile

Object

Specifications about a VM Size. This will also contain the corresponding rank and weight in future.

Name	Type	Description
name	string	The Sku name (e.g. 'Standard_DS1_v2')
rank	integer (int32) minimum: 0 maximum: 65535	The rank of the VM size. This is used with 'RegularPriorityAllocationStrategy.Prioritized' The lower the number, the higher the priority. Starting with 0.

VMSizeProperties

Object

Specifies VM Size Property settings on the virtual machine.

Name	Type	Description
vCPUsAvailable	integer (int32)	Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region.
vCPUsPerCore	integer (int32)	Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region. Setting this property to 1 also means that hyper-threading is disabled.

WindowsConfiguration

Object

Specifies Windows operating system settings on the virtual machine.

Name	Type	Description
additionalUnattendContent	AdditionalUnattendContent[]	Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.
enableAutomaticUpdates	boolean	Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.
enableVMAgentPlatformUpdates	boolean	Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false.
patchSettings	PatchSettings	[Preview Feature] Specifies settings related to VM Guest Patching on Windows.
provisionVMAgent	boolean	Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
timeZone	string	Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.
winRM	WinRMConfiguration	Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

WindowsPatchAssessmentMode

Enumeration

Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Value	Description
AutomaticByPlatform	The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
ImageDefault	You control the timing of patch assessments on a virtual machine.

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Enumeration

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

Value	Description
Always	Always Reboot setting
IfRequired	IfRequired Reboot setting
Never	Never Reboot setting
Unknown	Unknown Reboot setting

WindowsVMGuestPatchAutomaticByPlatformSettings

Object

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings.

Name	Type	Description
bypassPlatformSafetyChecksOnUserSchedule	boolean	Enables customer to schedule patching without accidental upgrades
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

WindowsVMGuestPatchMode

Enumeration

Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Value	Description
AutomaticByOS	The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.
AutomaticByPlatform	The virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true.
Manual	You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

WinRMConfiguration

Object

Describes Windows Remote Management configuration of the VM

Name	Type	Description
listeners	WinRMListener[]	The list of Windows Remote Management listeners

WinRMListener

Object

Describes Protocol and thumbprint of Windows Remote Management listener

Name	Type	Description
certificateUrl	string (uri)	This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"", "dataType":"pfx", "password":"" } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
protocol	ProtocolTypes	Specifies the protocol of WinRM listener. Possible values are: http, https.

Share via

Fleets - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Fleets_Get

Sample request

Sample response

Definitions

AdditionalUnattendContent

ApiEntityReference

ApplicationProfile

BaseVirtualMachineProfile

BootDiagnostics

CachingTypes

CapacityReservationProfile

ComputeProfile

createdByType

DeleteOptions

DiagnosticsProfile

DiffDiskOptions

DiffDiskPlacement

DiffDiskSettings

DiskControllerTypes

DiskCreateOptionTypes

DiskDeleteOptionTypes

DiskEncryptionSetParameters

DomainNameLabelScopeTypes

EncryptionIdentity

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

EvictionPolicy

Fleet

ImageReference

IPVersion

KeyVaultSecretReference

LinuxConfiguration

LinuxPatchAssessmentMode

LinuxPatchSettings

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

LinuxVMGuestPatchAutomaticByPlatformSettings

LinuxVMGuestPatchMode

ManagedServiceIdentity

ManagedServiceIdentityType

Mode

NetworkApiVersion

NetworkInterfaceAuxiliaryMode

NetworkInterfaceAuxiliarySku

OperatingSystemTypes

OSImageNotificationProfile

PatchSettings

Plan

ProtocolTypes

ProvisioningState

ProxyAgentSettings

PublicIPAddressSku

PublicIPAddressSkuName

PublicIPAddressSkuTier

RegularPriorityAllocationStrategy

RegularPriorityProfile

ScheduledEventsProfile

SecurityEncryptionTypes

SecurityPostureReference

SecurityProfile

SecurityTypes

ServiceArtifactReference

SettingNames

SpotAllocationStrategy

SpotPriorityProfile

SshConfiguration

SshPublicKey

StorageAccountTypes

SubResource

systemData

TerminateNotificationProfile

UefiSettings