MicrosoftDocs / azure-docs

Open source documentation of Microsoft Azure
https://docs.microsoft.com/azure
Creative Commons Attribution 4.0 International
10.08k stars 21.13k forks source link

The syntax for making an API connection for use with a Managed Identity is incorrect. #111343

Closed AWheelwrightBLM closed 6 months ago

AWheelwrightBLM commented 1 year ago

The syntax for an ARM template to deploy an API connection that uses a Managed Identity is incorrect. The properties field needs to have: "authenticatedUser": {} "customParameterValues": {}, "alternativeParameterValues": {}, "parameterValueType": "Alternative", "parameterValueSet":{},

Or it doesn't allow for Managed Identity use.

See example below. Also you should have "apiVersion": "[providers('Microsoft.Web','connections').apiVersions[0]]" in the documentation to help people use the most recent API versions in templates without having to go find them/update them.

{ "type": "Microsoft.Web/connections", "apiVersion": "[providers('Microsoft.Web','connections').apiVersions[0]]", "name": "azurevm", "location": "[variables('location')]", "kind": "V1", "properties": { "displayName": "AzureVmConnection", "authenticatedUser": {}, "connectionState": "Enabled", "customParameterValues": {}, "alternativeParameterValues": {}, "parameterValueType": "Alternative", "parameterValueSet":{}, "api": { "name": "azurevm", "displayName": "Azure VM", "description": "Azure VM connector allows you to manage virtual machines.", "iconUri": "https://connectoricons-prod.azureedge.net/u/shgogna/globalperconnector-train1/1.0.1639.3310/azurevm/icon.png", "brandColor": "#FFFFFF", "category": "Standard", "id": "[concat('/subscriptions/',variables('subscriptionid'),'/providers/Microsoft.Web/locations/',variables('location'),'/managedApis/', 'azurevm')]", "type": "Microsoft.Web/locations/managedApis" }, "testLinks": [] } }


Document Details

Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

Naveenommi-MSFT commented 1 year ago

@AWheelwrightBLM Thanks for your feedback! We will investigate and update as appropriate.

ecfan commented 6 months ago

Update to be published after 4 PM Pacific Time. #please-close