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
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Copyright (c) 2020 Jose Angel Munoz, <josea.munoz@gmail.com>
#
#
# 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_privatednszone
version_added: "0.0.1"
short_description: Manage Azure private DNS zones
description:
- Creates and deletes Azure private DNS zones.
options:
resource_group:
description:
- Name of resource group.
type: str
required: true
name:
description:
- Name of the private DNS zone.
type: str
required: true
state:
description:
- Assert the state of the zone. Use C(present) to create or update and C(absent) to delete.
default: present
type: str
choices:
- absent
- present
extends_documentation_fragment:
- azure.azcollection.azure
- azure.azcollection.azure_tags
author:
- Jose Angel Munoz (@imjoseangel)
'''
EXAMPLES = '''
- name: Create a private DNS zone
azure_rm_privatednszone:
resource_group: myResourceGroup
name: example.com
- name: Delete a private DNS zone
azure_rm_privatednszone:
resource_group: myResourceGroup
name: example.com
state: absent
'''
RETURN = '''
state:
description:
- Current state of the zone.
returned: always
type: dict
sample: {
"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup",
"location": "global",
"name": "Testing",
"number_of_record_sets": 2,
"number_of_virtual_network_links": 0,
"number_of_virtual_network_links_with_registration": 0
}
'''
from ansible_collections.azure.azcollection.plugins.module_utils.azure_rm_common import AzureRMModuleBase
try:
from azure.core.exceptions import ResourceNotFoundError
from azure.core.polling import LROPoller
except ImportError:
# This is handled in azure_rm_common
pass
class AzureRMPrivateDNSZone(AzureRMModuleBase):
def __init__(self):
# define user inputs from playbook
self.module_arg_spec = dict(resource_group=dict(type='str',
required=True),
name=dict(type='str', required=True),
state=dict(choices=['present', 'absent'],
default='present',
type='str'))
# store the results of the module operation
self.results = dict(changed=False, state=dict())
self.resource_group = None
self.name = None
self.state = None
self.tags = None
super(AzureRMPrivateDNSZone, self).__init__(self.module_arg_spec,
supports_check_mode=True,
supports_tags=True)
def exec_module(self, **kwargs):
# create a new zone variable in case the 'try' doesn't find a zone
zone = None
for key in list(self.module_arg_spec.keys()) + ['tags']:
setattr(self, key, kwargs[key])
self.results['check_mode'] = self.check_mode
# retrieve resource group to make sure it exists
self.get_resource_group(self.resource_group)
changed = False
results = dict()
try:
self.log('Fetching private DNS zone {0}'.format(self.name))
zone = self.private_dns_client.private_zones.get(
self.resource_group, self.name)
# serialize object into a dictionary
results = zone_to_dict(zone)
# don't change anything if creating an existing zone, but change if deleting it
if self.state == 'present':
changed = False
update_tags, results['tags'] = self.update_tags(
results['tags'])
if update_tags:
changed = True
elif self.state == 'absent':
changed = True
except ResourceNotFoundError:
# the zone does not exist so create it
if self.state == 'present':
changed = True
else:
# you can't delete what is not there
changed = False
self.results['changed'] = changed
self.results['state'] = results
# return the results if your only gathering information
if self.check_mode:
return self.results
if changed:
if self.state == 'present':
zone = self.private_dns_models.PrivateZone(tags=self.tags,
location='global')
self.results['state'] = self.create_or_update_zone(zone)
elif self.state == 'absent':
# delete zone
self.delete_zone()
# the delete does not actually return anything. if no exception, then we'll assume
# it worked.
self.results['state']['status'] = 'Deleted'
return self.results
def create_or_update_zone(self, zone):
try:
# create or update the new Zone object we created
new_zone = self.private_dns_client.private_zones.begin_create_or_update(
self.resource_group, self.name, zone)
if isinstance(new_zone, LROPoller):
new_zone = self.get_poller_result(new_zone)
except Exception as exc:
self.fail("Error creating or updating zone {0} - {1}".format(
self.name, exc.message or str(exc)))
return zone_to_dict(new_zone)
def delete_zone(self):
try:
# delete the Zone
poller = self.private_dns_client.private_zones.begin_delete(
self.resource_group, self.name)
result = self.get_poller_result(poller)
except Exception as exc:
self.fail("Error deleting zone {0} - {1}".format(
self.name, exc.message or str(exc)))
return result
def zone_to_dict(zone):
# turn Zone object into a dictionary (serialization)
result = dict(
id=zone.id,
name=zone.name,
number_of_record_sets=zone.number_of_record_sets,
number_of_virtual_network_links=zone.number_of_virtual_network_links,
number_of_virtual_network_links_with_registration=zone.
number_of_virtual_network_links_with_registration,
tags=zone.tags)
return result
def main():
AzureRMPrivateDNSZone()
if __name__ == '__main__':
main()
|
