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
|
# --------------------------------------------------------------------------
#
# Copyright (c) Microsoft Corporation. All rights reserved.
#
# The MIT License (MIT)
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the ""Software""), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
#
# --------------------------------------------------------------------------
from typing import Mapping, MutableMapping, Optional, Type, Union, cast, Dict, Any
import re
import logging
from azure.core import AzureClouds
_LOGGER = logging.getLogger(__name__)
_ARMID_RE = re.compile(
"(?i)/subscriptions/(?P<subscription>[^/]+)(/resourceGroups/(?P<resource_group>[^/]+))?"
+ "(/providers/(?P<namespace>[^/]+)/(?P<type>[^/]*)/(?P<name>[^/]+)(?P<children>.*))?"
)
_CHILDREN_RE = re.compile(
"(?i)(/providers/(?P<child_namespace>[^/]+))?/" + "(?P<child_type>[^/]*)/(?P<child_name>[^/]+)"
)
_ARMNAME_RE = re.compile("^[^<>%&:\\?/]{1,260}$")
__all__ = [
"parse_resource_id",
"resource_id",
"is_valid_resource_id",
"is_valid_resource_name",
"get_arm_endpoints",
]
def parse_resource_id(rid: str) -> Mapping[str, Union[str, int]]:
"""Parses a resource_id into its various parts.
Returns a dictionary with a single key-value pair, 'name': rid, if invalid resource id.
:param rid: The resource id being parsed
:type rid: str
:returns: A dictionary with with following key/value pairs (if found):
- subscription: Subscription id
- resource_group: Name of resource group
- namespace: Namespace for the resource provider (i.e. Microsoft.Compute)
- type: Type of the root resource (i.e. virtualMachines)
- name: Name of the root resource
- child_namespace_{level}: Namespace for the child resource of that level
- child_type_{level}: Type of the child resource of that level
- child_name_{level}: Name of the child resource of that level
- last_child_num: Level of the last child
- resource_parent: Computed parent in the following pattern: providers/{namespace}\
/{parent}/{type}/{name}
- resource_namespace: Same as namespace. Note that this may be different than the \
target resource's namespace.
- resource_type: Type of the target resource (not the parent)
- resource_name: Name of the target resource (not the parent)
:rtype: dict[str,str]
"""
if not rid:
return {}
match = _ARMID_RE.match(rid)
if match:
result: MutableMapping[str, Union[None, str, int]] = match.groupdict()
children = _CHILDREN_RE.finditer(cast(Optional[str], result["children"]) or "")
count = None
for count, child in enumerate(children):
result.update({key + "_%d" % (count + 1): group for key, group in child.groupdict().items()})
result["last_child_num"] = count + 1 if isinstance(count, int) else None
final_result = _populate_alternate_kwargs(result)
else:
final_result = result = {"name": rid}
return {key: value for key, value in final_result.items() if value is not None}
def _populate_alternate_kwargs(
kwargs: MutableMapping[str, Union[None, str, int]]
) -> Mapping[str, Union[None, str, int]]:
"""Translates the parsed arguments into a format used by generic ARM commands
such as the resource and lock commands.
:param any kwargs: The parsed arguments
:return: The translated arguments
:rtype: any
"""
resource_namespace = kwargs["namespace"]
resource_type = kwargs.get("child_type_{}".format(kwargs["last_child_num"])) or kwargs["type"]
resource_name = kwargs.get("child_name_{}".format(kwargs["last_child_num"])) or kwargs["name"]
_get_parents_from_parts(kwargs)
kwargs["resource_namespace"] = resource_namespace
kwargs["resource_type"] = resource_type
kwargs["resource_name"] = resource_name
return kwargs
def _get_parents_from_parts(kwargs: MutableMapping[str, Union[None, str, int]]) -> Mapping[str, Union[None, str, int]]:
"""Get the parents given all the children parameters.
:param any kwargs: The children parameters
:return: The parents
:rtype: any
"""
parent_builder = []
if kwargs["last_child_num"] is not None:
parent_builder.append("{type}/{name}/".format(**kwargs))
for index in range(1, cast(int, kwargs["last_child_num"])):
child_namespace = kwargs.get("child_namespace_{}".format(index))
if child_namespace is not None:
parent_builder.append("providers/{}/".format(child_namespace))
kwargs["child_parent_{}".format(index)] = "".join(parent_builder)
parent_builder.append("{{child_type_{0}}}/{{child_name_{0}}}/".format(index).format(**kwargs))
child_namespace = kwargs.get("child_namespace_{}".format(kwargs["last_child_num"]))
if child_namespace is not None:
parent_builder.append("providers/{}/".format(child_namespace))
kwargs["child_parent_{}".format(kwargs["last_child_num"])] = "".join(parent_builder)
kwargs["resource_parent"] = "".join(parent_builder) if kwargs["name"] else None
return kwargs
def resource_id(**kwargs: Optional[str]) -> str: # pylint: disable=docstring-keyword-should-match-keyword-only
"""Create a valid resource id string from the given parts.
This method builds the resource id from the left until the next required id parameter
to be appended is not found. It then returns the built up id.
:keyword str subscription: (required) Subscription id
:keyword str resource_group: Name of resource group
:keyword str namespace: Namespace for the resource provider (i.e. Microsoft.Compute)
:keyword str type: Type of the resource (i.e. virtualMachines)
:keyword str name: Name of the resource (or parent if child_name is also specified)
:keyword str child_namespace_{level}: Namespace for the child resource of that level (optional)
:keyword str child_type_{level}: Type of the child resource of that level
:keyword str child_name_{level}: Name of the child resource of that level
:returns: A resource id built from the given arguments.
:rtype: str
"""
kwargs = {k: v for k, v in kwargs.items() if v is not None}
rid_builder = ["/subscriptions/{subscription}".format(**kwargs)]
try:
try:
rid_builder.append("resourceGroups/{resource_group}".format(**kwargs))
except KeyError:
pass
rid_builder.append("providers/{namespace}".format(**kwargs))
rid_builder.append("{type}/{name}".format(**kwargs))
count = 1
while True:
try:
rid_builder.append("providers/{{child_namespace_{}}}".format(count).format(**kwargs))
except KeyError:
pass
rid_builder.append("{{child_type_{0}}}/{{child_name_{0}}}".format(count).format(**kwargs))
count += 1
except KeyError:
pass
return "/".join(rid_builder)
def is_valid_resource_id(rid: str, exception_type: Optional[Type[BaseException]] = None) -> bool:
"""Validates the given resource id.
:param rid: The resource id being validated.
:type rid: str
:param exception_type: Raises this Exception if invalid.
:type exception_type: Exception
:returns: A boolean describing whether the id is valid.
:rtype: bool
"""
is_valid: bool = False
try:
# Ideally, we would make a TypedDict here, but keeping this file simple for now.
is_valid = rid and resource_id(**parse_resource_id(rid)).lower() == rid.lower() # type: ignore
except KeyError:
pass
if not is_valid and exception_type:
raise exception_type()
return is_valid
def is_valid_resource_name(rname: str, exception_type: Optional[Type[BaseException]] = None) -> bool:
"""Validates the given resource name to ARM guidelines, individual services may be more restrictive.
:param rname: The resource name being validated.
:type rname: str
:param exception_type: Raises this Exception if invalid.
:type exception_type: Exception
:returns: A boolean describing whether the name is valid.
:rtype: bool
"""
match = _ARMNAME_RE.match(rname)
if match:
return True
if exception_type:
raise exception_type()
return False
def get_arm_endpoints(cloud_setting: AzureClouds) -> Dict[str, Any]:
"""Get the ARM endpoint and ARM credential scopes for the given cloud setting.
:param cloud_setting: The cloud setting for which to get the ARM endpoint.
:type cloud_setting: AzureClouds
:return: The ARM endpoint and ARM credential scopes.
:rtype: dict[str, Any]
"""
if cloud_setting == AzureClouds.AZURE_CHINA_CLOUD:
return {
"resource_manager": "https://management.chinacloudapi.cn/",
"credential_scopes": ["https://management.chinacloudapi.cn/.default"],
}
if cloud_setting == AzureClouds.AZURE_US_GOVERNMENT:
return {
"resource_manager": "https://management.usgovcloudapi.net/",
"credential_scopes": ["https://management.core.usgovcloudapi.net/.default"],
}
if cloud_setting == AzureClouds.AZURE_PUBLIC_CLOUD:
return {
"resource_manager": "https://management.azure.com/",
"credential_scopes": ["https://management.azure.com/.default"],
}
raise ValueError("Unknown cloud setting: {}".format(cloud_setting))
|
