How to add public IP to APIM via CLI?

Shuchita Tripathi 6

I am trying to add separately managed public IP to Azure APIM (external) using CLI. Command is not giving any error but IP is not getting attached.
Command:
az resource update --ids "<apim-id>" --set properties.publicIPAddresses="20.x.x.x"

Output:

For reference, this is what I am trying to do:

How can I add a separately managed public IP to APIM using automation? (preferably CLI, however powershell will also help). Separately managed IP refers to IP created using create public IP command, and then attaching that to APIM.

MayankBargali-MSFT 70,016 Reputation points

2021-07-07T06:13:31.917+00:00

@Shuchita Tripathi It might take between 15-45 minutes to complete the operation. Can you confirm what is the CLI version you are using and whether the publicIPAddresses was updated posted 1hr of executing the command.
Shuchita Tripathi 6 Reputation points

2021-07-07T09:59:52.737+00:00

Hi @MayankBargali-MSFT :
APIM is not updated after 1 hour. It is still showing the old ID. (I am checking the next day)
AZ cli version is 2.25.0
Shuchita Tripathi 6 Reputation points

2021-07-07T17:47:56.533+00:00

I have also tried with public IP's 'name', 'resourceID' and the property PublicIPAddressID (found it in ARM template). Every command gives the same result as above, and none changes the public IP to the one I am passing.

1 answer

MayankBargali-MSFT 70,016 Reputation points

2021-07-08T02:17:53.373+00:00

@Shuchita Tripathi Currently, the Azure portal uses API version 2021-01-01 preview when creating or updating an API Management instance. You can specify this API version using an Azure Resource Manager template or the API Management REST API. The Azure CLI and Azure PowerShell currently support API version 2020-12-01.

When I test with AZ CLI version is 2.25.0/2.26.0 then I observe the Bad Request as it is expected as the Azure CLI doesn't support this functionality yet. The same is documented here.
ERROR: Operation returned an invalid status 'Bad Request'

You should observe the same behavior. You can try running the command with --debug to get more details on the request and error message.

For any CLI feature/feedback/issue you can always post your query here.
Please sign in to rate this answer.
Shuchita Tripathi 6 Reputation points

2021-07-09T10:17:49.403+00:00

Thank @MayankBargali-MSFT ,
Is there any way this can be achieved?
We are creating APIM resource using terraform. However in terraform, we dont see an option to attach existing public IP. That is why we are going toward attaching the IP after APIM is created.
Is there any way this can be done? Our end goal is to make the APIM external and attach an existing public IP.

Shuchita Tripathi 6 Reputation points

2021-07-09T10:23:03.123+00:00

Adding one line in my previous comment:
We want to achieve it via automation. CLI/Powershell/Terraform/Rest
Not via portal.

MayankBargali-MSFT 70,016 Reputation points

2021-07-09T10:41:34.21+00:00

@Shuchita Tripathi Yes you can use REST API as currently this operation is only supported using Azure portal and REST API as mentioned in the document.
You need to use the version 2020-12-01 API for APIM Management Operation. You need to first call the Api Management Service - Get API and then use the output and add/update publicIpAddressId property. You can refer to request body section for details on what are the properties supported while updating the APIM instance.

Alternative, you can also use F12 traces to verify how the request body is formed when you are performing any operation from the portal.
Sign in to comment

Share via

How to add public IP to APIM via CLI?

1 answer