ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-27 23:21:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

update azure_rm_autoscale document (#56388)

Browse source
This commit is contained in:
Fred-sun 2019-05-14 17:10:59 +08:00 • committed by Yunge Zhu
commit 49ecfdbc10
2 changed files with 111 additions and 89 deletions
Download patch file Download diff file Expand all files Collapse all files

68
lib/ansible/modules/cloud/azure/azure_rm_autoscale.py
View file

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_autoscale module: azure_rm_autoscale
version_added: "2.7" version_added: "2.7"
short_description: Manage Azure autoscale setting. short_description: Manage Azure autoscale setting
description: description:
- Create, delete an autoscale setting. - Create, delete an autoscale setting.
options: options:
@ -28,10 +28,12 @@ options:
- It also could be a dict contains the C(name), C(subscription_id), C(namespace), C(types), C(resource_group) of the resource. - It also could be a dict contains the C(name), C(subscription_id), C(namespace), C(types), C(resource_group) of the resource.
resource_group: resource_group:
required: true required: true
description: resource group of the resource. description:
- Resource group of the resource.
enabled: enabled:
type: bool type: bool
description: Specifies whether automatic scaling is enabled for the resource. description:
- Specifies whether automatic scaling is enabled for the resource.
default: true default: true
profiles: profiles:
description: description:
@ -40,21 +42,25 @@ options:
suboptions: suboptions:
name: name:
required: true required: true
description: the name of the profile. description:
- The name of the profile.
count: count:
required: true required: true
description: description:
- The number of instances that will be set if metrics are not available for evaluation. - 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. - The default is only used if the current instance count is lower than the default.
min_count: min_count:
description: the minimum number of instances for the resource. description:
- The minimum number of instances for the resource.
max_count: max_count:
description: the maximum number of instances for the resource. description:
- 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.
recurrence_frequency: recurrence_frequency:
default: None default: None
description: description:
- How often the schedule profile should take effect. - How often the schedule profile should take effect.
- If this value is Week, meaning each week will have the same set of profiles. - If this value is C(Week), meaning each week will have the same set of profiles.
- This element is not used if the FixedDate element is used. - This element is not used if the FixedDate element is used.
choices: choices:
- None - None
@ -100,7 +106,8 @@ options:
suboptions: suboptions:
time_aggregation: time_aggregation:
default: Average default: Average
description: How the data that is collected should be combined over time. description:
- How the data that is collected should be combined over time.
choices: choices:
- Average - Average
- Minimum - Minimum
@ -114,22 +121,26 @@ options:
- This value must be greater than the delay in metric collection, which can vary from resource-to-resource. - This value must be greater than the delay in metric collection, which can vary from resource-to-resource.
- Must be between 5 ~ 720. - Must be between 5 ~ 720.
direction: direction:
description: Whether the scaling action increases or decreases the number of instances. description:
- Whether the scaling action increases or decreases the number of instances.
choices: choices:
- Increase - Increase
- Decrease - Decrease
metric_name: metric_name:
required: true required: true
description: The name of the metric that defines what the rule monitors. description:
- The name of the metric that defines what the rule monitors.
metric_resource_uri: metric_resource_uri:
description: The resource identifier of the resource the rule monitors. description:
- The resource identifier of the resource the rule monitors.
value: value:
description: description:
- The number of instances that are involved in the scaling action. - The number of instances that are involved in the scaling action.
- This value must be 1 or greater. - This value must be 1 or greater.
operator: operator:
default: GreaterThan default: GreaterThan
description: The operator that is used to compare the metric data and the threshold. description:
- The operator that is used to compare the metric data and the threshold.
choices: choices:
- Equals - Equals
- NotEquals - NotEquals
@ -149,7 +160,8 @@ options:
- Must be between 1 ~ 720. - Must be between 1 ~ 720.
statistic: statistic:
default: Average default: Average
description: How the metrics from multiple instances are combined. description:
- How the metrics from multiple instances are combined.
choices: choices:
- Average - Average
- Min - Min
@ -157,37 +169,47 @@ options:
- Sum - Sum
threshold: threshold:
default: 70 default: 70
description: The threshold of the metric that triggers the scale action. description:
- The threshold of the metric that triggers the scale action.
type: type:
description: The type of action that should occur when the scale rule fires. description:
- The type of action that should occur when the scale rule fires.
choices: choices:
- PercentChangeCount - PercentChangeCount
- ExactCount - ExactCount
- ChangeCount - ChangeCount
notifications: notifications:
description: the collection of notifications. description:
- The collection of notifications.
suboptions: suboptions:
custom_emails: custom_emails:
description: the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored. description:
- The custom e-mails list. This value can be null or empty, in which case this attribute will be ignored.
send_to_subscription_administrator: send_to_subscription_administrator:
type: bool type: bool
description: A value indicating whether to send email to subscription administrator. description:
- A value indicating whether to send email to subscription administrator.
webhooks: webhooks:
description: The list of webhook notifications service uri. description:
- The list of webhook notifications service uri.
send_to_subscription_co_administrators: send_to_subscription_co_administrators:
type: bool type: bool
description: A value indicating whether to send email to subscription co-administrators. description:
- A value indicating whether to send email to subscription co-administrators.
state: state:
default: present default: present
description: Assert the state of the virtual network. Use C(present) to create or update and C(absent) to delete. description:
- Assert the state of the virtual network. Use C(present) to create or update and C(absent) to delete.
choices: choices:
- present - present
- absent - absent
location: location:
description: location of the resource. description:
- location of the resource.
name: name:
required: true required: true
description: name of the resource. description:
- name of the resource.
extends_documentation_fragment: extends_documentation_fragment:

2
lib/ansible/modules/cloud/azure/azure_rm_autoscale_facts.py
View file

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_autoscale_facts module: azure_rm_autoscale_facts
version_added: "2.7" version_added: "2.7"
short_description: Get Azure Auto Scale Setting facts. short_description: Get Azure Auto Scale Setting facts
description: description:
- Get facts of Auto Scale Setting. - Get facts of Auto Scale Setting.