Update azure_rm_roledefinition related document (#57927)

* Update azure_rm_roledefinition related documentation
pull/58076/head
Fred-sun 7 years ago committed by Alicia Cozine
parent f656959861
commit 8cff96e388

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_roledefinition module: azure_rm_roledefinition
version_added: "2.8" version_added: "2.8"
short_description: Manage Azure Role Definition. short_description: Manage Azure Role Definition
description: description:
- Create, update and delete instance of Azure Role Definition. - Create, update and delete instance of Azure Role Definition.
@ -48,16 +48,18 @@ options:
- List of denied data actions. - List of denied data actions.
type: list type: list
assignable_scopes: assignable_scopes:
description: List of assignable scope of this definition. description:
- List of assignable scopes of this definition.
scope: scope:
description: The scope of the role definition. description:
- The scope of the role definition.
description: description:
description: description:
- The role definition description. - The role definition description.
state: state:
description: description:
- Assert the state of the role definition. - Assert the state of the role definition.
- Use 'present' to create or update a role definition and 'absent' to delete it. - Use C(present) to create or update a role definition; use C(absent) to delete it.
default: present default: present
choices: choices:
- absent - absent
@ -67,7 +69,7 @@ extends_documentation_fragment:
- azure - azure
author: author:
- "Yunge Zhu(@yungezz)" - Yunge Zhu(@yungezz)
''' '''
@ -87,7 +89,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
id: id:
description: Id of current role definition. description:
- ID of current role definition.
returned: always returned: always
type: str type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId" sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId"

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_roledefinition_facts module: azure_rm_roledefinition_facts
version_added: "2.8" version_added: "2.8"
short_description: Get Azure Role Definition facts. short_description: Get Azure Role Definition facts
description: description:
- Get facts of Azure Role Definition. - Get facts of Azure Role Definition.
@ -30,9 +30,11 @@ options:
description: description:
- Role definition id. - Role definition id.
role_name: role_name:
description: Role name. description:
- Role name.
type: type:
description: Type of role. description:
- Type of role.
choices: choices:
- system - system
- custom - custom
@ -41,7 +43,7 @@ extends_documentation_fragment:
- azure - azure
author: author:
- "Yunge Zhu(@yungezz)" - Yunge Zhu(@yungezz)
''' '''
@ -58,34 +60,38 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
roledefinitions: roledefinitions:
description: A list of Role Definition facts. description:
- A list of Role Definition facts.
returned: always returned: always
type: complex type: complex
contains: contains:
id: id:
description: Role Definition id. description:
- Role Definition ID.
returned: always returned: always
type: str type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
role_name: role_name:
description: Role name. description:
- Role name.
returned: always returned: always
type: str type: str
sample: myCustomRoleDefinition sample: myCustomRoleDefinition
name: name:
description: System assigned role name. description:
- System assigned role name.
returned: always returned: always
type: str type: str
sample: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx sample: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
assignable_scopes: assignable_scopes:
description: description:
- List of assignable scope of this definition. - List of assignable scopes of this definition.
returned: always returned: always
type: list type: list
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup" sample: [ "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup" ]
permissions: permissions:
description: description:
- List of Role Definition peremissions. - List of Role Definition permissions.
returned: always returned: always
contains: contains:
actions: actions:
@ -93,25 +99,25 @@ roledefinitions:
- List of allowed actions. - List of allowed actions.
returned: always returned: always
type: list type: list
sample: Microsoft.Compute/virtualMachines/read sample: [ 'Microsoft.Compute/virtualMachines/read' ]
not_actions: not_actions:
description: description:
- List of denied actions. - List of denied actions.
returned: always returned: always
type: list type: list
sample: Microsoft.Compute/virtualMachines/write sample: [ 'Microsoft.Compute/virtualMachines/write' ]
data_actions: data_actions:
description: description:
- List of allowed data actions. - List of allowed data actions.
returned: always returned: always
type: list type: list
sample: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read sample: [ 'Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read' ]
not_data_actions: not_data_actions:
description: description:
- List of denied actions. - List of denied data actions.
returned: always returned: always
type: list type: list
sample: Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write sample: [ 'Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write' ]
''' '''
from ansible.module_utils.azure_rm_common import AzureRMModuleBase from ansible.module_utils.azure_rm_common import AzureRMModuleBase

Loading…
Cancel
Save