mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Update azure_rm_postgresqlserver relate document (#57600)
This commit is contained in:
parent
f709d2e2bb
commit
74c21d40f9
2 changed files with 28 additions and 20 deletions
|
@ -17,7 +17,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: azure_rm_postgresqlserver
|
||||
version_added: "2.5"
|
||||
short_description: Manage PostgreSQL Server instance.
|
||||
short_description: Manage PostgreSQL Server instance
|
||||
description:
|
||||
- Create, update and delete instance of PostgreSQL Server.
|
||||
|
||||
|
@ -36,14 +36,16 @@ options:
|
|||
suboptions:
|
||||
name:
|
||||
description:
|
||||
- The name of the sku, typically, a letter + Number code, e.g. P3.
|
||||
- The name of the SKU, typically, tier + family + cores, for example C(B_Gen4_1), C(GP_Gen5_8).
|
||||
tier:
|
||||
description:
|
||||
- The tier of the particular SKU, e.g. Basic.
|
||||
choices: ['basic', 'standard']
|
||||
- The tier of the particular SKU, for example C(Basic).
|
||||
choices:
|
||||
- Basic
|
||||
- Standard
|
||||
capacity:
|
||||
description:
|
||||
- "The scale up/out capacity, representing server's compute units."
|
||||
- The scale up/out capacity, representing server's compute units.
|
||||
size:
|
||||
description:
|
||||
- The size code, to be interpreted by resource as appropriate.
|
||||
|
@ -53,10 +55,14 @@ options:
|
|||
storage_mb:
|
||||
description:
|
||||
- The maximum storage allowed for a server.
|
||||
type: int
|
||||
version:
|
||||
description:
|
||||
- Server version.
|
||||
choices: ['9.5', '9.6', '10']
|
||||
choices:
|
||||
- '9.5'
|
||||
- '9.6'
|
||||
- '10'
|
||||
enforce_ssl:
|
||||
description:
|
||||
- Enable SSL enforcement.
|
||||
|
@ -64,13 +70,13 @@ options:
|
|||
default: False
|
||||
admin_username:
|
||||
description:
|
||||
- "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation)."
|
||||
- The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
|
||||
admin_password:
|
||||
description:
|
||||
- The password of the administrator login.
|
||||
create_mode:
|
||||
description:
|
||||
- Create mode of SQL Server
|
||||
- Create mode of SQL Server.
|
||||
default: Default
|
||||
state:
|
||||
description:
|
||||
|
@ -85,7 +91,7 @@ extends_documentation_fragment:
|
|||
- azure_tags
|
||||
|
||||
author:
|
||||
- "Zim Kalinowski (@zikalino)"
|
||||
- Zim Kalinowski (@zikalino)
|
||||
|
||||
'''
|
||||
|
||||
|
@ -107,19 +113,19 @@ EXAMPLES = '''
|
|||
RETURN = '''
|
||||
id:
|
||||
description:
|
||||
- Resource ID
|
||||
- Resource ID.
|
||||
returned: always
|
||||
type: str
|
||||
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/mysqlsrv1b6dd89593
|
||||
version:
|
||||
description:
|
||||
- 'Server version. Possible values include: C(9.5), C(9.6), C(10)'
|
||||
- Server version. Possible values include C(9.5), C(9.6), C(10).
|
||||
returned: always
|
||||
type: str
|
||||
sample: 9.6
|
||||
state:
|
||||
description:
|
||||
- 'A state of a server that is visible to user. Possible values include: C(Ready), C(Dropping), C(Disabled)'
|
||||
- A state of a server that is visible to user. Possible values include C(Ready), C(Dropping), C(Disabled).
|
||||
returned: always
|
||||
type: str
|
||||
sample: Ready
|
||||
|
|
|
@ -17,7 +17,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: azure_rm_postgresqlserver_facts
|
||||
version_added: "2.7"
|
||||
short_description: Get Azure PostgreSQL Server facts.
|
||||
short_description: Get Azure PostgreSQL Server facts
|
||||
description:
|
||||
- Get facts of PostgreSQL Server.
|
||||
|
||||
|
@ -37,7 +37,7 @@ extends_documentation_fragment:
|
|||
- azure
|
||||
|
||||
author:
|
||||
- "Zim Kalinowski (@zikalino)"
|
||||
- Zim Kalinowski (@zikalino)
|
||||
|
||||
'''
|
||||
|
||||
|
@ -54,13 +54,14 @@ EXAMPLES = '''
|
|||
|
||||
RETURN = '''
|
||||
servers:
|
||||
description: A list of dictionaries containing facts for PostgreSQL servers.
|
||||
description:
|
||||
- A list of dictionaries containing facts for PostgreSQL servers.
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
id:
|
||||
description:
|
||||
- Resource ID
|
||||
- Resource ID.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/po
|
||||
|
@ -91,13 +92,13 @@ servers:
|
|||
contains:
|
||||
name:
|
||||
description:
|
||||
- The name of the SKU
|
||||
- The name of the SKU.
|
||||
returned: always
|
||||
type: str
|
||||
sample: GP_Gen4_2
|
||||
tier:
|
||||
description:
|
||||
- The tier of the particular SKU
|
||||
- The tier of the particular SKU.
|
||||
returned: always
|
||||
type: str
|
||||
sample: GeneralPurpose
|
||||
|
@ -121,7 +122,7 @@ servers:
|
|||
sample: False
|
||||
admin_username:
|
||||
description:
|
||||
- "The administrator's login name of a server."
|
||||
- The administrator's login name of a server.
|
||||
returned: always
|
||||
type: str
|
||||
sample: serveradmin
|
||||
|
@ -144,7 +145,8 @@ servers:
|
|||
type: str
|
||||
sample: postgreabdud1223.postgres.database.azure.com
|
||||
tags:
|
||||
description: Tags assigned to the resource. Dictionary of string:string pairs.
|
||||
description:
|
||||
- Tags assigned to the resource. Dictionary of string:string pairs.
|
||||
type: dict
|
||||
sample: { tag1: abc }
|
||||
'''
|
||||
|
|
Loading…
Reference in a new issue