insights.azure.com/v1api20221001

insights.azure.com/v1api20221001

Package v1api20221001 contains API Schema definitions for the insights v1api20221001 API group

Resource Types:

    APIVersion (string alias)

    Value Description

    "2022-10-01"

    AutoscaleNotification

    (Appears on:AutoscaleSetting_Spec)

    Autoscale notification.

    Field Description
    email
    EmailNotification

    Email: the email notification.

    operation
    AutoscaleNotification_Operation

    Operation: the operation associated with the notification and its value must be “scale”

    webhooks
    []WebhookNotification

    Webhooks: the collection of webhook notifications.

    AutoscaleNotification_Operation (string alias)

    (Appears on:AutoscaleNotification)

    Value Description

    "Scale"

    AutoscaleNotification_Operation_STATUS (string alias)

    (Appears on:AutoscaleNotification_STATUS)

    Value Description

    "Scale"

    AutoscaleNotification_STATUS

    (Appears on:Autoscalesetting_STATUS)

    Autoscale notification.

    Field Description
    email
    EmailNotification_STATUS

    Email: the email notification.

    operation
    AutoscaleNotification_Operation_STATUS

    Operation: the operation associated with the notification and its value must be “scale”

    webhooks
    []WebhookNotification_STATUS

    Webhooks: the collection of webhook notifications.

    AutoscaleProfile

    (Appears on:AutoscaleSetting_Spec)

    Autoscale profile.

    Field Description
    capacity
    ScaleCapacity

    Capacity: the number of instances that can be used during this profile.

    fixedDate
    TimeWindow

    FixedDate: the specific date-time for the profile. This element is not used if the Recurrence element is used.

    name
    string

    Name: the name of the profile.

    recurrence
    Recurrence

    Recurrence: the repeating times at which this profile begins. This element is not used if the FixedDate element is used.

    rules
    []ScaleRule

    Rules: the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified.

    AutoscaleProfile_STATUS

    (Appears on:Autoscalesetting_STATUS)

    Autoscale profile.

    Field Description
    capacity
    ScaleCapacity_STATUS

    Capacity: the number of instances that can be used during this profile.

    fixedDate
    TimeWindow_STATUS

    FixedDate: the specific date-time for the profile. This element is not used if the Recurrence element is used.

    name
    string

    Name: the name of the profile.

    recurrence
    Recurrence_STATUS

    Recurrence: the repeating times at which this profile begins. This element is not used if the FixedDate element is used.

    rules
    []ScaleRule_STATUS

    Rules: the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified.

    AutoscaleSetting

    Generator information: - Generated from: /monitor/resource-manager/Microsoft.Insights/stable/2022-10-01/autoscale_API.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourcegroups/​{resourceGroupName}/​providers/​Microsoft.Insights/​autoscalesettings/​{autoscaleSettingName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    AutoscaleSetting_Spec


    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    enabled
    bool

    Enabled: the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is ‘false’.

    location
    string

    Location: Resource location

    name
    string

    Name: the name of the autoscale setting.

    notifications
    []AutoscaleNotification

    Notifications: the collection of notifications.

    operatorSpec
    AutoscaleSettingOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    predictiveAutoscalePolicy
    PredictiveAutoscalePolicy

    PredictiveAutoscalePolicy: the predictive autoscale policy mode.

    profiles
    []AutoscaleProfile

    Profiles: the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified.

    tags
    map[string]string

    Tags: Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters.

    targetResourceLocation
    string

    TargetResourceLocation: the location of the resource that the autoscale setting should be added to.

    targetResourceUriReference
    genruntime.ResourceReference

    TargetResourceUriReference: the resource identifier of the resource that the autoscale setting should be added to.

    status
    Autoscalesetting_STATUS

    AutoscaleSettingOperatorSpec

    (Appears on:AutoscaleSetting_Spec)

    Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

    Field Description
    configMapExpressions
    []genruntime/core.DestinationExpression

    ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

    secretExpressions
    []genruntime/core.DestinationExpression

    SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

    AutoscaleSetting_Spec

    (Appears on:AutoscaleSetting)

    Field Description
    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    enabled
    bool

    Enabled: the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is ‘false’.

    location
    string

    Location: Resource location

    name
    string

    Name: the name of the autoscale setting.

    notifications
    []AutoscaleNotification

    Notifications: the collection of notifications.

    operatorSpec
    AutoscaleSettingOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    predictiveAutoscalePolicy
    PredictiveAutoscalePolicy

    PredictiveAutoscalePolicy: the predictive autoscale policy mode.

    profiles
    []AutoscaleProfile

    Profiles: the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified.

    tags
    map[string]string

    Tags: Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters.

    targetResourceLocation
    string

    TargetResourceLocation: the location of the resource that the autoscale setting should be added to.

    targetResourceUriReference
    genruntime.ResourceReference

    TargetResourceUriReference: the resource identifier of the resource that the autoscale setting should be added to.

    Autoscalesetting_STATUS

    (Appears on:AutoscaleSetting)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    enabled
    bool

    Enabled: the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is ‘false’.

    id
    string

    Id: Azure resource Id

    location
    string

    Location: Resource location

    name
    string

    Name: Azure resource name

    notifications
    []AutoscaleNotification_STATUS

    Notifications: the collection of notifications.

    predictiveAutoscalePolicy
    PredictiveAutoscalePolicy_STATUS

    PredictiveAutoscalePolicy: the predictive autoscale policy mode.

    profiles
    []AutoscaleProfile_STATUS

    Profiles: the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified.

    properties_name
    string

    PropertiesName: the name of the autoscale setting.

    systemData
    SystemData_STATUS

    SystemData: The system metadata related to the response.

    tags
    map[string]string

    Tags: Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters.

    targetResourceLocation
    string

    TargetResourceLocation: the location of the resource that the autoscale setting should be added to.

    targetResourceUri
    string

    TargetResourceUri: the resource identifier of the resource that the autoscale setting should be added to.

    type
    string

    Type: Azure resource type

    EmailNotification

    (Appears on:AutoscaleNotification)

    Email notification of an autoscale event.

    Field Description
    customEmails
    []string

    CustomEmails: the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored.

    sendToSubscriptionAdministrator
    bool

    SendToSubscriptionAdministrator: a value indicating whether to send email to subscription administrator.

    sendToSubscriptionCoAdministrators
    bool

    SendToSubscriptionCoAdministrators: a value indicating whether to send email to subscription co-administrators.

    EmailNotification_STATUS

    (Appears on:AutoscaleNotification_STATUS)

    Email notification of an autoscale event.

    Field Description
    customEmails
    []string

    CustomEmails: the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored.

    sendToSubscriptionAdministrator
    bool

    SendToSubscriptionAdministrator: a value indicating whether to send email to subscription administrator.

    sendToSubscriptionCoAdministrators
    bool

    SendToSubscriptionCoAdministrators: a value indicating whether to send email to subscription co-administrators.

    MetricTrigger

    (Appears on:ScaleRule)

    The trigger that results in a scaling action.

    Field Description
    dimensions
    []ScaleRuleMetricDimension

    Dimensions: List of dimension conditions. For example: [{“DimensionName”:“AppName”,“Operator”:“Equals”,“Values”:[“App1”]},{“DimensionName”:“Deployment”,“Operator”:“Equals”,“Values”:[“default”]}].

    dividePerInstance
    bool

    DividePerInstance: a value indicating whether metric should divide per instance.

    metricName
    string

    MetricName: the name of the metric that defines what the rule monitors.

    metricNamespace
    string

    MetricNamespace: the namespace of the metric that defines what the rule monitors.

    metricResourceLocation
    string

    MetricResourceLocation: the location of the resource the rule monitors.

    metricResourceUriReference
    genruntime.ResourceReference

    MetricResourceUriReference: the resource identifier of the resource the rule monitors.

    operator
    MetricTrigger_Operator

    Operator: the operator that is used to compare the metric data and the threshold.

    statistic
    MetricTrigger_Statistic

    Statistic: the metric statistic type. How the metrics from multiple instances are combined.

    threshold
    float64

    Threshold: the threshold of the metric that triggers the scale action.

    timeAggregation
    MetricTrigger_TimeAggregation

    TimeAggregation: time aggregation type. How the data that is collected should be combined over time. The default value is Average.

    timeGrain
    string

    TimeGrain: the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute.

    timeWindow
    string

    TimeWindow: the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes.

    MetricTrigger_Operator (string alias)

    (Appears on:MetricTrigger)

    Value Description

    "Equals"

    "GreaterThan"

    "GreaterThanOrEqual"

    "LessThan"

    "LessThanOrEqual"

    "NotEquals"

    MetricTrigger_Operator_STATUS (string alias)

    (Appears on:MetricTrigger_STATUS)

    Value Description

    "Equals"

    "GreaterThan"

    "GreaterThanOrEqual"

    "LessThan"

    "LessThanOrEqual"

    "NotEquals"

    MetricTrigger_STATUS

    (Appears on:ScaleRule_STATUS)

    The trigger that results in a scaling action.

    Field Description
    dimensions
    []ScaleRuleMetricDimension_STATUS

    Dimensions: List of dimension conditions. For example: [{“DimensionName”:“AppName”,“Operator”:“Equals”,“Values”:[“App1”]},{“DimensionName”:“Deployment”,“Operator”:“Equals”,“Values”:[“default”]}].

    dividePerInstance
    bool

    DividePerInstance: a value indicating whether metric should divide per instance.

    metricName
    string

    MetricName: the name of the metric that defines what the rule monitors.

    metricNamespace
    string

    MetricNamespace: the namespace of the metric that defines what the rule monitors.

    metricResourceLocation
    string

    MetricResourceLocation: the location of the resource the rule monitors.

    metricResourceUri
    string

    MetricResourceUri: the resource identifier of the resource the rule monitors.

    operator
    MetricTrigger_Operator_STATUS

    Operator: the operator that is used to compare the metric data and the threshold.

    statistic
    MetricTrigger_Statistic_STATUS

    Statistic: the metric statistic type. How the metrics from multiple instances are combined.

    threshold
    float64

    Threshold: the threshold of the metric that triggers the scale action.

    timeAggregation
    MetricTrigger_TimeAggregation_STATUS

    TimeAggregation: time aggregation type. How the data that is collected should be combined over time. The default value is Average.

    timeGrain
    string

    TimeGrain: the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute.

    timeWindow
    string

    TimeWindow: the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes.

    MetricTrigger_Statistic (string alias)

    (Appears on:MetricTrigger)

    Value Description

    "Average"

    "Count"

    "Max"

    "Min"

    "Sum"

    MetricTrigger_Statistic_STATUS (string alias)

    (Appears on:MetricTrigger_STATUS)

    Value Description

    "Average"

    "Count"

    "Max"

    "Min"

    "Sum"

    MetricTrigger_TimeAggregation (string alias)

    (Appears on:MetricTrigger)

    Value Description

    "Average"

    "Count"

    "Last"

    "Maximum"

    "Minimum"

    "Total"

    MetricTrigger_TimeAggregation_STATUS (string alias)

    (Appears on:MetricTrigger_STATUS)

    Value Description

    "Average"

    "Count"

    "Last"

    "Maximum"

    "Minimum"

    "Total"

    PredictiveAutoscalePolicy

    (Appears on:AutoscaleSetting_Spec)

    The parameters for enabling predictive autoscale.

    Field Description
    scaleLookAheadTime
    string

    ScaleLookAheadTime: the amount of time to specify by which instances are launched in advance. It must be between 1 minute and 60 minutes in ISO 8601 format.

    scaleMode
    PredictiveAutoscalePolicy_ScaleMode

    ScaleMode: the predictive autoscale mode

    PredictiveAutoscalePolicy_STATUS

    (Appears on:Autoscalesetting_STATUS)

    The parameters for enabling predictive autoscale.

    Field Description
    scaleLookAheadTime
    string

    ScaleLookAheadTime: the amount of time to specify by which instances are launched in advance. It must be between 1 minute and 60 minutes in ISO 8601 format.

    scaleMode
    PredictiveAutoscalePolicy_ScaleMode_STATUS

    ScaleMode: the predictive autoscale mode

    PredictiveAutoscalePolicy_ScaleMode (string alias)

    (Appears on:PredictiveAutoscalePolicy)

    Value Description

    "Disabled"

    "Enabled"

    "ForecastOnly"

    PredictiveAutoscalePolicy_ScaleMode_STATUS (string alias)

    (Appears on:PredictiveAutoscalePolicy_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    "ForecastOnly"

    Recurrence

    (Appears on:AutoscaleProfile)

    The repeating times at which this profile begins. This element is not used if the FixedDate element is used.

    Field Description
    frequency
    Recurrence_Frequency

    Frequency: the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles. For example, to set a daily schedule, set schedule to every day of the week. The frequency property specifies that the schedule is repeated weekly.

    schedule
    RecurrentSchedule

    Schedule: the scheduling constraints for when the profile begins.

    Recurrence_Frequency (string alias)

    (Appears on:Recurrence)

    Value Description

    "Day"

    "Hour"

    "Minute"

    "Month"

    "None"

    "Second"

    "Week"

    "Year"

    Recurrence_Frequency_STATUS (string alias)

    (Appears on:Recurrence_STATUS)

    Value Description

    "Day"

    "Hour"

    "Minute"

    "Month"

    "None"

    "Second"

    "Week"

    "Year"

    Recurrence_STATUS

    (Appears on:AutoscaleProfile_STATUS)

    The repeating times at which this profile begins. This element is not used if the FixedDate element is used.

    Field Description
    frequency
    Recurrence_Frequency_STATUS

    Frequency: the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles. For example, to set a daily schedule, set schedule to every day of the week. The frequency property specifies that the schedule is repeated weekly.

    schedule
    RecurrentSchedule_STATUS

    Schedule: the scheduling constraints for when the profile begins.

    RecurrentSchedule

    (Appears on:Recurrence)

    The scheduling constraints for when the profile begins.

    Field Description
    days
    []string

    Days: the collection of days that the profile takes effect on. Possible values are Sunday through Saturday.

    hours
    []int

    Hours: A collection of hours that the profile takes effect on. Values supported are 0 to 23 on the 24-hour clock (AM/PM times are not supported).

    minutes
    []int

    Minutes: A collection of minutes at which the profile takes effect at.

    timeZone
    string

    TimeZone: the timezone for the hours of the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time

    RecurrentSchedule_STATUS

    (Appears on:Recurrence_STATUS)

    The scheduling constraints for when the profile begins.

    Field Description
    days
    []string

    Days: the collection of days that the profile takes effect on. Possible values are Sunday through Saturday.

    hours
    []int

    Hours: A collection of hours that the profile takes effect on. Values supported are 0 to 23 on the 24-hour clock (AM/PM times are not supported).

    minutes
    []int

    Minutes: A collection of minutes at which the profile takes effect at.

    timeZone
    string

    TimeZone: the timezone for the hours of the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time

    ScaleAction

    (Appears on:ScaleRule)

    The parameters for the scaling action.

    Field Description
    cooldown
    string

    Cooldown: the amount of time to wait since the last scaling action before this action occurs. It must be between 1 week and 1 minute in ISO 8601 format.

    direction
    ScaleAction_Direction

    Direction: the scale direction. Whether the scaling action increases or decreases the number of instances.

    type
    ScaleAction_Type

    Type: the type of action that should occur when the scale rule fires.

    value
    string

    Value: the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1.

    ScaleAction_Direction (string alias)

    (Appears on:ScaleAction)

    Value Description

    "Decrease"

    "Increase"

    "None"

    ScaleAction_Direction_STATUS (string alias)

    (Appears on:ScaleAction_STATUS)

    Value Description

    "Decrease"

    "Increase"

    "None"

    ScaleAction_STATUS

    (Appears on:ScaleRule_STATUS)

    The parameters for the scaling action.

    Field Description
    cooldown
    string

    Cooldown: the amount of time to wait since the last scaling action before this action occurs. It must be between 1 week and 1 minute in ISO 8601 format.

    direction
    ScaleAction_Direction_STATUS

    Direction: the scale direction. Whether the scaling action increases or decreases the number of instances.

    type
    ScaleAction_Type_STATUS

    Type: the type of action that should occur when the scale rule fires.

    value
    string

    Value: the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1.

    ScaleAction_Type (string alias)

    (Appears on:ScaleAction)

    Value Description

    "ChangeCount"

    "ExactCount"

    "PercentChangeCount"

    "ServiceAllowedNextValue"

    ScaleAction_Type_STATUS (string alias)

    (Appears on:ScaleAction_STATUS)

    Value Description

    "ChangeCount"

    "ExactCount"

    "PercentChangeCount"

    "ServiceAllowedNextValue"

    ScaleCapacity

    (Appears on:AutoscaleProfile)

    The number of instances that can be used during this profile.

    Field Description
    default
    string

    Default: the number of instances that will be set if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default.

    maximum
    string

    Maximum: the maximum number of instances for the resource. The actual maximum number of instances is limited by the cores that are available in the subscription.

    minimum
    string

    Minimum: the minimum number of instances for the resource.

    ScaleCapacity_STATUS

    (Appears on:AutoscaleProfile_STATUS)

    The number of instances that can be used during this profile.

    Field Description
    default
    string

    Default: the number of instances that will be set if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default.

    maximum
    string

    Maximum: the maximum number of instances for the resource. The actual maximum number of instances is limited by the cores that are available in the subscription.

    minimum
    string

    Minimum: the minimum number of instances for the resource.

    ScaleRule

    (Appears on:AutoscaleProfile)

    A rule that provide the triggers and parameters for the scaling action.

    Field Description
    metricTrigger
    MetricTrigger

    MetricTrigger: the trigger that results in a scaling action.

    scaleAction
    ScaleAction

    ScaleAction: the parameters for the scaling action.

    ScaleRuleMetricDimension

    (Appears on:MetricTrigger)

    Specifies an auto scale rule metric dimension.

    Field Description
    DimensionName
    string

    DimensionName: Name of the dimension.

    Operator
    ScaleRuleMetricDimension_Operator

    Operator: the dimension operator. Only ‘Equals’ and ‘NotEquals’ are supported. ‘Equals’ being equal to any of the values. ‘NotEquals’ being not equal to all of the values

    Values
    []string

    Values: list of dimension values. For example: [“App1”,“App2”].

    ScaleRuleMetricDimension_Operator (string alias)

    (Appears on:ScaleRuleMetricDimension)

    Value Description

    "Equals"

    "NotEquals"

    ScaleRuleMetricDimension_Operator_STATUS (string alias)

    (Appears on:ScaleRuleMetricDimension_STATUS)

    Value Description

    "Equals"

    "NotEquals"

    ScaleRuleMetricDimension_STATUS

    (Appears on:MetricTrigger_STATUS)

    Specifies an auto scale rule metric dimension.

    Field Description
    DimensionName
    string

    DimensionName: Name of the dimension.

    Operator
    ScaleRuleMetricDimension_Operator_STATUS

    Operator: the dimension operator. Only ‘Equals’ and ‘NotEquals’ are supported. ‘Equals’ being equal to any of the values. ‘NotEquals’ being not equal to all of the values

    Values
    []string

    Values: list of dimension values. For example: [“App1”,“App2”].

    ScaleRule_STATUS

    (Appears on:AutoscaleProfile_STATUS)

    A rule that provide the triggers and parameters for the scaling action.

    Field Description
    metricTrigger
    MetricTrigger_STATUS

    MetricTrigger: the trigger that results in a scaling action.

    scaleAction
    ScaleAction_STATUS

    ScaleAction: the parameters for the scaling action.

    SystemData_CreatedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_STATUS

    (Appears on:Autoscalesetting_STATUS)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemData_CreatedByType_STATUS

    CreatedByType: The type of identity that created the resource.

    lastModifiedAt
    string

    LastModifiedAt: The timestamp of resource last modification (UTC)

    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.

    lastModifiedByType
    SystemData_LastModifiedByType_STATUS

    LastModifiedByType: The type of identity that last modified the resource.

    TimeWindow

    (Appears on:AutoscaleProfile)

    A specific date-time for the profile.

    Field Description
    end
    string

    End: the end time for the profile in ISO 8601 format.

    start
    string

    Start: the start time for the profile in ISO 8601 format.

    timeZone
    string

    TimeZone: the timezone of the start and end times for the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time

    TimeWindow_STATUS

    (Appears on:AutoscaleProfile_STATUS)

    A specific date-time for the profile.

    Field Description
    end
    string

    End: the end time for the profile in ISO 8601 format.

    start
    string

    Start: the start time for the profile in ISO 8601 format.

    timeZone
    string

    TimeZone: the timezone of the start and end times for the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time

    WebhookNotification

    (Appears on:AutoscaleNotification)

    Webhook notification of an autoscale event.

    Field Description
    properties
    map[string]string

    Properties: a property bag of settings. This value can be empty.

    serviceUri
    string

    ServiceUri: the service address to receive the notification.

    WebhookNotification_STATUS

    (Appears on:AutoscaleNotification_STATUS)

    Webhook notification of an autoscale event.

    Field Description
    properties
    map[string]string

    Properties: a property bag of settings. This value can be empty.

    serviceUri
    string

    ServiceUri: the service address to receive the notification.