Share via

Microsoft.Web connections 2015-08-01-preview

Bicep resource definition

The connections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Web/connections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Web/connections@2015-08-01-preview' = {
  scope: resourceSymbolicName or scope
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    api: {
      id: 'string'
      kind: 'string'
      location: 'string'
      name: 'string'
      properties: {
        entity: {
          id: 'string'
          location: 'string'
          name: 'string'
          plan: {
            name: 'string'
            product: 'string'
            promotionCode: 'string'
            publisher: 'string'
            version: 'string'
          }
          properties: {
            id: 'string'
            kind: 'string'
            location: 'string'
            name: 'string'
            properties: {
              apiDefinitionUrl: 'string'
              backendService: {
                id: 'string'
                kind: 'string'
                location: 'string'
                name: 'string'
                properties: {
                  hostingEnvironmentServiceUrls: [
                    {
                      hostId: 'string'
                      hostingEnvironmentId: 'string'
                      serviceUrl: 'string'
                      useInternalRouting: bool
                    }
                  ]
                  serviceUrl: 'string'
                }
                tags: {
                  {customized property}: 'string'
                }
                type: 'string'
              }
              capabilities: [
                'string'
              ]
              changedTime: 'string'
              connectionParameters: {
                {customized property}: {
                  defaultValue: any(...)
                  oAuthSettings: {
                    clientId: 'string'
                    clientSecret: 'string'
                    customParameters: {
                      {customized property}: {
                        options: any(...)
                        uiDefinition: any(...)
                        value: 'string'
                      }
                    }
                    identityProvider: 'string'
                    properties: any(...)
                    redirectUrl: 'string'
                    scopes: [
                      'string'
                    ]
                  }
                  type: 'string'
                  uiDefinition: any(...)
                }
              }
              createdTime: 'string'
              generalInformation: {
                id: 'string'
                kind: 'string'
                location: 'string'
                name: 'string'
                properties: {
                  connectionDisplayName: 'string'
                  connectionPortalUrl: any(...)
                  description: 'string'
                  displayName: 'string'
                  iconUrl: 'string'
                  termsOfUseUrl: 'string'
                }
                tags: {
                  {customized property}: 'string'
                }
                type: 'string'
              }
              metadata: any(...)
              name: 'string'
              path: 'string'
              policies: {
                id: 'string'
                kind: 'string'
                location: 'string'
                name: 'string'
                properties: {
                  content: 'string'
                }
                tags: {
                  {customized property}: 'string'
                }
                type: 'string'
              }
              protocols: [
                'string'
              ]
              runtimeUrls: [
                'string'
              ]
            }
            tags: {
              {customized property}: 'string'
            }
            type: 'string'
          }
          sku: {
            capacity: int
            family: 'string'
            name: 'string'
            size: 'string'
            tier: 'string'
          }
          tags: {
            {customized property}: 'string'
          }
          type: 'string'
        }
        id: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
      type: 'string'
    }
    changedTime: 'string'
    createdTime: 'string'
    customParameterValues: {
      {customized property}: {
        id: 'string'
        kind: 'string'
        location: 'string'
        name: 'string'
        properties: {
          customParameters: {
            {customized property}: {
              id: 'string'
              kind: 'string'
              location: 'string'
              name: 'string'
              properties: {
                option: 'string'
              }
              tags: {
                {customized property}: 'string'
              }
              type: 'string'
            }
          }
        }
        tags: {
          {customized property}: 'string'
        }
        type: 'string'
      }
    }
    displayName: 'string'
    firstExpirationTime: 'string'
    keywords: [
      'string'
    ]
    metadata: any(...)
    name: 'string'
    nonSecretParameterValues: {
      {customized property}: any(...)
    }
    parameterValues: {
      {customized property}: any(...)
    }
    statuses: [
      {
        id: 'string'
        kind: 'string'
        location: 'string'
        name: 'string'
        properties: {
          error: {
            id: 'string'
            kind: 'string'
            location: 'string'
            name: 'string'
            properties: {
              code: 'string'
              message: 'string'
            }
            tags: {
              {customized property}: 'string'
            }
            type: 'string'
          }
          status: 'string'
          target: 'string'
        }
        tags: {
          {customized property}: 'string'
        }
        type: 'string'
      }
    ]
    tenantId: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Web/connections

Name Description Value
kind Kind of resource string
location Resource Location string (required)
name The resource name string (required)
properties ConnectionProperties
scope Use when creating a resource at a scope that is different than the deployment scope. Set this property to the symbolic name of a resource to apply the extension resource.
tags Resource tags Dictionary of tag names and values. See Tags in templates

ApiEntity

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ApiEntityProperties
tags Resource tags ResourceTags
type Resource type string

ApiEntityProperties

Name Description Value
apiDefinitionUrl API definition Url - url where the swagger can be downloaded from string
backendService Backend service definition BackendServiceDefinition
capabilities Capabilities string[]
changedTime Timestamp of last connection change. string
connectionParameters Connection parameters ApiEntityPropertiesConnectionParameters
createdTime Timestamp of the connection creation string
generalInformation the URL path of this API when exposed via APIM GeneralApiInformation
metadata Free form object for the data caller wants to store any
name Name of the API
the URL path of this API when exposed via APIM		 string
path the URL path of this API when exposed via APIM string
policies API policies ApiPolicies
protocols Protocols supported by the front end - http/https string[]
runtimeUrls Read only property returning the runtime endpoints where the API can be called string[]

ApiEntityPropertiesConnectionParameters

Name Description Value

ApiOAuthSettings

Name Description Value
clientId Resource provider client id string
clientSecret Client Secret needed for OAuth string
customParameters OAuth parameters key is the name of parameter ApiOAuthSettingsCustomParameters
identityProvider Identity provider string
properties Read only properties for this oauth setting. any
redirectUrl Url string
scopes OAuth scopes string[]

ApiOAuthSettingsCustomParameters

Name Description Value

ApiOAuthSettingsParameter

Name Description Value
options Read only: Options available to this parameter any
uiDefinition UI definitions per culture as caller can specify the culture any
value Value string

ApiPolicies

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ApiPoliciesProperties
tags Resource tags ResourceTags
type Resource type string

ApiPoliciesProperties

Name Description Value
content Content of xml policy string

ArmPlan

Name Description Value
name The name string
product The product string
promotionCode The promotion code string
publisher The publisher string
version Version of product string

BackendServiceDefinition

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties BackendServiceDefinitionProperties
tags Resource tags ResourceTags
type Resource type string

BackendServiceDefinitionProperties

Name Description Value
hostingEnvironmentServiceUrls Service Urls per Hosting environment HostingEnvironmentServiceDescriptions[]
serviceUrl Url from which the swagger payload will be fetched string

ConnectionError

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ConnectionErrorProperties
tags Resource tags ResourceTags
type Resource type string

ConnectionErrorProperties

Name Description Value
code code of the status string
message Description of the status string

ConnectionParameter

Name Description Value
defaultValue Default parameter value any
oAuthSettings Settings defining OAuth flow for the back end provider ApiOAuthSettings
type Type of the parameter 'array'
'bool'
'connection'
'int'
'oauthSetting'
'object'
'secureobject'
'securestring'
'string'
uiDefinition UI definitions any

ConnectionProperties

Name Description Value
api expanded connection provider name ExpandedParentApiEntity
changedTime Timestamp of last connection change. string
createdTime Timestamp of the connection creation string
customParameterValues Custom login setting values. ConnectionPropertiesCustomParameterValues
displayName display name string
firstExpirationTime Time in UTC when the first expiration of OAuth tokens string
keywords List of Keywords that tag the acl string[]
metadata Any object any
name connection name string
nonSecretParameterValues Tokens/Claim ConnectionPropertiesNonSecretParameterValues
parameterValues Tokens/Claim ConnectionPropertiesParameterValues
statuses Status of the connection ConnectionStatus[]
tenantId string

ConnectionPropertiesCustomParameterValues

Name Description Value

ConnectionPropertiesNonSecretParameterValues

Name Description Value

ConnectionPropertiesParameterValues

Name Description Value

ConnectionStatus

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ConnectionStatusProperties
tags Resource tags ResourceTags
type Resource type string

ConnectionStatusProperties

Name Description Value
error Error details ConnectionError
status Status string
target Target of the error string

CustomLoginSettingValue

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties CustomLoginSettingValueProperties
tags Resource tags ResourceTags
type Resource type string

CustomLoginSettingValueProperties

Name Description Value
option Option selected for this custom login setting value string

ExpandedParentApiEntity

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ExpandedParentApiEntityProperties
tags Resource tags ResourceTags
type Resource type string

ExpandedParentApiEntityProperties

Name Description Value
entity Id of connection provider ResponseMessageEnvelopeApiEntity
id Id of connection provider string

GeneralApiInformation

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties GeneralApiInformationProperties
tags Resource tags ResourceTags
type Resource type string

GeneralApiInformationProperties

Name Description Value
connectionDisplayName DefaultConnectionNameTemplate string
connectionPortalUrl ConnectionPortalUrl any
description Description string
displayName Display Name string
iconUrl Icon Url string
termsOfUseUrl a public accessible url of the Terms Of Use Url of this API string

HostingEnvironmentServiceDescriptions

Name Description Value
hostId Host Id string
hostingEnvironmentId Hosting environment Id string
serviceUrl service url to use string
useInternalRouting When the backend url is in same ASE, for performance reason this flag can be set to true
If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only
via API calls
Note: calls will fail if this option is used but back end is not on the same ASE		 bool

ParameterCustomLoginSettingValues

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ParameterCustomLoginSettingValuesProperties
tags Resource tags ResourceTags
type Resource type string

ParameterCustomLoginSettingValuesProperties

Name Description Value
customParameters Custom parameters. ParameterCustomLoginSettingValuesPropertiesCustomParameters

ParameterCustomLoginSettingValuesPropertiesCustomParameters

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResponseMessageEnvelopeApiEntity

Name Description Value
id Resource Id. Typically id is populated only for responses to GET requests. Caller is responsible for passing in this
value for GET requests only.
For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}		 string
location Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia string
name Name of resource string
plan Azure resource manager plan ArmPlan
properties Resource specific properties ApiEntity
sku Sku description of the resource SkuDescription
tags Tags associated with resource ResponseMessageEnvelopeApiEntityTags
type Type of resource e.g Microsoft.Web/sites string

ResponseMessageEnvelopeApiEntityTags

Name Description Value

SkuDescription

Name Description Value
capacity Current number of instances assigned to the resource int
family Family code of the resource sku string
name Name of the resource sku string
size Size specifier of the resource sku string
tier Service Tier of the resource sku string

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Azure Logic Apps - AS2 Send Receive Creates integration accounts for two partners, Contoso and Fabrikam, including the artifacts for partners and agreements. The template also creates logic apps between Fabrikam Sales and Contoso to demonstrate synchronous AS2 Send Receive. The template also creates logic apps between Fabrikam Finance and Contoso, which demonstrate asynchronous AS2 Send Receive.
Copy FTP files to Azure Blob logic app This template allows you to create a Logic app triggers on files in an FTP server and copies them to an Azure Blob container. You can add an additional triggers or actions to customize it to your needs.
Retrieve Azure Storage access keys in ARM template This template will create a Storage account, after which it will create a API connection by dynamically retrieving the primary key of the Storage account. The API connection is then used in a Logic App as a trigger polling for blob changes.

ARM template resource definition

The connections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Web/connections resource, add the following JSON to your template.

{
  "type": "Microsoft.Web/connections",
  "apiVersion": "2015-08-01-preview",
  "name": "string",
  "kind": "string",
  "location": "string",
  "properties": {
    "api": {
      "id": "string",
      "kind": "string",
      "location": "string",
      "name": "string",
      "properties": {
        "entity": {
          "id": "string",
          "location": "string",
          "name": "string",
          "plan": {
            "name": "string",
            "product": "string",
            "promotionCode": "string",
            "publisher": "string",
            "version": "string"
          },
          "properties": {
            "id": "string",
            "kind": "string",
            "location": "string",
            "name": "string",
            "properties": {
              "apiDefinitionUrl": "string",
              "backendService": {
                "id": "string",
                "kind": "string",
                "location": "string",
                "name": "string",
                "properties": {
                  "hostingEnvironmentServiceUrls": [
                    {
                      "hostId": "string",
                      "hostingEnvironmentId": "string",
                      "serviceUrl": "string",
                      "useInternalRouting": "bool"
                    }
                  ],
                  "serviceUrl": "string"
                },
                "tags": {
                  "{customized property}": "string"
                },
                "type": "string"
              },
              "capabilities": [ "string" ],
              "changedTime": "string",
              "connectionParameters": {
                "{customized property}": {
                  "defaultValue": {},
                  "oAuthSettings": {
                    "clientId": "string",
                    "clientSecret": "string",
                    "customParameters": {
                      "{customized property}": {
                        "options": {},
                        "uiDefinition": {},
                        "value": "string"
                      }
                    },
                    "identityProvider": "string",
                    "properties": {},
                    "redirectUrl": "string",
                    "scopes": [ "string" ]
                  },
                  "type": "string",
                  "uiDefinition": {}
                }
              },
              "createdTime": "string",
              "generalInformation": {
                "id": "string",
                "kind": "string",
                "location": "string",
                "name": "string",
                "properties": {
                  "connectionDisplayName": "string",
                  "connectionPortalUrl": {},
                  "description": "string",
                  "displayName": "string",
                  "iconUrl": "string",
                  "termsOfUseUrl": "string"
                },
                "tags": {
                  "{customized property}": "string"
                },
                "type": "string"
              },
              "metadata": {},
              "name": "string",
              "path": "string",
              "policies": {
                "id": "string",
                "kind": "string",
                "location": "string",
                "name": "string",
                "properties": {
                  "content": "string"
                },
                "tags": {
                  "{customized property}": "string"
                },
                "type": "string"
              },
              "protocols": [ "string" ],
              "runtimeUrls": [ "string" ]
            },
            "tags": {
              "{customized property}": "string"
            },
            "type": "string"
          },
          "sku": {
            "capacity": "int",
            "family": "string",
            "name": "string",
            "size": "string",
            "tier": "string"
          },
          "tags": {
            "{customized property}": "string"
          },
          "type": "string"
        },
        "id": "string"
      },
      "tags": {
        "{customized property}": "string"
      },
      "type": "string"
    },
    "changedTime": "string",
    "createdTime": "string",
    "customParameterValues": {
      "{customized property}": {
        "id": "string",
        "kind": "string",
        "location": "string",
        "name": "string",
        "properties": {
          "customParameters": {
            "{customized property}": {
              "id": "string",
              "kind": "string",
              "location": "string",
              "name": "string",
              "properties": {
                "option": "string"
              },
              "tags": {
                "{customized property}": "string"
              },
              "type": "string"
            }
          }
        },
        "tags": {
          "{customized property}": "string"
        },
        "type": "string"
      }
    },
    "displayName": "string",
    "firstExpirationTime": "string",
    "keywords": [ "string" ],
    "metadata": {},
    "name": "string",
    "nonSecretParameterValues": {
      "{customized property}": {}
    },
    "parameterValues": {
      "{customized property}": {}
    },
    "statuses": [
      {
        "id": "string",
        "kind": "string",
        "location": "string",
        "name": "string",
        "properties": {
          "error": {
            "id": "string",
            "kind": "string",
            "location": "string",
            "name": "string",
            "properties": {
              "code": "string",
              "message": "string"
            },
            "tags": {
              "{customized property}": "string"
            },
            "type": "string"
          },
          "status": "string",
          "target": "string"
        },
        "tags": {
          "{customized property}": "string"
        },
        "type": "string"
      }
    ],
    "tenantId": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Web/connections

Name Description Value
apiVersion The api version '2015-08-01-preview'
kind Kind of resource string
location Resource Location string (required)
name The resource name string (required)
properties ConnectionProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Web/connections'

ApiEntity

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ApiEntityProperties
tags Resource tags ResourceTags
type Resource type string

ApiEntityProperties

Name Description Value
apiDefinitionUrl API definition Url - url where the swagger can be downloaded from string
backendService Backend service definition BackendServiceDefinition
capabilities Capabilities string[]
changedTime Timestamp of last connection change. string
connectionParameters Connection parameters ApiEntityPropertiesConnectionParameters
createdTime Timestamp of the connection creation string
generalInformation the URL path of this API when exposed via APIM GeneralApiInformation
metadata Free form object for the data caller wants to store any
name Name of the API
the URL path of this API when exposed via APIM		 string
path the URL path of this API when exposed via APIM string
policies API policies ApiPolicies
protocols Protocols supported by the front end - http/https string[]
runtimeUrls Read only property returning the runtime endpoints where the API can be called string[]

ApiEntityPropertiesConnectionParameters

Name Description Value

ApiOAuthSettings

Name Description Value
clientId Resource provider client id string
clientSecret Client Secret needed for OAuth string
customParameters OAuth parameters key is the name of parameter ApiOAuthSettingsCustomParameters
identityProvider Identity provider string
properties Read only properties for this oauth setting. any
redirectUrl Url string
scopes OAuth scopes string[]

ApiOAuthSettingsCustomParameters

Name Description Value

ApiOAuthSettingsParameter

Name Description Value
options Read only: Options available to this parameter any
uiDefinition UI definitions per culture as caller can specify the culture any
value Value string

ApiPolicies

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ApiPoliciesProperties
tags Resource tags ResourceTags
type Resource type string

ApiPoliciesProperties

Name Description Value
content Content of xml policy string

ArmPlan

Name Description Value
name The name string
product The product string
promotionCode The promotion code string
publisher The publisher string
version Version of product string

BackendServiceDefinition

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties BackendServiceDefinitionProperties
tags Resource tags ResourceTags
type Resource type string

BackendServiceDefinitionProperties

Name Description Value
hostingEnvironmentServiceUrls Service Urls per Hosting environment HostingEnvironmentServiceDescriptions[]
serviceUrl Url from which the swagger payload will be fetched string

ConnectionError

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ConnectionErrorProperties
tags Resource tags ResourceTags
type Resource type string

ConnectionErrorProperties

Name Description Value
code code of the status string
message Description of the status string

ConnectionParameter

Name Description Value
defaultValue Default parameter value any
oAuthSettings Settings defining OAuth flow for the back end provider ApiOAuthSettings
type Type of the parameter 'array'
'bool'
'connection'
'int'
'oauthSetting'
'object'
'secureobject'
'securestring'
'string'
uiDefinition UI definitions any

ConnectionProperties

Name Description Value
api expanded connection provider name ExpandedParentApiEntity
changedTime Timestamp of last connection change. string
createdTime Timestamp of the connection creation string
customParameterValues Custom login setting values. ConnectionPropertiesCustomParameterValues
displayName display name string
firstExpirationTime Time in UTC when the first expiration of OAuth tokens string
keywords List of Keywords that tag the acl string[]
metadata Any object any
name connection name string
nonSecretParameterValues Tokens/Claim ConnectionPropertiesNonSecretParameterValues
parameterValues Tokens/Claim ConnectionPropertiesParameterValues
statuses Status of the connection ConnectionStatus[]
tenantId string

ConnectionPropertiesCustomParameterValues

Name Description Value

ConnectionPropertiesNonSecretParameterValues

Name Description Value

ConnectionPropertiesParameterValues

Name Description Value

ConnectionStatus

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ConnectionStatusProperties
tags Resource tags ResourceTags
type Resource type string

ConnectionStatusProperties

Name Description Value
error Error details ConnectionError
status Status string
target Target of the error string

CustomLoginSettingValue

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties CustomLoginSettingValueProperties
tags Resource tags ResourceTags
type Resource type string

CustomLoginSettingValueProperties

Name Description Value
option Option selected for this custom login setting value string

ExpandedParentApiEntity

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ExpandedParentApiEntityProperties
tags Resource tags ResourceTags
type Resource type string

ExpandedParentApiEntityProperties

Name Description Value
entity Id of connection provider ResponseMessageEnvelopeApiEntity
id Id of connection provider string

GeneralApiInformation

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties GeneralApiInformationProperties
tags Resource tags ResourceTags
type Resource type string

GeneralApiInformationProperties

Name Description Value
connectionDisplayName DefaultConnectionNameTemplate string
connectionPortalUrl ConnectionPortalUrl any
description Description string
displayName Display Name string
iconUrl Icon Url string
termsOfUseUrl a public accessible url of the Terms Of Use Url of this API string

HostingEnvironmentServiceDescriptions

Name Description Value
hostId Host Id string
hostingEnvironmentId Hosting environment Id string
serviceUrl service url to use string
useInternalRouting When the backend url is in same ASE, for performance reason this flag can be set to true
If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only
via API calls
Note: calls will fail if this option is used but back end is not on the same ASE		 bool

ParameterCustomLoginSettingValues

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ParameterCustomLoginSettingValuesProperties
tags Resource tags ResourceTags
type Resource type string

ParameterCustomLoginSettingValuesProperties

Name Description Value
customParameters Custom parameters. ParameterCustomLoginSettingValuesPropertiesCustomParameters

ParameterCustomLoginSettingValuesPropertiesCustomParameters

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResponseMessageEnvelopeApiEntity

Name Description Value
id Resource Id. Typically id is populated only for responses to GET requests. Caller is responsible for passing in this
value for GET requests only.
For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}		 string
location Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia string
name Name of resource string
plan Azure resource manager plan ArmPlan
properties Resource specific properties ApiEntity
sku Sku description of the resource SkuDescription
tags Tags associated with resource ResponseMessageEnvelopeApiEntityTags
type Type of resource e.g Microsoft.Web/sites string

ResponseMessageEnvelopeApiEntityTags

Name Description Value

SkuDescription

Name Description Value
capacity Current number of instances assigned to the resource int
family Family code of the resource sku string
name Name of the resource sku string
size Size specifier of the resource sku string
tier Service Tier of the resource sku string

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Alert to queue with Logic app

Deploy to Azure		 This template allows you to create a Logic app that has a webhook. When the Logic app is triggered, it will add the payload you pass to an Azure Storage queue that you specify. You can add this webhook to an Azure Alert and then whenever the Alert fires, you'll get that item in the queue.
Alert to Slack with Logic app

Deploy to Azure		 This template allows you to create a Logic app that has a webhook to be used from an Azure Alert. When the Alert is triggered, it will post a message to a slack channel that you specify. You need to have a slack account to use this template.
Alert to text message with Logic app

Deploy to Azure		 This template allows you to create a Logic app that has a webhook to be used from an Azure Alert. When the Alert is triggered, it will send you a text message with the details of the alert. It uses the go.gl URL shortening service to include a link to the portal to see the resource.
Azure Logic Apps - AS2 Send Receive

Deploy to Azure		 Creates integration accounts for two partners, Contoso and Fabrikam, including the artifacts for partners and agreements. The template also creates logic apps between Fabrikam Sales and Contoso to demonstrate synchronous AS2 Send Receive. The template also creates logic apps between Fabrikam Finance and Contoso, which demonstrate asynchronous AS2 Send Receive.
Azure Logic Apps - B2B Disaster Recovery replication

Deploy to Azure		 Creates replication Logic Apps for AS2 MIC, generated and received X12 control numbers. Each Logic App's trigger points to a primary site integration account. Each Logic App's action points to a secondary site integration account.
Copy FTP files to Azure Blob logic app

Deploy to Azure		 This template allows you to create a Logic app triggers on files in an FTP server and copies them to an Azure Blob container. You can add an additional triggers or actions to customize it to your needs.
Correlating messages over Logic Apps using Service Bus

Deploy to Azure		 which shows how we can correlate messages over Logic Apps using Azure Service Bus
Deploy a sample logic app, to use as Entitlement Management custom extensions

Deploy to Azure		 This template creates a simple logic app with all the authorization policy settings, service now connetion to create tickets and schema to http trigger that is needed by Entitlement Management custom extension API.
Logic App to email detailed backup reports

Deploy to Azure		 Create a Logic App to send reports on backup instances, usage, jobs, policies, policy adherence, and optimization opportunities via email.
Logic App to email reports on backup and restore jobs

Deploy to Azure		 Create a Logic App to send reports on your backup and restore jobs via email
Logic App to email reports on backup cost optimizmation

Deploy to Azure		 This template deploys a Logic App that sends periodic reports on inactive backup resources, possible backup schedule optimizations and possible backup retention optimizations, to a specified set of email addresses.
Logic App to email reports on backup instances

Deploy to Azure		 Create a Logic App to send reports on backup instances protected using Azure Backup via email
Logic App to email reports on backup policies

Deploy to Azure		 Create a Logic App to send reports on your backup policies via email
Logic App to email reports on backup policy adherence

Deploy to Azure		 Create a Logic App to send reports on backup policy adherence of your backup instances via email
Logic App to email reports on your Azure Backup billing

Deploy to Azure		 This template deploys a Logic App that sends periodic reports on key backup billing parameters (protected instances and backup cloud storage consumed) at a billing-entity level, to a specified set of email addresses.
Logic App to email summary reports on backups

Deploy to Azure		 Create a Logic App to send summary reports on your backups via email.
Retrieve Azure Storage access keys in ARM template

Deploy to Azure		 This template will create a Storage account, after which it will create a API connection by dynamically retrieving the primary key of the Storage account. The API connection is then used in a Logic App as a trigger polling for blob changes.
Run a SQL stored procedure on a schedule via a logic app

Deploy to Azure		 This template allows you to create a Logic App that will run a SQL stored procedure on schedule. Any arguments for the procedure can be put into the body section of the template.
Send email with Logic app

Deploy to Azure		 This template allows you to create a Logic app that sends an email. You can add an additional triggers or actions to customize it to your needs.

Terraform (AzAPI provider) resource definition

The connections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Web/connections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/connections@2015-08-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "string"
    properties = {
      api = {
        id = "string"
        kind = "string"
        location = "string"
        name = "string"
        properties = {
          entity = {
            id = "string"
            location = "string"
            name = "string"
            plan = {
              name = "string"
              product = "string"
              promotionCode = "string"
              publisher = "string"
              version = "string"
            }
            properties = {
              id = "string"
              kind = "string"
              location = "string"
              name = "string"
              properties = {
                apiDefinitionUrl = "string"
                backendService = {
                  id = "string"
                  kind = "string"
                  location = "string"
                  name = "string"
                  properties = {
                    hostingEnvironmentServiceUrls = [
                      {
                        hostId = "string"
                        hostingEnvironmentId = "string"
                        serviceUrl = "string"
                        useInternalRouting = bool
                      }
                    ]
                    serviceUrl = "string"
                  }
                  tags = {
                    {customized property} = "string"
                  }
                  type = "string"
                }
                capabilities = [
                  "string"
                ]
                changedTime = "string"
                connectionParameters = {
                  {customized property} = {
                    defaultValue = ?
                    oAuthSettings = {
                      clientId = "string"
                      clientSecret = "string"
                      customParameters = {
                        {customized property} = {
                          options = ?
                          uiDefinition = ?
                          value = "string"
                        }
                      }
                      identityProvider = "string"
                      properties = ?
                      redirectUrl = "string"
                      scopes = [
                        "string"
                      ]
                    }
                    type = "string"
                    uiDefinition = ?
                  }
                }
                createdTime = "string"
                generalInformation = {
                  id = "string"
                  kind = "string"
                  location = "string"
                  name = "string"
                  properties = {
                    connectionDisplayName = "string"
                    connectionPortalUrl = ?
                    description = "string"
                    displayName = "string"
                    iconUrl = "string"
                    termsOfUseUrl = "string"
                  }
                  tags = {
                    {customized property} = "string"
                  }
                  type = "string"
                }
                metadata = ?
                name = "string"
                path = "string"
                policies = {
                  id = "string"
                  kind = "string"
                  location = "string"
                  name = "string"
                  properties = {
                    content = "string"
                  }
                  tags = {
                    {customized property} = "string"
                  }
                  type = "string"
                }
                protocols = [
                  "string"
                ]
                runtimeUrls = [
                  "string"
                ]
              }
              tags = {
                {customized property} = "string"
              }
              type = "string"
            }
            sku = {
              capacity = int
              family = "string"
              name = "string"
              size = "string"
              tier = "string"
            }
            tags = {
              {customized property} = "string"
            }
            type = "string"
          }
          id = "string"
        }
        tags = {
          {customized property} = "string"
        }
        type = "string"
      }
      changedTime = "string"
      createdTime = "string"
      customParameterValues = {
        {customized property} = {
          id = "string"
          kind = "string"
          location = "string"
          name = "string"
          properties = {
            customParameters = {
              {customized property} = {
                id = "string"
                kind = "string"
                location = "string"
                name = "string"
                properties = {
                  option = "string"
                }
                tags = {
                  {customized property} = "string"
                }
                type = "string"
              }
            }
          }
          tags = {
            {customized property} = "string"
          }
          type = "string"
        }
      }
      displayName = "string"
      firstExpirationTime = "string"
      keywords = [
        "string"
      ]
      metadata = ?
      name = "string"
      nonSecretParameterValues = {
        {customized property} = ?
      }
      parameterValues = {
        {customized property} = ?
      }
      statuses = [
        {
          id = "string"
          kind = "string"
          location = "string"
          name = "string"
          properties = {
            error = {
              id = "string"
              kind = "string"
              location = "string"
              name = "string"
              properties = {
                code = "string"
                message = "string"
              }
              tags = {
                {customized property} = "string"
              }
              type = "string"
            }
            status = "string"
            target = "string"
          }
          tags = {
            {customized property} = "string"
          }
          type = "string"
        }
      ]
      tenantId = "string"
    }
  }
}

Property Values

Microsoft.Web/connections

Name Description Value
kind Kind of resource string
location Resource Location string (required)
name The resource name string (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
properties ConnectionProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Web/connections@2015-08-01-preview"

ApiEntity

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ApiEntityProperties
tags Resource tags ResourceTags
type Resource type string

ApiEntityProperties

Name Description Value
apiDefinitionUrl API definition Url - url where the swagger can be downloaded from string
backendService Backend service definition BackendServiceDefinition
capabilities Capabilities string[]
changedTime Timestamp of last connection change. string
connectionParameters Connection parameters ApiEntityPropertiesConnectionParameters
createdTime Timestamp of the connection creation string
generalInformation the URL path of this API when exposed via APIM GeneralApiInformation
metadata Free form object for the data caller wants to store any
name Name of the API
the URL path of this API when exposed via APIM		 string
path the URL path of this API when exposed via APIM string
policies API policies ApiPolicies
protocols Protocols supported by the front end - http/https string[]
runtimeUrls Read only property returning the runtime endpoints where the API can be called string[]

ApiEntityPropertiesConnectionParameters

Name Description Value

ApiOAuthSettings

Name Description Value
clientId Resource provider client id string
clientSecret Client Secret needed for OAuth string
customParameters OAuth parameters key is the name of parameter ApiOAuthSettingsCustomParameters
identityProvider Identity provider string
properties Read only properties for this oauth setting. any
redirectUrl Url string
scopes OAuth scopes string[]

ApiOAuthSettingsCustomParameters

Name Description Value

ApiOAuthSettingsParameter

Name Description Value
options Read only: Options available to this parameter any
uiDefinition UI definitions per culture as caller can specify the culture any
value Value string

ApiPolicies

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ApiPoliciesProperties
tags Resource tags ResourceTags
type Resource type string

ApiPoliciesProperties

Name Description Value
content Content of xml policy string

ArmPlan

Name Description Value
name The name string
product The product string
promotionCode The promotion code string
publisher The publisher string
version Version of product string

BackendServiceDefinition

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties BackendServiceDefinitionProperties
tags Resource tags ResourceTags
type Resource type string

BackendServiceDefinitionProperties

Name Description Value
hostingEnvironmentServiceUrls Service Urls per Hosting environment HostingEnvironmentServiceDescriptions[]
serviceUrl Url from which the swagger payload will be fetched string

ConnectionError

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ConnectionErrorProperties
tags Resource tags ResourceTags
type Resource type string

ConnectionErrorProperties

Name Description Value
code code of the status string
message Description of the status string

ConnectionParameter

Name Description Value
defaultValue Default parameter value any
oAuthSettings Settings defining OAuth flow for the back end provider ApiOAuthSettings
type Type of the parameter 'array'
'bool'
'connection'
'int'
'oauthSetting'
'object'
'secureobject'
'securestring'
'string'
uiDefinition UI definitions any

ConnectionProperties

Name Description Value
api expanded connection provider name ExpandedParentApiEntity
changedTime Timestamp of last connection change. string
createdTime Timestamp of the connection creation string
customParameterValues Custom login setting values. ConnectionPropertiesCustomParameterValues
displayName display name string
firstExpirationTime Time in UTC when the first expiration of OAuth tokens string
keywords List of Keywords that tag the acl string[]
metadata Any object any
name connection name string
nonSecretParameterValues Tokens/Claim ConnectionPropertiesNonSecretParameterValues
parameterValues Tokens/Claim ConnectionPropertiesParameterValues
statuses Status of the connection ConnectionStatus[]
tenantId string

ConnectionPropertiesCustomParameterValues

Name Description Value

ConnectionPropertiesNonSecretParameterValues

Name Description Value

ConnectionPropertiesParameterValues

Name Description Value

ConnectionStatus

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ConnectionStatusProperties
tags Resource tags ResourceTags
type Resource type string

ConnectionStatusProperties

Name Description Value
error Error details ConnectionError
status Status string
target Target of the error string

CustomLoginSettingValue

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties CustomLoginSettingValueProperties
tags Resource tags ResourceTags
type Resource type string

CustomLoginSettingValueProperties

Name Description Value
option Option selected for this custom login setting value string

ExpandedParentApiEntity

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ExpandedParentApiEntityProperties
tags Resource tags ResourceTags
type Resource type string

ExpandedParentApiEntityProperties

Name Description Value
entity Id of connection provider ResponseMessageEnvelopeApiEntity
id Id of connection provider string

GeneralApiInformation

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties GeneralApiInformationProperties
tags Resource tags ResourceTags
type Resource type string

GeneralApiInformationProperties

Name Description Value
connectionDisplayName DefaultConnectionNameTemplate string
connectionPortalUrl ConnectionPortalUrl any
description Description string
displayName Display Name string
iconUrl Icon Url string
termsOfUseUrl a public accessible url of the Terms Of Use Url of this API string

HostingEnvironmentServiceDescriptions

Name Description Value
hostId Host Id string
hostingEnvironmentId Hosting environment Id string
serviceUrl service url to use string
useInternalRouting When the backend url is in same ASE, for performance reason this flag can be set to true
If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only
via API calls
Note: calls will fail if this option is used but back end is not on the same ASE		 bool

ParameterCustomLoginSettingValues

Name Description Value
id Resource Id string
kind Kind of resource string
location Resource Location string (required)
name Resource Name string
properties ParameterCustomLoginSettingValuesProperties
tags Resource tags ResourceTags
type Resource type string

ParameterCustomLoginSettingValuesProperties

Name Description Value
customParameters Custom parameters. ParameterCustomLoginSettingValuesPropertiesCustomParameters

ParameterCustomLoginSettingValuesPropertiesCustomParameters

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResourceTags

Name Description Value

ResponseMessageEnvelopeApiEntity

Name Description Value
id Resource Id. Typically id is populated only for responses to GET requests. Caller is responsible for passing in this
value for GET requests only.
For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}		 string
location Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia string
name Name of resource string
plan Azure resource manager plan ArmPlan
properties Resource specific properties ApiEntity
sku Sku description of the resource SkuDescription
tags Tags associated with resource ResponseMessageEnvelopeApiEntityTags
type Type of resource e.g Microsoft.Web/sites string

ResponseMessageEnvelopeApiEntityTags

Name Description Value

SkuDescription

Name Description Value
capacity Current number of instances assigned to the resource int
family Family code of the resource sku string
name Name of the resource sku string
size Size specifier of the resource sku string
tier Service Tier of the resource sku string

Usage Examples

Terraform Samples

A basic example of deploying API Connection.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

provider "azurerm" {
  features {
  }
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "eastus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "workflows" {
  type      = "Microsoft.Logic/workflows@2019-05-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    identity = {
      type                   = "None"
      userAssignedIdentities = null
    }
    properties = {
      definition = {
        "$schema"      = "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#"
        contentVersion = "1.0.0.0"
      }
      state = "Enabled"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "namespaces" {
  type      = "Microsoft.ServiceBus/namespaces@2022-10-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    identity = {
      type                   = "None"
      userAssignedIdentities = null
    }
    properties = {
      disableLocalAuth           = false
      minimumTlsVersion          = "1.2"
      premiumMessagingPartitions = 0
      publicNetworkAccess        = "Enabled"
    }
    sku = {
      capacity = 0
      name     = "Basic"
      tier     = "Basic"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

data "azurerm_managed_api" "test" {
  name     = "servicebus"
  location = var.location

  depends_on = [azapi_resource.workflows, azapi_resource.namespaces]
}

resource "azapi_resource" "connection" {
  type      = "Microsoft.Web/connections@2016-06-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      api = {
        id = data.azurerm_managed_api.test.id
      }
      displayName = "Service Bus"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}