insights.azure.com/v1api20221001
APIVersion
| Value | Description |
|---|---|
| “2022-10-01” |
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}
Used by: AutoscaleSettingList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | AutoscaleSetting_Spec Optional |
|
| status | Autoscalesetting_STATUS Optional |
AutoscaleSetting_Spec
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| enabled | the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is ‘false’. | bool Optional |
| location | Resource location | string Required |
| name | the name of the autoscale setting. | string Optional |
| notifications | the collection of notifications. | AutoscaleNotification[] Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | AutoscaleSettingOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| predictiveAutoscalePolicy | the predictive autoscale policy mode. | PredictiveAutoscalePolicy Optional |
| profiles | the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified. | AutoscaleProfile[] Required |
| 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. | map[string]string Optional |
| targetResourceLocation | the location of the resource that the autoscale setting should be added to. | string Optional |
| targetResourceUriReference | the resource identifier of the resource that the autoscale setting should be added to. | genruntime.ResourceReference Optional |
Autoscalesetting_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| enabled | the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is ‘false’. | bool Optional |
| id | Azure resource Id | string Optional |
| location | Resource location | string Optional |
| name | Azure resource name | string Optional |
| notifications | the collection of notifications. | AutoscaleNotification_STATUS[] Optional |
| predictiveAutoscalePolicy | the predictive autoscale policy mode. | PredictiveAutoscalePolicy_STATUS Optional |
| profiles | the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified. | AutoscaleProfile_STATUS[] Optional |
| properties_name | the name of the autoscale setting. | string Optional |
| systemData | The system metadata related to the response. | SystemData_STATUS Optional |
| 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. | map[string]string Optional |
| targetResourceLocation | the location of the resource that the autoscale setting should be added to. | string Optional |
| targetResourceUri | the resource identifier of the resource that the autoscale setting should be added to. | string Optional |
| type | Azure resource type | string Optional |
AutoscaleSettingList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | AutoscaleSetting[] Optional |
AutoscaleSetting_Spec
Used by: AutoscaleSetting.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| enabled | the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is ‘false’. | bool Optional |
| location | Resource location | string Required |
| name | the name of the autoscale setting. | string Optional |
| notifications | the collection of notifications. | AutoscaleNotification[] Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | AutoscaleSettingOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| predictiveAutoscalePolicy | the predictive autoscale policy mode. | PredictiveAutoscalePolicy Optional |
| profiles | the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified. | AutoscaleProfile[] Required |
| 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. | map[string]string Optional |
| targetResourceLocation | the location of the resource that the autoscale setting should be added to. | string Optional |
| targetResourceUriReference | the resource identifier of the resource that the autoscale setting should be added to. | genruntime.ResourceReference Optional |
Autoscalesetting_STATUS
Used by: AutoscaleSetting.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| enabled | the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is ‘false’. | bool Optional |
| id | Azure resource Id | string Optional |
| location | Resource location | string Optional |
| name | Azure resource name | string Optional |
| notifications | the collection of notifications. | AutoscaleNotification_STATUS[] Optional |
| predictiveAutoscalePolicy | the predictive autoscale policy mode. | PredictiveAutoscalePolicy_STATUS Optional |
| profiles | the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified. | AutoscaleProfile_STATUS[] Optional |
| properties_name | the name of the autoscale setting. | string Optional |
| systemData | The system metadata related to the response. | SystemData_STATUS Optional |
| 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. | map[string]string Optional |
| targetResourceLocation | the location of the resource that the autoscale setting should be added to. | string Optional |
| targetResourceUri | the resource identifier of the resource that the autoscale setting should be added to. | string Optional |
| type | Azure resource type | string Optional |
AutoscaleNotification
Autoscale notification.
Used by: AutoscaleSetting_Spec.
| Property | Description | Type |
|---|---|---|
| the email notification. | EmailNotification Optional |
|
| operation | the operation associated with the notification and its value must be “scale” | AutoscaleNotification_Operation Required |
| webhooks | the collection of webhook notifications. | WebhookNotification[] Optional |
AutoscaleNotification_STATUS
Autoscale notification.
Used by: Autoscalesetting_STATUS.
| Property | Description | Type |
|---|---|---|
| the email notification. | EmailNotification_STATUS Optional |
|
| operation | the operation associated with the notification and its value must be “scale” | AutoscaleNotification_Operation_STATUS Optional |
| webhooks | the collection of webhook notifications. | WebhookNotification_STATUS[] Optional |
AutoscaleProfile
Autoscale profile.
Used by: AutoscaleSetting_Spec.
| Property | Description | Type |
|---|---|---|
| capacity | the number of instances that can be used during this profile. | ScaleCapacity Required |
| fixedDate | the specific date-time for the profile. This element is not used if the Recurrence element is used. | TimeWindow Optional |
| name | the name of the profile. | string Required |
| recurrence | the repeating times at which this profile begins. This element is not used if the FixedDate element is used. | Recurrence Optional |
| rules | the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified. | ScaleRule[] Required |
AutoscaleProfile_STATUS
Autoscale profile.
Used by: Autoscalesetting_STATUS.
| Property | Description | Type |
|---|---|---|
| capacity | the number of instances that can be used during this profile. | ScaleCapacity_STATUS Required |
| fixedDate | the specific date-time for the profile. This element is not used if the Recurrence element is used. | TimeWindow_STATUS Optional |
| name | the name of the profile. | string Required |
| recurrence | the repeating times at which this profile begins. This element is not used if the FixedDate element is used. | Recurrence_STATUS Optional |
| rules | the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified. | ScaleRule_STATUS[] Required |
AutoscaleSettingOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: AutoscaleSetting_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
PredictiveAutoscalePolicy
The parameters for enabling predictive autoscale.
Used by: AutoscaleSetting_Spec.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| scaleMode | the predictive autoscale mode | PredictiveAutoscalePolicy_ScaleMode Required |
PredictiveAutoscalePolicy_STATUS
The parameters for enabling predictive autoscale.
Used by: Autoscalesetting_STATUS.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| scaleMode | the predictive autoscale mode | PredictiveAutoscalePolicy_ScaleMode_STATUS Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: Autoscalesetting_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
AutoscaleNotification_Operation
Used by: AutoscaleNotification.
| Value | Description |
|---|---|
| “Scale” |
AutoscaleNotification_Operation_STATUS
Used by: AutoscaleNotification_STATUS.
| Value | Description |
|---|---|
| “Scale” |
EmailNotification
Email notification of an autoscale event.
Used by: AutoscaleNotification.
| Property | Description | Type |
|---|---|---|
| customEmails | the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored. | string[] Optional |
| sendToSubscriptionAdministrator | a value indicating whether to send email to subscription administrator. | bool Optional |
| sendToSubscriptionCoAdministrators | a value indicating whether to send email to subscription co-administrators. | bool Optional |
EmailNotification_STATUS
Email notification of an autoscale event.
Used by: AutoscaleNotification_STATUS.
| Property | Description | Type |
|---|---|---|
| customEmails | the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored. | string[] Optional |
| sendToSubscriptionAdministrator | a value indicating whether to send email to subscription administrator. | bool Optional |
| sendToSubscriptionCoAdministrators | a value indicating whether to send email to subscription co-administrators. | bool Optional |
PredictiveAutoscalePolicy_ScaleMode
Used by: PredictiveAutoscalePolicy.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” | |
| “ForecastOnly” |
PredictiveAutoscalePolicy_ScaleMode_STATUS
Used by: PredictiveAutoscalePolicy_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” | |
| “ForecastOnly” |
Recurrence
The repeating times at which this profile begins. This element is not used if the FixedDate element is used.
Used by: AutoscaleProfile.
| Property | Description | Type |
|---|---|---|
| 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. | Recurrence_Frequency Required |
| schedule | the scheduling constraints for when the profile begins. | RecurrentSchedule Required |
Recurrence_STATUS
The repeating times at which this profile begins. This element is not used if the FixedDate element is used.
Used by: AutoscaleProfile_STATUS.
| Property | Description | Type |
|---|---|---|
| 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. | Recurrence_Frequency_STATUS Required |
| schedule | the scheduling constraints for when the profile begins. | RecurrentSchedule_STATUS Required |
ScaleCapacity
The number of instances that can be used during this profile.
Used by: AutoscaleProfile.
| Property | Description | Type |
|---|---|---|
| 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. | string Required |
| 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. | string Required |
| minimum | the minimum number of instances for the resource. | string Required |
ScaleCapacity_STATUS
The number of instances that can be used during this profile.
Used by: AutoscaleProfile_STATUS.
| Property | Description | Type |
|---|---|---|
| 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. | string Required |
| 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. | string Required |
| minimum | the minimum number of instances for the resource. | string Required |
ScaleRule
A rule that provide the triggers and parameters for the scaling action.
Used by: AutoscaleProfile.
| Property | Description | Type |
|---|---|---|
| metricTrigger | the trigger that results in a scaling action. | MetricTrigger Required |
| scaleAction | the parameters for the scaling action. | ScaleAction Required |
ScaleRule_STATUS
A rule that provide the triggers and parameters for the scaling action.
Used by: AutoscaleProfile_STATUS.
| Property | Description | Type |
|---|---|---|
| metricTrigger | the trigger that results in a scaling action. | MetricTrigger_STATUS Required |
| scaleAction | the parameters for the scaling action. | ScaleAction_STATUS Required |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
TimeWindow
A specific date-time for the profile.
Used by: AutoscaleProfile.
| Property | Description | Type |
|---|---|---|
| end | the end time for the profile in ISO 8601 format. | string Required |
| start | the start time for the profile in ISO 8601 format. | string Required |
| 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 | string Optional |
TimeWindow_STATUS
A specific date-time for the profile.
Used by: AutoscaleProfile_STATUS.
| Property | Description | Type |
|---|---|---|
| end | the end time for the profile in ISO 8601 format. | string Required |
| start | the start time for the profile in ISO 8601 format. | string Required |
| 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 | string Optional |
WebhookNotification
Webhook notification of an autoscale event.
Used by: AutoscaleNotification.
| Property | Description | Type |
|---|---|---|
| properties | a property bag of settings. This value can be empty. | map[string]string Optional |
| serviceUri | the service address to receive the notification. | string Optional |
WebhookNotification_STATUS
Webhook notification of an autoscale event.
Used by: AutoscaleNotification_STATUS.
| Property | Description | Type |
|---|---|---|
| properties | a property bag of settings. This value can be empty. | map[string]string Optional |
| serviceUri | the service address to receive the notification. | string Optional |
MetricTrigger
The trigger that results in a scaling action.
Used by: ScaleRule.
| Property | Description | Type |
|---|---|---|
| dimensions | List of dimension conditions. For example: [{“DimensionName”:“AppName”,“Operator”:“Equals”,“Values”:[“App1”]},{“DimensionName”:“Deployment”,“Operator”:“Equals”,“Values”:[“default”]}]. | ScaleRuleMetricDimension[] Optional |
| dividePerInstance | a value indicating whether metric should divide per instance. | bool Optional |
| metricName | the name of the metric that defines what the rule monitors. | string Required |
| metricNamespace | the namespace of the metric that defines what the rule monitors. | string Optional |
| metricResourceLocation | the location of the resource the rule monitors. | string Optional |
| metricResourceUriReference | the resource identifier of the resource the rule monitors. | genruntime.ResourceReference Required |
| operator | the operator that is used to compare the metric data and the threshold. | MetricTrigger_Operator Required |
| statistic | the metric statistic type. How the metrics from multiple instances are combined. | MetricTrigger_Statistic Required |
| threshold | the threshold of the metric that triggers the scale action. | float64 Required |
| timeAggregation | time aggregation type. How the data that is collected should be combined over time. The default value is Average. | MetricTrigger_TimeAggregation Required |
| 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. | string Required |
| 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. | string Required |
MetricTrigger_STATUS
The trigger that results in a scaling action.
Used by: ScaleRule_STATUS.
| Property | Description | Type |
|---|---|---|
| dimensions | List of dimension conditions. For example: [{“DimensionName”:“AppName”,“Operator”:“Equals”,“Values”:[“App1”]},{“DimensionName”:“Deployment”,“Operator”:“Equals”,“Values”:[“default”]}]. | ScaleRuleMetricDimension_STATUS[] Optional |
| dividePerInstance | a value indicating whether metric should divide per instance. | bool Optional |
| metricName | the name of the metric that defines what the rule monitors. | string Required |
| metricNamespace | the namespace of the metric that defines what the rule monitors. | string Optional |
| metricResourceLocation | the location of the resource the rule monitors. | string Optional |
| metricResourceUri | the resource identifier of the resource the rule monitors. | string Required |
| operator | the operator that is used to compare the metric data and the threshold. | MetricTrigger_Operator_STATUS Required |
| statistic | the metric statistic type. How the metrics from multiple instances are combined. | MetricTrigger_Statistic_STATUS Required |
| threshold | the threshold of the metric that triggers the scale action. | float64 Required |
| timeAggregation | time aggregation type. How the data that is collected should be combined over time. The default value is Average. | MetricTrigger_TimeAggregation_STATUS Required |
| 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. | string Required |
| 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. | string Required |
Recurrence_Frequency
Used by: Recurrence.
| Value | Description |
|---|---|
| “Day” | |
| “Hour” | |
| “Minute” | |
| “Month” | |
| “None” | |
| “Second” | |
| “Week” | |
| “Year” |
Recurrence_Frequency_STATUS
Used by: Recurrence_STATUS.
| Value | Description |
|---|---|
| “Day” | |
| “Hour” | |
| “Minute” | |
| “Month” | |
| “None” | |
| “Second” | |
| “Week” | |
| “Year” |
RecurrentSchedule
The scheduling constraints for when the profile begins.
Used by: Recurrence.
| Property | Description | Type |
|---|---|---|
| days | the collection of days that the profile takes effect on. Possible values are Sunday through Saturday. | string[] Required |
| 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). | int[] Required |
| minutes | A collection of minutes at which the profile takes effect at. | int[] Required |
| 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 | string Required |
RecurrentSchedule_STATUS
The scheduling constraints for when the profile begins.
Used by: Recurrence_STATUS.
| Property | Description | Type |
|---|---|---|
| days | the collection of days that the profile takes effect on. Possible values are Sunday through Saturday. | string[] Required |
| 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). | int[] Required |
| minutes | A collection of minutes at which the profile takes effect at. | int[] Required |
| 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 | string Required |
ScaleAction
The parameters for the scaling action.
Used by: ScaleRule.
| Property | Description | Type |
|---|---|---|
| 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. | string Required |
| direction | the scale direction. Whether the scaling action increases or decreases the number of instances. | ScaleAction_Direction Required |
| type | the type of action that should occur when the scale rule fires. | ScaleAction_Type Required |
| value | the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1. | string Optional |
ScaleAction_STATUS
The parameters for the scaling action.
Used by: ScaleRule_STATUS.
| Property | Description | Type |
|---|---|---|
| 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. | string Required |
| direction | the scale direction. Whether the scaling action increases or decreases the number of instances. | ScaleAction_Direction_STATUS Required |
| type | the type of action that should occur when the scale rule fires. | ScaleAction_Type_STATUS Required |
| value | the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1. | string Optional |
MetricTrigger_Operator
Used by: MetricTrigger.
| Value | Description |
|---|---|
| “Equals” | |
| “GreaterThan” | |
| “GreaterThanOrEqual” | |
| “LessThan” | |
| “LessThanOrEqual” | |
| “NotEquals” |
MetricTrigger_Operator_STATUS
Used by: MetricTrigger_STATUS.
| Value | Description |
|---|---|
| “Equals” | |
| “GreaterThan” | |
| “GreaterThanOrEqual” | |
| “LessThan” | |
| “LessThanOrEqual” | |
| “NotEquals” |
MetricTrigger_Statistic
Used by: MetricTrigger.
| Value | Description |
|---|---|
| “Average” | |
| “Count” | |
| “Max” | |
| “Min” | |
| “Sum” |
MetricTrigger_Statistic_STATUS
Used by: MetricTrigger_STATUS.
| Value | Description |
|---|---|
| “Average” | |
| “Count” | |
| “Max” | |
| “Min” | |
| “Sum” |
MetricTrigger_TimeAggregation
Used by: MetricTrigger.
| Value | Description |
|---|---|
| “Average” | |
| “Count” | |
| “Last” | |
| “Maximum” | |
| “Minimum” | |
| “Total” |
MetricTrigger_TimeAggregation_STATUS
Used by: MetricTrigger_STATUS.
| Value | Description |
|---|---|
| “Average” | |
| “Count” | |
| “Last” | |
| “Maximum” | |
| “Minimum” | |
| “Total” |
ScaleAction_Direction
Used by: ScaleAction.
| Value | Description |
|---|---|
| “Decrease” | |
| “Increase” | |
| “None” |
ScaleAction_Direction_STATUS
Used by: ScaleAction_STATUS.
| Value | Description |
|---|---|
| “Decrease” | |
| “Increase” | |
| “None” |
ScaleAction_Type
Used by: ScaleAction.
| Value | Description |
|---|---|
| “ChangeCount” | |
| “ExactCount” | |
| “PercentChangeCount” | |
| “ServiceAllowedNextValue” |
ScaleAction_Type_STATUS
Used by: ScaleAction_STATUS.
| Value | Description |
|---|---|
| “ChangeCount” | |
| “ExactCount” | |
| “PercentChangeCount” | |
| “ServiceAllowedNextValue” |
ScaleRuleMetricDimension
Specifies an auto scale rule metric dimension.
Used by: MetricTrigger.
| Property | Description | Type |
|---|---|---|
| DimensionName | Name of the dimension. | string Required |
| 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 | ScaleRuleMetricDimension_Operator Required |
| Values | list of dimension values. For example: [“App1”,“App2”]. | string[] Required |
ScaleRuleMetricDimension_STATUS
Specifies an auto scale rule metric dimension.
Used by: MetricTrigger_STATUS.
| Property | Description | Type |
|---|---|---|
| DimensionName | Name of the dimension. | string Required |
| 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 | ScaleRuleMetricDimension_Operator_STATUS Required |
| Values | list of dimension values. For example: [“App1”,“App2”]. | string[] Required |
ScaleRuleMetricDimension_Operator
Used by: ScaleRuleMetricDimension.
| Value | Description |
|---|---|
| “Equals” | |
| “NotEquals” |
ScaleRuleMetricDimension_Operator_STATUS
Used by: ScaleRuleMetricDimension_STATUS.
| Value | Description |
|---|---|
| “Equals” | |
| “NotEquals” |