autoscale

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.autoscale.Setting(resource_name, opts=None, enabled=None, location=None, name=None, notification=None, profiles=None, resource_group_name=None, tags=None, target_resource_id=None, __props__=None, __name__=None, __opts__=None)

Manages an AutoScale Setting which can be applied to Virtual Machine Scale Sets, App Services and other scalable resources.

NOTE: This resource has been deprecated in favour of the monitoring.AutoscaleSetting resource and will be removed in the next major version of the AzureRM Provider. The new resource shares the same fields as this one, and information on migrating across can be found in this guide.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • enabled (pulumi.Input[bool]) – Specifies whether automatic scaling is enabled for the target resource. Defaults to true.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the AutoScale Setting should exist. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – The name of the AutoScale Setting. Changing this forces a new resource to be created.

  • notification (pulumi.Input[dict]) – Specifies a notification block as defined below.

  • profiles (pulumi.Input[list]) – Specifies one or more (up to 20) profile blocks as defined below.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in the AutoScale Setting should be created. Changing this forces a new resource to be created.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • target_resource_id (pulumi.Input[str]) – Specifies the resource ID of the resource that the autoscale setting should be added to.

The notification object supports the following:

  • email (pulumi.Input[dict])

    • customEmails (pulumi.Input[list])

    • sendToSubscriptionAdministrator (pulumi.Input[bool])

    • sendToSubscriptionCoAdministrator (pulumi.Input[bool])

  • webhooks (pulumi.Input[list])

    • properties (pulumi.Input[dict])

    • serviceUri (pulumi.Input[str])

The profiles object supports the following:

  • capacity (pulumi.Input[dict])

    • default (pulumi.Input[float])

    • maximum (pulumi.Input[float])

    • minimum (pulumi.Input[float])

  • fixedDate (pulumi.Input[dict])

    • end (pulumi.Input[str])

    • start (pulumi.Input[str])

    • timezone (pulumi.Input[str])

  • name (pulumi.Input[str]) - The name of the AutoScale Setting. Changing this forces a new resource to be created.

  • recurrence (pulumi.Input[dict])

    • days (pulumi.Input[list])

    • hours (pulumi.Input[float])

    • minutes (pulumi.Input[float])

    • timezone (pulumi.Input[str])

  • rules (pulumi.Input[list])

    • metricTrigger (pulumi.Input[dict])

      • metricName (pulumi.Input[str])

      • metricResourceId (pulumi.Input[str])

      • operator (pulumi.Input[str])

      • statistic (pulumi.Input[str])

      • threshold (pulumi.Input[float])

      • timeAggregation (pulumi.Input[str])

      • timeGrain (pulumi.Input[str])

      • timeWindow (pulumi.Input[str])

    • scaleAction (pulumi.Input[dict])

      • cooldown (pulumi.Input[str])

      • direction (pulumi.Input[str])

      • type (pulumi.Input[str])

      • value (pulumi.Input[float])

enabled = None

Specifies whether automatic scaling is enabled for the target resource. Defaults to true.

location = None

Specifies the supported Azure location where the AutoScale Setting should exist. Changing this forces a new resource to be created.

name = None

The name of the AutoScale Setting. Changing this forces a new resource to be created.

notification = None

Specifies a notification block as defined below.

  • email (dict)

    • customEmails (list)

    • sendToSubscriptionAdministrator (bool)

    • sendToSubscriptionCoAdministrator (bool)

  • webhooks (list)

    • properties (dict)

    • serviceUri (str)

profiles = None

Specifies one or more (up to 20) profile blocks as defined below.

  • capacity (dict)

    • default (float)

    • maximum (float)

    • minimum (float)

  • fixedDate (dict)

    • end (str)

    • start (str)

    • timezone (str)

  • name (str) - The name of the AutoScale Setting. Changing this forces a new resource to be created.

  • recurrence (dict)

    • days (list)

    • hours (float)

    • minutes (float)

    • timezone (str)

  • rules (list)

    • metricTrigger (dict)

      • metricName (str)

      • metricResourceId (str)

      • operator (str)

      • statistic (str)

      • threshold (float)

      • timeAggregation (str)

      • timeGrain (str)

      • timeWindow (str)

    • scaleAction (dict)

      • cooldown (str)

      • direction (str)

      • type (str)

      • value (float)

resource_group_name = None

The name of the Resource Group in the AutoScale Setting should be created. Changing this forces a new resource to be created.

tags = None

A mapping of tags to assign to the resource.

target_resource_id = None

Specifies the resource ID of the resource that the autoscale setting should be added to.

static get(resource_name, id, opts=None, enabled=None, location=None, name=None, notification=None, profiles=None, resource_group_name=None, tags=None, target_resource_id=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • enabled (pulumi.Input[bool]) – Specifies whether automatic scaling is enabled for the target resource. Defaults to true.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the AutoScale Setting should exist. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – The name of the AutoScale Setting. Changing this forces a new resource to be created.

  • notification (pulumi.Input[dict]) – Specifies a notification block as defined below.

  • profiles (pulumi.Input[list]) – Specifies one or more (up to 20) profile blocks as defined below.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in the AutoScale Setting should be created. Changing this forces a new resource to be created.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • target_resource_id (pulumi.Input[str]) – Specifies the resource ID of the resource that the autoscale setting should be added to.

The notification object supports the following:

  • email (pulumi.Input[dict])

    • customEmails (pulumi.Input[list])

    • sendToSubscriptionAdministrator (pulumi.Input[bool])

    • sendToSubscriptionCoAdministrator (pulumi.Input[bool])

  • webhooks (pulumi.Input[list])

    • properties (pulumi.Input[dict])

    • serviceUri (pulumi.Input[str])

The profiles object supports the following:

  • capacity (pulumi.Input[dict])

    • default (pulumi.Input[float])

    • maximum (pulumi.Input[float])

    • minimum (pulumi.Input[float])

  • fixedDate (pulumi.Input[dict])

    • end (pulumi.Input[str])

    • start (pulumi.Input[str])

    • timezone (pulumi.Input[str])

  • name (pulumi.Input[str]) - The name of the AutoScale Setting. Changing this forces a new resource to be created.

  • recurrence (pulumi.Input[dict])

    • days (pulumi.Input[list])

    • hours (pulumi.Input[float])

    • minutes (pulumi.Input[float])

    • timezone (pulumi.Input[str])

  • rules (pulumi.Input[list])

    • metricTrigger (pulumi.Input[dict])

      • metricName (pulumi.Input[str])

      • metricResourceId (pulumi.Input[str])

      • operator (pulumi.Input[str])

      • statistic (pulumi.Input[str])

      • threshold (pulumi.Input[float])

      • timeAggregation (pulumi.Input[str])

      • timeGrain (pulumi.Input[str])

      • timeWindow (pulumi.Input[str])

    • scaleAction (pulumi.Input[dict])

      • cooldown (pulumi.Input[str])

      • direction (pulumi.Input[str])

      • type (pulumi.Input[str])

      • value (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str