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

minor doc fixes

This commit is contained in:
Brian Coca 2016-04-25 09:43:12 -04:00 committed by Matt Clay
parent e85368cb3e
commit 0ba37906df
7 changed files with 7 additions and 66 deletions

View file

@ -198,13 +198,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
changed:
description: Whether or not the object was changed.
returned: always
type: bool
sample: True
state: state:
description: Facts about the current state of the object. description: The current state of the network interface.
returned: always returned: always
type: dict type: dict
sample: { sample: {

View file

@ -22,14 +22,10 @@
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: azure_rm_resourcegroup module: azure_rm_resourcegroup
version_added: "2.1" version_added: "2.1"
short_description: Manage Azure resource groups. short_description: Manage Azure resource groups.
description: description:
- Create, update and delete a resource group. - Create, update and delete a resource group.
options: options:
force: force:
description: description:
@ -47,7 +43,6 @@ options:
description: description:
- Name of the resource group. - Name of the resource group.
required: true required: true
default: null
state: state:
description: description:
- Assert the state of the resource group. Use 'present' to create or update and - Assert the state of the resource group. Use 'present' to create or update and
@ -95,17 +90,12 @@ EXAMPLES = '''
state: absent state: absent
''' '''
RETURN = ''' RETURN = '''
changed:
description: Whether or not the object was changed.
returned: always
type: bool
sample: True
contains_resources: contains_resources:
description: Whether or not the resource group contains associated resources. description: Whether or not the resource group contains associated resources.
type: bool type: bool
sample: True sample: True
state: state:
description: Facts about the current state of the object. description: Current state of the resource group.
returned: always returned: always
type: dict type: dict
sample: { sample: {
@ -143,7 +133,7 @@ def resource_group_to_dict(rg):
class AzureRMResourceGroup(AzureRMModuleBase): class AzureRMResourceGroup(AzureRMModuleBase):
def __init__(self): def __init__(self):
self.module_arg_spec = dict( self.module_arg_spec = dict(
name=dict(type='str', required=True), name=dict(type='str', required=True),

View file

@ -22,11 +22,8 @@
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: azure_rm_securitygroup module: azure_rm_securitygroup
version_added: "2.1" version_added: "2.1"
short_description: Manage Azure network security groups. short_description: Manage Azure network security groups.
description: description:
- Create, update or delete a network security group. A security group contains Access Control List (ACL) rules - Create, update or delete a network security group. A security group contains Access Control List (ACL) rules
that allow or deny network traffic to subnets or individual network interfaces. A security group is created that allow or deny network traffic to subnets or individual network interfaces. A security group is created
@ -195,13 +192,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
changed:
description: Whether or not the object was changed.
returned: always
type: bool
sample: True
state: state:
description: Facts about the current state of the object. description: Current state of the security group.
returned: always returned: always
type: dict type: dict
sample: { sample: {

View file

@ -23,14 +23,10 @@
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: azure_rm_storageaccount module: azure_rm_storageaccount
version_added: "2.1" version_added: "2.1"
short_description: Manage Azure storage accounts. short_description: Manage Azure storage accounts.
description: description:
- Create, update or delete a storage account. - Create, update or delete a storage account.
options: options:
resource_group: resource_group:
description: description:
@ -119,13 +115,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
changed:
description: Whether or not the object was changed.
returned: always
type: bool
sample: True
state: state:
description: Facts about the current state of the object. description: Current state of the storage account.
returned: always returned: always
type: dict type: dict
sample: { sample: {

View file

@ -22,15 +22,11 @@
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: azure_rm_storageblob module: azure_rm_storageblob
short_description: Manage blob containers and blob objects. short_description: Manage blob containers and blob objects.
version_added: "2.1" version_added: "2.1"
description: description:
- Create, update and delete blob containers and blob objects. Use to upload a file and store it as a blob object, - Create, update and delete blob containers and blob objects. Use to upload a file and store it as a blob object,
or download a blob object to a file. or download a blob object to a file.
options: options:
storage_account_name: storage_account_name:
description: description:
@ -180,11 +176,6 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
changed:
description: Whether or not the object was changed.
returned: always
type: bool
sample: True
actions: actions:
description: List of descriptive actions taken by the module. description: List of descriptive actions taken by the module.
returned: always returned: always

View file

@ -22,16 +22,12 @@
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: azure_rm_subnet module: azure_rm_subnet
version_added: "2.1" version_added: "2.1"
short_description: Manage Azure subnets. short_description: Manage Azure subnets.
description: description:
- Create, update or delete a subnet within a given virtual network. Allows setting and updating the address - Create, update or delete a subnet within a given virtual network. Allows setting and updating the address
prefix CIDR, which must be valid within the context of the virtual network. Use the azure_rm_networkinterface prefix CIDR, which must be valid within the context of the virtual network. Use the azure_rm_networkinterface
module to associate interfaces with the subnet and assign specific IP addresses. module to associate interfaces with the subnet and assign specific IP addresses.
options: options:
resource_group: resource_group:
description: description:
@ -97,13 +93,8 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
changed:
description: Whether or not the object was changed.
returned: always
type: bool
sample: True
state: state:
description: Facts about the current state of the object. description: Current state of the subnet.
returned: always returned: always
type: dict type: dict
sample: { sample: {

View file

@ -23,15 +23,11 @@
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: azure_rm_virtualnetwork module: azure_rm_virtualnetwork
version_added: "2.1" version_added: "2.1"
short_description: Manage Azure virtual networks. short_description: Manage Azure virtual networks.
description: description:
- Create, update or delete a virtual networks. Allows setting and updating the available IPv4 address ranges - Create, update or delete a virtual networks. Allows setting and updating the available IPv4 address ranges
and setting custom DNS servers. Use the azure_rm_subnet module to associate subnets with a virtual network. and setting custom DNS servers. Use the azure_rm_subnet module to associate subnets with a virtual network.
options: options:
resource_group: resource_group:
description: description:
@ -125,13 +121,8 @@ EXAMPLES = '''
state: absent state: absent
''' '''
RETURN = ''' RETURN = '''
changed:
description: Whether or not the object was changed.
returned: always
type: bool
sample: True
state: state:
description: Facts about the current state of the object. description: Current state of the virtual network.
returned: always returned: always
type: dict type: dict
sample: { sample: {