Fix DeleteOptions on Public Ip Address (issue#38806)

sdk/resourcemanager/azure-resourcemanager-network/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "java",
   "TagPrefix": "java/resourcemanager/azure-resourcemanager-network",
-  "Tag": "java/resourcemanager/azure-resourcemanager-network_271269e41a"
+  "Tag": "java/resourcemanager/azure-resourcemanager-network_2b609265e1"
 }

sdk/resourcemanager/azure-resourcemanager-network/src/main/java/com/azure/resourcemanager/network/implementation/NetworkInterfaceImpl.java

@@ -9,6 +9,7 @@
 import com.azure.resourcemanager.network.NetworkManager;
 import com.azure.resourcemanager.network.fluent.models.ApplicationSecurityGroupInner;
 import com.azure.resourcemanager.network.models.ApplicationSecurityGroup;
+import com.azure.resourcemanager.network.models.DeleteOptions;
 import com.azure.resourcemanager.network.models.IpAllocationMethod;
 import com.azure.resourcemanager.network.models.LoadBalancer;
 import com.azure.resourcemanager.network.models.Network;
@@ -29,12 +30,16 @@
 import com.azure.resourcemanager.resources.fluentcore.arm.models.Resource;
 import com.azure.resourcemanager.resources.fluentcore.model.Creatable;
 
+import java.util.Arrays;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Comparator;
+import java.util.HashMap;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
+import java.util.Objects;
 import java.util.TreeMap;
 
 import reactor.core.publisher.Flux;
@@ -60,11 +65,16 @@ class NetworkInterfaceImpl
     private NetworkSecurityGroup existingNetworkSecurityGroupToAssociate;
     /** cached related resources. */
     private NetworkSecurityGroup networkSecurityGroup;
+    /** the name of specified ip config name */
+    private Map<DeleteOptions, HashSet<String>> specifiedIpConfigNames;
+    private boolean isInUpdateIpConfigMode = false;
 
     NetworkInterfaceImpl(String name, NetworkInterfaceInner innerModel, final NetworkManager networkManager) {
         super(name, innerModel, networkManager);
         this.nicName = name;
         this.namer = this.manager().resourceManager().internalContext().createIdentifierProvider(this.nicName);
+        this.isInUpdateIpConfigMode = false;
+        this.specifiedIpConfigNames = new HashMap<DeleteOptions, HashSet<String>>();
         initializeChildrenFromInner();
     }
 
@@ -141,18 +151,21 @@ public NetworkInterfaceImpl withExistingPrimaryNetwork(Network network) {
 
     @Override
     public NetworkInterfaceImpl withNewPrimaryPublicIPAddress(Creatable<PublicIpAddress> creatable) {
+        this.isInUpdateIpConfigMode = true;
         this.primaryIPConfiguration().withNewPublicIpAddress(creatable);
         return this;
     }
 
     @Override
     public NetworkInterfaceImpl withNewPrimaryPublicIPAddress() {
+        this.isInUpdateIpConfigMode = true;
         this.primaryIPConfiguration().withNewPublicIpAddress();
         return this;
     }
 
     @Override
     public NetworkInterfaceImpl withNewPrimaryPublicIPAddress(String leafDnsLabel) {
+        this.isInUpdateIpConfigMode = true;
         this.primaryIPConfiguration().withNewPublicIpAddress(leafDnsLabel);
         return this;
     }
@@ -196,6 +209,7 @@ public NetworkInterfaceImpl withoutPrimaryPublicIPAddress() {
     public NetworkInterfaceImpl withExistingPrimaryPublicIPAddress(PublicIpAddress publicIPAddress) {
         this.primaryIPConfiguration().withExistingPublicIpAddress(publicIPAddress);
         this.primaryIPConfiguration().withPrivateIpVersion(publicIPAddress.version());
+        this.isInUpdateIpConfigMode = true;
         return this;
     }
 
@@ -252,6 +266,7 @@ public NetworkInterfaceImpl withoutApplicationSecurityGroup(String applicationSe
 
     @Override
     public NicIpConfigurationImpl defineSecondaryIPConfiguration(String name) {
+        this.isInUpdateIpConfigMode = true;
         NicIpConfigurationImpl nicIpConfiguration = prepareNewNicIPConfiguration(name);
 
         // copy application security group from primary to secondary,
@@ -268,6 +283,7 @@ public NicIpConfigurationImpl defineSecondaryIPConfiguration(String name) {
 
     @Override
     public NicIpConfigurationImpl updateIPConfiguration(String name) {
+        this.isInUpdateIpConfigMode = true;
         return (NicIpConfigurationImpl) this.nicIPConfigurations.get(name);
     }
 
@@ -563,9 +579,41 @@ protected void beforeCreating() {
                 .withNetworkSecurityGroup(new NetworkSecurityGroupInner().withId(networkSecurityGroup.id()));
         }
 
-        NicIpConfigurationImpl.ensureConfigurations(this.nicIPConfigurations.values());
+        NicIpConfigurationImpl.ensureConfigurations(this.nicIPConfigurations.values(), this.specifiedIpConfigNames);
 
         // Reset and update IP configs
         this.innerModel().withIpConfigurations(innersFromWrappers(this.nicIPConfigurations.values()));
     }
+
+    @Override
+    public NetworkInterfaceImpl withPrimaryPublicIPAddressDeleteOptions(DeleteOptions deleteOptions) {
+        this.ensureDeleteOptions(deleteOptions, "primary");
+        return this;
+    }
+
+    @Override
+    public NetworkInterfaceImpl update() {
+        this.specifiedIpConfigNames = new HashMap<DeleteOptions, HashSet<String>>();
+        this.isInUpdateIpConfigMode = false;
+        return super.update();
+    }
+
+    @Override
+    public NetworkInterface apply() {
+        if (!isInCreateMode() && !isInUpdateIpConfigMode && !this.specifiedIpConfigNames.isEmpty()) {
+            this.specifiedIpConfigNames.forEach((deleteOptions, values) -> this.nicIPConfigurations.values()
+                    .stream().filter(ipConfig -> values.contains(ipConfig.name())
+                            && Objects.nonNull(ipConfig.innerModel().publicIpAddress()))
+                    .forEach(ipConfig -> ipConfig.innerModel().publicIpAddress().withDeleteOption(deleteOptions)));
+        }
+        return super.apply();
+    }
+
+    public void ensureDeleteOptions(DeleteOptions deleteOptions, String ipConfigName) {
+        if (this.specifiedIpConfigNames.containsKey(deleteOptions)) {
+            this.specifiedIpConfigNames.get(deleteOptions).add(ipConfigName);
+        } else {
+            this.specifiedIpConfigNames.put(deleteOptions, new HashSet<>(Arrays.asList(ipConfigName)));
+        }
+    }
 }

sdk/resourcemanager/azure-resourcemanager-network/src/main/java/com/azure/resourcemanager/network/implementation/NicIpConfigurationImpl.java

@@ -9,6 +9,7 @@
 import com.azure.resourcemanager.network.models.ApplicationGateway;
 import com.azure.resourcemanager.network.models.ApplicationGatewayBackendAddressPool;
 import com.azure.resourcemanager.network.models.ApplicationSecurityGroup;
+import com.azure.resourcemanager.network.models.DeleteOptions;
 import com.azure.resourcemanager.network.models.IpAllocationMethod;
 import com.azure.resourcemanager.network.models.IpVersion;
 import com.azure.resourcemanager.network.models.LoadBalancer;
@@ -28,7 +29,9 @@
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
+import java.util.Map;
 import java.util.Objects;
+import java.util.HashSet;
 
 /** Implementation for NicIPConfiguration and its create and update interfaces. */
 class NicIpConfigurationImpl extends NicIpConfigurationBaseImpl<NetworkInterfaceImpl, NetworkInterface>
@@ -257,11 +260,18 @@ private List<InboundNatRuleInner> ensureInboundNatRules() {
         return natRefs;
     }
 
-    protected static void ensureConfigurations(Collection<NicIpConfiguration> nicIPConfigurations) {
+    protected static void ensureConfigurations(Collection<NicIpConfiguration> nicIPConfigurations, Map<DeleteOptions, HashSet<String>> specifiedIpConfigNames) {
         for (NicIpConfiguration nicIPConfiguration : nicIPConfigurations) {
             NicIpConfigurationImpl config = (NicIpConfigurationImpl) nicIPConfiguration;
             config.innerModel().withSubnet(config.subnetToAssociate());
-            config.innerModel().withPublicIpAddress(config.publicIPToAssociate());
+            PublicIpAddressInner publicIpAddressInner = config.publicIPToAssociate();
+            for (Map.Entry<DeleteOptions, HashSet<String>> entry : specifiedIpConfigNames.entrySet()) {
+                if (entry.getValue().contains(nicIPConfiguration.name())) {
+                    publicIpAddressInner = config.publicIPToAssociate(entry.getKey());
+                    break;
+                }
+            }
+            config.innerModel().withPublicIpAddress(publicIpAddressInner);
         }
     }
 
@@ -352,6 +362,37 @@ private PublicIpAddressInner publicIPToAssociate() {
         }
     }
 
+    /**
+     * Get the SubResource instance representing a public IP that needs to be associated with the IP configuration.
+     *
+     * <p>null will be returned if withoutPublicIP() is specified in the update fluent chain or user did't opt for
+     * public IP in create fluent chain. In case of update chain, if withoutPublicIP(..) is not specified then existing
+     * associated (if any) public IP will be returned.
+     * @param deleteOptions what happens to the public IP address when the VM using it is deleted
+     * @return public IP SubResource
+     */
+    private PublicIpAddressInner publicIPToAssociate(DeleteOptions deleteOptions) {
+        String pipId = null;
+        if (this.removePrimaryPublicIPAssociation) {
+            return null;
+        } else if (this.creatablePublicIPKey != null) {
+            pipId = ((PublicIpAddress) this.parent().createdDependencyResource(this.creatablePublicIPKey)).id();
+        } else if (this.existingPublicIPAddressIdToAssociate != null) {
+            pipId = this.existingPublicIPAddressIdToAssociate;
+        }
+
+        if (pipId != null) {
+            return new PublicIpAddressInner().withId(pipId).withDeleteOption(deleteOptions);
+        } else if (!this.isInCreateMode) {
+            if (Objects.nonNull(this.innerModel().publicIpAddress())) {
+                return this.innerModel().publicIpAddress().withDeleteOption(deleteOptions);
+            }
+            return this.innerModel().publicIpAddress();
+        } else {
+            return null;
+        }
+    }
+
     @Override
     public NicIpConfigurationImpl withPrivateIpVersion(IpVersion ipVersion) {
         this.innerModel().withPrivateIpAddressVersion(ipVersion);
@@ -400,4 +441,10 @@ NicIpConfigurationImpl withoutApplicationSecurityGroup(String name) {
         }
         return this;
     }
+
+    @Override
+    public NicIpConfigurationImpl withPublicIPAddressDeleteOptions(DeleteOptions deleteOptions) {
+        this.parent().ensureDeleteOptions(deleteOptions, this.innerModel().name());
+        return this;
+    }
 }

sdk/resourcemanager/azure-resourcemanager-network/src/main/java/com/azure/resourcemanager/network/models/NetworkInterface.java

@@ -256,6 +256,17 @@ interface WithAcceleratedNetworking {
             WithCreate withAcceleratedNetworking();
         }
 
+        /** The stage of the definition allowing to specify delete options for the public ip address. */
+        interface WithPublicIPAddressDeleteOptions {
+            /**
+             * Sets delete options for public ip address.
+             *
+             * @param deleteOptions the delete options for primary network interfaces
+             * @return the next stage of the update
+             */
+            WithCreate withPrimaryPublicIPAddressDeleteOptions(DeleteOptions deleteOptions);
+        }
+
         /**
          * The stage of the network interface definition which contains all the minimum required inputs for the resource
          * to be created, but also allows for any other optional settings to be specified.
@@ -268,7 +279,8 @@ interface WithCreate
                 WithSecondaryIPConfiguration,
                 WithAcceleratedNetworking,
                 WithLoadBalancer,
-                WithApplicationSecurityGroup {
+                WithApplicationSecurityGroup,
+                WithPublicIPAddressDeleteOptions {
             /**
              * Enables IP forwarding in the network interface.
              *
@@ -576,6 +588,18 @@ interface WithLoadBalancer {
              */
             Update withoutLoadBalancerInboundNatRules();
         }
+
+        /** The stage of the network interface update allowing to specify delete options for the public ip address. */
+        interface WithPublicIPAddressDeleteOptions {
+
+            /**
+             * Sets delete options for public ip address.
+             *
+             * @param deleteOptions the delete options for primary network interfaces
+             * @return the next stage of the update
+             */
+            Update withPrimaryPublicIPAddressDeleteOptions(DeleteOptions deleteOptions);
+        }
     }
 
     /** The template for an update operation, containing all the settings that can be modified. */
@@ -591,6 +615,7 @@ interface Update
             UpdateStages.WithIPConfiguration,
             UpdateStages.WithLoadBalancer,
             UpdateStages.WithAcceleratedNetworking,
-            UpdateStages.WithApplicationSecurityGroup {
+            UpdateStages.WithApplicationSecurityGroup,
+            UpdateStages.WithPublicIPAddressDeleteOptions {
     }
 }

sdk/resourcemanager/azure-resourcemanager-network/src/main/java/com/azure/resourcemanager/network/models/NicIpConfiguration.java

@@ -188,6 +188,22 @@ WithAttach<ParentT> withExistingApplicationGatewayBackend(
                 ApplicationGateway appGateway, String backendName);
         }
 
+
+        /** The stage of the definition allowing to specify delete options for the public ip address.
+         *
+         * @param <ParentT> the stage of the parent network interface definition to return to after attaching this
+         *     definition
+         * */
+        interface WithPublicIPAddressDeleteOptions<ParentT> {
+            /**
+             * Sets delete options for public ip address.
+             *
+             * @param deleteOptions the delete options for primary network interfaces
+             * @return the next stage of the definition
+             */
+            WithAttach<ParentT> withPublicIPAddressDeleteOptions(DeleteOptions deleteOptions);
+        }
+
         /**
          * The final stage of network interface IP configuration.
          *
@@ -201,7 +217,8 @@ interface WithAttach<ParentT>
             extends Attachable.InDefinition<ParentT>,
                 WithPublicIPAddress<ParentT>,
                 WithLoadBalancer<ParentT>,
-                WithApplicationGateway<ParentT> {
+                WithApplicationGateway<ParentT>,
+                WithPublicIPAddressDeleteOptions<ParentT> {
         }
     }
 
@@ -372,6 +389,22 @@ WithAttach<ParentT> withExistingApplicationGatewayBackend(
                 ApplicationGateway appGateway, String backendName);
         }
 
+        /**
+         * The stage of the definition allowing to specify delete options for the public ip address.
+         *
+         * @param <ParentT> the stage of the parent network interface update to return to after attaching this
+         *     definition
+         * */
+        interface WithPublicIPAddressDeleteOptions<ParentT>  {
+            /**
+             * Sets delete options for public ip address.
+             *
+             * @param deleteOptions the delete options for primary network interfaces
+             * @return the next stage of the update
+             */
+            WithAttach<ParentT> withPublicIPAddressDeleteOptions(DeleteOptions deleteOptions);
+        }
+
         /**
          * The final stage of network interface IP configuration.
          *
@@ -385,7 +418,8 @@ interface WithAttach<ParentT>
             extends Attachable.InUpdate<ParentT>,
                 WithPublicIPAddress<ParentT>,
                 WithLoadBalancer<ParentT>,
-                WithApplicationGateway<ParentT> {
+                WithApplicationGateway<ParentT>,
+                WithPublicIPAddressDeleteOptions<ParentT> {
         }
     }
 
@@ -396,7 +430,8 @@ interface Update
             UpdateStages.WithPrivateIP,
             UpdateStages.WithPublicIPAddress,
             UpdateStages.WithLoadBalancer,
-            UpdateStages.WithApplicationGateway {
+            UpdateStages.WithApplicationGateway,
+            UpdateStages.WithPublicIPAddressDeleteOptions {
     }
 
     /** Grouping of network interface IP configuration update stages. */
@@ -486,5 +521,16 @@ interface WithApplicationGateway {
              */
             Update withoutApplicationGatewayBackends();
         }
+
+        /** The stage of the network interface update allowing to specify delete options for the public ip address. */
+        interface WithPublicIPAddressDeleteOptions {
+            /**
+             * Sets delete options for public ip address.
+             *
+             * @param deleteOptions the delete options for primary network interfaces
+             * @return the next stage of the update
+             */
+            Update withPublicIPAddressDeleteOptions(DeleteOptions deleteOptions);
+        }
     }
 }