| Description | : List Fleet resources by subscription ID |
| Reference | : Link ¶ |
⚶ Changes
{
"#id": "Fleets_ListBySubscription",
"$responses": {
"200": {
"$properties": {
"value": {
"$properties": {
"properties": [
{
"computeProfile": [
{
"baseVirtualMachineProfile": [
{
"osProfile": [
{
"#name": "adminPassword",
"Description": {
"new": "Specifies the password of the administrator account.
**Minimum-length\n(Windows):** 8 characters
**Minimum-length (Linux):** 6 characters\n
**Max-length (Windows):** 123 characters
**Max-length\n(Linux):** 72 characters
**Complexity requirements:** 3 out of 4\nconditions below need to be fulfilled
Has lower characters
Has upper\ncharacters
Has a digit
Has a special character (Regex match [\\W_])\n
**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\",\n\"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\",\n\"Password22\", \"iloveyou!\"
For resetting the password, see [How to\nreset the Remote Desktop service or its login password in a Windows\nVM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)\n
For resetting root password, see [Manage users, SSH, and check or\nrepair disks on Azure Linux VMs using the VMAccess\nExtension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)",
"old": "Specifies the password of the administrator account.
**Minimum-length\n(Windows):** 8 characters
**Minimum-length (Linux):** 6 characters\n
**Max-length (Windows):** 123 characters
**Max-length\n(Linux):** 72 characters
**Complexity requirements:** 3 out of 4\nconditions below need to be fulfilled
Has lower characters
Has upper\ncharacters
Has a digit
Has a special character (Regex match [\\W_])\n
**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\",\n\"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\",\n\"Password22\", \"iloveyou!\"
For resetting the password, see [How to\nreset the Remote Desktop service or its login password in a Windows\nVM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)\n
For resetting root password, see [Manage users, SSH, and check or\nrepair disks on Azure Linux VMs using the VMAccess\nExtension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)"
}
},
{
"#name": "customData",
"Description": {
"new": "Specifies a base-64 encoded string of custom data. The base-64 encoded string\nis decoded to a binary array that is saved as a file on the Virtual Machine.\nThe maximum length of the binary array is 65535 bytes. For using cloud-init for\nyour VM, see [Using cloud-init to customize a Linux VM during\ncreation](https://learn.microsoft.com/azure/virtual-machines/linux/using-cloud-init)",
"old": "Specifies a base-64 encoded string of custom data. The base-64 encoded string\nis decoded to a binary array that is saved as a file on the Virtual Machine.\nThe maximum length of the binary array is 65535 bytes. For using cloud-init for\nyour VM, see [Using cloud-init to customize a Linux VM during\ncreation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)"
}
},
{
"windowsConfiguration": [
{
"#name": "timeZone",
"Description": {
"new": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\".\nPossible values can be\n[TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id)\nvalue from time zones returned by\n[TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones).",
"old": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\".\nPossible values can be\n[TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id)\nvalue from time zones returned by\n[TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones)."
}
},
{
"winRM": [
{
"listeners": {
"$properties": [
{
"#name": "certificateUrl",
"Description": {
"new": "This is the URL of a certificate that has been uploaded to Key Vault as a\nsecret. For adding a secret to the Key Vault, see [Add a key or secret to the\nkey\nvault](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add).\nIn this case, your certificate needs to be the Base64 encoding of the following\nJSON Object which is encoded in UTF-8:
{
\n\"data\":\"\",
\"dataType\":\"pfx\",
\n\"password\":\"\"
}
To install certificates on a virtual\nmachine it is recommended to use the [Azure Key Vault virtual machine extension\nfor\nLinux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).",
"old": "This is the URL of a certificate that has been uploaded to Key Vault as a\nsecret. For adding a secret to the Key Vault, see [Add a key or secret to the\nkey\nvault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add).\nIn this case, your certificate needs to be the Base64 encoding of the following\nJSON Object which is encoded in UTF-8:
{
\n\"data\":\"\",
\"dataType\":\"pfx\",
\n\"password\":\"\"
}
To install certificates on a virtual\nmachine it is recommended to use the [Azure Key Vault virtual machine extension\nfor\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)."
}
}
]
}
}
]
}
]
},
{
"#name": "linuxConfiguration",
"Description": {
"new": "Specifies the Linux operating system settings on the virtual machine. For a\nlist of supported Linux distributions, see [Linux on Azure-Endorsed\nDistributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros).",
"old": "Specifies the Linux operating system settings on the virtual machine. For a\nlist of supported Linux distributions, see [Linux on Azure-Endorsed\nDistributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros)."
},
"$properties": {
"ssh": [
{
"publicKeys": {
"$properties": [
{
"#name": "keyData",
"Description": {
"new": "SSH public key certificate used to authenticate with the VM through ssh. The\nkey needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys,\nsee [Create SSH keys on Linux and Mac for Linux VMs in\nAzure]https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).",
"old": "SSH public key certificate used to authenticate with the VM through ssh. The\nkey needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys,\nsee [Create SSH keys on Linux and Mac for Linux VMs in\nAzure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed)."
}
}
]
}
}
]
}
},
{
"#name": "secrets",
"Description": {
"new": "Specifies set of certificates that should be installed onto the virtual\nmachines in the scale set. To install certificates on a virtual machine it is\nrecommended to use the [Azure Key Vault virtual machine extension for\nLinux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).",
"old": "Specifies set of certificates that should be installed onto the virtual\nmachines in the scale set. To install certificates on a virtual machine it is\nrecommended to use the [Azure Key Vault virtual machine extension for\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)."
},
"$items": {
"$properties": {
"vaultCertificates": {
"$properties": [
{
"#name": "certificateUrl",
"Description": {
"new": "This is the URL of a certificate that has been uploaded to Key Vault as a\nsecret. For adding a secret to the Key Vault, see [Add a key or secret to the\nkey\nvault](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add).\nIn this case, your certificate needs to be It is the Base64 encoding of the\nfollowing JSON Object which is encoded in UTF-8:
{
\n\"data\":\"\",
\"dataType\":\"pfx\",
\n\"password\":\"\"
}
To install certificates on a virtual\nmachine it is recommended to use the [Azure Key Vault virtual machine extension\nfor\nLinux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).",
"old": "This is the URL of a certificate that has been uploaded to Key Vault as a\nsecret. For adding a secret to the Key Vault, see [Add a key or secret to the\nkey\nvault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add).\nIn this case, your certificate needs to be It is the Base64 encoding of the\nfollowing JSON Object which is encoded in UTF-8:
{
\n\"data\":\"\",
\"dataType\":\"pfx\",
\n\"password\":\"\"
}
To install certificates on a virtual\nmachine it is recommended to use the [Azure Key Vault virtual machine extension\nfor\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)."
}
}
]
}
}
}
}
]
},
{
"storageProfile": [
{
"#name": "osDisk",
"Description": {
"new": "Specifies information about the operating system disk used by the virtual\nmachines in the scale set. For more information about disks, see [About disks\nand VHDs for Azure virtual\nmachines](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview).",
"old": "Specifies information about the operating system disk used by the virtual\nmachines in the scale set. For more information about disks, see [About disks\nand VHDs for Azure virtual\nmachines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
},
"$properties": {
"diffDiskSettings": [
{
"#name": "placement",
"Description": {
"new": "Specifies the ephemeral disk placement for operating system disk. Possible\nvalues are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is:\n**CacheDisk** if one is configured for the VM size otherwise **ResourceDisk**\nis used. Refer to the VM size documentation for Windows VM at\nhttps://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at\nhttps://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM\nsizes exposes a cache disk.",
"old": "Specifies the ephemeral disk placement for operating system disk. Possible\nvalues are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is:\n**CacheDisk** if one is configured for the VM size otherwise **ResourceDisk**\nis used. Refer to the VM size documentation for Windows VM at\nhttps://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at\nhttps://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM\nsizes exposes a cache disk."
}
}
]
}
},
{
"#name": "dataDisks",
"Description": {
"new": "Specifies the parameters that are used to add data disks to the virtual\nmachines in the scale set. For more information about disks, see [About disks\nand VHDs for Azure virtual\nmachines](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview).",
"old": "Specifies the parameters that are used to add data disks to the virtual\nmachines in the scale set. For more information about disks, see [About disks\nand VHDs for Azure virtual\nmachines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
}
}
]
},
{
"#name": "licenseType",
"Description": {
"new": "Specifies that the image or disk that is being used was licensed on-premises.\n
Possible values for Windows Server operating system are:
\nWindows_Client
Windows_Server
Possible values for Linux\nServer operating system are:
RHEL_BYOS (for RHEL)
SLES_BYOS\n(for SUSE)
For more information, see [Azure Hybrid Use Benefit for\nWindows\nServer](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)\n
[Azure Hybrid Use Benefit for Linux\nServer](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)\n
Minimum api-version: 2015-06-15",
"old": "Specifies that the image or disk that is being used was licensed on-premises.\n
Possible values for Windows Server operating system are:
\nWindows_Client
Windows_Server
Possible values for Linux\nServer operating system are:
RHEL_BYOS (for RHEL)
SLES_BYOS\n(for SUSE)
For more information, see [Azure Hybrid Use Benefit for\nWindows\nServer](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)\n
[Azure Hybrid Use Benefit for Linux\nServer](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)\n
Minimum api-version: 2015-06-15"
}
},
{
"hardwareProfile": [
{
"vmSizeProperties": [
{
"#name": "vCPUsAvailable",
"Description": {
"new": "Specifies the number of vCPUs available for the VM. When this property is not\nspecified in the request body the default behavior is to set it to the value of\nvCPUs available for that VM size exposed in api response of [List all available\nvirtual machine sizes in a\nregion](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list).",
"old": "Specifies the number of vCPUs available for the VM. When this property is not\nspecified in the request body the default behavior is to set it to the value of\nvCPUs available for that VM size exposed in api response of [List all available\nvirtual machine sizes in a\nregion](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list)."
}
},
{
"#name": "vCPUsPerCore",
"Description": {
"new": "Specifies the vCPU to physical core ratio. When this property is not specified\nin the request body the default behavior is set to the value of vCPUsPerCore\nfor the VM Size exposed in api response of [List all available virtual machine\nsizes in a\nregion](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list).\n**Setting this property to 1 also means that hyper-threading is disabled.**",
"old": "Specifies the vCPU to physical core ratio. When this property is not specified\nin the request body the default behavior is set to the value of vCPUsPerCore\nfor the VM Size exposed in api response of [List all available virtual machine\nsizes in a\nregion](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list).\n**Setting this property to 1 also means that hyper-threading is disabled.**"
}
}
]
}
]
}
]
}
]
}
]
}
}
}
}
}
}
⚼ Request
GET:
/subscriptions/{subscriptionId}/providers/Microsoft.AzureFleet/fleets
{
api-version:
string
,
subscriptionId:
string
,
}
⚐ Response (200)
{
value:
[
]
,
{
,
properties:
{
,
provisioningState:
enum
,
spotPriorityProfile:
{
,
capacity:
integer
,
minCapacity:
integer
,
maxPricePerVM:
number
,
evictionPolicy:
enum
,
allocationStrategy:
enum
,
}
regularPriorityProfile:
{
,
capacity:
integer
,
minCapacity:
integer
,
allocationStrategy:
enum
,
}
vmSizesProfile:
[
]
,
{
,
name:
string
,
}
computeProfile:
{
,
baseVirtualMachineProfile:
{
,
osProfile:
{
,
computerNamePrefix:
string
,
adminUsername:
string
,
adminPassword:
string
,
customData:
string
,
windowsConfiguration:
{
,
provisionVMAgent:
boolean
,
enableAutomaticUpdates:
boolean
,
timeZone:
string
,
additionalUnattendContent:
[
]
,
{
,
passName:
enum
,
componentName:
enum
,
settingName:
enum
,
content:
string
,
}
patchSettings:
{
,
patchMode:
enum
,
enableHotpatching:
boolean
,
assessmentMode:
enum
,
automaticByPlatformSettings:
}
{
,
rebootSetting:
enum
,
bypassPlatformSafetyChecksOnUserSchedule:
boolean
,
}
winRM:
{
,
listeners:
}
[
]
,
{
,
protocol:
enum
,
certificateUrl:
string
,
}
enableVMAgentPlatformUpdates:
boolean
,
}
linuxConfiguration:
{
,
disablePasswordAuthentication:
boolean
,
ssh:
{
,
publicKeys:
}
[
]
,
{
,
path:
string
,
keyData:
string
,
}
provisionVMAgent:
boolean
,
patchSettings:
{
,
patchMode:
enum
,
assessmentMode:
enum
,
automaticByPlatformSettings:
}
{
,
rebootSetting:
enum
,
bypassPlatformSafetyChecksOnUserSchedule:
boolean
,
}
enableVMAgentPlatformUpdates:
boolean
,
}
secrets:
[
]
,
{
,
sourceVault:
{
,
id:
string
,
}
vaultCertificates:
}
[
]
,
{
,
certificateUrl:
string
,
certificateStore:
string
,
}
allowExtensionOperations:
boolean
,
requireGuestProvisionSignal:
boolean
,
}
storageProfile:
{
,
imageReference:
{
,
id:
string
,
publisher:
string
,
offer:
string
,
sku:
string
,
version:
string
,
exactVersion:
string
,
sharedGalleryImageId:
string
,
communityGalleryImageId:
string
,
}
osDisk:
{
,
name:
string
,
caching:
enum
,
writeAcceleratorEnabled:
boolean
,
createOption:
enum
,
diffDiskSettings:
{
,
option:
enum
,
placement:
enum
,
}
diskSizeGB:
integer
,
osType:
enum
,
image:
{
,
uri:
string
,
}
vhdContainers:
[
,
string
,
]
managedDisk:
{
,
storageAccountType:
enum
,
diskEncryptionSet:
{
,
id:
string
,
}
securityProfile:
}
{
,
securityEncryptionType:
enum
,
diskEncryptionSet:
}
{
,
id:
string
,
}
deleteOption:
enum
,
}
dataDisks:
[
]
,
{
,
name:
string
,
lun:
integer
,
caching:
enum
,
writeAcceleratorEnabled:
boolean
,
createOption:
enum
,
diskSizeGB:
integer
,
managedDisk:
{
,
storageAccountType:
enum
,
diskEncryptionSet:
{
,
id:
string
,
}
securityProfile:
}
{
,
securityEncryptionType:
enum
,
diskEncryptionSet:
}
{
,
id:
string
,
}
diskIOPSReadWrite:
integer
,
diskMBpsReadWrite:
integer
,
deleteOption:
enum
,
}
diskControllerType:
enum
,
}
networkProfile:
{
,
healthProbe:
{
,
id:
string
,
}
networkInterfaceConfigurations:
[
]
,
{
,
name:
string
,
properties:
}
{
,
primary:
boolean
,
enableAcceleratedNetworking:
boolean
,
disableTcpStateTracking:
boolean
,
enableFpga:
boolean
,
networkSecurityGroup:
{
,
id:
string
,
}
dnsSettings:
{
,
dnsServers:
}
[
,
string
,
]
ipConfigurations:
[
]
,
{
,
name:
string
,
properties:
}
{
,
subnet:
{
,
id:
string
,
}
primary:
boolean
,
publicIPAddressConfiguration:
{
,
name:
string
,
properties:
{
,
idleTimeoutInMinutes:
integer
,
dnsSettings:
{
,
domainNameLabel:
string
,
domainNameLabelScope:
enum
,
}
ipTags:
[
]
,
{
,
ipTagType:
string
,
tag:
string
,
}
publicIPPrefix:
{
,
id:
string
,
}
publicIPAddressVersion:
enum
,
deleteOption:
enum
,
}
sku:
}
{
,
name:
enum
,
tier:
enum
,
}
privateIPAddressVersion:
enum
,
applicationGatewayBackendAddressPools:
[
]
,
{
,
id:
string
,
}
applicationSecurityGroups:
[
]
,
{
,
id:
string
,
}
loadBalancerBackendAddressPools:
[
]
,
{
,
id:
string
,
}
loadBalancerInboundNatPools:
}
[
]
,
{
,
id:
string
,
}
enableIPForwarding:
boolean
,
deleteOption:
enum
,
auxiliaryMode:
enum
,
auxiliarySku:
enum
,
}
networkApiVersion:
enum
,
}
securityProfile:
{
,
uefiSettings:
{
,
secureBootEnabled:
boolean
,
vTpmEnabled:
boolean
,
}
encryptionAtHost:
boolean
,
securityType:
enum
,
encryptionIdentity:
{
,
userAssignedIdentityResourceId:
string
,
}
proxyAgentSettings:
}
{
,
enabled:
boolean
,
mode:
enum
,
keyIncarnationId:
integer
,
}
diagnosticsProfile:
{
,
bootDiagnostics:
}
{
,
enabled:
boolean
,
storageUri:
string
,
}
extensionProfile:
{
,
extensions:
[
]
,
{
,
id:
string
,
name:
string
,
type:
string
,
properties:
}
{
,
forceUpdateTag:
string
,
publisher:
string
,
type:
string
,
typeHandlerVersion:
string
,
autoUpgradeMinorVersion:
boolean
,
enableAutomaticUpgrade:
boolean
,
settings:
object
,
protectedSettings:
object
,
provisioningState:
string
,
provisionAfterExtensions:
[
,
string
,
]
suppressFailures:
boolean
,
protectedSettingsFromKeyVault:
}
{
,
secretUrl:
string
,
sourceVault:
}
{
,
id:
string
,
}
extensionsTimeBudget:
string
,
}
licenseType:
string
,
scheduledEventsProfile:
{
,
terminateNotificationProfile:
{
,
notBeforeTimeout:
string
,
enable:
boolean
,
}
osImageNotificationProfile:
}
{
,
notBeforeTimeout:
string
,
enable:
boolean
,
}
userData:
string
,
capacityReservation:
{
,
capacityReservationGroup:
}
{
,
id:
string
,
}
applicationProfile:
{
,
galleryApplications:
}
[
]
,
{
,
tags:
string
,
order:
integer
,
packageReferenceId:
string
,
configurationReference:
string
,
treatFailureAsDeploymentFailure:
boolean
,
enableAutomaticUpgrade:
boolean
,
}
hardwareProfile:
{
,
vmSizeProperties:
}
{
,
vCPUsAvailable:
integer
,
vCPUsPerCore:
integer
,
}
serviceArtifactReference:
{
,
id:
string
,
}
securityPostureReference:
{
,
id:
string
,
excludeExtensions:
[
,
string
,
]
isOverridable:
boolean
,
}
timeCreated:
string
,
}
computeApiVersion:
string
,
}
timeCreated:
string
,
uniqueId:
string
,
}
zones:
[
,
string
,
]
identity:
{
,
principalId:
string
,
tenantId:
string
,
type:
enum
,
userAssignedIdentities:
object
,
}
plan:
}
{
,
name:
string
,
publisher:
string
,
product:
string
,
promotionCode:
string
,
version:
string
,
}
nextLink:
string
,
}
⚐ Response (default)
{
error:
}
{
,
code:
string
,
message:
string
,
target:
string
,
details:
[
,
string
,
]
additionalInfo:
}
[
]
,
{
,
type:
string
,
info:
object
,
}