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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
#!/usr/bin/python
#
# Copyright (c) 2019 Zim Kalinowski, (@zikalino)
#
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
module: azure_rm_devtestlabpolicy_info
version_added: "0.1.2"
short_description: Get Azure DTL Policy facts
description:
- Get facts of Azure DTL Policy.
options:
resource_group:
description:
- The name of the resource group.
required: True
type: str
lab_name:
description:
- The name of the lab.
required: True
type: str
policy_set_name:
description:
- The name of the policy set.
required: True
type: str
name:
description:
- The name of the policy.
type: str
tags:
description:
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
type: list
elements: str
extends_documentation_fragment:
- azure.azcollection.azure
author:
- Zim Kalinowski (@zikalino)
'''
EXAMPLES = '''
- name: Get instance of Policy
azure_rm_devtestlabpolicy_info:
resource_group: myResourceGroup
lab_name: myLab
policy_set_name: myPolicySet
name: myPolicy
tags:
- key:value
'''
RETURN = '''
policies:
description:
- A list of dictionaries containing facts for Policy.
returned: always
type: complex
contains:
id:
description:
- The identifier of the artifact source.
returned: always
type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DevTestLab/labs/myLab/po
licysets/myPolicySet/policies/myPolicy"
resource_group:
description:
- Name of the resource group.
returned: always
type: str
sample: myResourceGroup
lab_name:
description:
- Name of the lab.
returned: always
type: str
sample: myLab
name:
description:
- The name of the artifact source.
returned: always
type: str
sample: myArtifactSource
fact_name:
description:
- The name of the policy fact.
returned: always
type: str
sample: UserOwnedLabVmCount
evaluator_type:
description:
- Evaluator type for policy fact.
returned: always
type: str
sample: MaxValuePolicy
threshold:
description:
- Fact's threshold.
returned: always
type: str
sample: 5
tags:
description:
- The tags of the resource.
returned: always
type: dict
sample: "{ 'MyTag': 'MyValue' }"
'''
from ansible_collections.azure.azcollection.plugins.module_utils.azure_rm_common import AzureRMModuleBase
try:
from azure.core.exceptions import ResourceNotFoundError
from azure.mgmt.devtestlabs import DevTestLabsClient
except ImportError:
# This is handled in azure_rm_common
pass
class AzureRMDtlPolicyInfo(AzureRMModuleBase):
def __init__(self):
# define user inputs into argument
self.module_arg_spec = dict(
resource_group=dict(
type='str',
required=True
),
lab_name=dict(
type='str',
required=True
),
policy_set_name=dict(
type='str',
required=True
),
name=dict(
type='str'
),
tags=dict(
type='list',
elements='str'
)
)
# store the results of the module operation
self.results = dict(
changed=False
)
self.mgmt_client = None
self.resource_group = None
self.lab_name = None
self.policy_set_name = None
self.name = None
self.tags = None
super(AzureRMDtlPolicyInfo, self).__init__(self.module_arg_spec, supports_check_mode=True, supports_tags=False, facts_module=True)
def exec_module(self, **kwargs):
is_old_facts = self.module._name == 'azure_rm_devtestlabpolicy_facts'
if is_old_facts:
self.module.deprecate("The 'azure_rm_devtestlabpolicy_facts' module has been renamed to 'azure_rm_devtestlabpolicy_info'", version=(2.9, ))
for key in self.module_arg_spec:
setattr(self, key, kwargs[key])
self.mgmt_client = self.get_mgmt_svc_client(DevTestLabsClient,
base_url=self._cloud_environment.endpoints.resource_manager)
if self.name:
self.results['policies'] = self.get()
else:
self.results['policies'] = self.list()
return self.results
def get(self):
response = None
results = []
try:
response = self.mgmt_client.policies.get(resource_group_name=self.resource_group,
lab_name=self.lab_name,
policy_set_name=self.policy_set_name,
name=self.name)
self.log("Response : {0}".format(response))
except ResourceNotFoundError as e:
self.log('Could not get facts for Policy.')
if response and self.has_tags(response.tags, self.tags):
results.append(self.format_response(response))
return results
def list(self):
response = None
results = []
try:
response = self.mgmt_client.policies.list(resource_group_name=self.resource_group,
lab_name=self.lab_name,
policy_set_name=self.policy_set_name)
self.log("Response : {0}".format(response))
except Exception as e:
self.log('Could not get facts for Policy.')
if response is not None:
for item in response:
if self.has_tags(item.tags, self.tags):
results.append(self.format_response(item))
return results
def format_response(self, item):
d = item.as_dict()
d = {
'resource_group': self.resource_group,
'policy_set_name': self.policy_set_name,
'name': d.get('name'),
'id': d.get('id'),
'tags': d.get('tags'),
'status': d.get('status'),
'threshold': d.get('threshold'),
'fact_name': d.get('fact_name'),
'evaluator_type': d.get('evaluator_type')
}
return d
def main():
AzureRMDtlPolicyInfo()
if __name__ == '__main__':
main()
|
