Skip to content

Commit ad7747c

Browse files
committed
Add breaking change text for re purpose of args
1 parent 11568f4 commit ad7747c

File tree

5 files changed

+76
-19
lines changed

5 files changed

+76
-19
lines changed

src/azure-cli/azure/cli/command_modules/rdbms/_breaking_change.py

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,64 @@
33
# Licensed under the MIT License. See License.txt in the project root for license information.
44
# --------------------------------------------------------------------------------------------
55

6-
from azure.cli.core.breaking_change import register_argument_deprecate, register_command_group_deprecate
6+
from azure.cli.core.breaking_change import (register_argument_deprecate, register_command_group_deprecate,
7+
register_other_breaking_change)
78

9+
# High availability command argument changes
810
register_argument_deprecate('postgres flexible-server create', '--high-availability', redirect='--zonal-resiliency')
911
register_argument_deprecate('postgres flexible-server update', '--high-availability', redirect='--zonal-resiliency')
12+
13+
# Index Tuning command argument changes
1014
register_command_group_deprecate(command_group='postgres flexible-server index-tuning',
1115
redirect='postgres flexible-server autonomous-tuning',
1216
message='Index tuning feature has now expanded its capabilities to support '
1317
'other automatically generated recommendations which are covered by the '
1418
'new command.')
19+
20+
# LTR command argument changes
21+
register_other_breaking_change('postgres flexible-server long-term-retention',
22+
message='The --backup-name/-b argument has been deprecated and will be removed '
23+
'in next breaking change release(2.86.0) scheduled for May 2026.')
24+
register_other_breaking_change('postgres flexible-server long-term-retention',
25+
message='The --name/-n argument will be repurposed to specify the backup name. '
26+
'The --server-name/-s argument will be introduced to specify the server name '
27+
'in next breaking change release(2.86.0) scheduled for May 2026.')
28+
29+
# Backup command argument changes
30+
register_other_breaking_change('postgres flexible-server backup',
31+
message='The --backup-name/-b argument has been deprecated and will be removed '
32+
'in next breaking change release(2.86.0) scheduled for May 2026.')
33+
register_other_breaking_change('postgres flexible-server backup',
34+
message='The --name/-n argument will be repurposed to specify the backup name. '
35+
'The --server-name/-s argument will be introduced to specify the server name '
36+
'in next breaking change release(2.86.0) scheduled for May 2026.')
37+
38+
# Database command argument changes
39+
register_other_breaking_change('postgres flexible-server db',
40+
message='The --database-name/-d argument has been deprecated and will be removed '
41+
'in next breaking change release(2.86.0) scheduled for May 2026.')
42+
register_other_breaking_change('postgres flexible-server db',
43+
message='The --name/-n argument will be repurposed to specify the database name. '
44+
'The --server-name/-s argument will be introduced to specify the server name '
45+
'in next breaking change release(2.86.0) scheduled for May 2026.')
46+
47+
# Firewall rule command argument changes
48+
register_other_breaking_change('postgres flexible-server firewall-rule',
49+
message='The --name/-n argument will be repurposed to specify the firewall rule '
50+
'name. The --server-name/-s argument will be introduced to specify the server '
51+
'name in next breaking change release(2.86.0) scheduled for May 2026.')
52+
register_other_breaking_change('postgres flexible-server firewall-rule',
53+
message='The --rule-name/-r argument has been deprecated and will be removed '
54+
'in next breaking change release(2.86.0) scheduled for May 2026.')
55+
56+
# Migration command argument changes
57+
register_other_breaking_change('postgres flexible-server migration',
58+
message='The --migration-name argument has been deprecated and will be removed '
59+
'in next breaking change release(2.86.0) scheduled for May 2026.')
60+
register_other_breaking_change('postgres flexible-server migration',
61+
message='The --name/-n argument will be repurposed to specify the migration name. '
62+
'The --server-name/-s argument will be introduced to specify the server name '
63+
'in next breaking change release(2.86.0) scheduled for May 2026.')
64+
65+
# Replica command argument changes
66+
register_argument_deprecate('postgres flexible-server replica create', '--replica-name', redirect='--name')

src/azure-cli/azure/cli/command_modules/rdbms/_helptext_pg.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -822,10 +822,10 @@
822822
short-summary: Create a read replica for a server.
823823
examples:
824824
- name: Create a read replica 'testreplicaserver' for 'testserver' with public or private access in the specified zone and location if available.
825-
text: az postgres flexible-server replica create --replica-name testreplicaserver -g testGroup --source-server testserver --zone 3 --location testLocation
825+
text: az postgres flexible-server replica create --name testreplicaserver -g testGroup --source-server testserver --zone 3 --location testLocation
826826
- name: Create a read replica 'testreplicaserver' with new subnet for 'testserver' with private access.
827827
text: >
828-
az postgres flexible-server replica create --replica-name testreplicaserver -g testGroup \\
828+
az postgres flexible-server replica create --name testreplicaserver -g testGroup \\
829829
--source-server testserver --zone 3 --location testLocation \\
830830
--vnet newVnet --subnet newSubnet \\
831831
--address-prefixes 172.0.0.0/16 --subnet-prefixes 172.0.0.0/24 \\
@@ -836,13 +836,13 @@
836836
in the specified location if available. Since zone is not passed, it will automatically pick up zone in the \
837837
replica location which is different from source server, if available, else will pick up zone same as source server \
838838
in the replica location if available, else will set the zone as None, i.e. No preference
839-
text: az postgres flexible-server replica create --replica-name testreplicaserver -g testGroup --source-server testserver --location testLocation
839+
text: az postgres flexible-server replica create --name testreplicaserver -g testGroup --source-server testserver --location testLocation
840840
- name: Create a read replica 'testreplicaserver' for 'testserver' with custom --storage-size and --sku.
841-
text: az postgres flexible-server replica create --replica-name testreplicaserver -g testGroup --source-server testserver --sku-name Standard_D4ds_v5 --storage-size 256
841+
text: az postgres flexible-server replica create --name testreplicaserver -g testGroup --source-server testserver --sku-name Standard_D4ds_v5 --storage-size 256
842842
- name: Create a read replica 'testreplicaserver' for 'testserver', where 'testreplicaserver' is in a different resource group 'newTestGroup'. \
843843
Here --resource-group is for the read replica's resource group, and --source-server must be passed as resource ID.
844844
text: >
845-
az postgres flexible-server replica create --replica-name testreplicaserver -g newTestGroup \
845+
az postgres flexible-server replica create --name testreplicaserver -g newTestGroup \
846846
--source-server /subscriptions/{sourceSubscriptionId}/resourceGroups/{sourceResourceGroup}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{sourceServerName} --location testLocation
847847
"""
848848

src/azure-cli/azure/cli/command_modules/rdbms/_params.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -897,6 +897,8 @@ def _flexible_server_params(command_group):
897897
c.argument('source_server', arg_type=source_server_arg_type)
898898
c.argument('replica_name', options_list=['--replica-name'],
899899
help='The name of the server to restore to.')
900+
c.argument('name', options_list=['--name', '-n'],
901+
help='The name of the read replica.')
900902
c.argument('zone', arg_type=zone_arg_type)
901903
c.argument('location', arg_type=get_location_type(self.cli_ctx))
902904
c.argument('vnet', arg_type=vnet_arg_type)

src/azure-cli/azure/cli/command_modules/rdbms/flexible_server_custom_postgres.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -590,14 +590,17 @@ def flexible_replica_list_by_server(cmd, client, resource_group_name, server_nam
590590
return client.list_by_server(resource_group_name, server_name)
591591

592592

593-
def flexible_replica_create(cmd, client, resource_group_name, source_server, replica_name, zone=None,
593+
def flexible_replica_create(cmd, client, resource_group_name, source_server, replica_name=None, name=None, zone=None,
594594
location=None, vnet=None, vnet_address_prefix=None, subnet=None,
595595
subnet_address_prefix=None, private_dns_zone_arguments=None, no_wait=False,
596596
byok_identity=None, byok_key=None,
597597
sku_name=None, tier=None,
598598
storage_gb=None, performance_tier=None, yes=False, tags=None):
599599
validate_resource_group(resource_group_name)
600-
replica_name = replica_name.lower()
600+
601+
if replica_name is None and name is None:
602+
raise RequiredArgumentMissingError('the following arguments are required: --name')
603+
replica_name = replica_name.lower() if name is None else name.lower()
601604

602605
if not is_valid_resource_id(source_server):
603606
if _is_resource_name(source_server):

src/azure-cli/azure/cli/command_modules/rdbms/tests/latest/test_rdbms_flexible_commands.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -237,12 +237,12 @@ def _test_flexible_server_mgmt_empty_rg_name_return_error(self, database_engine)
237237
--public-access None'.format(database_engine, random_rg_name, server_name, backup_retention,
238238
sku_name, tier, storage_size, 'dbadmin', version, ha_value))
239239

240-
self.cmd('postgres flexible-server replica create -g "" --replica-name {} --source-server {}'.format(
240+
self.cmd('postgres flexible-server replica create -g "" --name {} --source-server {}'.format(
241241
replica_1_name,
242242
server_name
243243
), expect_failure=True)
244244

245-
self.cmd('postgres flexible-server replica create -g \'\' --replica-name {} --source-server {}'.format(
245+
self.cmd('postgres flexible-server replica create -g \'\' --name {} --source-server {}'.format(
246246
replica_1_name,
247247
server_name
248248
), expect_failure=True)
@@ -420,7 +420,7 @@ def _test_flexible_server_ssdv2_mgmt(self, database_engine, resource_group):
420420
expect_failure=True)
421421

422422
replica_name = 'rep-ssdv2-' + server_name
423-
self.cmd('{} flexible-server replica create -g {} --replica-name {} --source-server {}'
423+
self.cmd('{} flexible-server replica create -g {} --name {} --source-server {}'
424424
.format(database_engine, resource_group, replica_name, basic_info['id']),
425425
expect_failure=True)
426426

@@ -739,7 +739,7 @@ def main_tests(geo_redundant_backup):
739739
# create replica 1 with data encryption
740740
replica_1_name = self.create_random_name(SERVER_NAME_PREFIX, SERVER_NAME_MAX_LENGTH)
741741

742-
self.cmd('postgres flexible-server replica create -g {} --replica-name {} --source-server {} --key {} --identity {}'.format(
742+
self.cmd('postgres flexible-server replica create -g {} --name {} --source-server {} --key {} --identity {}'.format(
743743
resource_group,
744744
replica_1_name,
745745
primary_server_name,
@@ -1284,7 +1284,7 @@ def _test_flexible_server_replica_validator(self, database_engine, resource_grou
12841284
JMESPathCheck('storage.autoGrow', source_server_auto_grow)]).get_output_in_json()
12851285

12861286
# test replica create
1287-
self.cmd('{} flexible-server replica create -g {} --replica-name {} --source-server {} --zone 2 {}'
1287+
self.cmd('{} flexible-server replica create -g {} --name {} --source-server {} --zone 2 {}'
12881288
.format(database_engine, resource_group, replicas[0], result['id'], public_access_arg),
12891289
checks=[
12901290
JMESPathCheck('name', replicas[0]),
@@ -1329,7 +1329,7 @@ def _test_flexible_server_replica_mgmt(self, database_engine, resource_group, vn
13291329
checks=[JMESPathCheck('replica.role', primary_role)] + master_vnet_check).get_output_in_json()
13301330

13311331
# test replica create
1332-
self.cmd('{} flexible-server replica create -g {} --replica-name {} --source-server {} --zone 2 {} {}'
1332+
self.cmd('{} flexible-server replica create -g {} --name {} --source-server {} --zone 2 {} {}'
13331333
.format(database_engine, resource_group, replicas[0], result['id'], replica_vnet_args[0], public_access_arg),
13341334
checks=[
13351335
JMESPathCheck('name', replicas[0]),
@@ -1366,7 +1366,7 @@ def _test_flexible_server_replica_mgmt(self, database_engine, resource_group, vn
13661366
JMESPathCheck('sourceServerResourceId', 'None')])
13671367

13681368
# test delete master server
1369-
self.cmd('{} flexible-server replica create -g {} --replica-name {} --source-server {} {}'
1369+
self.cmd('{} flexible-server replica create -g {} --name {} --source-server {} {}'
13701370
.format(database_engine, resource_group, replicas[1], result['id'], replica_vnet_args[1]),
13711371
checks=[
13721372
JMESPathCheck('name', replicas[1]),
@@ -1382,7 +1382,7 @@ def _test_flexible_server_replica_mgmt(self, database_engine, resource_group, vn
13821382

13831383
# test virtual-endpoint
13841384
if not vnet_enabled:
1385-
self.cmd('{} flexible-server replica create -g {} --replica-name {} --source-server {}'
1385+
self.cmd('{} flexible-server replica create -g {} --name {} --source-server {}'
13861386
.format(database_engine, resource_group, replicas[2], result['id']),
13871387
checks=[
13881388
JMESPathCheck('name', replicas[2]),
@@ -2171,7 +2171,7 @@ def _test_flexible_server_upgrade_mgmt(self, database_engine, resource_group, pu
21712171
checks=[JMESPathCheck('version', current_version)])
21722172

21732173
# create replica
2174-
self.cmd('{} flexible-server replica create -g {} --replica-name {} --source-server {}'
2174+
self.cmd('{} flexible-server replica create -g {} --name {} --source-server {}'
21752175
.format(database_engine, resource_group, replica_name, server_name),
21762176
checks=[JMESPathCheck('version', current_version)])
21772177

@@ -2283,7 +2283,7 @@ def _test_identity_microsoft_entra_admin_mgmt(self, database_engine, resource_gr
22832283
JMESPathCheckExists('userAssignedIdentities."{}"'.format(identity_id[0]))])
22842284

22852285
# create replica 1
2286-
self.cmd('{} flexible-server replica create -g {} --replica-name {} --source-server {}'
2286+
self.cmd('{} flexible-server replica create -g {} --name {} --source-server {}'
22872287
.format(database_engine, resource_group, replica[0], server))
22882288

22892289
if database_engine == 'postgres':
@@ -2338,7 +2338,7 @@ def _test_identity_microsoft_entra_admin_mgmt(self, database_engine, resource_gr
23382338
JMESPathCheckExists('userAssignedIdentities."{}"'.format(identity_id[1]))])
23392339

23402340
# create replica 2
2341-
self.cmd('{} flexible-server replica create -g {} --replica-name {} --source-server {}'
2341+
self.cmd('{} flexible-server replica create -g {} --name {} --source-server {}'
23422342
.format(database_engine, resource_group, replica[1], server))
23432343

23442344
if database_engine == 'postgres':

0 commit comments

Comments
 (0)