API Connections [Microsoft.Web/connections]

⚠️THIS MODULE IS CURRENTLY ORPHANED.⚠️

• Only security and bug fixes are being handled by the AVM core team at present.
• If interested in becoming the module owner of this orphaned module (must be Microsoft FTE), please look for the related "orphaned module" GitHub issue here!

This module deploys an Azure API Connection.

Navigation

• Resource Types
• Usage examples
• Parameters
• Outputs
• Cross-referenced modules
• Data Collection

Resource Types

Usage examples

The following section provides usage examples for the module, which were used to validate and deploy the module successfully. For a full reference, please review the module's test folder in its repository.

Note: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.

Note: To reference the module, please use the following syntax ./packages/api-connections/main.bicep.

• Using only defaults
• Using large parameter set
• WAF-aligned

Example 1: Using only defaults

This instance deploys the module with the minimum set of required parameters.

module connection './packages/api-connections/main.bicep' = {
  name: 'connectionDeployment'
  params: {
    // Required parameters
    displayName: 'azuremonitorlogs'
    name: 'azuremonitor'
    // Non-required parameters
    api: {
      id: '<id>'
    }
    location: '<location>'
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "displayName": {
      "value": "azuremonitorlogs"
    },
    "name": {
      "value": "azuremonitor"
    },
    // Non-required parameters
    "api": {
      "value": {
        "id": "<id>"
      }
    },
    "location": {
      "value": "<location>"
    }
  }
}

using './packages/api-connections/main.bicep'

// Required parameters
param displayName = 'azuremonitorlogs'
param name = 'azuremonitor'
// Non-required parameters
param api = {
  id: '<id>'
}
param location = '<location>'

Example 2: Using large parameter set

This instance deploys the module with most of its features enabled.

module connection './packages/api-connections/main.bicep' = {
  name: 'connectionDeployment'
  params: {
    // Required parameters
    displayName: 'azuremonitorlogs'
    name: 'azuremonitor'
    // Non-required parameters
    api: {
      id: '<id>'
    }
    location: '<location>'
    lock: {
      kind: 'CanNotDelete'
      name: 'myCustomLockName'
    }
    roleAssignments: [
      {
        name: '396667c8-de54-4dcb-916a-72af71359f34'
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: 'Owner'
      }
      {
        name: '<name>'
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: 'b24988ac-6180-42a0-ab88-20f7382dd24c'
      }
      {
        principalId: '<principalId>'
        principalType: 'ServicePrincipal'
        roleDefinitionIdOrName: '<roleDefinitionIdOrName>'
      }
    ]
    tags: {
      Environment: 'Non-Prod'
      'hidden-title': 'This is visible in the resource name'
      Role: 'DeploymentValidation'
    }
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "displayName": {
      "value": "azuremonitorlogs"
    },
    "name": {
      "value": "azuremonitor"
    },
    // Non-required parameters
    "api": {
      "value": {
        "id": "<id>"
      }
    },
    "location": {
      "value": "<location>"
    },
    "lock": {
      "value": {
        "kind": "CanNotDelete",
        "name": "myCustomLockName"
      }
    },
    "roleAssignments": {
      "value": [
        {
          "name": "396667c8-de54-4dcb-916a-72af71359f34",
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "Owner"
        },
        {
          "name": "<name>",
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "b24988ac-6180-42a0-ab88-20f7382dd24c"
        },
        {
          "principalId": "<principalId>",
          "principalType": "ServicePrincipal",
          "roleDefinitionIdOrName": "<roleDefinitionIdOrName>"
        }
      ]
    },
    "tags": {
      "value": {
        "Environment": "Non-Prod",
        "hidden-title": "This is visible in the resource name",
        "Role": "DeploymentValidation"
      }
    }
  }
}

using './packages/api-connections/main.bicep'

// Required parameters
param displayName = 'azuremonitorlogs'
param name = 'azuremonitor'
// Non-required parameters
param api = {
  id: '<id>'
}
param location = '<location>'
param lock = {
  kind: 'CanNotDelete'
  name: 'myCustomLockName'
}
param roleAssignments = [
  {
    name: '396667c8-de54-4dcb-916a-72af71359f34'
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: 'Owner'
  }
  {
    name: '<name>'
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: 'b24988ac-6180-42a0-ab88-20f7382dd24c'
  }
  {
    principalId: '<principalId>'
    principalType: 'ServicePrincipal'
    roleDefinitionIdOrName: '<roleDefinitionIdOrName>'
  }
]
param tags = {
  Environment: 'Non-Prod'
  'hidden-title': 'This is visible in the resource name'
  Role: 'DeploymentValidation'
}

Example 3: WAF-aligned

This instance deploys the module in alignment with the best-practices of the Azure Well-Architected Framework.

module connection './packages/api-connections/main.bicep' = {
  name: 'connectionDeployment'
  params: {
    // Required parameters
    displayName: 'azuremonitorlogs'
    name: 'azuremonitor'
    // Non-required parameters
    api: {
      id: '<id>'
    }
    location: '<location>'
    tags: {
      Environment: 'Non-Prod'
      'hidden-title': 'This is visible in the resource name'
      Role: 'DeploymentValidation'
    }
  }
}

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    // Required parameters
    "displayName": {
      "value": "azuremonitorlogs"
    },
    "name": {
      "value": "azuremonitor"
    },
    // Non-required parameters
    "api": {
      "value": {
        "id": "<id>"
      }
    },
    "location": {
      "value": "<location>"
    },
    "tags": {
      "value": {
        "Environment": "Non-Prod",
        "hidden-title": "This is visible in the resource name",
        "Role": "DeploymentValidation"
      }
    }
  }
}

using './packages/api-connections/main.bicep'

// Required parameters
param displayName = 'azuremonitorlogs'
param name = 'azuremonitor'
// Non-required parameters
param api = {
  id: '<id>'
}
param location = '<location>'
param tags = {
  Environment: 'Non-Prod'
  'hidden-title': 'This is visible in the resource name'
  Role: 'DeploymentValidation'
}

Parameters

Required parameters

Optional parameters

Parameter: displayName

Display name connection. Example: blobconnection when using blobs. It can change depending on the resource.

• Required: Yes
• Type: string

Parameter: name

Connection name for connection. It can change depending on the resource.

• Required: Yes
• Type: string

Parameter: api

Specific values for some API connections.

• Required: No
• Type: object
• Example:

  // for a Service Bus connection
  {
    type: 'Microsoft.Web/locations/managedApis'
    id: subscriptionResourceId('Microsoft.Web/locations/managedApis', '${resourceLocation}', 'servicebus')
  }
  

Parameter: customParameterValues

Dictionary of custom parameter values for specific connections.

• Required: No
• Type: object

Parameter: enableTelemetry

Enable/Disable usage telemetry for module.

• Required: No
• Type: bool
• Default: True

Parameter: location

Location of the deployment.

• Required: No
• Type: string
• Default: [resourceGroup().location]

Parameter: lock

The lock settings of the service.

• Required: No
• Type: object

Optional parameters

Parameter: lock.kind

Specify the type of lock.

• Required: No
• Type: string
• Allowed:

  [
    'CanNotDelete'
    'None'
    'ReadOnly'
  ]
  

Parameter: lock.name

Specify the name of lock.

• Required: No
• Type: string

Parameter: nonSecretParameterValues

Dictionary of nonsecret parameter values.

• Required: No
• Type: object

Parameter: parameterValues

Connection strings or access keys for connection. Example: accountName and accessKey when using blobs. It can change depending on the resource.

• Required: No
• Type: secureObject
• Example:

  {
    connectionString: 'listKeys('/subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/Microsoft.ServiceBus/namespaces/AuthorizationRules/<serviceBusName>/RootManagedSharedAccessKey', '2023-01-01').primaryConnectionString'
  }
  {
    rootfolder: fileshareConnection.rootfolder
    authType: fileshareConnection.authType
    // to add an object, use the any() function
    gateway: any({
      name: fileshareConnection.odgw.name
      id: resourceId(fileshareConnection.odgw.resourceGroup, 'Microsoft.Web/connectionGateways', fileshareConnection.odgw.name)
      type: 'Microsoft.Web/connectionGateways'
    })
    username: username
    password: password
  }
  

Parameter: parameterValueSet

Additional parameter value set used for authentication settings.

• Required: No
• Type: object
• Example:

  // for a Service Bus connection
  {
    name: 'managedIdentityAuth'
    values: {
      namespaceEndpoint: {
        value: 'sb://${dependency.outputs.serviceBusEndpoint}'
      }
    }
  }
  

Parameter: roleAssignments

Array of role assignments to create.

• Required: No
• Type: array
• Roles configurable by name:
  • 'Contributor'
  • 'Owner'
  • 'Reader'
  • 'Role Based Access Control Administrator'
  • 'User Access Administrator'

Required parameters

Optional parameters

Parameter: roleAssignments.principalId

The principal ID of the principal (user/group/identity) to assign the role to.

• Required: Yes
• Type: string

Parameter: roleAssignments.roleDefinitionIdOrName

The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.

• Required: Yes
• Type: string

Parameter: roleAssignments.condition

The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container".

• Required: No
• Type: string

Parameter: roleAssignments.conditionVersion

Version of the condition.

• Required: No
• Type: string
• Allowed:

  [
    '2.0'
  ]
  

Parameter: roleAssignments.delegatedManagedIdentityResourceId

The Resource Id of the delegated managed identity resource.

• Required: No
• Type: string

Parameter: roleAssignments.description

The description of the role assignment.

• Required: No
• Type: string

Parameter: roleAssignments.name

The name (as GUID) of the role assignment. If not provided, a GUID will be generated.

• Required: No
• Type: string

Parameter: roleAssignments.principalType

The principal type of the assigned principal ID.

• Required: No
• Type: string
• Allowed:

  [
    'Device'
    'ForeignGroup'
    'Group'
    'ServicePrincipal'
    'User'
  ]
  

Parameter: statuses

The status of the connection.

• Required: No
• Type: array

Parameter: tags

Tags of the resource.

• Required: No
• Type: object
• Example:

  {
      key1: 'value1'
      key2: 'value2'
  }
  

Parameter: testLinks

Links to test the API connection.

• Required: No
• Type: array

Outputs

Cross-referenced modules

This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.