Update azure_rm_roleassignment related document (#57820)

* Update azure_rm_roleassignment related document

* add new
pull/57884/head
Fred-sun 6 years ago committed by Sandra McCann
parent 49983fdaf7
commit 23eb465956

@ -17,7 +17,7 @@ DOCUMENTATION = '''
---
module: azure_rm_roleassignment
version_added: "2.8"
short_description: Manage Azure Role Assignment.
short_description: Manage Azure Role Assignment
description:
- Create and delete instance of Azure Role Assignment.
@ -37,23 +37,23 @@ options:
scope:
description:
- The scope of the role assignment to create.
- For example, use /subscriptions/{subscription-id}/ for subscription,
- /subscriptions/{subscription-id}/resourceGroups/{resource-group-name} for resource group,
- For example, use /subscriptions/{subscription-id}/ for subscription.
- /subscriptions/{subscription-id}/resourceGroups/{resource-group-name} for resource group.
- /subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name} for resource.
state:
description:
- Assert the state of the role assignment.
- Use 'present' to create or update a role assignment and 'absent' to delete it.
default: present
choices:
- absent
- present
description:
- Assert the state of the role assignment.
- Use C(present) to create or update a role assignment and C(absent) to delete it.
default: present
choices:
- absent
- present
extends_documentation_fragment:
- azure
author:
- "Yunge Zhu(@yungezz)"
- Yunge Zhu(@yungezz)
'''
@ -75,11 +75,11 @@ EXAMPLES = '''
RETURN = '''
id:
description: Id of current role assignment.
description:
- Id of current role assignment.
returned: always
type: str
sample:
"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleAssignments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleAssignments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
'''
import uuid

@ -17,7 +17,7 @@ DOCUMENTATION = '''
---
module: azure_rm_roleassignment_facts
version_added: "2.8"
short_description: Gets Azure Role Assignment facts.
short_description: Gets Azure Role Assignment facts
description:
- Gets facts of Azure Role Assignment.
@ -25,9 +25,9 @@ options:
scope:
description:
- The scope that the role assignment applies to.
- For example, use /subscriptions/{subscription-id}/ for a subscription,
- /subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name} for a resource group,
- /subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name}/providers/{resource-provider}/{resource-type}/{resource-name} for a resource
- For example, use /subscriptions/{subscription-id}/ for a subscription.
- /subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name} for a resource group.
- /subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name}/providers/{resource-provider}/{resource-type}/{resource-name} for a resource.
name:
description:
- Name of role assignment.
@ -44,7 +44,7 @@ extends_documentation_fragment:
- azure
author:
- "Yunge Zhu(@yungezz)"
- Yunge Zhu(@yungezz)
'''
@ -60,7 +60,8 @@ EXAMPLES = '''
RETURN = '''
roleassignments:
description: List of role assignments.
description:
- List of role assignments.
returned: always
type: complex
contains:
@ -96,7 +97,7 @@ roleassignments:
sample: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
scope:
description:
- The role assignment scope
- The role assignment scope.
type: str
returned: always
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Loading…
Cancel
Save