-
Notifications
You must be signed in to change notification settings - Fork 3.1k
/
Copy path_params.py
1122 lines (961 loc) · 77.4 KB
/
_params.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=line-too-long
# pylint: disable=too-many-statements
from knack.arguments import CLIArgumentType
from azure.cli.core.commands.parameters import (
get_resource_name_completion_list,
tags_type, get_location_type,
get_enum_type, file_type,
resource_group_name_type,
get_three_state_flag)
from azure.cli.command_modules.rdbms.validators import configuration_value_validator, validate_subnet, \
tls_validator, public_access_validator, maintenance_window_validator, ip_address_validator, \
retention_validator, validate_identity, validate_byok_identity, validate_identities, \
virtual_endpoint_name_validator, node_count_validator, postgres_firewall_rule_name_validator
from azure.cli.core.local_context import LocalContextAttribute, LocalContextAction
from .randomname.generate import generate_username
from ._flexible_server_util import get_current_time
from argcomplete.completers import FilesCompleter
from ._util import get_index_tuning_settings_map
def load_arguments(self, _): # pylint: disable=too-many-statements, too-many-locals
server_completers = {
'mariadb': get_resource_name_completion_list('Microsoft.DBforMariaDB/servers'),
'mysql': get_resource_name_completion_list('Microsoft.DBforMySQL/servers'),
'postgres': get_resource_name_completion_list('Microsoft.DBforPostgreSQL/servers')
}
def _complex_params(command_group): # pylint: disable=too-many-statements
server_name_help = "Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. " + \
"Minimum 3 characters and maximum 63 characters."
server_name_scope = ['{}'.format(command_group)]
server_name_setter_arg_type = CLIArgumentType(metavar='NAME', help=server_name_help, id_part='name',
local_context_attribute=LocalContextAttribute(name='server_name', actions=[LocalContextAction.SET], scopes=server_name_scope))
server_name_getter_arg_type = CLIArgumentType(metavar='NAME', help=server_name_help, id_part='name',
local_context_attribute=LocalContextAttribute(name='server_name', actions=[LocalContextAction.GET], scopes=server_name_scope))
server_name_arg_type = CLIArgumentType(metavar='NAME', help=server_name_help, id_part='name',
local_context_attribute=LocalContextAttribute(name='server_name', actions=[LocalContextAction.SET, LocalContextAction.GET], scopes=server_name_scope))
administrator_login_arg_type = CLIArgumentType(metavar='NAME',
local_context_attribute=LocalContextAttribute(name='administrator_login', actions=[LocalContextAction.GET, LocalContextAction.SET], scopes=server_name_scope))
overriding_none_arg_type = CLIArgumentType(local_context_attribute=LocalContextAttribute(name='context_name', actions=[LocalContextAction.GET]))
with self.argument_context(command_group) as c:
c.argument('name', options_list=['--sku-name'], required=True)
c.argument('server_name', arg_type=server_name_arg_type, completer=server_completers[command_group], options_list=['--server-name', '-s'])
with self.argument_context('{} server'.format(command_group)) as c:
c.ignore('family', 'capacity', 'tier')
c.argument('server_name', arg_type=server_name_arg_type, options_list=['--name', '-n'], id_part='name', help='Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.')
c.argument('administrator_login', options_list=['--admin-user', '-u'], help='Administrator username for the server. Once set, it cannot be changed.')
c.argument('administrator_login_password', options_list=['--admin-password', '-p'], help='The password of the administrator. Minimum 8 characters and maximum 128 characters. Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters.')
c.argument('ssl_enforcement', arg_type=get_enum_type(['Enabled', 'Disabled']), options_list=['--ssl-enforcement'], help='Enable or disable ssl enforcement for connections to server. Default is Enabled.')
c.argument('minimal_tls_version', arg_type=get_enum_type(['TLS1_0', 'TLS1_1', 'TLS1_2', 'TLSEnforcementDisabled']), options_list=['--minimal-tls-version'], help='Set the minimal TLS version for connections to server when SSL is enabled. Default is TLSEnforcementDisabled.', validator=tls_validator)
c.argument('public_network_access', options_list=['--public-network-access', '--public'], help='Enable or disable public network access to server. When disabled, only connections made through Private Links can reach this server. Allowed values are : `Enabled`, `Disabled`, `all`, `0.0.0.0`, `<SingleIP>`, `<StartIP-DestinationIP>`. Default is `Enabled`.')
c.argument('tier', arg_type=get_enum_type(['Basic', 'GeneralPurpose', 'MemoryOptimized']), options_list=['--performance-tier'], help='The performance tier of the server.')
c.argument('capacity', options_list=['--vcore'], type=int, help='Number of vcore.')
c.argument('family', options_list=['--family'], arg_type=get_enum_type(['Gen4', 'Gen5']), help='Hardware generation.')
c.argument('storage_mb', options_list=['--storage-size'], type=int, help='The storage capacity of the server (unit is megabytes). Minimum 5120 and increases in 1024 increments. Default is 5120.')
c.argument('backup_retention', options_list=['--backup-retention'], type=int, help='The number of days a backup is retained. Range of 7 to 35 days. Default is 7 days.', validator=retention_validator)
c.argument('auto_grow', arg_type=get_enum_type(['Enabled', 'Disabled']), options_list=['--auto-grow'], help='Enable or disable autogrow of the storage. Default value is Enabled.')
c.argument('auto_scale_iops', arg_type=get_enum_type(['Enabled', 'Disabled']), options_list=['--auto-scale-iops'], help='Enable or disable autoscale of iops. Default value is Disabled.')
c.argument('infrastructure_encryption', arg_type=get_enum_type(['Enabled', 'Disabled']), options_list=['--infrastructure-encryption', '-i'], help='Add an optional second layer of encryption for data using new encryption algorithm. Default value is Disabled.')
c.argument('assign_identity', options_list=['--assign-identity'], help='Generate and assign an Microsoft Entra Identity for this server for use with key management services like Azure KeyVault.')
c.argument('tags', tags_type)
if command_group == 'mariadb':
c.ignore('assign_identity')
c.ignore('infrastructure_encryption')
with self.argument_context('{} server create'.format(command_group)) as c:
c.argument('server_name', options_list=['--name', '-n'], arg_type=server_name_setter_arg_type)
c.argument('sku_name', default='GP_Gen5_2', options_list=['--sku-name'],
help='The name of the sku. Follows the convention {pricing tier}_{compute generation}_{vCores} in shorthand. Examples: B_Gen5_1, GP_Gen5_4, MO_Gen5_16. ')
c.argument('administrator_login', default=generate_username(), arg_group='Authentication')
c.argument('administrator_login_password', arg_group='Authentication')
c.argument('backup_retention', type=int, options_list=['--backup-retention'], help='The number of days a backup is retained. Range of 7 to 35 days. Default is 7 days.', validator=retention_validator)
c.argument('geo_redundant_backup', arg_type=get_enum_type(['Enabled', 'Disabled']), options_list=['--geo-redundant-backup'], help='Enable or disable geo-redundant backups. Default value is Disabled. Not supported in Basic pricing tier.')
c.argument('storage_mb', default=5120, options_list=['--storage-size'], type=int, help='The storage capacity of the server (unit is megabytes). Minimum 5120 and increases in 1024 increments. Default is 5120.')
c.argument('auto_grow', arg_type=get_enum_type(['Enabled', 'Disabled']), options_list=['--auto-grow'], help='Enable or disable autogrow of the storage. Default value is Enabled.')
c.argument('auto_scale_iops', arg_type=get_enum_type(['Enabled', 'Disabled']), options_list=['--auto-scale-iops'], help='Enable or disable autogrow of the storage. Default value is Disabled.')
c.argument('infrastructure_encryption', arg_type=get_enum_type(['Enabled', 'Disabled']), options_list=['--infrastructure-encryption', '-i'], help='Add an optional second layer of encryption for data using new encryption algorithm. Default value is Disabled.')
c.argument('assign_identity', options_list=['--assign-identity'], help='Generate and assign an Microsoft Entra Identity for this server for use with key management services like Azure KeyVault.')
c.argument('location', arg_type=get_location_type(self.cli_ctx))
if command_group == 'postgres':
c.argument('version', default='11',
help='Server major version. https://learn.microsoft.com/en-us/azure/postgresql/single-server/concepts-supported-versions')
else:
c.argument('version', help='Server major version.')
with self.argument_context('{} server update'.format(command_group)) as c:
c.ignore('family', 'capacity', 'tier')
c.argument('sku_name', options_list=['--sku-name'], help='The name of the sku. Follows the convention {pricing tier}_{compute generation}_{vCores} in shorthand. Examples: B_Gen5_1, GP_Gen5_4, MO_Gen5_16.')
c.argument('assign_identity', options_list=['--assign-identity'], help='Generate and assign an Microsoft Entra Identity for this server for use with key management services like Azure KeyVault.')
with self.argument_context('{} server restore'. format(command_group)) as c:
c.argument('server_name', options_list=['--name', '-n'], arg_type=overriding_none_arg_type)
c.argument('source_server', options_list=['--source-server', '-s'], help='The name or resource ID of the source server to restore from.')
c.argument('restore_point_in_time', options_list=['--restore-point-in-time', '--pitr-time'], help='The point in time in UTC to restore from (ISO8601 format), e.g., 2017-04-26T02:10:00+08:00')
with self.argument_context('{} server georestore'. format(command_group)) as c:
c.argument('location', arg_type=get_location_type(self.cli_ctx), required=True)
c.argument('sku_name', options_list=['--sku-name'], required=False, help='The name of the sku. Defaults to sku of the source server. Follows the convention {pricing tier}_{compute generation}_{vCores} in shorthand. Examples: B_Gen5_1, GP_Gen5_4, MO_Gen5_16.')
c.argument('source_server', options_list=['--source-server', '-s'], required=True, help='The name or ID of the source server to restore from.')
c.argument('backup_retention', options_list=['--backup-retention'], type=int, help='The number of days a backup is retained. Range of 7 to 35 days. Default is 7 days.', validator=retention_validator)
c.argument('geo_redundant_backup', options_list=['--geo-redundant-backup'], help='Enable or disable geo-redundant backups. Default value is Disabled. Not supported in Basic pricing tier.')
with self.argument_context('{} server replica'.format(command_group)) as c:
c.argument('server_name', options_list=['--name', '-n'], arg_type=overriding_none_arg_type)
c.argument('source_server', options_list=['--source-server', '-s'], help='The name or resource ID of the master server to the create replica for.')
c.argument('location', options_list=['--location', '-l'], help='Location. Values from: `az account list-locations`. If not provided, the create replica will be in the same location as the master server')
c.argument('sku_name', options_list=['--sku-name'], help='The name of the sku. Follows the convention {pricing tier}_{compute generation}_{vCores} in shorthand. Examples: B_Gen5_1, GP_Gen5_4, MO_Gen5_16.')
with self.argument_context('{} server configuration set'.format(command_group)) as c:
c.argument('value', help='Value of the configuration. If not provided, configuration value will be set to default.', validator=configuration_value_validator)
c.argument('configuration_name', options_list=['--name', '-n'], id_part='child_name_1', help='The name of the configuration')
c.ignore('source')
with self.argument_context('{} server wait'.format(command_group)) as c:
c.ignore('created', 'deleted', 'updated')
with self.argument_context('{} server delete'.format(command_group)) as c:
c.argument('server_name', options_list=['--name', '-n'], arg_type=server_name_getter_arg_type)
with self.argument_context('{} server-logs'.format(command_group)) as c:
c.argument('file_name', options_list=['--name', '-n'], nargs='+', help='Space-separated list of log filenames on the server to download.')
c.argument('max_file_size', type=int, help='The file size limitation to filter files.')
c.argument('file_last_written', type=int, help='Integer in hours to indicate file last modify time, default value is 72.')
c.argument('filename_contains', help='The pattern that file name should match.')
with self.argument_context('{} server-logs list'.format(command_group)) as c:
c.argument('server_name', id_part=None, help='Name of the Server.')
with self.argument_context('{} db'.format(command_group)) as c:
c.argument('database_name', options_list=['--name', '-n'], help='The name of the database')
c.argument('charset', options_list=['--charset'], help='The charset of the database')
c.argument('collation', options_list=['--collation'], help='The collation of the database')
with self.argument_context('{} db list'.format(command_group)) as c:
c.argument('server_name', id_part=None, help='Name of the Server.')
with self.argument_context('{} server firewall-rule'.format(command_group)) as c:
c.argument('server_name', options_list=['--server-name', '-s'])
c.argument('firewall_rule_name', options_list=['--name', '-n'], id_part='child_name_1', help='The name of the firewall rule. The firewall rule name cannot be empty. The firewall rule name can only contain 0-9, a-z, A-Z, \'-\' and \'_\'. Additionally, the name of the firewall rule must be at least 3 characters and no more than 128 characters in length.')
c.argument('start_ip_address', options_list=['--start-ip-address'], help='The start IP address of the firewall rule. Must be IPv4 format. Use value \'0.0.0.0\' to represent all Azure-internal IP addresses.')
c.argument('end_ip_address', options_list=['--end-ip-address'], help='The end IP address of the firewall rule. Must be IPv4 format. Use value \'0.0.0.0\' to represent all Azure-internal IP addresses.')
with self.argument_context('{} server vnet-rule'.format(command_group)) as c:
c.argument('server_name', options_list=['--server-name', '-s'])
c.argument('virtual_network_rule_name', options_list=['--name', '-n'], id_part='child_name_1', help='The name of the vnet rule.')
c.argument('virtual_network_subnet_id', options_list=['--subnet'], help='Name or ID of the subnet that allows access to an Azure Postgres Server. If subnet name is provided, --vnet-name must be provided.')
c.argument('ignore_missing_vnet_service_endpoint', options_list=['--ignore-missing-endpoint', '-i'], help='Create vnet rule before virtual network has vnet service endpoint enabled', arg_type=get_three_state_flag())
with self.argument_context('{} server vnet-rule create'.format(command_group)) as c:
c.extra('vnet_name', options_list=['--vnet-name'], help='The virtual network name', validator=validate_subnet)
with self.argument_context('{} server vnet-rule update'.format(command_group)) as c:
c.extra('vnet_name', options_list=['--vnet-name'], help='The virtual network name',
validator=validate_subnet)
with self.argument_context('{} server configuration'.format(command_group)) as c:
c.argument('server_name', options_list=['--server-name', '-s'])
c.argument('configuration_name', options_list=['--name', '-n'], id_part='child_name_1')
with self.argument_context('{} server replica list'.format(command_group)) as c:
c.argument('server_name', options_list=['--server-name', '-s'], help='Name of the master server.')
for item in ['approve', 'reject', 'delete', 'show']:
with self.argument_context('{} server private-endpoint-connection {}'.format(command_group, item)) as c:
c.argument('private_endpoint_connection_name', options_list=['--name', '-n'], required=False,
help='The name of the private endpoint connection associated with the Server. '
'Required if --id is not specified')
c.extra('connection_id', options_list=['--id'], required=False,
help='The ID of the private endpoint connection associated with the Server. '
'If specified --server-name/-s and --name/-n, this should be omitted.')
c.argument('server_name', options_list=['--server-name', '-s'], required=False,
help='Name of the Server. Required if --id is not specified')
c.argument('resource_group_name', help='The resource group name of specified server.',
required=False)
c.argument('description', help='Comments for {} operation.'.format(item))
with self.argument_context('{} server private-link-resource'.format(command_group)) as c:
c.argument('server_name', options_list=['--server-name', '-s'], required=True, help='Name of the Server.')
with self.argument_context('{} server list-skus'.format(command_group)) as c:
c.argument('location_name', options_list=['--location', '-l'])
with self.argument_context('{} server show-connection-string'.format(command_group)) as c:
c.argument('server_name', options_list=['--server-name', '-s'], arg_type=server_name_arg_type, help='Name of the server.')
c.argument('administrator_login', options_list=['--admin-user', '-u'], arg_type=administrator_login_arg_type,
help='The login username of the administrator.')
c.argument('administrator_login_password', options_list=['--admin-password', '-p'],
help='The login password of the administrator.')
c.argument('database_name', options_list=['--database-name', '-d'], help='The name of a database.')
if command_group != 'mariadb':
with self.argument_context('{} server key'.format(command_group)) as c:
c.argument('server_name', options_list=['--name', '-s'])
c.argument('kid', options_list=['--kid', '-k'], help='The Azure Key Vault key identifier of the server key. An example key identifier is "https://YourVaultName.vault.azure.net/keys/YourKeyName/01234567890123456789012345678901"')
with self.argument_context('{} server ad-admin'.format(command_group)) as c:
c.argument('server_name', options_list=['--server-name', '-s'])
c.argument('login', options_list=['--display-name', '-u'], help='Display name of the Microsoft Entra administrator user or group.')
c.argument('sid', options_list=['--object-id', '-i'], help='The unique ID of the Microsoft Entra administrator.')
if command_group == 'mysql':
with self.argument_context('{} server upgrade'.format(command_group)) as c:
c.argument('target_server_version', options_list=['--target-server-version', '-t'], required=True, help='The server version you want to upgrade your mysql server to, currently only support 5.7.')
_complex_params('mariadb')
_complex_params('mysql')
_complex_params('postgres')
# Flexible-server
# pylint: disable=too-many-locals, too-many-branches
def _flexible_server_params(command_group):
server_name_arg_type = CLIArgumentType(
metavar='NAME',
options_list=['--name', '-n'],
id_part='name',
help="Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.",
local_context_attribute=LocalContextAttribute(
name='server_name',
actions=[LocalContextAction.SET, LocalContextAction.GET],
scopes=['{} flexible-server'.format(command_group)]))
migration_id_arg_type = CLIArgumentType(
metavar='NAME',
help="ID of the migration.",
local_context_attribute=LocalContextAttribute(
name='migration_id',
actions=[LocalContextAction.SET, LocalContextAction.GET],
scopes=['{} flexible-server'.format(command_group)]))
administrator_login_arg_type = CLIArgumentType(
options_list=['--admin-user', '-u'],
arg_group='Authentication',
help='Administrator username for the server. Once set, it cannot be changed. ',
local_context_attribute=LocalContextAttribute(
name='administrator_login',
actions=[LocalContextAction.GET, LocalContextAction.SET],
scopes=['{} flexible-server'.format(command_group)]))
administrator_login_password_arg_type = CLIArgumentType(
options_list=['--admin-password', '-p'],
help='The password of the administrator. Minimum 8 characters and maximum 128 characters. '
'Password must contain characters from three of the following categories: '
'English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters.',
arg_group='Authentication'
)
database_name_arg_type = CLIArgumentType(
metavar='NAME',
options_list=['--database-name', '-d'],
id_part='child_name_1',
help='The name of the database to be created when provisioning the database server',
local_context_attribute=LocalContextAttribute(
name='database_name',
actions=[LocalContextAction.GET, LocalContextAction.SET],
scopes=['{} flexible-server'.format(command_group)]))
tier_arg_type = CLIArgumentType(
options_list=['--tier'],
help='Compute tier of the server. Accepted values: Burstable, GeneralPurpose, MemoryOptimized '
)
sku_name_arg_type = CLIArgumentType(
options_list=['--sku-name'],
help='The name of the compute SKU. Follows the convention Standard_{VM name}. Examples: Standard_B1ms'
)
storage_gb_arg_type = CLIArgumentType(
type=int,
options_list=['--storage-size'],
help='The storage capacity of the server. Minimum is 32 GiB and max is 16 TiB.'
)
pg_backup_retention_arg_type = CLIArgumentType(
type=int,
options_list=['--backup-retention'],
help='The number of days a backup is retained. Range of 7 to 35 days. Default is 7 days.',
validator=retention_validator
)
mysql_backup_retention_arg_type = CLIArgumentType(
type=int,
options_list=['--backup-retention'],
help='The number of days a backup is retained. Range of 1 to 35 days. Default is 7 days.',
)
version_arg_type = CLIArgumentType(
options_list=['--version'],
help='Server major version.'
)
iops_arg_type = CLIArgumentType(
type=int,
options_list=['--iops'],
help='Number of IOPS to be allocated for this server. You will get certain amount of free IOPS based '
'on compute and storage provisioned. The default value for IOPS is free IOPS. '
'To learn more about IOPS based on compute and storage, refer to IOPS in Azure Database for MySQL Flexible Server'
)
iops_v2_arg_type = CLIArgumentType(
type=int,
options_list=['--iops'],
help='Value of IOPS in (operations/sec) to be allocated for this server. '
'This value can only be updated if flexible server is using Premium SSD v2 Disks.'
)
throughput_arg_type = CLIArgumentType(
type=int,
options_list=['--throughput'],
help='Storage throughput in (MB/sec) for the server. '
'This value can only be updated if flexible server is using Premium SSD v2 Disks.'
)
create_default_db_arg_type = CLIArgumentType(
arg_type=get_enum_type(['Enabled', 'Disabled']),
options_list=['--create-default-database', '-c'],
help='Enable or disable the creation of default database flexibleserverdb. Default value is Enabled.'
)
cluster_option_arg_type = CLIArgumentType(
arg_type=get_enum_type(['Server', 'ElasticCluster']),
options_list=['--cluster-option'],
help='Cluster option for the server. Servers are for workloads that can fit on one node. '
'Elastic clusters provides schema- and row-based sharding on a database. Default value is Server.'
)
create_node_count_arg_type = CLIArgumentType(
type=int,
options_list=['--node-count'],
help='The number of nodes for elastic cluster. Range of 1 to 10. Default is 2 nodes.',
validator=node_count_validator
)
update_node_count_arg_type = CLIArgumentType(
type=int,
options_list=['--node-count'],
help='The number of nodes for elastic cluster. Range of 1 to 10.',
validator=node_count_validator
)
auto_grow_arg_type = CLIArgumentType(
arg_type=get_enum_type(['Enabled', 'Disabled']),
options_list=['--storage-auto-grow'],
help='Enable or disable autogrow of the storage. Default value is Enabled.'
)
storage_type_arg_type = CLIArgumentType(
arg_type=get_enum_type(['PremiumV2_LRS', 'Premium_LRS']),
options_list=['--storage-type'],
help='Storage type for the server. Allowed values are Premium_LRS and PremiumV2_LRS. Default value is Premium_LRS.'
'Must set iops and throughput if using PremiumV2_LRS.'
)
storage_type_restore_arg_type = CLIArgumentType(
arg_type=get_enum_type(['PremiumV2_LRS']),
options_list=['--storage-type'],
help='Storage type for the new server. Allowed value is PremiumV2_LRS. Default value is none.'
)
auto_scale_iops_arg_type = CLIArgumentType(
arg_type=get_enum_type(['Enabled', 'Disabled']),
options_list=['--auto-scale-iops'],
help='Enable or disable the auto scale iops. Default value is Disabled.'
)
performance_tier_arg_type = CLIArgumentType(
options_list=['--performance-tier'],
help='Performance tier of the server.'
)
yes_arg_type = CLIArgumentType(
options_list=['--yes', '-y'],
action='store_true',
help='Do not prompt for confirmation.'
)
vnet_arg_type = CLIArgumentType(
options_list=['--vnet'],
help='Name or ID of a new or existing virtual network. '
'If you want to use a vnet from different resource group or subscription, '
'please provide a resource ID. The name must be between 2 to 64 characters. '
'The name must begin with a letter or number, end with a letter, number or underscore, '
'and may contain only letters, numbers, underscores, periods, or hyphens.'
)
vnet_address_prefix_arg_type = CLIArgumentType(
options_list=['--address-prefixes'],
help='The IP address prefix to use when creating a new virtual network in CIDR format. '
'Default value is 10.0.0.0/16.'
)
subnet_arg_type = CLIArgumentType(
options_list=['--subnet'],
help='Name or resource ID of a new or existing subnet. '
'If you want to use a subnet from different resource group or subscription, please provide resource ID instead of name. '
'Please note that the subnet will be delegated to flexibleServers. '
'After delegation, this subnet cannot be used for any other type of Azure resources.'
)
subnet_address_prefix_arg_type = CLIArgumentType(
options_list=['--subnet-prefixes'],
help='The subnet IP address prefix to use when creating a new subnet in CIDR format. Default value is 10.0.0.0/24.'
)
zone_arg_type = CLIArgumentType(
options_list=['--zone', '-z'],
help='Availability zone into which to provision the resource.'
)
public_access_update_arg_type = CLIArgumentType(
options_list=['--public-access'],
arg_type=get_enum_type(['Enabled', 'Disabled']),
help='Enable or disable the public access on a server.'
)
public_access_create_arg_type = CLIArgumentType(
options_list=['--public-access'],
help='Determines the public access. Enter single or range of IP addresses to be included in the allowed list of IPs. '
'IP address ranges must be dash-separated and not contain any spaces. '
'Specifying 0.0.0.0 allows public access from any resources deployed within Azure to access your server. '
'Setting it to "None" sets the server in public access mode but does not create a firewall rule. '
'Acceptable values are \'Disabled\', \'Enabled\', \'All\', \'None\',\'{startIP}\' and '
'\'{startIP}-{destinationIP}\' where startIP and destinationIP ranges from '
'0.0.0.0 to 255.255.255.255. ',
validator=public_access_validator
)
standby_availability_zone_arg_type = CLIArgumentType(
options_list=['--standby-zone'],
help="The availability zone information of the standby server when high availability is enabled."
)
high_availability_arg_type = CLIArgumentType(
arg_type=get_enum_type(['ZoneRedundant', 'SameZone', 'Disabled']),
options_list=['--high-availability'],
help='Enable (ZoneRedundant or SameZone) or disable high availability feature.'
)
mysql_version_upgrade_arg_type = CLIArgumentType(
arg_type=get_enum_type(['8']),
options_list=['--version', '-v'],
help='Server major version.'
)
pg_version_upgrade_arg_type = CLIArgumentType(
arg_type=get_enum_type(['12', '13', '14', '15', '16']),
options_list=['--version', '-v'],
help='Server major version.'
)
private_dns_zone_arguments_arg_type = CLIArgumentType(
options_list=['--private-dns-zone'],
help='This parameter only applies for a server with private access. '
'The name or id of new or existing private dns zone. '
'You can use the private dns zone from same resource group, different resource group, or different subscription. '
'If you want to use a zone from different resource group or subscription, please provide resource Id. '
'CLI creates a new private dns zone within the same resource group as virtual network if not provided by users.'
)
restore_point_in_time_arg_type = CLIArgumentType(
options_list=['--restore-time'],
default=get_current_time(),
help='The point in time in UTC to restore from (ISO8601 format), e.g., 2017-04-26T02:10:00+00:00'
'The default value is set to current time.'
)
source_server_arg_type = CLIArgumentType(
options_list=['--source-server'],
help='The name or resource ID of the source server to restore from.'
)
geo_redundant_backup_arg_type = CLIArgumentType(
options_list=['--geo-redundant-backup'],
arg_type=get_enum_type(['Enabled', 'Disabled']),
help='Whether or not geo redundant backup is enabled.'
)
identity_arg_type = CLIArgumentType(
options_list=['--identity'],
help='The name or resource ID of the user assigned identity for data encryption.',
validator=validate_byok_identity
)
backup_identity_arg_type = CLIArgumentType(
options_list=['--backup-identity'],
help='The name or resource ID of the geo backup user identity for data encryption. The identity needs to be in the same region as the backup region.',
validator=validate_byok_identity
)
key_arg_type = CLIArgumentType(
options_list=['--key'],
help='The resource ID of the primary keyvault key for data encryption.'
)
backup_key_arg_type = CLIArgumentType(
options_list=['--backup-key'],
help='The resource ID of the geo backup keyvault key for data encryption. The key needs to be in the same region as the backup region.'
)
disable_data_encryption_arg_type = CLIArgumentType(
options_list=['--disable-data-encryption'],
arg_type=get_three_state_flag(),
help='Disable data encryption by removing key(s).'
)
identities_arg_type = CLIArgumentType(
options_list=['--identity', '-n'],
nargs='+',
help='Space-separated names or ID\'s of identities.',
validator=validate_identities
)
active_directory_auth_arg_type = CLIArgumentType(
options_list=['--active-directory-auth'],
arg_type=get_enum_type(['Enabled', 'Disabled']),
help='Whether Microsoft Entra authentication is enabled.'
)
password_auth_arg_type = CLIArgumentType(
options_list=['--password-auth'],
arg_type=get_enum_type(['Enabled', 'Disabled']),
help='Whether password authentication is enabled.'
)
gtid_set_arg_type = CLIArgumentType(
options_list=['--gtid-set'],
help='A GTID set is a set comprising one or more single GTIDs or ranges of GTIDs. '
'A GTID is represented as a pair of coordinates, separated by a colon character (:), as shown: source_id:transaction_id'
)
pg_bouncer_arg_type = CLIArgumentType(
options_list=['--pg-bouncer'],
action='store_true',
help='Show connection strings for PgBouncer.'
)
promote_mode_arg_type = CLIArgumentType(
arg_type=get_enum_type(['standalone', 'switchover']),
help='Whether to promote read replica to an independent server or promote it as a primary server.'
)
promote_option_arg_type = CLIArgumentType(
arg_type=get_enum_type(['planned', 'forced']),
help='Whether to sync data before promoting read replica or promote as soon as possible.'
)
virtual_endpoint_arg_type = CLIArgumentType(
metavar='NAME',
options_list=['--name', '-n'],
id_part='name',
help="Name of the virtual endpoint. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.",
local_context_attribute=LocalContextAttribute(
name='virtual_endpoint_name',
actions=[LocalContextAction.SET, LocalContextAction.GET],
scopes=['{} flexible-server'.format(command_group)]))
endpoint_type_arg_type = CLIArgumentType(
options_list=['--endpoint-type', '-t'],
arg_type=get_enum_type(['ReadWrite']),
help='Type of connection point for virtual endpoint.'
)
members_type = CLIArgumentType(
options_list=['--members', '-m'],
help='The read replicas the virtual endpoints point to.'
)
with self.argument_context('{} flexible-server'.format(command_group)) as c:
c.argument('resource_group_name', arg_type=resource_group_name_type)
c.argument('server_name', arg_type=server_name_arg_type)
with self.argument_context('{} flexible-server create'.format(command_group)) as c:
# Add create mode as a parameter
if command_group == 'postgres':
c.argument('tier', default='GeneralPurpose', arg_type=tier_arg_type)
c.argument('sku_name', default='Standard_D2s_v3', arg_type=sku_name_arg_type)
c.argument('storage_gb', default='128', arg_type=storage_gb_arg_type)
c.argument('version', default='16', arg_type=version_arg_type)
c.argument('backup_retention', default=7, arg_type=pg_backup_retention_arg_type)
c.argument('active_directory_auth', default='Disabled', arg_type=active_directory_auth_arg_type)
c.argument('admin_id', options_list=['--admin-object-id', '-i'], help='The unique ID of the Microsoft Entra administrator.')
c.argument('admin_name', options_list=['--admin-display-name', '-m'], help='Display name of the Microsoft Entra administrator user or group.')
c.argument('admin_type', options_list=['--admin-type', '-t'],
arg_type=get_enum_type(['User', 'Group', 'ServicePrincipal', 'Unknown']), help='Type of the Microsoft Entra administrator.')
c.argument('password_auth', default='Enabled', arg_type=password_auth_arg_type)
c.argument('auto_grow', default='Disabled', arg_type=auto_grow_arg_type)
c.argument('storage_type', default=None, arg_type=storage_type_arg_type)
c.argument('iops', default=None, arg_type=iops_v2_arg_type)
c.argument('throughput', default=None, arg_type=throughput_arg_type)
c.argument('performance_tier', default=None, arg_type=performance_tier_arg_type)
c.argument('create_default_db', default='Enabled', arg_type=create_default_db_arg_type)
c.argument('create_cluster', default='Server', arg_type=cluster_option_arg_type)
c.argument('cluster_size', default=None, arg_type=create_node_count_arg_type)
elif command_group == 'mysql':
c.argument('tier', default='Burstable', arg_type=tier_arg_type)
c.argument('sku_name', default='Standard_B1ms', arg_type=sku_name_arg_type)
c.argument('storage_gb', default='32', arg_type=storage_gb_arg_type)
c.argument('version', default='5.7', arg_type=version_arg_type)
c.argument('iops', arg_type=iops_arg_type)
c.argument('auto_grow', default='Enabled', arg_type=auto_grow_arg_type)
c.argument('auto_scale_iops', default='Disabled', arg_type=auto_scale_iops_arg_type)
c.argument('backup_retention', default=7, arg_type=mysql_backup_retention_arg_type)
c.argument('byok_identity', arg_type=identity_arg_type)
c.argument('byok_key', arg_type=key_arg_type)
c.argument('backup_byok_identity', arg_type=backup_identity_arg_type)
c.argument('backup_byok_key', arg_type=backup_key_arg_type)
c.argument('geo_redundant_backup', default='Disabled', arg_type=geo_redundant_backup_arg_type)
c.argument('location', arg_type=get_location_type(self.cli_ctx))
c.argument('administrator_login', default=generate_username(), arg_type=administrator_login_arg_type)
c.argument('administrator_login_password', arg_type=administrator_login_password_arg_type)
c.argument('high_availability', arg_type=high_availability_arg_type, default="Disabled")
c.argument('public_access', arg_type=public_access_create_arg_type)
c.argument('vnet', arg_type=vnet_arg_type)
c.argument('vnet_address_prefix', arg_type=vnet_address_prefix_arg_type)
c.argument('subnet', arg_type=subnet_arg_type)
c.argument('subnet_address_prefix', arg_type=subnet_address_prefix_arg_type)
c.argument('private_dns_zone_arguments', private_dns_zone_arguments_arg_type)
c.argument('zone', zone_arg_type)
c.argument('tags', tags_type)
c.argument('standby_availability_zone', arg_type=standby_availability_zone_arg_type)
c.argument('database_name', arg_type=database_name_arg_type)
c.argument('yes', arg_type=yes_arg_type)
with self.argument_context('{} flexible-server list'.format(command_group)) as c:
c.argument('show_cluster', options_list=['--show-cluster'], required=False, action='store_true',
help='Only show elastic clusters.')
with self.argument_context('{} flexible-server delete'.format(command_group)) as c:
c.argument('yes', arg_type=yes_arg_type)
with self.argument_context('{} flexible-server restore'.format(command_group)) as c:
c.argument('restore_point_in_time', arg_type=restore_point_in_time_arg_type)
c.argument('source_server', arg_type=source_server_arg_type)
c.argument('vnet', arg_type=vnet_arg_type)
c.argument('vnet_address_prefix', arg_type=vnet_address_prefix_arg_type)
c.argument('subnet', arg_type=subnet_arg_type)
c.argument('subnet_address_prefix', arg_type=subnet_address_prefix_arg_type)
c.argument('private_dns_zone_arguments', private_dns_zone_arguments_arg_type)
c.argument('zone', arg_type=zone_arg_type)
c.argument('yes', arg_type=yes_arg_type)
if command_group == 'mysql':
c.argument('sku_name', arg_type=sku_name_arg_type)
c.argument('tier', arg_type=tier_arg_type)
c.argument('storage_gb', arg_type=storage_gb_arg_type)
c.argument('auto_grow', arg_type=auto_grow_arg_type)
c.argument('backup_retention', arg_type=mysql_backup_retention_arg_type)
c.argument('geo_redundant_backup', arg_type=geo_redundant_backup_arg_type)
c.argument('public_access', options_list=['--public-access'], arg_type=get_enum_type(['Enabled', 'Disabled']),
help='Determines the public access. ')
elif command_group == 'postgres':
c.argument('byok_key', arg_type=key_arg_type)
c.argument('byok_identity', arg_type=identity_arg_type)
c.argument('geo_redundant_backup', default='Disabled', arg_type=geo_redundant_backup_arg_type)
c.argument('backup_byok_identity', arg_type=backup_identity_arg_type)
c.argument('backup_byok_key', arg_type=backup_key_arg_type)
c.argument('storage_type', default=None, arg_type=storage_type_restore_arg_type)
with self.argument_context('{} flexible-server geo-restore'. format(command_group)) as c:
c.argument('location', arg_type=get_location_type(self.cli_ctx), required=True)
c.argument('sku_name', arg_type=sku_name_arg_type)
c.argument('source_server', arg_type=source_server_arg_type)
c.argument('vnet', arg_type=vnet_arg_type)
c.argument('vnet_address_prefix', arg_type=vnet_address_prefix_arg_type)
c.argument('subnet', arg_type=subnet_arg_type)
c.argument('subnet_address_prefix', arg_type=subnet_address_prefix_arg_type)
c.argument('private_dns_zone_arguments', private_dns_zone_arguments_arg_type)
c.argument('zone', arg_type=zone_arg_type)
c.argument('yes', arg_type=yes_arg_type)
if command_group == 'mysql':
c.argument('sku_name', arg_type=sku_name_arg_type)
c.argument('tier', arg_type=tier_arg_type)
c.argument('storage_gb', arg_type=storage_gb_arg_type)
c.argument('auto_grow', arg_type=auto_grow_arg_type)
c.argument('backup_retention', arg_type=mysql_backup_retention_arg_type)
c.argument('geo_redundant_backup', arg_type=geo_redundant_backup_arg_type)
c.argument('public_access', options_list=['--public-access'], arg_type=get_enum_type(['Enabled', 'Disabled']),
help='Determines the public access. ')
elif command_group == 'postgres':
c.argument('restore_point_in_time', arg_type=restore_point_in_time_arg_type)
c.argument('geo_redundant_backup', default='Disabled', arg_type=geo_redundant_backup_arg_type)
c.argument('byok_key', arg_type=key_arg_type)
c.argument('byok_identity', arg_type=identity_arg_type)
c.argument('backup_byok_identity', arg_type=backup_identity_arg_type)
c.argument('backup_byok_key', arg_type=backup_key_arg_type)
with self.argument_context('{} flexible-server revive-dropped'. format(command_group)) as c:
c.argument('location', arg_type=get_location_type(self.cli_ctx), required=True)
c.argument('sku_name', arg_type=sku_name_arg_type)
c.argument('source_server', arg_type=source_server_arg_type)
c.argument('vnet', arg_type=vnet_arg_type)
c.argument('vnet_address_prefix', arg_type=vnet_address_prefix_arg_type)
c.argument('subnet', arg_type=subnet_arg_type)
c.argument('subnet_address_prefix', arg_type=subnet_address_prefix_arg_type)
c.argument('private_dns_zone_arguments', private_dns_zone_arguments_arg_type)
c.argument('zone', arg_type=zone_arg_type)
c.argument('yes', arg_type=yes_arg_type)
c.argument('geo_redundant_backup', default='Disabled', arg_type=geo_redundant_backup_arg_type)
c.argument('byok_key', arg_type=key_arg_type)
c.argument('byok_identity', arg_type=identity_arg_type)
c.argument('backup_byok_identity', arg_type=backup_identity_arg_type)
c.argument('backup_byok_key', arg_type=backup_key_arg_type)
with self.argument_context('{} flexible-server update'.format(command_group)) as c:
c.argument('administrator_login_password', arg_type=administrator_login_password_arg_type)
c.argument('maintenance_window', options_list=['--maintenance-window'], validator=maintenance_window_validator,
help='Period of time (UTC) designated for maintenance. Examples: "Sun:23:30" to schedule on Sunday, 11:30pm UTC. To set back to default pass in "Disabled".')
c.argument('tags', tags_type)
c.argument('tier', arg_type=tier_arg_type)
c.argument('sku_name', arg_type=sku_name_arg_type)
c.argument('storage_gb', arg_type=storage_gb_arg_type)
c.argument('standby_availability_zone', arg_type=standby_availability_zone_arg_type)
c.argument('high_availability', arg_type=high_availability_arg_type)
c.argument('byok_key', arg_type=key_arg_type)
c.argument('byok_identity', arg_type=identity_arg_type)
c.argument('backup_byok_identity', arg_type=backup_identity_arg_type)
c.argument('backup_byok_key', arg_type=backup_key_arg_type)
c.argument('public_access', arg_type=public_access_update_arg_type)
if command_group == 'mysql':
c.argument('auto_grow', arg_type=auto_grow_arg_type)
c.argument('auto_scale_iops', arg_type=auto_scale_iops_arg_type)
c.argument('replication_role', options_list=['--replication-role'],
help='The replication role of the server.')
c.argument('iops', arg_type=iops_arg_type)
c.argument('backup_retention', arg_type=mysql_backup_retention_arg_type)
c.argument('geo_redundant_backup', arg_type=geo_redundant_backup_arg_type)
c.argument('disable_data_encryption', arg_type=disable_data_encryption_arg_type)
elif command_group == 'postgres':
c.argument('auto_grow', arg_type=auto_grow_arg_type)
c.argument('performance_tier', default=None, arg_type=performance_tier_arg_type)
c.argument('iops', default=None, arg_type=iops_v2_arg_type)
c.argument('throughput', default=None, arg_type=throughput_arg_type)
c.argument('backup_retention', arg_type=pg_backup_retention_arg_type)
c.argument('active_directory_auth', arg_type=active_directory_auth_arg_type)
c.argument('password_auth', arg_type=password_auth_arg_type)
c.argument('private_dns_zone_arguments', private_dns_zone_arguments_arg_type)
c.argument('cluster_size', default=None, arg_type=update_node_count_arg_type)
c.argument('yes', arg_type=yes_arg_type)
with self.argument_context('{} flexible-server upgrade'.format(command_group)) as c:
c.argument('version', arg_type=mysql_version_upgrade_arg_type if command_group == 'mysql' else pg_version_upgrade_arg_type)
c.argument('yes', arg_type=yes_arg_type)
with self.argument_context('{} flexible-server restart'.format(command_group)) as c:
if command_group == 'postgres':
c.argument('fail_over', options_list=['--failover'],
help='Forced or planned failover for server restart operation. Allowed values: Forced, Planned')
elif command_group == 'mysql':
c.argument('fail_over', options_list=['--failover'],
help='Forced failover for server restart operation. Allowed values: Forced')
with self.argument_context('{} flexible-server list-skus'.format(command_group)) as c:
c.argument('location', arg_type=get_location_type(self.cli_ctx))
# flexible-server parameter
for scope in ['list', 'set', 'show']:
argument_context_string = '{} flexible-server parameter {}'.format(command_group, scope)
with self.argument_context(argument_context_string) as c:
if scope == "list":
c.argument('server_name', options_list=['--server-name', '-s'], id_part=None, arg_type=server_name_arg_type)
else:
c.argument('server_name', options_list=['--server-name', '-s'], arg_type=server_name_arg_type)
for scope in ['show', 'set']:
argument_context_string = '{} flexible-server parameter {}'.format(command_group, scope)
with self.argument_context(argument_context_string) as c:
c.argument('configuration_name', id_part='child_name_1', options_list=['--name', '-n'], required=True,
help='The name of the server configuration')
with self.argument_context('{} flexible-server parameter set'.format(command_group)) as c:
c.argument('value', options_list=['--value', '-v'],
help='Value of the configuration.')
c.argument('source', options_list=['--source'],
help='Source of the configuration.')
# firewall-rule
for scope in ['create', 'delete', 'list', 'show', 'update']:
argument_context_string = '{} flexible-server firewall-rule {}'.format(command_group, scope)
with self.argument_context(argument_context_string) as c:
c.argument('resource_group_name', arg_type=resource_group_name_type)
if scope == "list":
c.argument('server_name', id_part=None, arg_type=server_name_arg_type)
else:
c.argument('server_name', id_part='name', arg_type=server_name_arg_type)
for scope in ['create', 'delete', 'show', 'update']:
argument_context_string = '{} flexible-server firewall-rule {}'.format(command_group, scope)
with self.argument_context(argument_context_string) as c:
c.argument('firewall_rule_name', id_part='child_name_1', options_list=['--rule-name', '-r'], validator=postgres_firewall_rule_name_validator,
help='The name of the firewall rule. If name is omitted, default name will be chosen for firewall name. The firewall rule name can only contain 0-9, a-z, A-Z, \'-\' and \'_\'. Additionally, the name of the firewall rule must be at least 3 characters and no more than 128 characters in length. ')
c.argument('end_ip_address', options_list=['--end-ip-address'], validator=ip_address_validator,
help='The end IP address of the firewall rule. Must be IPv4 format. Use value \'0.0.0.0\' to represent all Azure-internal IP addresses. ')
c.argument('start_ip_address', options_list=['--start-ip-address'], validator=ip_address_validator,
help='The start IP address of the firewall rule. Must be IPv4 format. Use value \'0.0.0.0\' to represent all Azure-internal IP addresses. ')
with self.argument_context('{} flexible-server firewall-rule delete'.format(command_group)) as c:
c.argument('yes', arg_type=yes_arg_type)
# db
for scope in ['create', 'delete', 'list', 'show', 'update']:
argument_context_string = '{} flexible-server db {}'.format(command_group, scope)
with self.argument_context(argument_context_string) as c:
c.argument('server_name', options_list=['--server-name', '-s'], arg_type=server_name_arg_type)
c.argument('database_name', arg_type=database_name_arg_type)
with self.argument_context('{} flexible-server db list'.format(command_group)) as c:
c.argument('server_name', id_part=None, options_list=['--server-name', '-s'], arg_type=server_name_arg_type)
with self.argument_context('{} flexible-server db create'.format(command_group)) as c:
c.argument('charset', help='The charset of the database. The default value is UTF8')
c.argument('collation', help='The collation of the database.')
with self.argument_context('{} flexible-server db delete'.format(command_group)) as c:
c.argument('yes', arg_type=yes_arg_type)
with self.argument_context('{} flexible-server show-connection-string'.format(command_group)) as c:
c.argument('server_name', options_list=['--server-name', '-s'], arg_type=server_name_arg_type)
c.argument('administrator_login', arg_type=administrator_login_arg_type,)
c.argument('administrator_login_password', arg_type=administrator_login_password_arg_type)
c.argument('database_name', arg_type=database_name_arg_type)
c.argument('show_pg_bouncer', arg_type=pg_bouncer_arg_type)
# virtual-endpoint
for scope in ['create', 'delete', 'list', 'show', 'update']:
argument_context_string = '{} flexible-server virtual-endpoint {}'.format(command_group, scope)
with self.argument_context(argument_context_string) as c:
c.argument('resource_group_name', arg_type=resource_group_name_type)
c.argument('server_name', options_list=['--server-name', '-s'], arg_type=server_name_arg_type)
c.argument('virtual_endpoint_name', options_list=['--name', '-n'], arg_type=virtual_endpoint_arg_type, validator=virtual_endpoint_name_validator)
with self.argument_context('{} flexible-server long-term-retention list'.format(command_group)) as c:
c.argument('server_name', id_part=None, arg_type=server_name_arg_type)
with self.argument_context('{} flexible-server long-term-retention show'.format(command_group)) as c:
c.argument('backup_name', options_list=['--backup-name', '-b'], help='Backup name.')
c.argument('server_name', id_part=None, arg_type=server_name_arg_type)
with self.argument_context('{} flexible-server long-term-retention start'.format(command_group)) as c:
c.argument('backup_name', options_list=['--backup-name', '-b'], help='The name of the new long-term-retention backup.')
c.argument('server_name', id_part=None, arg_type=server_name_arg_type)
c.argument('sas_url', options_list=['--sas-url', '-u'], help='Container SAS URL.')
with self.argument_context('{} flexible-server long-term-retention pre-check'.format(command_group)) as c:
c.argument('backup_name', options_list=['--backup-name', '-b'], help='The name of the new long-term-retention backup.')
c.argument('server_name', id_part=None, arg_type=server_name_arg_type)
for scope in ['create', 'update']:
argument_context_string = '{} flexible-server virtual-endpoint {}'.format(command_group, scope)
with self.argument_context(argument_context_string) as c:
c.argument('endpoint_type', options_list=['--endpoint-type', '-t'], arg_type=endpoint_type_arg_type,
help='Virtual Endpoints offer two distinct types of connection points. Writer endpoint (Read/Write), this endpoint always points to the current primary server. Read-only endpoint, This endpoint can point to either a read replica or primary server. ')
c.argument('members', options_list=['--members', '-m'], arg_type=members_type,
help='The read replicas the virtual endpoints point to. ')
with self.argument_context('{} flexible-server virtual-endpoint delete'.format(command_group)) as c:
c.argument('yes', arg_type=yes_arg_type)
with self.argument_context('{} flexible-server replica list'.format(command_group)) as c:
c.argument('server_name', id_part=None, options_list=['--name', '-n'], help='Name of the source server.')
with self.argument_context('{} flexible-server replica create'.format(command_group)) as c:
c.argument('source_server', arg_type=source_server_arg_type)
c.argument('replica_name', options_list=['--replica-name'],
help='The name of the server to restore to.')
c.argument('zone', arg_type=zone_arg_type)
c.argument('location', arg_type=get_location_type(self.cli_ctx))
c.argument('vnet', arg_type=vnet_arg_type)
c.argument('subnet', arg_type=subnet_arg_type)
c.argument('private_dns_zone_arguments', private_dns_zone_arguments_arg_type)
if command_group == 'postgres':
c.argument('vnet_address_prefix', arg_type=vnet_address_prefix_arg_type)
c.argument('subnet_address_prefix', arg_type=subnet_address_prefix_arg_type)
c.argument('byok_key', arg_type=key_arg_type)
c.argument('byok_identity', arg_type=identity_arg_type)
c.argument('tier', arg_type=tier_arg_type)
c.argument('sku_name', arg_type=sku_name_arg_type)
c.argument('storage_gb', arg_type=storage_gb_arg_type)
c.argument('performance_tier', default=None, arg_type=performance_tier_arg_type)
c.argument('yes', arg_type=yes_arg_type)
c.argument('tags', arg_type=tags_type)
if command_group == 'mysql':
c.argument('public_access', options_list=['--public-access'], arg_type=get_enum_type(['Enabled', 'Disabled']),
help='Determines the public access. ')
with self.argument_context('{} flexible-server replica promote'.format(command_group)) as c:
c.argument('server_name', arg_type=server_name_arg_type)
c.argument('promote_mode', options_list=['--promote-mode'], required=False, arg_type=promote_mode_arg_type)
c.argument('promote_option', options_list=['--promote-option'], required=False, arg_type=promote_option_arg_type)
c.argument('yes', arg_type=yes_arg_type)
with self.argument_context('{} flexible-server deploy setup'.format(command_group)) as c:
c.argument('resource_group_name', arg_type=resource_group_name_type)
c.argument('server_name', options_list=['--server-name', '-s'], arg_type=server_name_arg_type)
c.argument('database_name', arg_type=database_name_arg_type)
c.argument('administrator_login', arg_type=administrator_login_arg_type)
c.argument('administrator_login_password', arg_type=administrator_login_password_arg_type)
c.argument('sql_file_path', options_list=['--sql-file'], help='The path of the sql file. The sql file should be already in the repository')
c.argument('action_name', options_list=['--action-name'], help='The name of the github action')
c.argument('repository', options_list=['--repo'], help='The name of your github username and repository e.g., Azure/azure-cli ')
c.argument('branch', options_list=['--branch'], help='The name of the branch you want upload github action file. The default will be your current branch.')
c.argument('allow_push', default=False, options_list=['--allow-push'], arg_type=get_three_state_flag(), help='Push the action yml file to the remote repository. The changes will be pushed to origin repository, speicified branch or current branch if not specified.')
with self.argument_context('{} flexible-server deploy run'.format(command_group)) as c:
c.argument('action_name', options_list=['--action-name'], help='The name of the github action')
c.argument('branch', options_list=['--branch'], help='The name of the branch you want upload github action file. The default will be your current branch.')
# logs
if command_group == 'mysql':
with self.argument_context('{} flexible-server server-logs download'.format(command_group)) as c:
c.argument('server_name', id_part=None, options_list=['--server-name', '-s'], arg_type=server_name_arg_type)
c.argument('file_name', options_list=['--name', '-n'], nargs='+', help='Space-separated list of log filenames on the server to download.')
with self.argument_context('{} flexible-server server-logs list'.format(command_group)) as c:
c.argument('server_name', id_part=None, options_list=['--server-name', '-s'], arg_type=server_name_arg_type)
c.argument('filename_contains', help='The pattern that file name should match.')
c.argument('file_last_written', type=int, help='Integer in hours to indicate file last modify time.', default=72)
c.argument('max_file_size', type=int, help='The file size limitation to filter files.')
# backups
if command_group != 'mariadb':
with self.argument_context('{} flexible-server backup create'.format(command_group)) as c:
c.argument('backup_name', options_list=['--backup-name', '-b'], help='The name of the new backup.')
with self.argument_context('{} flexible-server backup show'.format(command_group)) as c:
c.argument('backup_name', id_part='child_name_1', options_list=['--backup-name', '-b'], help='The name of the backup.')
with self.argument_context('{} flexible-server backup list'.format(command_group)) as c:
c.argument('server_name', id_part=None, arg_type=server_name_arg_type)
if command_group == 'postgres':
with self.argument_context('{} flexible-server backup delete'.format(command_group)) as c:
c.argument('backup_name', options_list=['--backup-name', '-b'], help='The name of the new backup.')
c.argument('yes', arg_type=yes_arg_type)
# identity
with self.argument_context('{} flexible-server identity'.format(command_group)) as c:
c.argument('server_name', id_part=None, options_list=['--server-name', '-s'], arg_type=server_name_arg_type)
for scope in ['assign', 'remove']:
with self.argument_context('{} flexible-server identity'.format(command_group)) as c:
c.argument('identities', arg_type=identities_arg_type)
with self.argument_context('{} flexible-server identity show'.format(command_group)) as c:
c.argument('identity', options_list=['--identity', '-n'], help='Name or ID of identity to show.', validator=validate_identity)
if command_group == 'postgres':
with self.argument_context('{} flexible-server identity update'.format(command_group)) as c:
c.argument('system_assigned', options_list=['--system-assigned'], arg_type=get_enum_type(['Enabled', 'Disabled']),
help='Enable or disable system assigned identity to authenticate to cloud services without storing credentials in code. Default is `Disabled`.')
# fabric mirroring
if command_group == 'postgres':
for scope in ['start', 'stop', 'update-databases']:
with self.argument_context('{} flexible-server fabric-mirroring'.format(command_group)) as c:
c.argument('server_name', id_part=None, options_list=['--server-name', '-s'], arg_type=server_name_arg_type)
c.argument('yes', arg_type=yes_arg_type)
for scope in ['start', 'update-databases']:
with self.argument_context('{} flexible-server fabric-mirroring'.format(command_group)) as c:
c.argument('database_names', options_list=['--database-names', '-d'], nargs='+',
help='Space-separated list of the database names to be mirrored. Required if --mirroring is enabled.')
# ad-admin
with self.argument_context('{} flexible-server ad-admin'.format(command_group)) as c:
c.argument('server_name', id_part=None, options_list=['--server-name', '-s'], arg_type=server_name_arg_type)
for scope in ['create', 'show', 'delete', 'wait']:
with self.argument_context('{} flexible-server ad-admin {}'.format(command_group, scope)) as c:
c.argument('sid', options_list=['--object-id', '-i'], help='The unique ID of the Microsoft Entra administrator.')
with self.argument_context('{} flexible-server ad-admin create'.format(command_group)) as c:
c.argument('login', options_list=['--display-name', '-u'], help='Display name of the Microsoft Entra administrator user or group.')
c.argument('principal_type', options_list=['--type', '-t'], default='User', arg_type=get_enum_type(['User', 'Group', 'ServicePrincipal', 'Unknown']), help='Type of the Microsoft Entra administrator.')
c.argument('identity', help='Name or ID of identity used for AAD Authentication.', validator=validate_identity)
# server advanced threat protection settings
for scope in ['update', 'show']:
argument_context_string = '{} flexible-server advanced-threat-protection-setting {}'.format(command_group, scope)
with self.argument_context(argument_context_string) as c:
c.argument('resource_group_name', arg_type=resource_group_name_type)
c.argument('server_name', id_part='name', options_list=['--server-name', '-s'], arg_type=server_name_arg_type)
with self.argument_context('{} flexible-server advanced-threat-protection-setting update'.format(command_group)) as c:
c.argument('state',
options_list=['--state'],