Update azure_rm_mariadbserver related document (#57333)
parent
695cd7f1da
commit
1ddb37cdc2
|
@ -18,7 +18,7 @@ DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: azure_rm_mariadbserver
|
module: azure_rm_mariadbserver
|
||||||
version_added: "2.8"
|
version_added: "2.8"
|
||||||
short_description: Manage MariaDB Server instance.
|
short_description: Manage MariaDB Server instance
|
||||||
description:
|
description:
|
||||||
- Create, update and delete instance of MariaDB Server.
|
- Create, update and delete instance of MariaDB Server.
|
||||||
|
|
||||||
|
@ -37,14 +37,17 @@ options:
|
||||||
suboptions:
|
suboptions:
|
||||||
name:
|
name:
|
||||||
description:
|
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:
|
tier:
|
||||||
description:
|
description:
|
||||||
- The tier of the particular SKU, e.g. Basic.
|
- The tier of the particular SKU, for example C(Basic).
|
||||||
choices: ['basic', 'standard']
|
choices:
|
||||||
|
- basic
|
||||||
|
- standard
|
||||||
capacity:
|
capacity:
|
||||||
description:
|
description:
|
||||||
- "The scale up/out capacity, representing server's compute units."
|
- The scale up/out capacity, representing server's compute units.
|
||||||
|
type: int
|
||||||
size:
|
size:
|
||||||
description:
|
description:
|
||||||
- The size code, to be interpreted by resource as appropriate.
|
- The size code, to be interpreted by resource as appropriate.
|
||||||
|
@ -54,10 +57,12 @@ options:
|
||||||
storage_mb:
|
storage_mb:
|
||||||
description:
|
description:
|
||||||
- The maximum storage allowed for a server.
|
- The maximum storage allowed for a server.
|
||||||
|
type: int
|
||||||
version:
|
version:
|
||||||
description:
|
description:
|
||||||
- Server version.
|
- Server version.
|
||||||
choices: ['10.2']
|
choices:
|
||||||
|
- 10.2
|
||||||
enforce_ssl:
|
enforce_ssl:
|
||||||
description:
|
description:
|
||||||
- Enable SSL enforcement.
|
- Enable SSL enforcement.
|
||||||
|
@ -65,13 +70,13 @@ options:
|
||||||
default: False
|
default: False
|
||||||
admin_username:
|
admin_username:
|
||||||
description:
|
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:
|
admin_password:
|
||||||
description:
|
description:
|
||||||
- The password of the administrator login.
|
- The password of the administrator login.
|
||||||
create_mode:
|
create_mode:
|
||||||
description:
|
description:
|
||||||
- Create mode of SQL Server
|
- Create mode of SQL Server.
|
||||||
default: Default
|
default: Default
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
|
@ -86,8 +91,8 @@ extends_documentation_fragment:
|
||||||
- azure_tags
|
- azure_tags
|
||||||
|
|
||||||
author:
|
author:
|
||||||
- "Zim Kalinowski (@zikalino)"
|
- Zim Kalinowski (@zikalino)
|
||||||
- "Matti Ranta (@techknowlogick)"
|
- Matti Ranta (@techknowlogick)
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
@ -110,19 +115,19 @@ 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/myResourceGroup/providers/Microsoft.DBforMariaDB/servers/mariadbsrv1b6dd89593
|
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMariaDB/servers/mariadbsrv1b6dd89593
|
||||||
version:
|
version:
|
||||||
description:
|
description:
|
||||||
- 'Server version. Possible values include: C(10.2)'
|
- Server version. Possible values include C(10.2).
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: 10.2
|
sample: 10.2
|
||||||
state:
|
state:
|
||||||
description:
|
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
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: Ready
|
sample: Ready
|
||||||
|
|
|
@ -18,7 +18,7 @@ DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: azure_rm_mariadbserver_facts
|
module: azure_rm_mariadbserver_facts
|
||||||
version_added: "2.8"
|
version_added: "2.8"
|
||||||
short_description: Get Azure MariaDB Server facts.
|
short_description: Get Azure MariaDB Server facts
|
||||||
description:
|
description:
|
||||||
- Get facts of MariaDB Server.
|
- Get facts of MariaDB Server.
|
||||||
|
|
||||||
|
@ -38,8 +38,8 @@ extends_documentation_fragment:
|
||||||
- azure
|
- azure
|
||||||
|
|
||||||
author:
|
author:
|
||||||
- "Zim Kalinowski (@zikalino)"
|
- Zim Kalinowski (@zikalino)
|
||||||
- "Matti Ranta (@techknowlogick)"
|
- Matti Ranta (@techknowlogick)
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
@ -56,13 +56,14 @@ EXAMPLES = '''
|
||||||
|
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
servers:
|
servers:
|
||||||
description: A list of dictionaries containing facts for MariaDB servers.
|
description:
|
||||||
|
- A list of dictionaries containing facts for MariaDB servers.
|
||||||
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.DBforMariaDB/servers/myabdud1223
|
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMariaDB/servers/myabdud1223
|
||||||
|
@ -92,13 +93,13 @@ servers:
|
||||||
contains:
|
contains:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- The name of the SKU
|
- The name of the SKU.
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: GP_Gen4_2
|
sample: GP_Gen4_2
|
||||||
tier:
|
tier:
|
||||||
description:
|
description:
|
||||||
- The tier of the particular SKU
|
- The tier of the particular SKU.
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: GeneralPurpose
|
sample: GeneralPurpose
|
||||||
|
@ -122,7 +123,7 @@ servers:
|
||||||
sample: False
|
sample: False
|
||||||
admin_username:
|
admin_username:
|
||||||
description:
|
description:
|
||||||
- "The administrator's login name of a server."
|
- The administrator's login name of a server.
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: serveradmin
|
sample: serveradmin
|
||||||
|
@ -145,7 +146,8 @@ servers:
|
||||||
type: str
|
type: str
|
||||||
sample: myabdud1223.mys.database.azure.com
|
sample: myabdud1223.mys.database.azure.com
|
||||||
tags:
|
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
|
type: dict
|
||||||
sample: { tag1: abc }
|
sample: { tag1: abc }
|
||||||
'''
|
'''
|
||||||
|
|
Loading…
Reference in New Issue