clean up doc - removed required: false (#46357)
This commit is contained in:
parent
25a192034f
commit
2a4bf670bb
7 changed files with 6 additions and 42 deletions
|
@ -110,11 +110,9 @@ options:
|
||||||
client_id:
|
client_id:
|
||||||
description:
|
description:
|
||||||
- The ID for the Service Principal.
|
- The ID for the Service Principal.
|
||||||
required: false
|
|
||||||
client_secret:
|
client_secret:
|
||||||
description:
|
description:
|
||||||
- The secret password associated with the service principal.
|
- The secret password associated with the service principal.
|
||||||
required: false
|
|
||||||
diagnostics_profile:
|
diagnostics_profile:
|
||||||
description:
|
description:
|
||||||
- Should VM Diagnostics be enabled for the Container Service VM's.
|
- Should VM Diagnostics be enabled for the Container Service VM's.
|
||||||
|
@ -469,13 +467,11 @@ class AzureRMContainerService(AzureRMModuleBase):
|
||||||
),
|
),
|
||||||
state=dict(
|
state=dict(
|
||||||
type='str',
|
type='str',
|
||||||
required=False,
|
|
||||||
default='present',
|
default='present',
|
||||||
choices=['present', 'absent']
|
choices=['present', 'absent']
|
||||||
),
|
),
|
||||||
location=dict(
|
location=dict(
|
||||||
type='str',
|
type='str'
|
||||||
required=False
|
|
||||||
),
|
),
|
||||||
orchestration_platform=dict(
|
orchestration_platform=dict(
|
||||||
type='str',
|
type='str',
|
||||||
|
@ -495,8 +491,7 @@ class AzureRMContainerService(AzureRMModuleBase):
|
||||||
required=True
|
required=True
|
||||||
),
|
),
|
||||||
service_principal=dict(
|
service_principal=dict(
|
||||||
type='list',
|
type='list'
|
||||||
required=False
|
|
||||||
),
|
),
|
||||||
diagnostics_profile=dict(
|
diagnostics_profile=dict(
|
||||||
type='bool',
|
type='bool',
|
||||||
|
|
|
@ -303,7 +303,6 @@ options:
|
||||||
choices:
|
choices:
|
||||||
- absent
|
- absent
|
||||||
- present
|
- present
|
||||||
required: false
|
|
||||||
|
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- azure
|
- azure
|
||||||
|
|
|
@ -41,21 +41,17 @@ options:
|
||||||
choices:
|
choices:
|
||||||
- absent
|
- absent
|
||||||
- present
|
- present
|
||||||
required: false
|
|
||||||
location:
|
location:
|
||||||
description:
|
description:
|
||||||
- Valid azure location. Defaults to location of the resource group.
|
- Valid azure location. Defaults to location of the resource group.
|
||||||
required: false
|
|
||||||
platform_update_domain_count:
|
platform_update_domain_count:
|
||||||
description:
|
description:
|
||||||
- Update domains indicate groups of virtual machines and underlying physical hardware that can be rebooted at the same time. Default is 5.
|
- Update domains indicate groups of virtual machines and underlying physical hardware that can be rebooted at the same time. Default is 5.
|
||||||
default: 5
|
default: 5
|
||||||
required: false
|
|
||||||
platform_fault_domain_count:
|
platform_fault_domain_count:
|
||||||
description:
|
description:
|
||||||
- Fault domains define the group of virtual machines that share a common power source and network switch. Should be between 1 and 3. Default is 3
|
- Fault domains define the group of virtual machines that share a common power source and network switch. Should be between 1 and 3. Default is 3
|
||||||
default: 3
|
default: 3
|
||||||
required: false
|
|
||||||
sku:
|
sku:
|
||||||
description:
|
description:
|
||||||
- Define if the availability set supports managed disks.
|
- Define if the availability set supports managed disks.
|
||||||
|
@ -63,7 +59,6 @@ options:
|
||||||
choices:
|
choices:
|
||||||
- Classic
|
- Classic
|
||||||
- Aligned
|
- Aligned
|
||||||
required: false
|
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- azure
|
- azure
|
||||||
- azure_tags
|
- azure_tags
|
||||||
|
@ -147,28 +142,23 @@ class AzureRMAvailabilitySet(AzureRMModuleBase):
|
||||||
),
|
),
|
||||||
state=dict(
|
state=dict(
|
||||||
type='str',
|
type='str',
|
||||||
required=False,
|
|
||||||
default='present',
|
default='present',
|
||||||
choices=['present', 'absent']
|
choices=['present', 'absent']
|
||||||
),
|
),
|
||||||
location=dict(
|
location=dict(
|
||||||
type='str',
|
type='str'
|
||||||
required=False
|
|
||||||
),
|
),
|
||||||
platform_update_domain_count=dict(
|
platform_update_domain_count=dict(
|
||||||
type='int',
|
type='int',
|
||||||
default=5,
|
default=5
|
||||||
required=False
|
|
||||||
),
|
),
|
||||||
platform_fault_domain_count=dict(
|
platform_fault_domain_count=dict(
|
||||||
type='int',
|
type='int',
|
||||||
default=3,
|
default=3
|
||||||
required=False
|
|
||||||
),
|
),
|
||||||
sku=dict(
|
sku=dict(
|
||||||
type='str',
|
type='str',
|
||||||
default='Classic',
|
default='Classic',
|
||||||
required=False,
|
|
||||||
choices=['Classic', 'Aligned']
|
choices=['Classic', 'Aligned']
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
|
@ -48,7 +48,6 @@ options:
|
||||||
description:
|
description:
|
||||||
- Assert the state of the Function App. Use 'present' to create or update a Function App and
|
- Assert the state of the Function App. Use 'present' to create or update a Function App and
|
||||||
'absent' to delete.
|
'absent' to delete.
|
||||||
required: false
|
|
||||||
default: present
|
default: present
|
||||||
choices:
|
choices:
|
||||||
- absent
|
- absent
|
||||||
|
@ -143,10 +142,9 @@ class AzureRMFunctionApp(AzureRMModuleBase):
|
||||||
resource_group=dict(type='str', required=True, aliases=['resource_group_name']),
|
resource_group=dict(type='str', required=True, aliases=['resource_group_name']),
|
||||||
name=dict(type='str', required=True),
|
name=dict(type='str', required=True),
|
||||||
state=dict(type='str', default='present', choices=['present', 'absent']),
|
state=dict(type='str', default='present', choices=['present', 'absent']),
|
||||||
location=dict(type='str', required=False),
|
location=dict(type='str'),
|
||||||
storage_account=dict(
|
storage_account=dict(
|
||||||
type='str',
|
type='str',
|
||||||
required=False,
|
|
||||||
aliases=['storage', 'storage_account_name']
|
aliases=['storage', 'storage_account_name']
|
||||||
),
|
),
|
||||||
app_settings=dict(type='dict')
|
app_settings=dict(type='dict')
|
||||||
|
|
|
@ -41,7 +41,6 @@ options:
|
||||||
description:
|
description:
|
||||||
- Assert the state of the key. Use 'present' to create a key and
|
- Assert the state of the key. Use 'present' to create a key and
|
||||||
'absent' to delete a key.
|
'absent' to delete a key.
|
||||||
required: false
|
|
||||||
default: present
|
default: present
|
||||||
choices:
|
choices:
|
||||||
- absent
|
- absent
|
||||||
|
|
|
@ -31,12 +31,10 @@ options:
|
||||||
secret_value:
|
secret_value:
|
||||||
description:
|
description:
|
||||||
- Secret to be secured by keyvault.
|
- Secret to be secured by keyvault.
|
||||||
required: false
|
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Assert the state of the subnet. Use 'present' to create or update a secret and
|
- Assert the state of the subnet. Use 'present' to create or update a secret and
|
||||||
'absent' to delete a secret .
|
'absent' to delete a secret .
|
||||||
required: false
|
|
||||||
default: present
|
default: present
|
||||||
choices:
|
choices:
|
||||||
- absent
|
- absent
|
||||||
|
|
|
@ -212,17 +212,14 @@ options:
|
||||||
- public_ip_address
|
- public_ip_address
|
||||||
- public_ip_name
|
- public_ip_name
|
||||||
- public_ip
|
- public_ip
|
||||||
required: false
|
|
||||||
probe_port:
|
probe_port:
|
||||||
description:
|
description:
|
||||||
- (deprecated) The port that the health probe will use.
|
- (deprecated) The port that the health probe will use.
|
||||||
- This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.
|
- This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.
|
||||||
required: false
|
|
||||||
probe_protocol:
|
probe_protocol:
|
||||||
description:
|
description:
|
||||||
- (deprecated) The protocol to use for the health probe.
|
- (deprecated) The protocol to use for the health probe.
|
||||||
- This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.
|
- This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.
|
||||||
required: false
|
|
||||||
choices:
|
choices:
|
||||||
- Tcp
|
- Tcp
|
||||||
- Http
|
- Http
|
||||||
|
@ -231,23 +228,19 @@ options:
|
||||||
- (deprecated) Time (in seconds) between endpoint health probes.
|
- (deprecated) Time (in seconds) between endpoint health probes.
|
||||||
- This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.
|
- This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.
|
||||||
default: 15
|
default: 15
|
||||||
required: false
|
|
||||||
probe_fail_count:
|
probe_fail_count:
|
||||||
description:
|
description:
|
||||||
- (deprecated) The amount of probe failures for the load balancer to make a health determination.
|
- (deprecated) The amount of probe failures for the load balancer to make a health determination.
|
||||||
- This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.
|
- This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.
|
||||||
default: 3
|
default: 3
|
||||||
required: false
|
|
||||||
probe_request_path:
|
probe_request_path:
|
||||||
description:
|
description:
|
||||||
- (deprecated) The URL that an HTTP probe will use (only relevant if probe_protocol is set to Http).
|
- (deprecated) The URL that an HTTP probe will use (only relevant if probe_protocol is set to Http).
|
||||||
- This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.
|
- This option has been deprecated, and will be removed in 2.9. Use I(probes) instead.
|
||||||
required: false
|
|
||||||
protocol:
|
protocol:
|
||||||
description:
|
description:
|
||||||
- (deprecated) The protocol (TCP or UDP) that the load balancer will use.
|
- (deprecated) The protocol (TCP or UDP) that the load balancer will use.
|
||||||
- This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.
|
- This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.
|
||||||
required: false
|
|
||||||
choices:
|
choices:
|
||||||
- Tcp
|
- Tcp
|
||||||
- Udp
|
- Udp
|
||||||
|
@ -255,7 +248,6 @@ options:
|
||||||
description:
|
description:
|
||||||
- (deprecated) The type of load distribution that the load balancer will employ.
|
- (deprecated) The type of load distribution that the load balancer will employ.
|
||||||
- This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.
|
- This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.
|
||||||
required: false
|
|
||||||
choices:
|
choices:
|
||||||
- Default
|
- Default
|
||||||
- SourceIP
|
- SourceIP
|
||||||
|
@ -264,38 +256,31 @@ options:
|
||||||
description:
|
description:
|
||||||
- (deprecated) Frontend port that will be exposed for the load balancer.
|
- (deprecated) Frontend port that will be exposed for the load balancer.
|
||||||
- This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.
|
- This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.
|
||||||
required: false
|
|
||||||
backend_port:
|
backend_port:
|
||||||
description:
|
description:
|
||||||
- (deprecated) Backend port that will be exposed for the load balancer.
|
- (deprecated) Backend port that will be exposed for the load balancer.
|
||||||
- This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.
|
- This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.
|
||||||
required: false
|
|
||||||
idle_timeout:
|
idle_timeout:
|
||||||
description:
|
description:
|
||||||
- (deprecated) Timeout for TCP idle connection in minutes.
|
- (deprecated) Timeout for TCP idle connection in minutes.
|
||||||
- This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.
|
- This option has been deprecated, and will be removed in 2.9. Use I(load_balancing_rules) instead.
|
||||||
default: 4
|
default: 4
|
||||||
required: false
|
|
||||||
natpool_frontend_port_start:
|
natpool_frontend_port_start:
|
||||||
description:
|
description:
|
||||||
- (deprecated) Start of the port range for a NAT pool.
|
- (deprecated) Start of the port range for a NAT pool.
|
||||||
- This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead.
|
- This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead.
|
||||||
required: false
|
|
||||||
natpool_frontend_port_end:
|
natpool_frontend_port_end:
|
||||||
description:
|
description:
|
||||||
- (deprecated) End of the port range for a NAT pool.
|
- (deprecated) End of the port range for a NAT pool.
|
||||||
- This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead.
|
- This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead.
|
||||||
required: false
|
|
||||||
natpool_backend_port:
|
natpool_backend_port:
|
||||||
description:
|
description:
|
||||||
- (deprecated) Backend port used by the NAT pool.
|
- (deprecated) Backend port used by the NAT pool.
|
||||||
- This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead.
|
- This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead.
|
||||||
required: false
|
|
||||||
natpool_protocol:
|
natpool_protocol:
|
||||||
description:
|
description:
|
||||||
- (deprecated) The protocol for the NAT pool.
|
- (deprecated) The protocol for the NAT pool.
|
||||||
- This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead.
|
- This option has been deprecated, and will be removed in 2.9. Use I(inbound_nat_pools) instead.
|
||||||
required: false
|
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- azure
|
- azure
|
||||||
- azure_tags
|
- azure_tags
|
||||||
|
|
Loading…
Reference in a new issue