ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Update azure_rm_cdnendpoint related module document (#56440)

Browse source
This commit is contained in:
Fred-sun 2019-05-17 16:02:40 +08:00 committed by Yunge Zhu
parent dfab364a19
commit 11c63d6c1e
1 changed files with 15 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
lib/ansible/modules/cloud/azure/azure_rm_cdnendpoint.py
View file

@ -15,7 +15,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_cdnendpoint module: azure_rm_cdnendpoint
version_added: "2.8" version_added: "2.8"
short_description: Manage a Azure CDN endpoint. short_description: Manage a Azure CDN endpoint
description: description:
- Create, update, start, stop and delete a Azure CDN endpoint. - Create, update, start, stop and delete a Azure CDN endpoint.
@ -33,16 +33,16 @@ options:
- Valid azure location. Defaults to location of the resource group. - Valid azure location. Defaults to location of the resource group.
started: started:
description: description:
- Use with I(state) C(present) to start the endpoint. Set to C(false) to stop the endpoint. Set to C(true) to start the endpoint. - Use with I(state=present) to start the endpoint.
type: bool type: bool
purge: purge:
description: description:
- Use with I(state) C(present) to purge the endpoint. Set to C(true) to have the endpoint be purged. - Use with I(state=present) to purge the endpoint.
type: bool type: bool
default: false default: false
purge_content_paths: purge_content_paths:
description: description:
- Use with I(state) C(present) and I(purge) C(true) to specify content paths to be purged. - Use with I(state=present) and I(purge=true) to specify content paths to be purged.
type: list type: list
default: ['/'] default: ['/']
profile_name: profile_name:
@ -55,18 +55,21 @@ options:
suboptions: suboptions:
name: name:
description: description:
- Origin name - Origin name.
required: true required: true
host_name: host_name:
description: description:
- The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. - The address of the origin.
- It can be a domain name, IPv4 address, or IPv6 address.
required: true required: true
http_port: http_port:
description: description:
- The value of the HTTP port. Must be between 1 and 65535 - The value of the HTTP port. Must be between C(1) and C(65535).
type: int
https_port: https_port:
description: description:
- The value of the HTTPS port. Must be between 1 and 65535 - The value of the HTTPS port. Must be between C(1) and C(65535).
type: int
required: true required: true
origin_host_header: origin_host_header:
description: description:
@ -75,10 +78,12 @@ options:
origin_path: origin_path:
description: description:
- A directory path on the origin that CDN can use to retrieve content from. - A directory path on the origin that CDN can use to retrieve content from.
- E.g. contoso.cloudapp.net/originpath.
type: str type: str
content_types_to_compress: content_types_to_compress:
description: description:
- List of content types on which compression applies. - List of content types on which compression applies.
- This value should be a valid MIME type.
type: list type: list
is_compression_enabled: is_compression_enabled:
description: description:
@ -97,7 +102,7 @@ options:
default: true default: true
query_string_caching_behavior: query_string_caching_behavior:
description: description:
- Defines how CDN caches requests that include query strings - Defines how CDN caches requests that include query strings.
type: str type: str
choices: choices:
- ignore_query_string - ignore_query_string
@ -143,7 +148,7 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
state: state:
description: Current state of the Azure CDN endpoint description: Current state of the Azure CDN endpoint.
returned: always returned: always
type: str type: str
id: id: