| Description | : Gets all the VM scale sets under the specified subscription for the specified location. |
| Reference | : Link ¶ |
⚶ Changes
{
"#id": "VirtualMachineScaleSets_ListByLocation",
"$responses": {
"200": {
"$properties": {
"value": {
"$properties": {
"properties": [
{
"additionalCapabilities": [
{
"@added_2b971fa5c01f400cb206226e7f9e2197": {
"#name": "enableFips1403Encryption",
"Description": "The flag enables the usage of FIPS 140-3 compliant cryptography on the protectedSettings of an extension. Learn more at: https://aka.ms/linuxagentfipssupport.",
"Required": false,
"Type": "boolean"
}
}
]
}
]
}
}
}
}
}
}
⚼ Request
GET:
/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachineScaleSets
{
api-version:
string
,
subscriptionId:
string
,
location:
string
,
}
⚐ Response (200)
{
value:
[
]
,
{
,
sku:
{
,
name:
string
,
tier:
string
,
capacity:
integer
,
}
plan:
{
,
name:
string
,
publisher:
string
,
product:
string
,
promotionCode:
string
,
}
properties:
{
,
upgradePolicy:
{
,
mode:
enum
,
rollingUpgradePolicy:
{
,
maxBatchInstancePercent:
integer
,
maxUnhealthyInstancePercent:
integer
,
maxUnhealthyUpgradedInstancePercent:
integer
,
pauseTimeBetweenBatches:
string
,
enableCrossZoneUpgrade:
boolean
,
prioritizeUnhealthyInstances:
boolean
,
rollbackFailedInstancesOnPolicyBreach:
boolean
,
maxSurge:
boolean
,
}
automaticOSUpgradePolicy:
}
{
,
enableAutomaticOSUpgrade:
boolean
,
disableAutomaticRollback:
boolean
,
useRollingUpgradePolicy:
boolean
,
osRollingUpgradeDeferral:
boolean
,
}
scheduledEventsPolicy:
{
,
userInitiatedRedeploy:
{
,
automaticallyApprove:
boolean
,
}
userInitiatedReboot:
{
,
automaticallyApprove:
boolean
,
}
scheduledEventsAdditionalPublishingTargets:
{
,
eventGridAndResourceGraph:
}
{
,
enable:
boolean
,
scheduledEventsApiVersion:
string
,
}
allInstancesDown:
}
{
,
automaticallyApprove:
boolean
,
}
automaticRepairsPolicy:
{
,
enabled:
boolean
,
gracePeriod:
string
,
repairAction:
enum
,
}
virtualMachineProfile:
{
,
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:
{
,
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:
object
,
securityProfile:
}
{
,
securityEncryptionType:
enum
,
diskEncryptionSet:
object
,
}
deleteOption:
enum
,
}
dataDisks:
[
]
,
{
,
name:
string
,
lun:
integer
,
caching:
enum
,
writeAcceleratorEnabled:
boolean
,
createOption:
enum
,
diskSizeGB:
integer
,
managedDisk:
{
,
storageAccountType:
enum
,
diskEncryptionSet:
object
,
securityProfile:
}
{
,
securityEncryptionType:
enum
,
diskEncryptionSet:
object
,
}
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
,
}
tags:
object
,
}
privateIPAddressVersion:
enum
,
applicationGatewayBackendAddressPools:
[
]
,
{
,
id:
string
,
}
applicationSecurityGroups:
[
]
,
{
,
id:
string
,
}
loadBalancerBackendAddressPools:
[
]
,
{
,
id:
string
,
}
loadBalancerInboundNatPools:
}
[
]
,
{
,
id:
string
,
}
enableIPForwarding:
boolean
,
deleteOption:
enum
,
auxiliaryMode:
enum
,
auxiliarySku:
enum
,
}
tags:
object
,
}
networkApiVersion:
enum
,
}
securityProfile:
{
,
uefiSettings:
{
,
secureBootEnabled:
boolean
,
vTpmEnabled:
boolean
,
}
encryptionAtHost:
boolean
,
securityType:
enum
,
encryptionIdentity:
{
,
userAssignedIdentityResourceId:
string
,
}
proxyAgentSettings:
}
{
,
enabled:
boolean
,
mode:
enum
,
keyIncarnationId:
integer
,
wireServer:
{
,
mode:
enum
,
inVMAccessControlProfileReferenceId:
string
,
}
imds:
{
,
mode:
enum
,
inVMAccessControlProfileReferenceId:
string
,
}
addProxyAgentExtension:
boolean
,
}
diagnosticsProfile:
{
,
bootDiagnostics:
}
{
,
enabled:
boolean
,
storageUri:
string
,
}
extensionProfile:
{
,
extensions:
[
]
,
{
,
properties:
{
,
forceUpdateTag:
string
,
publisher:
string
,
type:
string
,
typeHandlerVersion:
string
,
autoUpgradeMinorVersion:
boolean
,
enableAutomaticUpgrade:
boolean
,
settings:
string
,
protectedSettings:
string
,
provisioningState:
string
,
provisionAfterExtensions:
[
,
string
,
]
suppressFailures:
boolean
,
protectedSettingsFromKeyVault:
}
{
,
secretUrl:
string
,
sourceVault:
}
{
,
id:
string
,
}
type:
string
,
name:
string
,
}
extensionsTimeBudget:
string
,
}
licenseType:
string
,
priority:
enum
,
evictionPolicy:
enum
,
billingProfile:
{
,
maxPrice:
number
,
}
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
,
}
provisioningState:
string
,
overprovision:
boolean
,
doNotRunExtensionsOnOverprovisionedVMs:
boolean
,
uniqueId:
string
,
singlePlacementGroup:
boolean
,
zoneBalance:
boolean
,
platformFaultDomainCount:
integer
,
proximityPlacementGroup:
{
,
id:
string
,
}
hostGroup:
{
,
id:
string
,
}
additionalCapabilities:
{
,
ultraSSDEnabled:
boolean
,
hibernationEnabled:
boolean
,
enableFips1403Encryption:
boolean
,
}
scaleInPolicy:
{
,
rules:
[
,
string
,
]
forceDeletion:
boolean
,
prioritizeUnhealthyVMs:
boolean
,
}
orchestrationMode:
enum
,
spotRestorePolicy:
{
,
enabled:
boolean
,
restoreTimeout:
string
,
}
priorityMixPolicy:
{
,
baseRegularPriorityCount:
integer
,
regularPriorityPercentageAboveBase:
integer
,
}
timeCreated:
string
,
constrainedMaximumCapacity:
boolean
,
resiliencyPolicy:
{
,
resilientVMCreationPolicy:
{
,
enabled:
boolean
,
}
resilientVMDeletionPolicy:
{
,
enabled:
boolean
,
}
automaticZoneRebalancingPolicy:
{
,
enabled:
boolean
,
rebalanceStrategy:
enum
,
rebalanceBehavior:
enum
,
}
zoneAllocationPolicy:
}
{
,
maxZoneCount:
integer
,
maxInstancePercentPerZonePolicy:
}
{
,
enabled:
boolean
,
value:
integer
,
}
zonalPlatformFaultDomainAlignMode:
enum
,
skuProfile:
{
,
vmSizes:
[
]
,
{
,
name:
string
,
rank:
integer
,
}
allocationStrategy:
enum
,
}
highSpeedInterconnectPlacement:
enum
,
}
identity:
{
,
principalId:
string
,
tenantId:
string
,
type:
enum
,
userAssignedIdentities:
object
,
}
zones:
[
,
string
,
]
extendedLocation:
{
,
name:
string
,
type:
enum
,
}
etag:
string
,
placement:
}
{
,
zonePlacementPolicy:
enum
,
includeZones:
[
,
string
,
]
excludeZones:
}
[
,
string
,
]
nextLink:
string
,
}
⚐ Response (default)
{
error:
}
{
,
details:
[
]
,
{
,
code:
string
,
target:
string
,
message:
string
,
}
innererror:
{
,
exceptiontype:
string
,
errordetail:
string
,
}
code:
string
,
target:
string
,
message:
string
,
}