Update azure_rm_postgresqldatabase related document (#57458)
This commit is contained in:
parent
433e00c219
commit
7cf0d82108
2 changed files with 15 additions and 18 deletions
|
@ -17,7 +17,7 @@ DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: azure_rm_postgresqldatabase
|
module: azure_rm_postgresqldatabase
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
short_description: Manage PostgreSQL Database instance.
|
short_description: Manage PostgreSQL Database instance
|
||||||
description:
|
description:
|
||||||
- Create, update and delete instance of PostgreSQL Database.
|
- Create, update and delete instance of PostgreSQL Database.
|
||||||
|
|
||||||
|
@ -37,21 +37,17 @@ options:
|
||||||
charset:
|
charset:
|
||||||
description:
|
description:
|
||||||
- The charset of the database. Check PostgreSQL documentation for possible values.
|
- The charset of the database. Check PostgreSQL documentation for possible values.
|
||||||
- This is only set on creation, use I(force_update) to recreate a database if the
|
- This is only set on creation, use I(force_update) to recreate a database if the values don't match.
|
||||||
values don't match.
|
|
||||||
collation:
|
collation:
|
||||||
description:
|
description:
|
||||||
- The collation of the database. Check PostgreSQL documentation for possible values.
|
- The collation of the database. Check PostgreSQL documentation for possible values.
|
||||||
- This is only set on creation, use I(force_update) to recreate a database if the
|
- This is only set on creation, use I(force_update) to recreate a database if the values don't match.
|
||||||
values don't match.
|
|
||||||
force_update:
|
force_update:
|
||||||
description:
|
description:
|
||||||
- When set to C(true), will delete and recreate the existing PostgreSQL database if any
|
- When set to C(true), will delete and recreate the existing PostgreSQL database if any of the properties don't match what is set.
|
||||||
of the properties don't match what is set.
|
- When set to C(false), no change will occur to the database even if any of the properties do not match.
|
||||||
- When set to C(false), no change will occur to the database even if any
|
type: bool
|
||||||
of the properties do not match.
|
default: 'no'
|
||||||
type: bool
|
|
||||||
default: 'no'
|
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Assert the state of the PostgreSQL database. Use C(present) to create or update a database and C(absent) to delete it.
|
- Assert the state of the PostgreSQL database. Use C(present) to create or update a database and C(absent) to delete it.
|
||||||
|
@ -64,7 +60,7 @@ extends_documentation_fragment:
|
||||||
- azure
|
- azure
|
||||||
|
|
||||||
author:
|
author:
|
||||||
- "Zim Kalinowski (@zikalino)"
|
- Zim Kalinowski (@zikalino)
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
@ -79,7 +75,7 @@ EXAMPLES = '''
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
id:
|
id:
|
||||||
description:
|
description:
|
||||||
- Resource ID
|
- Resource ID.
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroups/providers/Microsoft.DBforPostgreSQL/servers/testserve
|
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroups/providers/Microsoft.DBforPostgreSQL/servers/testserve
|
||||||
|
|
|
@ -17,7 +17,7 @@ DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: azure_rm_postgresqldatabase_facts
|
module: azure_rm_postgresqldatabase_facts
|
||||||
version_added: "2.7"
|
version_added: "2.7"
|
||||||
short_description: Get Azure PostgreSQL Database facts.
|
short_description: Get Azure PostgreSQL Database facts
|
||||||
description:
|
description:
|
||||||
- Get facts of PostgreSQL Database.
|
- Get facts of PostgreSQL Database.
|
||||||
|
|
||||||
|
@ -38,7 +38,7 @@ extends_documentation_fragment:
|
||||||
- azure
|
- azure
|
||||||
|
|
||||||
author:
|
author:
|
||||||
- "Zim Kalinowski (@zikalino)"
|
- Zim Kalinowski (@zikalino)
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
@ -57,13 +57,14 @@ EXAMPLES = '''
|
||||||
|
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
databases:
|
databases:
|
||||||
description: A list of dict results where the key is the name of the PostgreSQL Database and the values are the facts for that PostgreSQL Database.
|
description:
|
||||||
|
- A list of dict results where the key is the name of the PostgreSQL Database and the values are the facts for that PostgreSQL Database.
|
||||||
returned: always
|
returned: always
|
||||||
type: complex
|
type: complex
|
||||||
contains:
|
contains:
|
||||||
id:
|
id:
|
||||||
description:
|
description:
|
||||||
- Resource ID
|
- Resource ID.
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/testser
|
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/testser
|
||||||
|
|
Loading…
Reference in a new issue