archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

update azure_rm_appgateway document (#56339)

Browse Source 
* update azure_rm_appgateway documentation
pull/56405/head
Fred-sun 5 years ago committed by Alicia Cozine
parent 7f41cc40e6
commit 84f5666aab
1 changed files with 40 additions and 28 deletions
Show Stats Download Patch File Download Diff File

68
lib/ansible/modules/cloud/azure/azure_rm_appgateway.py
Unescape Escape View File

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_appgateway module: azure_rm_appgateway
version_added: "2.7" version_added: "2.7"
short_description: Manage Application Gateway instance. short_description: Manage Application Gateway instance
description: description:
- Create, update and delete instance of Application Gateway. - Create, update and delete instance of Application Gateway.
@ -134,18 +134,18 @@ options:
suboptions: suboptions:
data: data:
description: description:
- Certificate public data - base64 encoded pfx - Certificate public data - base64 encoded pfx.
name: name:
description: description:
- Name of the resource that is unique within a resource group. This name can be used to access the resource. - Name of the resource that is unique within a resource group. This name can be used to access the resource.
redirect_configurations: redirect_configurations:
version_added: "2.8" version_added: "2.8"
description: description:
- Redirect configurations of the application gateway resource - Redirect configurations of the application gateway resource.
suboptions: suboptions:
redirect_type: redirect_type:
description: description:
- Redirection type - Redirection type.
choices: choices:
- 'permanent' - 'permanent'
- 'found' - 'found'
@ -153,16 +153,16 @@ options:
- 'temporary' - 'temporary'
target_listener: target_listener:
description: description:
- Reference to a listener to redirect the request to - Reference to a listener to redirect the request to.
include_path: include_path:
description: description:
- Include path in the redirected url - Include path in the redirected url.
include_query_string: include_query_string:
description: description:
- Include query string in the redirected url - Include query string in the redirected url.
name: name:
description: description:
- Name of the resource that is unique within a resource group - Name of the resource that is unique within a resource group.
ssl_certificates: ssl_certificates:
description: description:
- SSL certificates of the application gateway resource. - SSL certificates of the application gateway resource.
@ -170,9 +170,11 @@ options:
data: data:
description: description:
- Base-64 encoded pfx certificate. - Base-64 encoded pfx certificate.
- Only applicable in PUT Request.
password: password:
description: description:
- Password for the pfx file specified in I(data). - Password for the pfx file specified in I(data).
- Only applicable in PUT request.
name: name:
description: description:
- Name of the resource that is unique within a resource group. This name can be used to access the resource. - Name of the resource that is unique within a resource group. This name can be used to access the resource.
@ -204,7 +206,7 @@ options:
suboptions: suboptions:
port: port:
description: description:
- Frontend port - Frontend port.
name: name:
description: description:
- Name of the resource that is unique within a resource group. This name can be used to access the resource. - Name of the resource that is unique within a resource group. This name can be used to access the resource.
@ -214,14 +216,14 @@ options:
suboptions: suboptions:
backend_addresses: backend_addresses:
description: description:
- List of backend addresses - List of backend addresses.
suboptions: suboptions:
fqdn: fqdn:
description: description:
- Fully qualified domain name (FQDN). - Fully qualified domain name (FQDN).
ip_address: ip_address:
description: description:
- IP address - IP address.
name: name:
description: description:
- Resource that is unique within a resource group. This name can be used to access the resource. - Resource that is unique within a resource group. This name can be used to access the resource.
@ -232,41 +234,49 @@ options:
suboptions: suboptions:
name: name:
description: description:
- Name - Name of the I(probe) that is unique within an Application Gateway.
protocol: protocol:
description: description:
- Protocol - The protocol used for the I(probe).
choices: choices:
- 'http' - 'http'
- 'https' - 'https'
host: host:
description: description:
- Host - Host name to send the I(probe) to.
path: path:
description: description:
- Path - Relative path of I(probe).
- Valid path starts from '/'.
- Probe is sent to <Protocol>://<host>:<port><path>.
timeout: timeout:
description: description:
- Timeout - The probe timeout in seconds.
- Probe marked as failed if valid response is not received with this timeout period.
- Acceptable values are from 1 second to 86400 seconds.
interval: interval:
description: description:
- Interval - The probing interval in seconds.
- This is the time interval between two consecutive probes.
- Acceptable values are from 1 second to 86400 seconds.
unhealthy_threshold: unhealthy_threshold:
description: description:
- Unhealthy Threshold - The I(probe) retry count.
- Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold.
- Acceptable values are from 1 second to 20.
backend_http_settings_collection: backend_http_settings_collection:
description: description:
- Backend http settings of the application gateway resource. - Backend http settings of the application gateway resource.
suboptions: suboptions:
probe: probe:
description: description:
- Probe - Probe resource of an application gateway.
port: port:
description: description:
- Port - The destination port on the backend.
protocol: protocol:
description: description:
- Protocol. - The protocol used to communicate with the backend.
choices: choices:
- 'http' - 'http'
- 'https' - 'https'
@ -278,8 +288,9 @@ options:
- 'disabled' - 'disabled'
request_timeout: request_timeout:
description: description:
- "Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable va - Request timeout in seconds.
lues are from 1 second to 86400 seconds." - Application Gateway will fail the request if response is not received within RequestTimeout.
- Acceptable values are from 1 second to 86400 seconds.
authentication_certificates: authentication_certificates:
description: description:
- List of references to application gateway authentication certificates. - List of references to application gateway authentication certificates.
@ -298,7 +309,8 @@ options:
- Cookie name to use for the affinity cookie. - Cookie name to use for the affinity cookie.
path: path:
description: description:
- Path which should be used as a prefix for all C(http) requests. Null means no path will be prefixed. Default value is null. - Path which should be used as a prefix for all C(http) requests.
- Null means no path will be prefixed. Default value is null.
name: name:
description: description:
- Name of the resource that is unique within a resource group. This name can be used to access the resource. - Name of the resource that is unique within a resource group. This name can be used to access the resource.
@ -314,7 +326,7 @@ options:
- Frontend port resource of an application gateway. - Frontend port resource of an application gateway.
protocol: protocol:
description: description:
- Protocol. - Protocol of the c(http) listener.
choices: choices:
- 'http' - 'http'
- 'https' - 'https'
@ -336,7 +348,7 @@ options:
suboptions: suboptions:
rule_type: rule_type:
description: description:
- Rule I(type). - Rule type.
choices: choices:
- 'basic' - 'basic'
- 'path_based_routing' - 'path_based_routing'
@ -345,7 +357,7 @@ options:
- Backend address pool resource of the application gateway. - Backend address pool resource of the application gateway.
backend_http_settings: backend_http_settings:
description: description:
- Frontend port resource of the application gateway. - Backend C(http) settings resource of the application gateway.
http_listener: http_listener:
description: description:
- Http listener resource of the application gateway. - Http listener resource of the application gateway.
@ -354,7 +366,7 @@ options:
- Name of the resource that is unique within a resource group. This name can be used to access the resource. - Name of the resource that is unique within a resource group. This name can be used to access the resource.
redirect_configuration: redirect_configuration:
description: description:
- Redirect configuration resource of the application gateway - Redirect configuration resource of the application gateway.
state: state:
description: description:
- Assert the state of the Public IP. Use C(present) to create or update a and - Assert the state of the Public IP. Use C(present) to create or update a and

Write Preview
Loading…
Cancel
Save