We recommend using Azure Native.
Manages a Virtual Desktop Scaling Plan Host Pool Association.
Create ScalingPlanHostPoolAssociation Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ScalingPlanHostPoolAssociation(name: string, args: ScalingPlanHostPoolAssociationArgs, opts?: CustomResourceOptions);@overload
def ScalingPlanHostPoolAssociation(resource_name: str,
args: ScalingPlanHostPoolAssociationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ScalingPlanHostPoolAssociation(resource_name: str,
opts: Optional[ResourceOptions] = None,
enabled: Optional[bool] = None,
host_pool_id: Optional[str] = None,
scaling_plan_id: Optional[str] = None)func NewScalingPlanHostPoolAssociation(ctx *Context, name string, args ScalingPlanHostPoolAssociationArgs, opts ...ResourceOption) (*ScalingPlanHostPoolAssociation, error)public ScalingPlanHostPoolAssociation(string name, ScalingPlanHostPoolAssociationArgs args, CustomResourceOptions? opts = null)
public ScalingPlanHostPoolAssociation(String name, ScalingPlanHostPoolAssociationArgs args)
public ScalingPlanHostPoolAssociation(String name, ScalingPlanHostPoolAssociationArgs args, CustomResourceOptions options)
type: azure:desktopvirtualization:ScalingPlanHostPoolAssociation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ScalingPlanHostPoolAssociationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ScalingPlanHostPoolAssociationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ScalingPlanHostPoolAssociationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ScalingPlanHostPoolAssociationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ScalingPlanHostPoolAssociationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var scalingPlanHostPoolAssociationResource = new Azure.DesktopVirtualization.ScalingPlanHostPoolAssociation("scalingPlanHostPoolAssociationResource", new()
{
Enabled = false,
HostPoolId = "string",
ScalingPlanId = "string",
});
example, err := desktopvirtualization.NewScalingPlanHostPoolAssociation(ctx, "scalingPlanHostPoolAssociationResource", &desktopvirtualization.ScalingPlanHostPoolAssociationArgs{
Enabled: pulumi.Bool(false),
HostPoolId: pulumi.String("string"),
ScalingPlanId: pulumi.String("string"),
})
var scalingPlanHostPoolAssociationResource = new ScalingPlanHostPoolAssociation("scalingPlanHostPoolAssociationResource", ScalingPlanHostPoolAssociationArgs.builder()
.enabled(false)
.hostPoolId("string")
.scalingPlanId("string")
.build());
scaling_plan_host_pool_association_resource = azure.desktopvirtualization.ScalingPlanHostPoolAssociation("scalingPlanHostPoolAssociationResource",
enabled=False,
host_pool_id="string",
scaling_plan_id="string")
const scalingPlanHostPoolAssociationResource = new azure.desktopvirtualization.ScalingPlanHostPoolAssociation("scalingPlanHostPoolAssociationResource", {
enabled: false,
hostPoolId: "string",
scalingPlanId: "string",
});
type: azure:desktopvirtualization:ScalingPlanHostPoolAssociation
properties:
enabled: false
hostPoolId: string
scalingPlanId: string
ScalingPlanHostPoolAssociation Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ScalingPlanHostPoolAssociation resource accepts the following input properties:
- Enabled bool
- Should the Scaling Plan be enabled on this Host Pool.
- Host
Pool stringId - The resource ID for the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
- Scaling
Plan stringId - The resource ID for the Virtual Desktop Scaling Plan. Changing this forces a new resource to be created.
- Enabled bool
- Should the Scaling Plan be enabled on this Host Pool.
- Host
Pool stringId - The resource ID for the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
- Scaling
Plan stringId - The resource ID for the Virtual Desktop Scaling Plan. Changing this forces a new resource to be created.
- enabled Boolean
- Should the Scaling Plan be enabled on this Host Pool.
- host
Pool StringId - The resource ID for the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
- scaling
Plan StringId - The resource ID for the Virtual Desktop Scaling Plan. Changing this forces a new resource to be created.
- enabled boolean
- Should the Scaling Plan be enabled on this Host Pool.
- host
Pool stringId - The resource ID for the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
- scaling
Plan stringId - The resource ID for the Virtual Desktop Scaling Plan. Changing this forces a new resource to be created.
- enabled bool
- Should the Scaling Plan be enabled on this Host Pool.
- host_
pool_ strid - The resource ID for the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
- scaling_
plan_ strid - The resource ID for the Virtual Desktop Scaling Plan. Changing this forces a new resource to be created.
- enabled Boolean
- Should the Scaling Plan be enabled on this Host Pool.
- host
Pool StringId - The resource ID for the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
- scaling
Plan StringId - The resource ID for the Virtual Desktop Scaling Plan. Changing this forces a new resource to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the ScalingPlanHostPoolAssociation resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing ScalingPlanHostPoolAssociation Resource
Get an existing ScalingPlanHostPoolAssociation 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?: ScalingPlanHostPoolAssociationState, opts?: CustomResourceOptions): ScalingPlanHostPoolAssociation@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
enabled: Optional[bool] = None,
host_pool_id: Optional[str] = None,
scaling_plan_id: Optional[str] = None) -> ScalingPlanHostPoolAssociationfunc GetScalingPlanHostPoolAssociation(ctx *Context, name string, id IDInput, state *ScalingPlanHostPoolAssociationState, opts ...ResourceOption) (*ScalingPlanHostPoolAssociation, error)public static ScalingPlanHostPoolAssociation Get(string name, Input<string> id, ScalingPlanHostPoolAssociationState? state, CustomResourceOptions? opts = null)public static ScalingPlanHostPoolAssociation get(String name, Output<String> id, ScalingPlanHostPoolAssociationState state, CustomResourceOptions options)resources: _: type: azure:desktopvirtualization:ScalingPlanHostPoolAssociation get: id: ${id}- 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.
- 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.
- Enabled bool
- Should the Scaling Plan be enabled on this Host Pool.
- Host
Pool stringId - The resource ID for the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
- Scaling
Plan stringId - The resource ID for the Virtual Desktop Scaling Plan. Changing this forces a new resource to be created.
- Enabled bool
- Should the Scaling Plan be enabled on this Host Pool.
- Host
Pool stringId - The resource ID for the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
- Scaling
Plan stringId - The resource ID for the Virtual Desktop Scaling Plan. Changing this forces a new resource to be created.
- enabled Boolean
- Should the Scaling Plan be enabled on this Host Pool.
- host
Pool StringId - The resource ID for the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
- scaling
Plan StringId - The resource ID for the Virtual Desktop Scaling Plan. Changing this forces a new resource to be created.
- enabled boolean
- Should the Scaling Plan be enabled on this Host Pool.
- host
Pool stringId - The resource ID for the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
- scaling
Plan stringId - The resource ID for the Virtual Desktop Scaling Plan. Changing this forces a new resource to be created.
- enabled bool
- Should the Scaling Plan be enabled on this Host Pool.
- host_
pool_ strid - The resource ID for the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
- scaling_
plan_ strid - The resource ID for the Virtual Desktop Scaling Plan. Changing this forces a new resource to be created.
- enabled Boolean
- Should the Scaling Plan be enabled on this Host Pool.
- host
Pool StringId - The resource ID for the Virtual Desktop Host Pool. Changing this forces a new resource to be created.
- scaling
Plan StringId - The resource ID for the Virtual Desktop Scaling Plan. Changing this forces a new resource to be created.
Import
Associations between Virtual Desktop Scaling Plans and Virtual Desktop Host Pools can be imported using the resource id, e.g.
$ pulumi import azure:desktopvirtualization/scalingPlanHostPoolAssociation:ScalingPlanHostPoolAssociation example "/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/plan1|/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup1/providers/Microsoft.DesktopVirtualization/hostPools/myhostpool"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.
