Microsoft.Web connections

• Latest
• 2016-06-01

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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@2016-06-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  etag: 'string'
  properties: {
    api: {
      brandColor: 'string'
      description: 'string'
      displayName: 'string'
      iconUri: 'string'
      id: 'string'
      name: 'string'
      swagger: any()
      type: 'string'
    }
    changedTime: 'string'
    createdTime: 'string'
    customParameterValues: {}
    displayName: 'string'
    nonSecretParameterValues: {}
    parameterValues: {}
    statuses: [
      {
        error: {
          etag: 'string'
          location: 'string'
          properties: {
            code: 'string'
            message: 'string'
          }
          tags: {}
        }
        status: 'string'
        target: 'string'
      }
    ]
    testLinks: [
      {
        method: 'string'
        requestUri: 'string'
      }
    ]
  }
}

Property values

connections

Name	Description	Value
name	The resource name	string (required)
location	Resource location	string
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
etag	Resource ETag	string
properties		ApiConnectionDefinitionProperties

ApiConnectionDefinitionProperties

Name	Description	Value
api		ApiReference
changedTime	Timestamp of last connection change	string
createdTime	Timestamp of the connection creation	string
customParameterValues	Dictionary of custom parameter values	object
displayName	Display name	string
nonSecretParameterValues	Dictionary of nonsecret parameter values	object
parameterValues	Dictionary of parameter values	object
statuses	Status of the connection	ConnectionStatusDefinition[]
testLinks	Links to test the API connection	ApiConnectionTestLink[]

ApiReference

Name	Description	Value
brandColor	Brand color	string
description	The custom API description	string
displayName	The display name	string
iconUri	The icon URI	string
id	Resource reference id	string
name	The name of the API	string
swagger	The JSON representation of the swagger	For Bicep, you can use the any() function.
type	Resource reference type	string

ConnectionStatusDefinition

Name	Description	Value
error	Connection error	ConnectionError
status	The gateway status	string
target	Target of the error	string

ConnectionError

Name	Description	Value
etag	Resource ETag	string
location	Resource location	string
properties		ConnectionErrorProperties
tags	Resource tags	object

ConnectionErrorProperties

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

ApiConnectionTestLink

Name	Description	Value
method	HTTP Method	string
requestUri	Test link request URI	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Alert to queue with Logic app	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	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	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.
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. The complete scenario can be found on /samples/azure/azure-quickstart-templates/arm-template-retrieve-azure-storage-access-keys/.
Logic App to email detailed backup reports	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 instances	Create a Logic App to send reports on backup instances protected using Azure Backup via email
Logic App to email reports on backup and restore jobs	Create a Logic App to send reports on your backup and restore jobs via email
Logic App to email reports on backup cost optimizmation	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 policies	Create a Logic App to send reports on your backup policies via email
Logic App to email reports on backup policy adherence	Create a Logic App to send reports on backup policy adherence of your backup instances via email
Logic App to email summary reports on backups	Create a Logic App to send summary reports on your backups via email.
Logic App to email reports on your Azure Backup billing	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.
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.
Azure Logic Apps - B2B Disaster Recovery replication	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.
Correlating messages over Logic Apps using Service Bus	which shows how we can correlate messages over Logic Apps using Azure Service Bus
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.
Send email with Logic app	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.
Run a SQL stored procedure on a schedule via a logic app	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.

ARM template resource definition

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

• Resource groups - See resource group deployment commands

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": "2016-06-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "etag": "string",
  "properties": {
    "api": {
      "brandColor": "string",
      "description": "string",
      "displayName": "string",
      "iconUri": "string",
      "id": "string",
      "name": "string",
      "swagger": {},
      "type": "string"
    },
    "changedTime": "string",
    "createdTime": "string",
    "customParameterValues": {},
    "displayName": "string",
    "nonSecretParameterValues": {},
    "parameterValues": {},
    "statuses": [
      {
        "error": {
          "etag": "string",
          "location": "string",
          "properties": {
            "code": "string",
            "message": "string"
          },
          "tags": {}
        },
        "status": "string",
        "target": "string"
      }
    ],
    "testLinks": [
      {
        "method": "string",
        "requestUri": "string"
      }
    ]
  }
}

Property values

connections

Name	Description	Value
type	The resource type	'Microsoft.Web/connections'
apiVersion	The resource api version	'2016-06-01'
name	The resource name	string (required)
location	Resource location	string
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
etag	Resource ETag	string
properties		ApiConnectionDefinitionProperties

ApiConnectionDefinitionProperties

Name	Description	Value
api		ApiReference
changedTime	Timestamp of last connection change	string
createdTime	Timestamp of the connection creation	string
customParameterValues	Dictionary of custom parameter values	object
displayName	Display name	string
nonSecretParameterValues	Dictionary of nonsecret parameter values	object
parameterValues	Dictionary of parameter values	object
statuses	Status of the connection	ConnectionStatusDefinition[]
testLinks	Links to test the API connection	ApiConnectionTestLink[]

ApiReference

Name	Description	Value
brandColor	Brand color	string
description	The custom API description	string
displayName	The display name	string
iconUri	The icon URI	string
id	Resource reference id	string
name	The name of the API	string
swagger	The JSON representation of the swagger
type	Resource reference type	string

ConnectionStatusDefinition

Name	Description	Value
error	Connection error	ConnectionError
status	The gateway status	string
target	Target of the error	string

ConnectionError

Name	Description	Value
etag	Resource ETag	string
location	Resource location	string
properties		ConnectionErrorProperties
tags	Resource tags	object

ConnectionErrorProperties

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

ApiConnectionTestLink

Name	Description	Value
method	HTTP Method	string
requestUri	Test link request URI	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Alert to queue with Logic app	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	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	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.
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. The complete scenario can be found on /samples/azure/azure-quickstart-templates/arm-template-retrieve-azure-storage-access-keys/.
Logic App to email detailed backup reports	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 instances	Create a Logic App to send reports on backup instances protected using Azure Backup via email
Logic App to email reports on backup and restore jobs	Create a Logic App to send reports on your backup and restore jobs via email
Logic App to email reports on backup cost optimizmation	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 policies	Create a Logic App to send reports on your backup policies via email
Logic App to email reports on backup policy adherence	Create a Logic App to send reports on backup policy adherence of your backup instances via email
Logic App to email summary reports on backups	Create a Logic App to send summary reports on your backups via email.
Logic App to email reports on your Azure Backup billing	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.
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.
Azure Logic Apps - B2B Disaster Recovery replication	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.
Correlating messages over Logic Apps using Service Bus	which shows how we can correlate messages over Logic Apps using Azure Service Bus
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.
Send email with Logic app	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.
Run a SQL stored procedure on a schedule via a logic app	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.

Terraform (AzAPI provider) resource definition

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

• Resource groups

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@2016-06-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      api = {
        brandColor = "string"
        description = "string"
        displayName = "string"
        iconUri = "string"
        id = "string"
        name = "string"
        type = "string"
      }
      changedTime = "string"
      createdTime = "string"
      customParameterValues = {}
      displayName = "string"
      nonSecretParameterValues = {}
      parameterValues = {}
      statuses = [
        {
          error = {
            etag = "string"
            location = "string"
            properties = {
              code = "string"
              message = "string"
            }
            tags = {}
          }
          status = "string"
          target = "string"
        }
      ]
      testLinks = [
        {
          method = "string"
          requestUri = "string"
        }
      ]
    }
    etag = "string"
  })
}

Property values

connections

Name	Description	Value
type	The resource type	"Microsoft.Web/connections@2016-06-01"
name	The resource name	string (required)
location	Resource location	string
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Resource tags	Dictionary of tag names and values.
etag	Resource ETag	string
properties		ApiConnectionDefinitionProperties

ApiConnectionDefinitionProperties

Name	Description	Value
api		ApiReference
changedTime	Timestamp of last connection change	string
createdTime	Timestamp of the connection creation	string
customParameterValues	Dictionary of custom parameter values	object
displayName	Display name	string
nonSecretParameterValues	Dictionary of nonsecret parameter values	object
parameterValues	Dictionary of parameter values	object
statuses	Status of the connection	ConnectionStatusDefinition[]
testLinks	Links to test the API connection	ApiConnectionTestLink[]

ApiReference

Name	Description	Value
brandColor	Brand color	string
description	The custom API description	string
displayName	The display name	string
iconUri	The icon URI	string
id	Resource reference id	string
name	The name of the API	string
swagger	The JSON representation of the swagger
type	Resource reference type	string

ConnectionStatusDefinition

Name	Description	Value
error	Connection error	ConnectionError
status	The gateway status	string
target	Target of the error	string

ConnectionError

Name	Description	Value
etag	Resource ETag	string
location	Resource location	string
properties		ConnectionErrorProperties
tags	Resource tags	object

ConnectionErrorProperties

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

ApiConnectionTestLink

Name	Description	Value
method	HTTP Method	string
requestUri	Test link request URI	string