Update azure_rm_mysqlserver related document (#57382)

This commit is contained in:
Fred-sun 2019-06-05 09:10:12 -04:00 committed by Sandra McCann
parent 9b6a295ca5
commit 206f18dcca
2 changed files with 27 additions and 20 deletions

View file

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_mysqlserver module: azure_rm_mysqlserver
version_added: "2.5" version_added: "2.5"
short_description: Manage MySQL Server instance. short_description: Manage MySQL Server instance
description: description:
- Create, update and delete instance of MySQL Server. - Create, update and delete instance of MySQL Server.
@ -36,14 +36,16 @@ 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.
size: size:
description: description:
- The size code, to be interpreted by resource as appropriate. - The size code, to be interpreted by resource as appropriate.
@ -53,10 +55,13 @@ 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: ['5.6', '5.7'] choices:
- 5.6
- 5.7
enforce_ssl: enforce_ssl:
description: description:
- Enable SSL enforcement. - Enable SSL enforcement.
@ -64,13 +69,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:
@ -85,7 +90,7 @@ extends_documentation_fragment:
- azure_tags - azure_tags
author: author:
- "Zim Kalinowski (@zikalino)" - Zim Kalinowski (@zikalino)
''' '''
@ -108,19 +113,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.DBforMySQL/servers/mysqlsrv1b6dd89593 sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMySQL/servers/mysqlsrv1b6dd89593
version: version:
description: description:
- 'Server version. Possible values include: C(5.6), C(5.7)' - Server version. Possible values include C(5.6), C(5.7).
returned: always returned: always
type: str type: str
sample: 5.6 sample: 5.6
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

View file

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_mysqlserver_facts module: azure_rm_mysqlserver_facts
version_added: "2.7" version_added: "2.7"
short_description: Get Azure MySQL Server facts. short_description: Get Azure MySQL Server facts
description: description:
- Get facts of MySQL Server. - Get facts of MySQL Server.
@ -37,7 +37,7 @@ extends_documentation_fragment:
- azure - azure
author: author:
- "Zim Kalinowski (@zikalino)" - Zim Kalinowski (@zikalino)
''' '''
@ -54,13 +54,14 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
servers: servers:
description: A list of dictionaries containing facts for MySQL servers. description:
- A list of dictionaries containing facts for MySQL 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.DBforMySQL/servers/myabdud1223 sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMySQL/servers/myabdud1223
@ -90,13 +91,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
@ -120,7 +121,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
@ -143,7 +144,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 }
''' '''