az vmss create
Create an Azure Virtual Machine Scale Set. Azure CLI reference
158 options Its page in the Azure CLI reference
Options
Show its 158 options
--accelerated-networkingenable accelerated networking.--accept-termAccept the license agreement and privacy statement.--add-proxy-agent-extension, --add-proxy-agent-extSpecify whether to implicitly install the ProxyAgent Extension.--additional-scheduled-events, --additional-eventsThe configuration parameter used while creating event grid and resource graph scheduled event setting.--admin-passwordPassword for the VM if authentication type is 'Password'.--admin-usernameUsername for the VM.--app-gateway-capacityThe number of instances to use when creating a new application gateway.--app-gateway-skuSKU when creating a new application gateway.--app-gateway-subnet-address-prefixThe subnet IP address prefix to use when creating a new application gateway in CIDR format.--app-gatewayName to use when creating a new application gateway (default) or referencing an existing one.--asgsSpace-separated list of existing application security groups to associate with the VM.--assign-identityaccept system or user assigned identities separated by spaces.--authentication-typeType of authentication to use with the VM.--automatic-repairs-actionType of repair action that will be used for repairing unhealthy virtual machines in the scale set.--automatic-repairs-grace-periodThe amount of time (in minutes, between 30 and 90) for which automatic repairs are suspended due to a state change on VM.--automatic-zone-balancing-behavior, --balancing-behaviorType of rebalance behavior that will be used for recreating virtualmachines in the scale set across availability zones.--automatic-zone-balancing-strategy, --balancing-strategyType of rebalance strategy that will be used for rebalancing virtualmachines in the scale set across availability zones.--backend-pool-nameName to use for the backend pool when creating a new load balancer or application gateway.--backend-portWhen creating a new load balancer, backend port to open with NAT rules (Defaults to 22 on Linux and 3389 on Windows).--capacity-reservation-group, --crgThe ID or name of the capacity reservation group that is used to allocate.--computer-name-prefixComputer name prefix for all of the virtual machines in the scale set.--custom-dataCustom init script file or text (cloud-init, cloud-config, etc..)--data-disk-cachingstorage caching type for data disk(s), including 'None', 'ReadOnly', 'ReadWrite', etc.--data-disk-delete-optionSpecify whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is only for VMSS with flexible orchestration mode)--data-disk-encryption-setsNames or IDs (space delimited) of disk encryption sets for data disks.--data-disk-iopsSpecify the Read-Write IOPS (space delimited) for the managed disk.--data-disk-mbpsSpecify the bandwidth in MB per second (space delimited) for the managed disk.--data-disk-sizes-gbspace-separated empty managed data disk sizes in GB to create--data-disk-storage-fd-alignment, --data-disk-fdaSpecifies the storage fault domain alignment type for data disks.--disable-capacity-reservation-assignment, --no-cap-reservationSpecifies whether the virtual machine scale set is explicitly opted out from being associated with any capacity reservation.--disable-integrity-monitoring-autoupgradeDisable auto upgrade of guest attestation extension for Trusted Launch enabled VMs and VMSS.--disable-integrity-monitoringDisable installing guest attestation extension and enabling System Assigned Identity for Trusted Launch enabled VMs and VMSS.--disable-overprovisionOverprovision option (see https://azure.microsoft.com/documentation/articles/virtual-machine-scale-sets-overview/ for details).--disk-controller-typeSpecify the disk controller type configured for the VM or VMSS.--dns-serversspace-separated IP addresses of DNS servers, e.g. 10.0.0.5 10.0.0.6--edge-zoneThe name of edge zone.--enable-agentIndicate whether virtual machine agent should be provisioned on the virtual machine.--enable-all-instance-down, --all-instance-downSpecifies if Scheduled Events should be auto-approved when all instances are down.--enable-auto-os-upgradeIndicate whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.--enable-auto-updateIndicate whether Automatic Updates is enabled for the Windows virtual machine--enable-automatic-repairs, --enable-auto-repairsEnable automatic repairs--enable-automatic-zone-balancing, --enable-zone-balancingSpecify whether automatic AZ balancing should be enabled on the virtualmachine scale set.--enable-cross-zone-upgradeSet this Boolean property will allow VMSS to ignore AZ boundaries when constructing upgrade batches, and only consider Update Domain and maxBatchInstancePercent to determine the batch size--enable-hibernationThe flag that enable or disable hibernation capability on the VMSS.--enable-integrity-monitoringEnable installing Microsoft propietary and not security supported guest attestation extension and enabling System Assigned Identity for Trusted Launch enabled VMs and VMSS.--enable-osimage-notificationSpecify whether the OS Image Scheduled event is enabled or disabled.--enable-proxy-agentSpecify whether metadata security protoco (proxy agent) feature should be enabled on the virtual machine or virtual machine scale set.--enable-resilient-creationAutomatically recover customers from OS Provisioning Timeout and VM Start Timeout errors experienced during a VM Create operation by deleting and recreating the affected VM.--enable-resilient-deletionRetry VM Delete requests asynchronously in the event of a failed delete operation.--enable-secure-bootEnable secure boot.--enable-spot-restoreEnable the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints--enable-user-reboot-scheduled-events, --enable-rebootThe configuration parameter used while publishing scheduled events additional publishing targets.--enable-user-redeploy-scheduled-events, --enable-redeployThe configuration parameter used while creating user initiated redeploy scheduled event setting creation.--enable-vtpmEnable vTPM.--encryption-at-hostEnable Host Encryption for the VM or VMSS.--encryption-identityResource Id of the user managed identity which can be used for Azure disk encryption--ephemeral-os-disk-enable-full-caching, --ephemeral-full-cachingSpecify whether or not to enable full caching for this VM/VMSS which will cache the OS disk locally on the host and make this VM/VMSS more resilient to storage outages--ephemeral-os-disk-placement, --ephemeral-placementOnly applicable when used with --ephemeral-os-disk.--ephemeral-os-diskAllows you to create an OS disk directly on the host node, providing local disk performance and faster VM/VMSS reimage time.--eviction-policyThe eviction policy for virtual machines in a Spot priority scale set.--exclude-zonesSpecify a list of availability zones that must be excluded from placement when --zone-placement-policy is set to Auto.--generate-ssh-keysGenerate SSH public and private key files if missing.--health-probeProbe name from the existing load balancer, mainly used for rolling upgrade or automatic repairs--imageThe name of the operating system image as a URN alias, URN, custom image name or ID, or VHD blob URI.--imds-access-control-profile-reference-id, --imds-profile-idSpecify the access control profile version resource id resource id of imds.--include-zonesSpecify a list of availability zones that must be considered for placement when --zone-placement-policy is set to Auto.--instance-countNumber of VMs in the scale set.--instance-percent-policy, --ippSpecify whether maximum percentage of virtual machine instances per zone policy should be enabled on the virtual machine scale set.--lb-nat-pool-name, --nat-pool-nameName to use for the NAT pool when creating a new load balancer.--lb-nat-rule-name, --nat-rule-nameName to use for the NAT rule v2 when creating a new load balancer.--lb-skuSku of the Load Balancer to create.--license-typeSpecifies that the Windows image or disk was licensed on-premises.--load-balancer, --lbName to use when creating a new load balancer (default) or referencing an existing one.--location, -lLocation in which to create VM and related resources.--max-batch-instance-percentThe maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch.--max-priceThe maximum price (in US Dollars) you are willing to pay for a Spot VM/VMSS.--max-surgeSpecify it to create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines.--max-unhealthy-instance-percentThe maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy.--max-unhealthy-upgraded-instance-percentThe maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state.--max-zone-countSpecify the maximum number of availability zones to use when --zone-placement-policy is set to Auto.--name, -nName of the virtual machine scale set.--nat-backend-portBackend port to open with NAT rules.--network-api-versionSpecify the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'.--nic-delete-optionSpecify what happens to the network interface when the VM is deleted.--nicsNames or IDs of existing NICs to attach to the VM.--no-waitDo not wait for the long-running operation to finish.--nsgName or ID of an existing Network Security Group.--orchestration-modeChoose how virtual machines are managed by the scale set.--os-disk-cachingStorage caching type for the VM OS disk.--os-disk-delete-optionSpecify whether OS disk should be deleted or detached upon VMSS Flex deletion (This feature is only for VMSS with flexible orchestration mode).--os-disk-encryption-setName or ID of disk encryption set for OS disk.--os-disk-nameThe name of the new VM OS disk.--os-disk-secure-vm-disk-encryption-setSpecify the customer managed disk encryption set resource ID or name for the managed disk that is used for customer managed key encrypted Confidential VM OS disk and VM guest blob.--os-disk-security-encryption-typeSpecify the encryption type of the OS managed disk.--os-disk-size-gbOS disk size in GB to create.--os-disk-storage-fd-alignment, --os-disk-fdaSpecifies the storage fault domain alignment type for the OS disk.--os-typeType of OS installed on a custom VHD.--patch-modeMode of in-guest patching to IaaS virtual machine.--pause-time-between-batchesThe wait time between completing the update for all virtual machines in one batch and starting the next batch.--plan-nameplan name--plan-productplan product--plan-promotion-codeplan promotion code--plan-publisherplan publisher--platform-fault-domain-countFault Domain count for each placement group in the availability zone--ppgThe name or ID of the proximity placement group the VMSS should be associated with.--prioritize-unhealthy-instancesSet this Boolean property will lead to all unhealthy instances in a scale set getting upgraded before any healthy instances--priorityPriority.--private-ip-addressStatic private IP address (e.g. 10.0.0.5).--processor-modeSpecifies the processor mode for the virtual machine or virtual machine scale set.--proxy-agent-mode, --wire-server-mode, --imds-modeSpecify the mode that proxy agent will execute on if the feature is enabled.--public-ip-address-allocation, --storage-sku--public-ip-address-dns-nameGlobally unique DNS name for a newly created public IP.--public-ip-addressName of the public IP address when creating one (default) or referencing an existing one.--public-ip-per-vmEach VM instance will have a public ip.--public-ip-skuPublic IP SKU.--regular-priority-countThe base number of regular priority VMs that will be created in this scale set as it scales out.--regular-priority-percentageThe percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority.--roleRole name or id the system assigned identity will have.--scale-in-policySpecify the scale-in policy (space delimited) that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in.--scheduled-events-api-version, --se-api-versionSpecifies the api-version to determine which Scheduled Events configuration schema version will be delivered.--scopeScope that the system assigned identity can access.--secretsOne or many Key Vault secrets as JSON strings or files via @{path} containing [{ "sourceVault": { "id": "value" }, "vaultCertificates": [{ "certificateUrl": "value", "certificateStore": "cert store name (only on windows)"}] }]--security-posture-reference-exclude-extensions, --exclude-extensionsList of virtual machine extensions to exclude when applying the Security Posture.--security-posture-reference-id, --security-posture-idThe security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest--security-posture-reference-is-overridable, --is-overridableWhether the security posture can be overridden by the user.--security-typeSpecify the security type of the virtual machine scale set.--single-placement-groupLimit the scale set to a single placement group.--sizeThe VM size to be created.--skuprofile-allocation-strategy, --sku-allocat-stratAllocation strategy for vm sizes in SKU profile.--skuprofile-rankA list for ranks associated with the SKU profile vm sizes.--skuprofile-vmsizesA list of VM sizes in the scale set.--specializedIndicate whether the source image is specialized.--spot-restore-timeoutTimeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances--ssh-dest-key-pathDestination file path on the VM for the SSH key.--ssh-key-typeSpecify the type of SSH public and private key files to be generated if missing.--ssh-key-valuesSpace-separated list of SSH public keys or public key file paths.--storage-container-name, --storage-accountOnly applicable when used with --use-unmanaged-disk.--subnet-address-prefixThe subnet IP address prefix to use when creating a new VNet in CIDR format.--subnetThe name of the subnet when creating a new VNet or referencing an existing one.--tagsspace-separated tags: key[=value] [key[=value] ...].--terminate-notification-timeLength of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted--ultra-ssd-enabledEnables or disables the capability to have 1 or more managed data disks with UltraSSD_LRS storage account--upgrade-policy-modeSpecify the mode of an upgrade to virtual machines in the scale set.--use-unmanaged-diskDo not use managed disk to persist VM--user-dataUserData for the virtual machines in the scale set.--v-cpus-availableSpecify the number of vCPUs available--v-cpus-per-coreSpecify the ratio of vCPU to physical core.--validateGenerate and validate the ARM template without creating any resources.--value-max-instance-percent-per-zone, --max-instance-percentSpecify the maximum percentage of virtual machine instances that can be allocated to a single availability zone in the virtual machine scale set.--vm-domain-namedomain name of VM instances, once configured, the FQDN is vm<vm-index>.<vm-domain-name>.<..rest..>--vm-skuSize of VMs in the scale set.--vnet-address-prefixThe IP address prefix to use when creating a new VNet in CIDR format.--vnet-nameName of the virtual network when creating a new one or referencing an existing one.--wire-server-access-control-profile-reference-id, --wire-server-profile-idSpecify the access control profile version resource id of wire server.--wire-server-use-local-file-rules, --wire-local-rulesWhen set to true, instructs the GuestProxyAgent inside the VM to load additional access control rules defined in a local file on the VM.--zonal-fault-domain-align-mode, --zonal-fdaSpecifies the alignment mode between Virtual Machine Scale Set compute and storage fault domains.--zone-balanceWhether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.--zone-placement-policySpecify the policy for availability zone placement of the virtual machine scale set.