summaryrefslogtreecommitdiff
path: root/lib/ansible/plugins/doc_fragments/azure_tags.py
blob: ea4268c8ca3f837d893737284413554e35d72642 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# -*- coding: utf-8 -*-

# Copyright: (c) 2016, Matt Davis, <mdavis@ansible.com>
# Copyright: (c) 2016, Chris Houseknecht, <house@redhat.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)


class ModuleDocFragment(object):

    # Azure doc fragment
    DOCUMENTATION = r'''
options:
    tags:
        description:
            - Dictionary of string:string pairs to assign as metadata to the object.
            - Metadata tags on the object will be updated with any provided values.
            - To remove tags set append_tags option to false.
        type: dict
    append_tags:
        description:
            - Use to control if tags field is canonical or just appends to existing tags.
            - When canonical, any tags not found in the tags parameter will be removed from the object's metadata.
        type: bool
        default: yes
    '''