From 60c1155d50f348121a0e961ca86f690d7c5f4605 Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Tue, 26 Apr 2016 12:34:35 -0400 Subject: [PATCH] added common azure tags fragment --- .../utils/module_docs_fragments/azure_tags.py | 38 +++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 lib/ansible/utils/module_docs_fragments/azure_tags.py diff --git a/lib/ansible/utils/module_docs_fragments/azure_tags.py b/lib/ansible/utils/module_docs_fragments/azure_tags.py new file mode 100644 index 0000000000..ea8ba15f13 --- /dev/null +++ b/lib/ansible/utils/module_docs_fragments/azure_tags.py @@ -0,0 +1,38 @@ +#!/usr/bin/python +# +# Copyright (c) 2016 Matt Davis, +# Chris Houseknecht, +# +# This file is part of Ansible +# +# Ansible is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see . +# + + +class ModuleDocFragment(object): + + # Azure doc fragment + DOCUMENTATION = ''' +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." + required: false + default: null + append_tags: + description: + - Use to control if tags field is cannonical or just appends to existing tags. When cannonical, any tags not found in the tags parameter will be removed from the object's metadata. + default: True + required: false + '''