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
242
243
244
245
246
247
248
249
250
|
#!/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_deployment_info
version_added: "0.1.2"
short_description: Get Azure Deployment facts
description:
- Get facts of Azure Deployment.
options:
resource_group:
description:
- The name of the resource group.
required: True
type: str
name:
description:
- The name of the deployment.
type: str
extends_documentation_fragment:
- azure.azcollection.azure
author:
- Zim Kalinowski (@zikalino)
'''
EXAMPLES = '''
- name: Get instance of Deployment
azure_rm_deployment_info:
resource_group: myResourceGroup
name: myDeployment
'''
RETURN = '''
deployments:
description:
- A list of dictionaries containing facts for deployments.
returned: always
type: complex
contains:
id:
description:
- The identifier of the resource.
returned: always
type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/myDeployment"
resource_group:
description:
- Resource group name.
returned: always
sample: myResourceGroup
type: str
name:
description:
- Deployment name.
returned: always
type: str
sample: myDeployment
provisioning_state:
description:
- Provisioning state of the deployment.
returned: always
type: str
sample: Succeeded
template_link:
description:
- Link to the template.
returned: always
type: str
sample: "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/d01a5c06f4f1bc03a049ca17bbbd6e06d62657b3/101-vm-simple-linux/
azuredeploy.json"
parameters:
description:
- Dictionary containing deployment parameters.
returned: always
type: dict
outputs:
description:
- Dictionary containing deployment outputs.
returned: always
type: dict
output_resources:
description:
- List of resources.
returned: always
type: complex
contains:
id:
description:
- Resource id.
returned: always
type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkI
nterfaces/myNetworkInterface"
name:
description:
- Resource name.
returned: always
type: str
sample: myNetworkInterface
type:
description:
- Resource type.
returned: always
type: str
sample: Microsoft.Network/networkInterfaces
depends_on:
description:
- List of resource ids.
type: list
returned: always
sample:
- "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGropup/providers/Microsoft.Network/virtualNet
works/myVirtualNetwork"
'''
from ansible_collections.azure.azcollection.plugins.module_utils.azure_rm_common import AzureRMModuleBase
try:
from azure.core.exceptions import ResourceNotFoundError
except ImportError:
# This is handled in azure_rm_common
pass
class AzureRMDeploymentInfo(AzureRMModuleBase):
def __init__(self):
self.module_arg_spec = dict(
resource_group=dict(
type='str',
required=True
),
name=dict(
type='str'
)
)
self.results = dict(
changed=False
)
self.resource_group = None
self.name = None
super(AzureRMDeploymentInfo, self).__init__(self.module_arg_spec, supports_check_mode=True, supports_tags=False)
def exec_module(self, **kwargs):
is_old_facts = self.module._name == 'azure_rm_deployment_facts'
if is_old_facts:
self.module.deprecate("The 'azure_rm_deployment_facts' module has been renamed to 'azure_rm_deployment_info'", version=(2.9, ))
for key in self.module_arg_spec:
setattr(self, key, kwargs[key])
if self.name:
self.results['deployments'] = self.get()
else:
self.results['deployments'] = self.list()
return self.results
def get(self):
response = None
results = []
try:
response = self.rm_client.deployments.get(self.resource_group, deployment_name=self.name)
self.log("Response : {0}".format(response))
except ResourceNotFoundError as e:
self.log('Could not get facts for Deployment.')
if response:
results.append(self.format_response(response))
return results
def list(self):
response = None
results = []
try:
response = self.rm_client.deployments.list_by_resource_group(self.resource_group)
self.log("Response : {0}".format(response))
except Exception as e:
self.log('Could not get facts for Deployment.')
if response is not None:
for item in response:
results.append(self.format_response(item))
return results
def format_response(self, item):
d = item.as_dict()
output_resources = {}
for dependency in d.get('properties', {}).get('dependencies'):
# go through dependent resources
depends_on = []
for depends_on_resource in dependency['depends_on']:
depends_on.append(depends_on_resource['id'])
# append if not in list
if not output_resources.get(depends_on_resource['id']):
sub_resource = {
'id': depends_on_resource['id'],
'name': depends_on_resource['resource_name'],
'type': depends_on_resource['resource_type'],
'depends_on': []
}
output_resources[depends_on_resource['id']] = sub_resource
resource = {
'id': dependency['id'],
'name': dependency['resource_name'],
'type': dependency['resource_type'],
'depends_on': depends_on
}
output_resources[dependency['id']] = resource
# convert dictionary to list
output_resources_list = []
for r in output_resources:
output_resources_list.append(output_resources[r])
d = {
'id': d.get('id'),
'resource_group': self.resource_group,
'name': d.get('name'),
'provisioning_state': d.get('properties', {}).get('provisioning_state'),
'parameters': d.get('properties', {}).get('parameters'),
'outputs': d.get('properties', {}).get('outputs'),
'output_resources': output_resources_list,
'template_link': d.get('properties', {}).get('template_link', {}).get('uri'),
'correlation_id': d.get('properties', {}).get('correlation_id')
}
return d
def main():
AzureRMDeploymentInfo()
if __name__ == '__main__':
main()
|
