-
Notifications
You must be signed in to change notification settings - Fork 2.8k
/
custom.py
3887 lines (3140 loc) · 196 KB
/
custom.py
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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
# pylint: disable=too-many-lines
# pylint: disable=line-too-long
from collections import OrderedDict
import codecs
import json
import os
import re
import ssl
import sys
import uuid
import base64
from urllib.request import urlopen
from urllib.parse import urlparse
from msrestazure.tools import is_valid_resource_id, parse_resource_id
from azure.mgmt.resource.resources.models import GenericResource, DeploymentMode
from azure.cli.core.azclierror import ArgumentUsageError, InvalidArgumentValueError, RequiredArgumentMissingError
from azure.cli.core.parser import IncorrectUsageError
from azure.cli.core.util import get_file_json, read_file_content, shell_safe_json_parse, sdk_no_wait
from azure.cli.core.commands import LongRunningOperation
from azure.cli.core.commands.arm import raise_subdivision_deployment_error
from azure.cli.core.commands.client_factory import get_mgmt_service_client, get_subscription_id
from azure.cli.core.profiles import ResourceType, get_sdk, get_api_version, AZURE_API_PROFILES
from azure.cli.command_modules.resource._client_factory import (
_resource_client_factory, _resource_policy_client_factory, _resource_lock_client_factory,
_resource_links_client_factory, _resource_deploymentscripts_client_factory, _authorization_management_client, _resource_managedapps_client_factory, _resource_templatespecs_client_factory, _resource_privatelinks_client_factory)
from azure.cli.command_modules.resource._validators import _parse_lock_id
from azure.core.pipeline.policies import SansIOHTTPPolicy
from knack.log import get_logger
from knack.prompting import prompt, prompt_pass, prompt_t_f, prompt_choice_list, prompt_int, NoTTYException
from knack.util import CLIError
from ._validators import MSI_LOCAL_ID
from ._formatters import format_what_if_operation_result
from ._bicep import (
run_bicep_command,
is_bicep_file,
is_bicepparam_file,
ensure_bicep_installation,
remove_bicep_installation,
get_bicep_latest_release_tag,
get_bicep_available_release_tags,
validate_bicep_target_scope,
bicep_version_greater_than_or_equal_to
)
from ._utils import _build_preflight_error_message, _build_http_response_error_message
logger = get_logger(__name__)
RPAAS_APIS = {'microsoft.datadog': '/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/agreements/default?api-version=2020-02-01-preview',
'microsoft.confluent': '/subscriptions/{subscriptionId}/providers/Microsoft.Confluent/agreements/default?api-version=2020-03-01-preview'}
def _build_resource_id(**kwargs):
from msrestazure.tools import resource_id as resource_id_from_dict
try:
return resource_id_from_dict(**kwargs)
except KeyError:
return None
def _process_parameters(template_param_defs, parameter_lists): # pylint: disable=too-many-statements
def _try_parse_json_object(value):
try:
parsed = _remove_comments_from_json(value, False)
return parsed.get('parameters', parsed)
except Exception: # pylint: disable=broad-except
return None
def _try_load_file_object(file_path):
try:
is_file = os.path.isfile(file_path)
except ValueError:
return None
if is_file is True:
try:
content = read_file_content(file_path)
if not content:
return None
parsed = _remove_comments_from_json(content, False, file_path)
return parsed.get('parameters', parsed)
except Exception as ex:
raise CLIError("Failed to parse {} with exception:\n {}".format(file_path, ex))
return None
def _try_load_uri(uri):
if "://" in uri:
try:
value = _urlretrieve(uri).decode('utf-8')
parsed = _remove_comments_from_json(value, False)
return parsed.get('parameters', parsed)
except Exception: # pylint: disable=broad-except
pass
return None
def _try_parse_key_value_object(template_param_defs, parameters, value):
# support situation where empty JSON "{}" is provided
if value == '{}' and not parameters:
return True
try:
key, value = value.split('=', 1)
except ValueError:
return False
param = template_param_defs.get(key, None)
if param is None:
raise CLIError("unrecognized template parameter '{}'. Allowed parameters: {}"
.format(key, ', '.join(sorted(template_param_defs.keys()))))
param_type = param.get('type', None)
if param_type:
param_type = param_type.lower()
if param_type in ['object', 'array', 'secureobject']:
parameters[key] = {'value': shell_safe_json_parse(value)}
elif param_type in ['string', 'securestring']:
parameters[key] = {'value': value}
elif param_type == 'bool':
parameters[key] = {'value': value.lower() == 'true'}
elif param_type == 'int':
parameters[key] = {'value': int(value)}
else:
logger.warning("Unrecognized type '%s' for parameter '%s'. Interpretting as string.", param_type, key)
parameters[key] = {'value': value}
return True
parameters = {}
for params in parameter_lists or []:
for item in params:
param_obj = _try_load_file_object(item)
if param_obj is None:
param_obj = _try_parse_json_object(item)
if param_obj is None:
param_obj = _try_load_uri(item)
if param_obj is not None:
parameters.update(param_obj)
elif not _try_parse_key_value_object(template_param_defs, parameters, item):
raise CLIError('Unable to parse parameter: {}'.format(item))
return parameters
# pylint: disable=redefined-outer-name
def _find_missing_parameters(parameters, template):
if template is None:
return {}
template_parameters = template.get('parameters', None)
if template_parameters is None:
return {}
missing = OrderedDict()
for parameter_name in template_parameters:
parameter = template_parameters[parameter_name]
if 'defaultValue' in parameter:
continue
if parameters is not None and parameters.get(parameter_name, None) is not None:
continue
missing[parameter_name] = parameter
return missing
def _prompt_for_parameters(missing_parameters, fail_on_no_tty=True): # pylint: disable=too-many-statements
prompt_list = missing_parameters.keys() if isinstance(missing_parameters, OrderedDict) \
else sorted(missing_parameters)
result = OrderedDict()
no_tty = False
for param_name in prompt_list:
param = missing_parameters[param_name]
param_type = param.get('type', 'string').lower()
description = 'Missing description'
metadata = param.get('metadata', None)
if metadata is not None:
description = metadata.get('description', description)
allowed_values = param.get('allowedValues', None)
prompt_str = "Please provide {} value for '{}' (? for help): ".format(param_type, param_name)
while True:
if allowed_values is not None:
try:
ix = prompt_choice_list(prompt_str, allowed_values, help_string=description)
result[param_name] = allowed_values[ix]
except NoTTYException:
result[param_name] = None
no_tty = True
break
if param_type == 'securestring':
try:
value = prompt_pass(prompt_str, help_string=description)
except NoTTYException:
value = None
no_tty = True
result[param_name] = value
break
if param_type == 'int':
try:
int_value = prompt_int(prompt_str, help_string=description)
result[param_name] = int_value
except NoTTYException:
result[param_name] = 0
no_tty = True
break
if param_type == 'bool':
try:
value = prompt_t_f(prompt_str, help_string=description)
result[param_name] = value
except NoTTYException:
result[param_name] = False
no_tty = True
break
if param_type in ['object', 'array']:
try:
value = prompt(prompt_str, help_string=description)
except NoTTYException:
value = ''
no_tty = True
if value == '':
value = {} if param_type == 'object' else []
else:
try:
value = shell_safe_json_parse(value)
except Exception as ex: # pylint: disable=broad-except
logger.error(ex)
continue
result[param_name] = value
break
try:
result[param_name] = prompt(prompt_str, help_string=description)
except NoTTYException:
result[param_name] = None
no_tty = True
break
if no_tty and fail_on_no_tty:
raise NoTTYException
return result
# pylint: disable=redefined-outer-name
def _get_missing_parameters(parameters, template, prompt_fn, no_prompt=False):
missing = _find_missing_parameters(parameters, template)
if missing:
if no_prompt is True:
logger.warning("Missing input parameters: %s ", ', '.join(sorted(missing.keys())))
else:
try:
prompt_parameters = prompt_fn(missing)
for param_name in prompt_parameters:
parameters[param_name] = {
"value": prompt_parameters[param_name]
}
except NoTTYException:
raise CLIError("Missing input parameters: {}".format(', '.join(sorted(missing.keys()))))
return parameters
def _is_bicepparam_file_provided(parameters):
if not parameters or len(parameters) < 1:
return False
for parameter in parameters:
if is_bicepparam_file(parameter[0]):
return True
return False
def _ssl_context():
if sys.version_info < (3, 4):
return ssl.SSLContext(ssl.PROTOCOL_TLSv1)
return ssl.create_default_context()
def _urlretrieve(url):
try:
req = urlopen(url, context=_ssl_context())
return req.read()
except Exception: # pylint: disable=broad-except
raise CLIError('Unable to retrieve url {}'.format(url))
# pylint: disable=redefined-outer-name
def _remove_comments_from_json(template, preserve_order=True, file_path=None):
from ._json_handler import json_min
# When commenting at the bottom of all elements in a JSON object, jsmin has a bug that will wrap lines.
# It will affect the subsequent multi-line processing logic, so remove those comments in advance here.
# Related issue: https://github.com/Azure/azure-cli/issues/11995, the sample is in the additional context of it.
template = re.sub(r'(^[\t ]*//[\s\S]*?\n)|(^[\t ]*/\*{1,2}[\s\S]*?\*/)', '', template, flags=re.M)
# In order to solve the package conflict introduced by jsmin, the jsmin code is referenced into json_min
minified = json_min(template)
try:
return shell_safe_json_parse(minified, preserve_order, strict=False) # use strict=False to allow multiline strings
except CLIError:
# Because the processing of removing comments and compression will lead to misplacement of error location,
# so the error message should be wrapped.
if file_path:
raise CLIError("Failed to parse '{}', please check whether it is a valid JSON format".format(file_path))
raise CLIError("Failed to parse the JSON data, please check whether it is a valid JSON format")
# pylint: disable=too-many-locals, too-many-statements, too-few-public-methods
def _deploy_arm_template_core_unmodified(cmd, resource_group_name, template_file=None,
template_uri=None, deployment_name=None, parameters=None,
mode=None, rollback_on_error=None, validate_only=False, no_wait=False,
aux_subscriptions=None, aux_tenants=None, no_prompt=False):
DeploymentProperties, TemplateLink, OnErrorDeployment = cmd.get_models('DeploymentProperties', 'TemplateLink',
'OnErrorDeployment')
template_link = None
template_obj = None
on_error_deployment = None
template_content = None
if template_uri:
template_link = TemplateLink(uri=template_uri)
template_obj = _remove_comments_from_json(_urlretrieve(template_uri).decode('utf-8'), file_path=template_uri)
else:
template_content = (
run_bicep_command(cmd.cli_ctx, ["build", "--stdout", template_file])
if is_bicep_file(template_file)
else read_file_content(template_file)
)
template_obj = _remove_comments_from_json(template_content, file_path=template_file)
if rollback_on_error == '':
on_error_deployment = OnErrorDeployment(type='LastSuccessful')
elif rollback_on_error:
on_error_deployment = OnErrorDeployment(type='SpecificDeployment', deployment_name=rollback_on_error)
template_param_defs = template_obj.get('parameters', {})
template_obj['resources'] = template_obj.get('resources', [])
parameters = _process_parameters(template_param_defs, parameters) or {}
parameters = _get_missing_parameters(parameters, template_obj, _prompt_for_parameters, no_prompt)
parameters = json.loads(json.dumps(parameters))
properties = DeploymentProperties(template=template_content, template_link=template_link,
parameters=parameters, mode=mode, on_error_deployment=on_error_deployment)
smc = get_mgmt_service_client(cmd.cli_ctx, ResourceType.MGMT_RESOURCE_RESOURCES,
aux_subscriptions=aux_subscriptions, aux_tenants=aux_tenants)
deployment_client = smc.deployments # This solves the multi-api for you
if not template_uri:
# Plug this as default HTTP pipeline
# pylint: disable=protected-access
from azure.core.pipeline import Pipeline
smc._client._pipeline._impl_policies.append(JsonCTemplatePolicy())
# Because JsonCTemplatePolicy needs to be wrapped as _SansIOHTTPPolicyRunner, so a new Pipeline is built
smc._client._pipeline = Pipeline(
policies=smc._client._pipeline._impl_policies,
transport=smc._client._pipeline._transport
)
from azure.core.exceptions import HttpResponseError
Deployment = cmd.get_models('Deployment')
deployment = Deployment(properties=properties)
if cmd.supported_api_version(min_api='2019-10-01', resource_type=ResourceType.MGMT_RESOURCE_RESOURCES):
try:
validation_poller = deployment_client.begin_validate(resource_group_name, deployment_name, deployment)
except HttpResponseError as err:
err_message = _build_http_response_error_message(err)
raise_subdivision_deployment_error(err_message, err.error.code if err.error else None)
validation_result = LongRunningOperation(cmd.cli_ctx)(validation_poller)
else:
validation_result = deployment_client.validate(resource_group_name, deployment_name, deployment)
if validation_result and validation_result.error:
err_message = _build_preflight_error_message(validation_result.error)
raise_subdivision_deployment_error(err_message)
if validate_only:
return validation_result
return sdk_no_wait(no_wait, deployment_client.begin_create_or_update, resource_group_name, deployment_name,
deployment)
class JsonCTemplatePolicy(SansIOHTTPPolicy):
# Obtain the template data and then splice it with other properties into the JSONC format
def on_request(self, request):
http_request = request.http_request
request_data = getattr(http_request, 'data', {}) or {}
if not request_data:
return
# In the case of retry, because the first request has been processed and
# converted the type of "request.http_request.data" from string to bytes,
# so there is no need to process request object again during retry
if isinstance(request_data, bytes):
return
# 'request_data' has been dumped into JSON string in set_json_body() when building HttpRequest in Python SDK.
# In order to facilitate subsequent parsing, it is converted into a dict first
http_request.data = json.loads(request_data)
if http_request.data.get('properties', {}).get('template'):
template = http_request.data["properties"]["template"]
del http_request.data["properties"]["template"]
# templateLink nad template cannot exist at the same time in deployment_dry_run mode
if "templateLink" in http_request.data["properties"].keys():
del http_request.data["properties"]["templateLink"]
# The 'template' and other properties (such as 'parameters','mode'...) are spliced and encoded into the UTF-8 bytes as the request data
# The format of the request data is: {"properties": {"parameters": {...}, "mode": "Incremental", template:{\r\n "$schema": "...",\r\n "contentVersion": "...",\r\n "parameters": {...}}}
# This is not an ordinary JSON format, but it is a JSONC format that service can deserialize
# If not do this splicing, the request data generated by default serialization cannot be deserialized on the service side.
# Because the service cannot deserialize the template element: "template": "{\r\n \"$schema\": \"...\",\r\n \"contentVersion\": \"...\",\r\n \"parameters\": {...}}"
partial_request = json.dumps(http_request.data)
http_request.data = partial_request[:-2] + ", template:" + template + r"}}"
http_request.data = http_request.data.encode('utf-8')
# pylint: disable=unused-argument
def deploy_arm_template_at_subscription_scope(cmd,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, deployment_location=None,
no_wait=False, handle_extended_json_format=None, no_prompt=False,
confirm_with_what_if=None, what_if_result_format=None,
what_if_exclude_change_types=None, template_spec=None, query_string=None,
what_if=None, proceed_if_no_change=None):
if confirm_with_what_if or what_if:
what_if_result = _what_if_deploy_arm_template_at_subscription_scope_core(cmd,
template_file=template_file, template_uri=template_uri,
parameters=parameters, deployment_name=deployment_name,
deployment_location=deployment_location,
result_format=what_if_result_format,
exclude_change_types=what_if_exclude_change_types,
no_prompt=no_prompt, template_spec=template_spec, query_string=query_string,
return_result=True)
if what_if:
return None
ChangeType = cmd.get_models('ChangeType')
has_change = any(change.change_type not in [ChangeType.no_change, ChangeType.ignore] for change in what_if_result.changes)
if not proceed_if_no_change or has_change:
from knack.prompting import prompt_y_n
if not prompt_y_n("\nAre you sure you want to execute the deployment?"):
return None
return _deploy_arm_template_at_subscription_scope(cmd=cmd,
template_file=template_file, template_uri=template_uri, parameters=parameters,
deployment_name=deployment_name, deployment_location=deployment_location,
validate_only=False, no_wait=no_wait,
no_prompt=no_prompt, template_spec=template_spec, query_string=query_string)
# pylint: disable=unused-argument
def validate_arm_template_at_subscription_scope(cmd,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, deployment_location=None,
no_wait=False, handle_extended_json_format=None,
no_prompt=False, template_spec=None, query_string=None):
return _deploy_arm_template_at_subscription_scope(cmd=cmd,
template_file=template_file, template_uri=template_uri, parameters=parameters,
deployment_name=deployment_name, deployment_location=deployment_location,
validate_only=True, no_wait=no_wait,
no_prompt=no_prompt, template_spec=template_spec, query_string=query_string,)
def _deploy_arm_template_at_subscription_scope(cmd,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, deployment_location=None, validate_only=False,
no_wait=False, no_prompt=False, template_spec=None, query_string=None):
deployment_properties = _prepare_deployment_properties_unmodified(cmd, 'subscription', template_file=template_file,
template_uri=template_uri, parameters=parameters,
mode='Incremental',
no_prompt=no_prompt,
template_spec=template_spec, query_string=query_string)
mgmt_client = _get_deployment_management_client(cmd.cli_ctx, plug_pipeline=(template_uri is None and template_spec is None))
from azure.core.exceptions import HttpResponseError
Deployment = cmd.get_models('Deployment')
deployment = Deployment(properties=deployment_properties, location=deployment_location)
if cmd.supported_api_version(min_api='2019-10-01', resource_type=ResourceType.MGMT_RESOURCE_RESOURCES):
try:
validation_poller = mgmt_client.begin_validate_at_subscription_scope(deployment_name, deployment)
except HttpResponseError as err:
err_message = _build_http_response_error_message(err)
raise_subdivision_deployment_error(err_message, err.error.code if err.error else None)
validation_result = LongRunningOperation(cmd.cli_ctx)(validation_poller)
else:
validation_result = mgmt_client.validate_at_subscription_scope(deployment_name, deployment)
if validation_result and validation_result.error:
err_message = _build_preflight_error_message(validation_result.error)
raise_subdivision_deployment_error(err_message)
if validate_only:
return validation_result
return sdk_no_wait(no_wait, mgmt_client.begin_create_or_update_at_subscription_scope, deployment_name, deployment)
# pylint: disable=unused-argument
def deploy_arm_template_at_resource_group(cmd,
resource_group_name=None,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, mode=None, rollback_on_error=None,
no_wait=False, handle_extended_json_format=None,
aux_subscriptions=None, aux_tenants=None, no_prompt=False,
confirm_with_what_if=None, what_if_result_format=None,
what_if_exclude_change_types=None, template_spec=None, query_string=None,
what_if=None, proceed_if_no_change=None):
if confirm_with_what_if or what_if:
what_if_result = _what_if_deploy_arm_template_at_resource_group_core(cmd,
resource_group_name=resource_group_name,
template_file=template_file, template_uri=template_uri,
parameters=parameters, deployment_name=deployment_name, mode=mode,
aux_tenants=aux_tenants, result_format=what_if_result_format,
exclude_change_types=what_if_exclude_change_types,
no_prompt=no_prompt, template_spec=template_spec, query_string=query_string,
return_result=True)
if what_if:
return None
ChangeType = cmd.get_models('ChangeType')
has_change = any(change.change_type not in [ChangeType.no_change, ChangeType.ignore] for change in what_if_result.changes)
if not proceed_if_no_change or has_change:
from knack.prompting import prompt_y_n
if not prompt_y_n("\nAre you sure you want to execute the deployment?"):
return None
return _deploy_arm_template_at_resource_group(cmd=cmd,
resource_group_name=resource_group_name,
template_file=template_file, template_uri=template_uri, parameters=parameters,
deployment_name=deployment_name, mode=mode, rollback_on_error=rollback_on_error,
validate_only=False, no_wait=no_wait,
aux_subscriptions=aux_subscriptions, aux_tenants=aux_tenants,
no_prompt=no_prompt, template_spec=template_spec, query_string=query_string)
# pylint: disable=unused-argument
def validate_arm_template_at_resource_group(cmd,
resource_group_name=None,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, mode=None, rollback_on_error=None,
no_wait=False, handle_extended_json_format=None, no_prompt=False, template_spec=None, query_string=None):
return _deploy_arm_template_at_resource_group(cmd,
resource_group_name=resource_group_name,
template_file=template_file, template_uri=template_uri, parameters=parameters,
deployment_name=deployment_name, mode=mode, rollback_on_error=rollback_on_error,
validate_only=True, no_wait=no_wait,
no_prompt=no_prompt, template_spec=template_spec, query_string=query_string)
def _deploy_arm_template_at_resource_group(cmd,
resource_group_name=None,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, mode=None, rollback_on_error=None,
validate_only=False, no_wait=False,
aux_subscriptions=None, aux_tenants=None, no_prompt=False, template_spec=None, query_string=None):
deployment_properties = _prepare_deployment_properties_unmodified(cmd, 'resourceGroup', template_file=template_file,
template_uri=template_uri,
parameters=parameters, mode=mode,
rollback_on_error=rollback_on_error,
no_prompt=no_prompt, template_spec=template_spec, query_string=query_string)
mgmt_client = _get_deployment_management_client(cmd.cli_ctx, aux_subscriptions=aux_subscriptions,
aux_tenants=aux_tenants, plug_pipeline=(template_uri is None and template_spec is None))
from azure.core.exceptions import HttpResponseError
Deployment = cmd.get_models('Deployment')
deployment = Deployment(properties=deployment_properties)
if cmd.supported_api_version(min_api='2019-10-01', resource_type=ResourceType.MGMT_RESOURCE_RESOURCES):
try:
validation_poller = mgmt_client.begin_validate(resource_group_name, deployment_name, deployment)
except HttpResponseError as err:
err_message = _build_http_response_error_message(err)
raise_subdivision_deployment_error(err_message, err.error.code if err.error else None)
validation_result = LongRunningOperation(cmd.cli_ctx)(validation_poller)
else:
validation_result = mgmt_client.validate(resource_group_name, deployment_name, deployment)
if validation_result and validation_result.error:
err_message = _build_preflight_error_message(validation_result.error)
raise_subdivision_deployment_error(err_message)
if validate_only:
return validation_result
return sdk_no_wait(no_wait, mgmt_client.begin_create_or_update, resource_group_name, deployment_name, deployment)
# pylint: disable=unused-argument
def deploy_arm_template_at_management_group(cmd,
management_group_id=None,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, deployment_location=None,
no_wait=False, handle_extended_json_format=None, no_prompt=False,
confirm_with_what_if=None, what_if_result_format=None,
what_if_exclude_change_types=None, template_spec=None, query_string=None,
what_if=None, proceed_if_no_change=None, mode=None):
if confirm_with_what_if or what_if:
what_if_result = _what_if_deploy_arm_template_at_management_group_core(cmd,
management_group_id=management_group_id,
template_file=template_file, template_uri=template_uri,
parameters=parameters, deployment_name=deployment_name,
deployment_location=deployment_location,
result_format=what_if_result_format,
exclude_change_types=what_if_exclude_change_types,
no_prompt=no_prompt, template_spec=template_spec, query_string=query_string,
return_result=True)
if what_if:
return None
ChangeType = cmd.get_models('ChangeType')
has_change = any(change.change_type not in [ChangeType.no_change, ChangeType.ignore] for change in what_if_result.changes)
if not proceed_if_no_change or has_change:
from knack.prompting import prompt_y_n
if not prompt_y_n("\nAre you sure you want to execute the deployment?"):
return None
return _deploy_arm_template_at_management_group(cmd=cmd,
management_group_id=management_group_id,
template_file=template_file, template_uri=template_uri, parameters=parameters,
deployment_name=deployment_name, deployment_location=deployment_location,
validate_only=False, no_wait=no_wait,
no_prompt=no_prompt, template_spec=template_spec, query_string=query_string,
mode=mode)
# pylint: disable=unused-argument
def validate_arm_template_at_management_group(cmd,
management_group_id=None,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, deployment_location=None,
no_wait=False, handle_extended_json_format=None,
no_prompt=False, template_spec=None, query_string=None):
return _deploy_arm_template_at_management_group(cmd=cmd,
management_group_id=management_group_id,
template_file=template_file, template_uri=template_uri, parameters=parameters,
deployment_name=deployment_name, deployment_location=deployment_location,
validate_only=True, no_wait=no_wait,
no_prompt=no_prompt, template_spec=template_spec, query_string=query_string,
mode='Incremental')
def _deploy_arm_template_at_management_group(cmd,
management_group_id=None,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, deployment_location=None, validate_only=False,
no_wait=False, no_prompt=False, template_spec=None, query_string=None,
mode=None):
deployment_properties = _prepare_deployment_properties_unmodified(cmd, 'managementGroup', template_file=template_file,
template_uri=template_uri,
parameters=parameters, mode=mode,
no_prompt=no_prompt, template_spec=template_spec, query_string=query_string)
mgmt_client = _get_deployment_management_client(cmd.cli_ctx, plug_pipeline=(template_uri is None and template_spec is None))
from azure.core.exceptions import HttpResponseError
ScopedDeployment = cmd.get_models('ScopedDeployment')
deployment = ScopedDeployment(properties=deployment_properties, location=deployment_location)
if cmd.supported_api_version(min_api='2019-10-01', resource_type=ResourceType.MGMT_RESOURCE_RESOURCES):
try:
validation_poller = mgmt_client.begin_validate_at_management_group_scope(management_group_id,
deployment_name, deployment)
except HttpResponseError as err:
err_message = _build_http_response_error_message(err)
raise_subdivision_deployment_error(err_message, err.error.code if err.error else None)
validation_result = LongRunningOperation(cmd.cli_ctx)(validation_poller)
else:
validation_result = mgmt_client.validate_at_management_group_scope(management_group_id, deployment_name,
deployment)
if validation_result and validation_result.error:
err_message = _build_preflight_error_message(validation_result.error)
raise_subdivision_deployment_error(err_message)
if validate_only:
return validation_result
return sdk_no_wait(no_wait, mgmt_client.begin_create_or_update_at_management_group_scope, management_group_id,
deployment_name, deployment)
# pylint: disable=unused-argument
def deploy_arm_template_at_tenant_scope(cmd,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, deployment_location=None,
no_wait=False, handle_extended_json_format=None, no_prompt=False,
confirm_with_what_if=None, what_if_result_format=None,
what_if_exclude_change_types=None, template_spec=None, query_string=None,
what_if=None, proceed_if_no_change=None):
if confirm_with_what_if or what_if:
what_if_result = _what_if_deploy_arm_template_at_tenant_scope_core(cmd,
template_file=template_file, template_uri=template_uri,
parameters=parameters, deployment_name=deployment_name,
deployment_location=deployment_location,
result_format=what_if_result_format,
exclude_change_types=what_if_exclude_change_types,
no_prompt=no_prompt, template_spec=template_spec, query_string=query_string,
return_result=True)
if what_if:
return None
ChangeType = cmd.get_models('ChangeType')
has_change = any(change.change_type not in [ChangeType.no_change, ChangeType.ignore] for change in what_if_result.changes)
if not proceed_if_no_change or has_change:
from knack.prompting import prompt_y_n
if not prompt_y_n("\nAre you sure you want to execute the deployment?"):
return None
return _deploy_arm_template_at_tenant_scope(cmd=cmd,
template_file=template_file, template_uri=template_uri, parameters=parameters,
deployment_name=deployment_name, deployment_location=deployment_location,
validate_only=False, no_wait=no_wait,
no_prompt=no_prompt, template_spec=template_spec, query_string=query_string)
# pylint: disable=unused-argument
def validate_arm_template_at_tenant_scope(cmd,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, deployment_location=None,
no_wait=False, handle_extended_json_format=None, no_prompt=False, template_spec=None, query_string=None):
return _deploy_arm_template_at_tenant_scope(cmd=cmd,
template_file=template_file, template_uri=template_uri, parameters=parameters,
deployment_name=deployment_name, deployment_location=deployment_location,
validate_only=True, no_wait=no_wait,
no_prompt=no_prompt, template_spec=template_spec, query_string=query_string)
def _deploy_arm_template_at_tenant_scope(cmd,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, deployment_location=None, validate_only=False,
no_wait=False, no_prompt=False, template_spec=None, query_string=None):
deployment_properties = _prepare_deployment_properties_unmodified(cmd, 'tenant', template_file=template_file,
template_uri=template_uri,
parameters=parameters, mode='Incremental',
no_prompt=no_prompt, template_spec=template_spec, query_string=query_string,)
mgmt_client = _get_deployment_management_client(cmd.cli_ctx, plug_pipeline=(template_uri is None and template_spec is None))
from azure.core.exceptions import HttpResponseError
ScopedDeployment = cmd.get_models('ScopedDeployment')
deployment = ScopedDeployment(properties=deployment_properties, location=deployment_location)
if cmd.supported_api_version(min_api='2019-10-01', resource_type=ResourceType.MGMT_RESOURCE_RESOURCES):
try:
validation_poller = mgmt_client.begin_validate_at_tenant_scope(deployment_name=deployment_name,
parameters=deployment)
except HttpResponseError as err:
err_message = _build_http_response_error_message(err)
raise_subdivision_deployment_error(err_message, err.error.code if err.error else None)
validation_result = LongRunningOperation(cmd.cli_ctx)(validation_poller)
else:
validation_result = mgmt_client.validate_at_tenant_scope(deployment_name=deployment_name,
parameters=deployment)
if validation_result and validation_result.error:
err_message = _build_preflight_error_message(validation_result.error)
raise_subdivision_deployment_error(err_message)
if validate_only:
return validation_result
return sdk_no_wait(no_wait, mgmt_client.begin_create_or_update_at_tenant_scope, deployment_name, deployment)
def what_if_deploy_arm_template_at_resource_group(cmd, resource_group_name,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, mode=None,
aux_tenants=None, result_format=None,
no_pretty_print=None, no_prompt=False,
exclude_change_types=None, template_spec=None, query_string=None):
return _what_if_deploy_arm_template_at_resource_group_core(cmd, resource_group_name,
template_file, template_uri, parameters,
deployment_name, mode,
aux_tenants, result_format,
no_pretty_print, no_prompt,
exclude_change_types, template_spec, query_string)
def _what_if_deploy_arm_template_at_resource_group_core(cmd, resource_group_name,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, mode=DeploymentMode.incremental,
aux_tenants=None, result_format=None,
no_pretty_print=None, no_prompt=False,
exclude_change_types=None, template_spec=None, query_string=None,
return_result=None):
what_if_properties = _prepare_deployment_what_if_properties(cmd, 'resourceGroup', template_file, template_uri,
parameters, mode, result_format, no_prompt, template_spec, query_string)
mgmt_client = _get_deployment_management_client(cmd.cli_ctx, aux_tenants=aux_tenants,
plug_pipeline=(template_uri is None and template_spec is None))
DeploymentWhatIf = cmd.get_models('DeploymentWhatIf')
deployment_what_if = DeploymentWhatIf(properties=what_if_properties)
what_if_poller = mgmt_client.begin_what_if(resource_group_name, deployment_name,
parameters=deployment_what_if)
what_if_result = _what_if_deploy_arm_template_core(cmd.cli_ctx, what_if_poller, no_pretty_print, exclude_change_types)
return what_if_result if no_pretty_print or return_result else None
def what_if_deploy_arm_template_at_subscription_scope(cmd,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, deployment_location=None,
result_format=None, no_pretty_print=None, no_prompt=False,
exclude_change_types=None, template_spec=None, query_string=None):
return _what_if_deploy_arm_template_at_subscription_scope_core(cmd,
template_file, template_uri, parameters,
deployment_name, deployment_location,
result_format, no_pretty_print, no_prompt,
exclude_change_types, template_spec, query_string)
def _what_if_deploy_arm_template_at_subscription_scope_core(cmd,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, deployment_location=None,
result_format=None, no_pretty_print=None, no_prompt=False,
exclude_change_types=None, template_spec=None, query_string=None,
return_result=None):
what_if_properties = _prepare_deployment_what_if_properties(cmd, 'subscription', template_file, template_uri, parameters,
DeploymentMode.incremental, result_format, no_prompt, template_spec, query_string)
mgmt_client = _get_deployment_management_client(cmd.cli_ctx, plug_pipeline=(template_uri is None and template_spec is None))
ScopedDeploymentWhatIf = cmd.get_models('ScopedDeploymentWhatIf')
scoped_deployment_what_if = ScopedDeploymentWhatIf(location=deployment_location, properties=what_if_properties)
what_if_poller = mgmt_client.begin_what_if_at_subscription_scope(deployment_name,
parameters=scoped_deployment_what_if)
what_if_result = _what_if_deploy_arm_template_core(cmd.cli_ctx, what_if_poller, no_pretty_print, exclude_change_types)
return what_if_result if no_pretty_print or return_result else None
def what_if_deploy_arm_template_at_management_group(cmd, management_group_id=None,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, deployment_location=None,
result_format=None, no_pretty_print=None, no_prompt=False,
exclude_change_types=None, template_spec=None, query_string=None):
return _what_if_deploy_arm_template_at_management_group_core(cmd, management_group_id,
template_file, template_uri, parameters,
deployment_name, deployment_location,
result_format, no_pretty_print, no_prompt,
exclude_change_types, template_spec, query_string)
def _what_if_deploy_arm_template_at_management_group_core(cmd, management_group_id=None,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, deployment_location=None,
result_format=None, no_pretty_print=None, no_prompt=False,
exclude_change_types=None, template_spec=None, query_string=None,
return_result=None):
what_if_properties = _prepare_deployment_what_if_properties(cmd, 'managementGroup', template_file, template_uri, parameters,
DeploymentMode.incremental, result_format, no_prompt, template_spec=template_spec, query_string=query_string)
mgmt_client = _get_deployment_management_client(cmd.cli_ctx, plug_pipeline=(template_uri is None and template_spec is None))
ScopedDeploymentWhatIf = cmd.get_models('ScopedDeploymentWhatIf')
scoped_deployment_what_if = ScopedDeploymentWhatIf(location=deployment_location, properties=what_if_properties)
what_if_poller = mgmt_client.begin_what_if_at_management_group_scope(management_group_id, deployment_name,
parameters=scoped_deployment_what_if)
what_if_result = _what_if_deploy_arm_template_core(cmd.cli_ctx, what_if_poller, no_pretty_print, exclude_change_types)
return what_if_result if no_pretty_print or return_result else None
def what_if_deploy_arm_template_at_tenant_scope(cmd,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, deployment_location=None,
result_format=None, no_pretty_print=None, no_prompt=False,
exclude_change_types=None, template_spec=None, query_string=None):
return _what_if_deploy_arm_template_at_tenant_scope_core(cmd,
template_file, template_uri, parameters,
deployment_name, deployment_location,
result_format, no_pretty_print, no_prompt,
exclude_change_types, template_spec, query_string)
def _what_if_deploy_arm_template_at_tenant_scope_core(cmd,
template_file=None, template_uri=None, parameters=None,
deployment_name=None, deployment_location=None,
result_format=None, no_pretty_print=None, no_prompt=False,
exclude_change_types=None, template_spec=None, query_string=None,
return_result=None):
what_if_properties = _prepare_deployment_what_if_properties(cmd, 'tenant', template_file, template_uri, parameters,
DeploymentMode.incremental, result_format, no_prompt, template_spec, query_string)
mgmt_client = _get_deployment_management_client(cmd.cli_ctx, plug_pipeline=(template_uri is None and template_spec is None))
ScopedDeploymentWhatIf = cmd.get_models('ScopedDeploymentWhatIf')
scoped_deployment_what_if = ScopedDeploymentWhatIf(location=deployment_location, properties=what_if_properties)
what_if_poller = mgmt_client.begin_what_if_at_tenant_scope(deployment_name, parameters=scoped_deployment_what_if)
what_if_result = _what_if_deploy_arm_template_core(cmd.cli_ctx, what_if_poller, no_pretty_print, exclude_change_types)
return what_if_result if no_pretty_print or return_result else None
def _what_if_deploy_arm_template_core(cli_ctx, what_if_poller, no_pretty_print, exclude_change_types):
what_if_result = LongRunningOperation(cli_ctx)(what_if_poller)
if what_if_result.error:
# The status code is 200 even when there's an error, because
# it is technically a successful What-If operation. The error
# is on the ARM template but not the operation.
err_message = _build_preflight_error_message(what_if_result.error)
raise CLIError(err_message)
if exclude_change_types:
exclude_change_types = set(map(lambda x: x.lower(), exclude_change_types))
what_if_result.changes = list(
filter(lambda x: x.change_type.lower() not in exclude_change_types, what_if_result.changes)
)
if no_pretty_print:
return what_if_result
print(format_what_if_operation_result(what_if_result, cli_ctx.enable_color))
return what_if_result
def _prepare_template_uri_with_query_string(template_uri, input_query_string):
from urllib.parse import urlencode, parse_qs, urlsplit, urlunsplit
try:
scheme, netloc, path, query_string, fragment = urlsplit(template_uri) # pylint: disable=unused-variable
query_params = parse_qs(input_query_string)
new_query_string = urlencode(query_params, doseq=True)
return urlunsplit((scheme, netloc, path, new_query_string, fragment))
except Exception: # pylint: disable=broad-except
raise InvalidArgumentValueError('Unable to parse parameter: {} .Make sure the value is formed correctly.'.format(input_query_string))
def _prepare_deployment_properties_unmodified(cmd, deployment_scope, template_file=None, template_uri=None, parameters=None,
mode=None, rollback_on_error=None, no_prompt=False, template_spec=None, query_string=None):
cli_ctx = cmd.cli_ctx
DeploymentProperties, TemplateLink, OnErrorDeployment = get_sdk(cli_ctx, ResourceType.MGMT_RESOURCE_RESOURCES,
'DeploymentProperties', 'TemplateLink',
'OnErrorDeployment', mod='models')
template_link = None
template_obj = None
on_error_deployment = None
template_content = None
if query_string and not template_uri:
raise IncorrectUsageError('please provide --template-uri if --query-string is specified')
if template_uri:
if query_string:
template_link = TemplateLink(uri=template_uri, query_string=query_string)
template_uri = _prepare_template_uri_with_query_string(template_uri=template_uri, input_query_string=query_string)
else:
template_link = TemplateLink(uri=template_uri)
template_obj = _remove_comments_from_json(_urlretrieve(template_uri).decode('utf-8'), file_path=template_uri)
elif template_spec:
template_link = TemplateLink(id=template_spec, mode="Incremental")
# The api-version for ResourceType.MGMT_RESOURCE_RESOURCES may get updated and point to another (newer) version of the api version for
# ResourceType.MGMT_RESOURCE_TEMPLATESPECS than our designated version. This ensures the api-version of all the rest requests for
# template_spec are consistent in the same profile:
api_version = get_api_version(cli_ctx, ResourceType.MGMT_RESOURCE_TEMPLATESPECS)
template_obj = show_resource(cmd=cmd, resource_ids=[template_spec], api_version=api_version).properties['mainTemplate']
else:
if _is_bicepparam_file_provided(parameters):
ensure_bicep_installation(cli_ctx)
minimum_supported_version = "0.14.85"
if not bicep_version_greater_than_or_equal_to(minimum_supported_version):
raise ArgumentUsageError(f"Unable to compile .bicepparam file with the current version of Bicep CLI. Please upgrade Bicep CLI to {minimum_supported_version} or later.")
if len(parameters) > 1:
raise ArgumentUsageError("Can not use --parameters argument more than once when using a .bicepparam file")
bicepparam_file = parameters[0][0]
if not is_bicep_file(template_file):
raise ArgumentUsageError("Only a .bicep template is allowed with a .bicepparam parameter file")
build_bicepparam_output = run_bicep_command(cmd.cli_ctx, ["build-params", bicepparam_file, "--bicep-file", template_file, "--stdout"])
build_bicepparam_output_json = json.loads(build_bicepparam_output)
template_content = build_bicepparam_output_json["templateJson"]
bicepparam_json_content = build_bicepparam_output_json["parametersJson"]
else:
template_content = (
run_bicep_command(cmd.cli_ctx, ["build", "--stdout", template_file])
if is_bicep_file(template_file)
else read_file_content(template_file)
)
template_obj = _remove_comments_from_json(template_content, file_path=template_file)
if is_bicep_file(template_file):
template_schema = template_obj.get('$schema', '')
validate_bicep_target_scope(template_schema, deployment_scope)
if rollback_on_error == '':