azure::scale-set¶

Creates a scale set.

Example¶

azure::scale-set scale-set-example
     name: "scale-set-example"
     resource-group: $(azure::resource-group scale-set-resource-group-example)
     sku-name: "Standard_A0"
     sku-tier: "Standard"

     os-type: "linux"
     image-type: "popular"
     known-virtual-image: "UBUNTU_SERVER_14_04_LTS"
     admin-user-name: "qwerty@123"
     admin-password: "qwerty@123"
     capacity: 2

     proximity-placement-group
         name: "proximity-placement-group-example"
         type: "STANDARD"
     end

     network: $(azure::network scale-set-network-example)
     subnet-name: "subnet2"

     primary-internet-facing-load-balancer
         load-balancer: $(azure::load-balancer scale-set-load-balancer-example-internet-facing)
         backends: [
             "backend-one",
             "backend-two"
         ]
         inbound-nat-pools: [
             "test-nat-pool-public"
         ]
     end

     primary-internal-load-balancer
         load-balancer: $(azure::load-balancer scale-set-load-balancer-example-internal)
         backends: [
             "backend-one",
             "backend-two"
         ]
         inbound-nat-pools: [
             "test-nat-pool"
         ]
     end

     tags: {
         Name: "scale-set-example"
     }
 end

Attributes¶

Attribute	Description
name	The name of the Scale Set. (Required)
resource-group	The Resource Group under which the Scale Set would reside. (Required)
sku-name	The SKU name of the Scale Set. (Required)
sku-tier	The SKU tier of the Scale Set. (Required)
proximity-placement-group subresource	The Proximity Placement Group for the Scale Set. name The name of the Proximity Placement Group. (Required) type The type of the Proximity Placement Group. Defaults to `STANDARD`. Valid values are `STANDARD` or `ULTRA`.
do-not-run-extensions-on-overprovisioned-v-ms	Disable running extensions over provisioned VMs. Defaults to `false`.
additional-capability subresource	Additional capability for the Scale set to enable Ultra SSD. Defaults to disabled. ultra-s-s-d-enabled Enable ultra SSD. Defaults to `false`.
network	The Virtual Network to be associated with the Scale Set. (Required)
subnet-name	The Subnet to be associated with the Scale Set. (Required)
primary-internet-facing-load-balancer subresource	The primary internet facing Load Balancer to be associated with the Scale Set. load-balancer The Load Balancer to be attached as internal/public-internet type to a Scale Set. (Required) backends set The corresponding Load Balancer Backends. (Required) inbound-nat-pools set The corresponding Load Balancer Inbound Nat Pools.
primary-internal-load-balancer subresource	The primary internal Load Balancer to be associated with the Scale Set. load-balancer The Load Balancer to be attached as internal/public-internet type to a Scale Set. (Required) backends set The corresponding Load Balancer Backends. (Required) inbound-nat-pools set The corresponding Load Balancer Inbound Nat Pools.
os-type	The type of os for the VMs deployed by the Scale Set. Valid values are `linux` or `windows`. (Required)
image-type	The type of image to be used for the VMs deployed by the Scale Set. Valid values are `latest`, `popular`, `specific`, `custom` or `stored`. (Required)
admin-user-name	The root/admin user name for the os for the VMs deployed by the Scale Set. (Required)
admin-password	The root/admin password for the os for the VMs deployed by the Scale Set. Required if ‘ssh’ not set.
ssh	The root/admin ssh for the os for the VMs deployed by the Scale Set. Required if ‘password’ not set.
image-publisher	The publisher of the image to be used for creating the VMs deployed by the Scale Set. Required if `image-type` selected as `latest` or `specific`.
image-offer	The offer of the image to be used for creating the VMs deployed by the Scale Set. Required if `image-type` selected as `latest` or `specific`.
image-sku	The SKU of the image to be used for creating the VMs deployed by the Scale Set. Required if `image-type` selected as `latest` or `specific`.
image-region	The region where the image resides to be used for creating the VMs deployed by the Scale Set. Required if `image-type` selected as `latest` or `specific`.
image-version	The version of the image to be used for creating the VMs deployed by the Scale Set. Required if `image-type` selected as `latest` or `specific`.
known-virtual-image	The known Virtual Machine image type used for creating the VMs deployed by the Scale Set. Required if `image-type` selected as `popular`.
stored-image	The Stored Image Uri used for creating the VMs deployed by the Scale Set. Required if `image-type` selected as `stored`.
custom-image	The CustomImage ID used for creating the VMs deployed by the Scale Set. Required if `image-type` selected as `custom`.
capacity	The max supported VMs in a the Scale Set. (Required)
application-security-groups set	A set of associated Application Security Groups with the Scale Set.
application-gateway-backend-pool-ids set	A set of associated Application Gateway Backend Pool IDs with the Scale Set.
network-security-group	Associated Network Security Group with the Scale Set.
storage-account	Associated Storage Account with the Scale Set.
tags map	A set of tags for the Scale Set.
enable-accelerated-networking	Enable/Disable accelerated networking for the Scale Set. Defaults to `false`.
enable-boot-diagnostic	Enable/Disable boot diagnostic for the Scale Set. Defaults to `false`.
boot-diagnostic-storage	Set the Storage Account to store the boot diagnostic for the Scale Set. Allowed only if ‘enable-boot-diagnostic’ is set to `true`.
boot-diagnostic-blob	Set the Storage Account Blob to store the boot diagnostic for the Scale Set. Allowed only if ‘enable-boot-diagnostic’ is set to `true`.
computer-name-prefix	Set the prefix of the VMs launched by this Scale Set.
custom-data	Set the custom data of the VMs launched by this Scale Set.
enable-ip-forwarding	Enable/Disable IP forwarding for the VMs launched by this Scale Set. Defaults to `false`.
os-disk-caching	Set the OS Disk caching type for the VMs launched by this Scale Set. Valid values are `NONE`, `READ_ONLY` or `READ_WRITE`.
os-disk-name	Set the OS Disk name for the VMs launched by this Scale Set.
enable-over-provision	Enable/Disable over provisioning for the VMs launched by this Scale Set. Defaults to `false`.
enable-low-priority-vm	Enable/Disable flagging low priority for the VMs launched by this Scale Set. Defaults to `false`.
low-priority-vm-policy	Set the policy for eviction of the flagged low priority VMs launched by this Scale Set. Allowed only of ‘enable-low-priority-vm’ is set to `true`. Valid values are `DEALLOCATE` or `DELETE`.
time-zone	The time zone for VMs launched by this Scale Set. Required when ‘os-type’ is set to `windows`.
enable-system-managed-service-identity	Enable system managed service identity for scale sets. Defaults to `false`.
identities set	A list of identities associated with the Scale Set.

Outputs¶

Attribute	Description
system-managed-service-identity-principal-id	The principal id for the system managed service identity of the Scale Set.
id	The ID of the Scale Set.