[AzNetwork] Add Ip Preservation Cmdlets by pribansa · Pull Request #29373 · Azure/azure-powershell

pribansa · 2026-04-08T03:20:34Z

Description

Mandatory Checklist

Please choose the target release of Azure PowerShell. (⚠️Target release is a different concept from API readiness. Please click below links for details.)
- General release
- Public preview
- Private preview
- Engineering build
- No need for a release
Check this box to confirm: I have read the Submitting Changes section of CONTRIBUTING.md and reviewed the following information:

SHOULD update ChangeLog.md file(s) appropriately
- Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
  - A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
- Should not change ChangeLog.md if no new release is required, such as fixing test case only.
SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
SHOULD have proper test coverage for changes in pull request.
SHOULD NOT adjust version of module manually in pull request

azure-client-tools-bot-prd · 2026-04-08T03:20:37Z

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

pribansa · 2026-04-08T03:26:36Z

/azp run

azure-pipelines · 2026-04-08T03:26:43Z

Commenter does not have sufficient privileges for PR 29373 in repo Azure/azure-powershell

Copilot

Pull request overview

Adds new Az.Network cmdlets to manage cloud service public IP address reservation/rollback and to disassociate a standalone reserved public IP, along with help/manifest updates and initial scenario tests.

Changes:

Added 2 new Invoke-AzPublicIpAddress* cmdlets for cloud service IP reservation and reserved IP disassociation.
Added help markdown and updated module cmdlet index/export list.
Added scenario tests (currently focused on missing-resource error handling).

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
src/Network/Network/PublicIpAddress/InvokeAzurePublicIpAddressCloudServiceReservationCommand.cs	New cmdlet implementation to reserve or roll back cloud service public IP allocation.
src/Network/Network/PublicIpAddress/InvokeAzurePublicIpAddressDisassociateCloudServiceReservedIpCommand.cs	New cmdlet implementation to disassociate a standalone reserved public IP from a cloud service public IP.
src/Network/Network/help/Invoke-AzPublicIpAddressCloudServiceReservation.md	New reference help for reservation/rollback cmdlet.
src/Network/Network/help/Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp.md	New reference help for disassociate cmdlet.
src/Network/Network/help/Az.Network.md	Added both cmdlets to the module help index.
src/Network/Network/ChangeLog.md	Added upcoming release notes for the new cmdlets.
src/Network/Network/Az.Network.psd1	Exported the two new cmdlets from the module manifest.
src/Network/Network.Test/ScenarioTests/PublicIpAddressTests.ps1	Added scenario tests for error handling when the target public IP does not exist.
src/Network/Network.Test/ScenarioTests/PublicIpAddressTests.cs	Wired new scenario tests into the xUnit test runner.

Copilot · 2026-04-08T03:28:59Z

+
+            if (!this.IsPublicIpAddressPresent(this.ResourceGroupName, this.Name))
+            {
+                throw new ArgumentException(Microsoft.Azure.Commands.Network.Properties.Resources.ResourceNotFound);


Resources.ResourceNotFound includes a format placeholder ("Resource '{0}' not found"), but this throws it without formatting, so users will see the literal {0}. Format the message with the public IP name (and/or resource group) before throwing, or use a non-formatted resource string.

Suggested change

throw new ArgumentException(Microsoft.Azure.Commands.Network.Properties.Resources.ResourceNotFound);

throw new ArgumentException(string.Format(Microsoft.Azure.Commands.Network.Properties.Resources.ResourceNotFound, this.Name));

Copilot · 2026-04-08T03:28:59Z

+
+            if (!this.IsPublicIpAddressPresent(this.ResourceGroupName, this.Name))
+            {
+                throw new ArgumentException(Microsoft.Azure.Commands.Network.Properties.Resources.ResourceNotFound);


Resources.ResourceNotFound is a formatted string ("Resource '{0}' not found"), but it’s thrown without string.Format, so the {0} placeholder will show up in the error text. Please format the message with the cloud service public IP name (and/or resource group) before throwing.

Suggested change

throw new ArgumentException(Microsoft.Azure.Commands.Network.Properties.Resources.ResourceNotFound);

throw new ArgumentException(string.Format(Microsoft.Azure.Commands.Network.Properties.Resources.ResourceNotFound, this.Name));

Copilot · 2026-04-08T03:29:00Z

+```
+
+## DESCRIPTION
+The **Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp** cmdlet invokes the **DisassociateCloudServiceReservedPublicIp** operation. Use **PublicIpArmId** to specify the ARM resource ID of the standalone public IP to disassociate from the cloud service public IP identified by **Name** and **ResourceGroupName**, **ResourceId**, or **InputObject**.


The help text refers to an "ARM resource ID"; consider expanding this on first use to "Azure Resource Manager (ARM) resource ID" to avoid assuming familiarity with the acronym.

Suggested change

The **Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp** cmdlet invokes the **DisassociateCloudServiceReservedPublicIp** operation. Use **PublicIpArmId** to specify the ARM resource ID of the standalone public IP to disassociate from the cloud service public IP identified by **Name** and **ResourceGroupName**, **ResourceId**, or **InputObject**.

The **Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp** cmdlet invokes the **DisassociateCloudServiceReservedPublicIp** operation. Use **PublicIpArmId** to specify the Azure Resource Manager (ARM) resource ID of the standalone public IP to disassociate from the cloud service public IP identified by **Name** and **ResourceGroupName**, **ResourceId**, or **InputObject**.

Copilot · 2026-04-08T03:29:00Z

 ## Upcoming Release
+* Added cmdlets for cloud service public IP address operations:
+    - `Invoke-AzPublicIpAddressCloudServiceReservation`: reserve a cloud service public IP or roll back to dynamic allocation (`-IsRollback`).
+    - `Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp`: disassociate a standalone reserved public IP from a cloud service public IP (`-PublicIpArmId`).


The changelog entry includes the parameter name -PublicIpArmId, which introduces the less-obvious acronym "ARM". Please expand it on first use in this release section (for example, "Azure Resource Manager (ARM) resource ID").

Suggested change

- `Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp`: disassociate a standalone reserved public IP from a cloud service public IP (`-PublicIpArmId`).

- `Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp`: disassociate a standalone reserved public IP from a cloud service public IP by using the Azure Resource Manager (ARM) resource ID parameter (`-PublicIpArmId`).

Copilot · 2026-04-08T03:29:00Z

+        $subId = (Get-AzContext).Subscription.Id
+        $resourceId = "/subscriptions/$subId/resourceGroups/$rgname/providers/Microsoft.Network/publicIPAddresses/$fakePipName"
+
+        Assert-ThrowsContains { Invoke-AzPublicIpAddressCloudServiceReservation -ResourceGroupName $rgname -Name $fakePipName } "not found"
+        Assert-ThrowsContains { Invoke-AzPublicIpAddressCloudServiceReservation -ResourceId $resourceId } "not found"


These new tests only validate the "not found" error path for the new cmdlets. Please add a happy-path test (or an alternative test approach if provisioning a cloud service public IP is required) so the end-to-end behavior is covered.

Copilot · 2026-04-08T03:29:00Z

+
+        Assert-ThrowsContains {
+            Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp -ResourceGroupName $rgname -Name $fakeCloudServicePip -PublicIpArmId $standaloneArmId
+        } "not found"
+


This new test only exercises the missing-resource error path for Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp. Please add a happy-path validation (or an alternative test approach if this operation requires specific cloud service public IP prerequisites) to cover the real behavior.

Copilot · 2026-04-08T03:29:01Z

+Disassociates the standalone public IP **standalonePip** from the cloud service public IP **myCloudServicePublicIp**.
+
+### Example 2: Pipe the cloud service public IP
+```powershell


Example 2 references $standaloneId but doesn’t define it within the example, so it isn’t self-contained. Define the variable in this example (or inline the resource ID) so users can copy/paste it as-is.

Suggested change

```powershell

```powershell

$standaloneId = '/subscriptions/{subId}/resourceGroups/myRg/providers/Microsoft.Network/publicIPAddresses/standalonePip'

Copilot · 2026-04-08T03:29:01Z

+### Example 2: Pipe the cloud service public IP
+```powershell
+$cloudPip = Get-AzPublicIpAddress -ResourceGroupName 'myResourceGroup' -Name 'myCloudServicePublicIp'
+Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp -InputObject $cloudPip -PublicIpArmId $standaloneId


Example 2 is titled "Pipe the cloud service public IP", but the snippet uses -InputObject $cloudPip rather than piping ($cloudPip | ...). Either change the example to actually use the pipeline or adjust the title/description to match the shown usage.

Suggested change

Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp -InputObject $cloudPip -PublicIpArmId $standaloneId

$cloudPip | Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp -PublicIpArmId $standaloneId

VeryEarly · 2026-04-08T05:22:55Z

/azp run

azure-pipelines · 2026-04-08T05:23:11Z

Azure Pipelines successfully started running 3 pipeline(s).

VeryEarly · 2026-04-11T08:42:49Z

/azp run

azure-pipelines · 2026-04-11T08:43:04Z

Azure Pipelines successfully started running 3 pipeline(s).

Copilot

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 6 comments.

Copilot · 2026-04-11T08:46:12Z

+            Mandatory = true,
+            ParameterSetName = ParameterSetNames.ByName,
+            ValueFromPipelineByPropertyName = true,
+            HelpMessage = "The public IP address name.")]


The HelpMessage text for -Name says "The public IP address name." but this cmdlet is explicitly scoped to cloud service public IPs (per cmdlet name/synopsis). Updating the parameter HelpMessage to consistently say "cloud service public IP address" would avoid confusing users and keep it aligned with the generated help markdown.

Suggested change

HelpMessage = "The public IP address name.")]

HelpMessage = "The cloud service public IP address name.")]

Copilot · 2026-04-11T08:46:12Z

+        [Parameter(
+            ParameterSetName = ParameterSetNames.ByInputObject,
+            Mandatory = true,
+            ValueFromPipeline = true,
+            HelpMessage = "The public IP address object.")]
+        [ValidateNotNullOrEmpty]
+        public PSPublicIpAddress InputObject { get; set; }
+
+        [Parameter(
+            ParameterSetName = ParameterSetNames.ByResourceId,
+            Mandatory = true,
+            ValueFromPipelineByPropertyName = true,
+            HelpMessage = "The public IP address resource ID.")]
+        [ValidateNotNullOrEmpty]
+        [ResourceIdCompleter("Microsoft.Network/publicIPAddresses")]
+        public string ResourceId { get; set; }


The HelpMessage text for -InputObject says "The public IP address object." but this cmdlet targets cloud service public IPs. Please update this HelpMessage (and similarly -ResourceId) so the parameter descriptions match the cmdlet purpose and the synopsis/description in the help file.

Copilot · 2026-04-11T08:46:12Z

+### -InputObject
+The public IP address object.
+
+```yaml
+Type: PSPublicIpAddress
+Parameter Sets: ByInputObject
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: True (ByValue)
+Accept wildcard characters: False
+```


Parameter description for -InputObject says "The public IP address object." but the cmdlet synopsis/description describe a cloud service public IP address. Please align the parameter description with the cmdlet scope to avoid ambiguity for users.

Copilot · 2026-04-11T08:46:13Z

+### -Name
+The public IP address name.
+
+```yaml
+Type: String
+Parameter Sets: ByName
+Aliases: ResourceName
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```


Parameter description for -Name currently says "The public IP address name." but this cmdlet is specific to cloud service public IP addresses. Please update the parameter description to be consistent with the synopsis/description.

Copilot · 2026-04-11T08:46:13Z

+### -ResourceId
+The public IP address resource ID.
+
+```yaml
+Type: String
+Parameter Sets: ByResourceId
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```


Parameter description for -ResourceId says "The public IP address resource ID." but the cmdlet targets cloud service public IPs. Please clarify this is the cloud service public IP resource ID (or otherwise adjust the cmdlet description if it is intended to work for any Public IP).

Copilot · 2026-04-11T08:46:13Z

+    try
+    {
+        New-AzResourceGroup -Name $rgname -Location $rglocation | Out-Null
+        $subId = (Get-AzContext).Subscription.Id
+        $resourceId = "/subscriptions/$subId/resourceGroups/$rgname/providers/Microsoft.Network/publicIPAddresses/$fakePipName"
+
+        Assert-ThrowsContains { Invoke-AzPublicIpAddressCloudServiceReservation -ResourceGroupName $rgname -Name $fakePipName } "not found"
+        Assert-ThrowsContains { Invoke-AzPublicIpAddressCloudServiceReservation -ResourceId $resourceId } "not found"
+    }


The new scenario tests only validate the "resource not found" path (the cmdlet exits before calling the Reserve/Disassociate operations). This doesn't exercise the actual service operation call, request construction (e.g., -IsRollback / -PublicIpArmId), output mapping, or the ByInputObject parameter set. Please add at least one test that reaches the SDK operation (even if it validates an expected service-side error for a non-cloud-service Public IP), so the cmdlet implementation beyond the existence check is covered.

Add Ip Preservation Cmdlets

bfd888a

pribansa requested a review from Copilot April 8, 2026 03:21

Copilot started reviewing on behalf of pribansa April 8, 2026 03:23 View session

Copilot AI reviewed Apr 8, 2026

View reviewed changes

VeryEarly self-assigned this Apr 8, 2026

VeryEarly previously approved these changes Apr 8, 2026

View reviewed changes

VeryEarly enabled auto-merge (squash) April 8, 2026 05:22

Add session record files to fix broken tests

ded7448

auto-merge was automatically disabled April 11, 2026 08:16
Head branch was pushed to by a user without write access

pribansa dismissed VeryEarly’s stale review via ded7448 April 11, 2026 08:16

Address review comments

be44801

pribansa requested a review from Copilot April 11, 2026 08:39

Copilot started reviewing on behalf of pribansa April 11, 2026 08:42 View session

Copilot AI reviewed Apr 11, 2026

View reviewed changes

VeryEarly approved these changes Apr 13, 2026

View reviewed changes

VeryEarly merged commit 47e2acf into Azure:release-network-2025-07-01 Apr 13, 2026
15 of 16 checks passed

	throw new ArgumentException(Microsoft.Azure.Commands.Network.Properties.Resources.ResourceNotFound);
	throw new ArgumentException(string.Format(Microsoft.Azure.Commands.Network.Properties.Resources.ResourceNotFound, this.Name));

	The Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp cmdlet invokes the DisassociateCloudServiceReservedPublicIp operation. Use PublicIpArmId to specify the ARM resource ID of the standalone public IP to disassociate from the cloud service public IP identified by Name and ResourceGroupName, ResourceId, or InputObject.
	The Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp cmdlet invokes the DisassociateCloudServiceReservedPublicIp operation. Use PublicIpArmId to specify the Azure Resource Manager (ARM) resource ID of the standalone public IP to disassociate from the cloud service public IP identified by Name and ResourceGroupName, ResourceId, or InputObject.

	- `Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp`: disassociate a standalone reserved public IP from a cloud service public IP (`-PublicIpArmId`).
	- `Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp`: disassociate a standalone reserved public IP from a cloud service public IP by using the Azure Resource Manager (ARM) resource ID parameter (`-PublicIpArmId`).

	```powershell
	```powershell
	$standaloneId = '/subscriptions/{subId}/resourceGroups/myRg/providers/Microsoft.Network/publicIPAddresses/standalonePip'

	Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp -InputObject $cloudPip -PublicIpArmId $standaloneId
	$cloudPip \| Invoke-AzPublicIpAddressDisassociateCloudServiceReservedIp -PublicIpArmId $standaloneId

	HelpMessage = "The public IP address name.")]
	HelpMessage = "The cloud service public IP address name.")]

Conversation

pribansa commented Apr 8, 2026

Description

Mandatory Checklist

Uh oh!

azure-client-tools-bot-prd bot commented Apr 8, 2026

Uh oh!

pribansa commented Apr 8, 2026

Uh oh!

azure-pipelines bot commented Apr 8, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

VeryEarly commented Apr 8, 2026

Uh oh!

azure-pipelines bot commented Apr 8, 2026

Uh oh!

VeryEarly commented Apr 11, 2026

Uh oh!

azure-pipelines bot commented Apr 11, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants