1. Docs
  2. Reference
  3. API
  4. Azure
  5. compute
  6. OrchestratedVirtualMachineScaleSet

OrchestratedVirtualMachineScaleSet

Create a OrchestratedVirtualMachineScaleSet Resource

new OrchestratedVirtualMachineScaleSet(name: string, args: OrchestratedVirtualMachineScaleSetArgs, opts?: CustomResourceOptions);
def OrchestratedVirtualMachineScaleSet(resource_name, opts=None, location=None, name=None, platform_fault_domain_count=None, resource_group_name=None, single_placement_group=None, tags=None, zones=None, __props__=None);
func NewOrchestratedVirtualMachineScaleSet(ctx *Context, name string, args OrchestratedVirtualMachineScaleSetArgs, opts ...ResourceOption) (*OrchestratedVirtualMachineScaleSet, error)
public OrchestratedVirtualMachineScaleSet(string name, OrchestratedVirtualMachineScaleSetArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args OrchestratedVirtualMachineScaleSetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args OrchestratedVirtualMachineScaleSetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args OrchestratedVirtualMachineScaleSetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

OrchestratedVirtualMachineScaleSet Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The OrchestratedVirtualMachineScaleSet resource accepts the following input properties:

PlatformFaultDomainCount int

Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the Resource Group in which the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

Location string

The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

Name string

The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

SinglePlacementGroup bool

Should the Orchestrated Virtual Machine Scale Set use single placement group?

Deprecated: Due to an upgrade of the compute API this preview property has now been deprecated and required to be false in the 2019-12-01 api versions for orchestrated VMSS - as it will always be false for the current and future API versions this property now defaults to false and will removed in version 3.0 of the provider.

Tags Dictionary<string, string>

A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.

Zones string

A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.

PlatformFaultDomainCount int

Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the Resource Group in which the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

Location string

The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

Name string

The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

SinglePlacementGroup bool

Should the Orchestrated Virtual Machine Scale Set use single placement group?

Deprecated: Due to an upgrade of the compute API this preview property has now been deprecated and required to be false in the 2019-12-01 api versions for orchestrated VMSS - as it will always be false for the current and future API versions this property now defaults to false and will removed in version 3.0 of the provider.

Tags map[string]string

A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.

Zones string

A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.

platformFaultDomainCount number

Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

resourceGroupName string

The name of the Resource Group in which the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

location string

The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

name string

The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

singlePlacementGroup boolean

Should the Orchestrated Virtual Machine Scale Set use single placement group?

Deprecated: Due to an upgrade of the compute API this preview property has now been deprecated and required to be false in the 2019-12-01 api versions for orchestrated VMSS - as it will always be false for the current and future API versions this property now defaults to false and will removed in version 3.0 of the provider.

tags {[key: string]: string}

A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.

zones string

A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.

platform_fault_domain_count float

Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

resource_group_name str

The name of the Resource Group in which the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

location str

The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

name str

The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

single_placement_group bool

Should the Orchestrated Virtual Machine Scale Set use single placement group?

Deprecated: Due to an upgrade of the compute API this preview property has now been deprecated and required to be false in the 2019-12-01 api versions for orchestrated VMSS - as it will always be false for the current and future API versions this property now defaults to false and will removed in version 3.0 of the provider.

tags Dict[str, str]

A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.

zones str

A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the OrchestratedVirtualMachineScaleSet resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
UniqueId string

The Unique ID for the Orchestrated Virtual Machine Scale Set.

Id string
The provider-assigned unique ID for this managed resource.
UniqueId string

The Unique ID for the Orchestrated Virtual Machine Scale Set.

id string
The provider-assigned unique ID for this managed resource.
uniqueId string

The Unique ID for the Orchestrated Virtual Machine Scale Set.

id str
The provider-assigned unique ID for this managed resource.
unique_id str

The Unique ID for the Orchestrated Virtual Machine Scale Set.

Look up an Existing OrchestratedVirtualMachineScaleSet Resource

Get an existing OrchestratedVirtualMachineScaleSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: OrchestratedVirtualMachineScaleSetState, opts?: CustomResourceOptions): OrchestratedVirtualMachineScaleSet
static get(resource_name, id, opts=None, location=None, name=None, platform_fault_domain_count=None, resource_group_name=None, single_placement_group=None, tags=None, unique_id=None, zones=None, __props__=None);
func GetOrchestratedVirtualMachineScaleSet(ctx *Context, name string, id IDInput, state *OrchestratedVirtualMachineScaleSetState, opts ...ResourceOption) (*OrchestratedVirtualMachineScaleSet, error)
public static OrchestratedVirtualMachineScaleSet Get(string name, Input<string> id, OrchestratedVirtualMachineScaleSetState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Location string

The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

Name string

The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

PlatformFaultDomainCount int

Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the Resource Group in which the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

SinglePlacementGroup bool

Should the Orchestrated Virtual Machine Scale Set use single placement group?

Deprecated: Due to an upgrade of the compute API this preview property has now been deprecated and required to be false in the 2019-12-01 api versions for orchestrated VMSS - as it will always be false for the current and future API versions this property now defaults to false and will removed in version 3.0 of the provider.

Tags Dictionary<string, string>

A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.

UniqueId string

The Unique ID for the Orchestrated Virtual Machine Scale Set.

Zones string

A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.

Location string

The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

Name string

The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

PlatformFaultDomainCount int

Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the Resource Group in which the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

SinglePlacementGroup bool

Should the Orchestrated Virtual Machine Scale Set use single placement group?

Deprecated: Due to an upgrade of the compute API this preview property has now been deprecated and required to be false in the 2019-12-01 api versions for orchestrated VMSS - as it will always be false for the current and future API versions this property now defaults to false and will removed in version 3.0 of the provider.

Tags map[string]string

A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.

UniqueId string

The Unique ID for the Orchestrated Virtual Machine Scale Set.

Zones string

A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.

location string

The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

name string

The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

platformFaultDomainCount number

Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

resourceGroupName string

The name of the Resource Group in which the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

singlePlacementGroup boolean

Should the Orchestrated Virtual Machine Scale Set use single placement group?

Deprecated: Due to an upgrade of the compute API this preview property has now been deprecated and required to be false in the 2019-12-01 api versions for orchestrated VMSS - as it will always be false for the current and future API versions this property now defaults to false and will removed in version 3.0 of the provider.

tags {[key: string]: string}

A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.

uniqueId string

The Unique ID for the Orchestrated Virtual Machine Scale Set.

zones string

A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.

location str

The Azure location where the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

name str

The name of the Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

platform_fault_domain_count float

Specifies the number of fault domains that are used by this Orchestrated Virtual Machine Scale Set. Changing this forces a new resource to be created.

resource_group_name str

The name of the Resource Group in which the Orchestrated Virtual Machine Scale Set should exist. Changing this forces a new resource to be created.

single_placement_group bool

Should the Orchestrated Virtual Machine Scale Set use single placement group?

Deprecated: Due to an upgrade of the compute API this preview property has now been deprecated and required to be false in the 2019-12-01 api versions for orchestrated VMSS - as it will always be false for the current and future API versions this property now defaults to false and will removed in version 3.0 of the provider.

tags Dict[str, str]

A mapping of tags which should be assigned to this Orchestrated Virtual Machine Scale Set.

unique_id str

The Unique ID for the Orchestrated Virtual Machine Scale Set.

zones str

A list of Availability Zones in which the Virtual Machines in this Scale Set should be created in. Changing this forces a new resource to be created.

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.