Share via

Microsoft.Logic integrationServiceEnvironments 2019-05-01

Bicep resource definition

The integrationServiceEnvironments 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.Logic/integrationServiceEnvironments resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Logic/integrationServiceEnvironments@2019-05-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    encryptionConfiguration: {
      encryptionKeyReference: {
        keyName: 'string'
        keyVault: {
          id: 'string'
        }
        keyVersion: 'string'
      }
    }
    endpointsConfiguration: {
      connector: {
        accessEndpointIpAddresses: [
          {
            address: 'string'
          }
        ]
        outgoingIpAddresses: [
          {
            address: 'string'
          }
        ]
      }
      workflow: {
        accessEndpointIpAddresses: [
          {
            address: 'string'
          }
        ]
        outgoingIpAddresses: [
          {
            address: 'string'
          }
        ]
      }
    }
    integrationServiceEnvironmentId: 'string'
    networkConfiguration: {
      accessEndpoint: {
        type: 'string'
      }
      subnets: [
        {
          id: 'string'
        }
      ]
      virtualNetworkAddressSpace: 'string'
    }
    provisioningState: 'string'
    state: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Logic/integrationServiceEnvironments

Name Description Value
identity Managed service identity properties. ManagedServiceIdentity
location The resource location. string
name The resource name string (required)
properties The integration service environment properties. IntegrationServiceEnvironmentProperties
sku The sku. IntegrationServiceEnvironmentSku
tags Resource tags Dictionary of tag names and values. See Tags in templates

FlowEndpoints

Name Description Value
accessEndpointIpAddresses The access endpoint ip address. IpAddress[]
outgoingIpAddresses The outgoing ip address. IpAddress[]

FlowEndpointsConfiguration

Name Description Value
connector The connector endpoints. FlowEndpoints
workflow The workflow endpoints. FlowEndpoints

IntegrationServiceEnvironmenEncryptionConfiguration

Name Description Value
encryptionKeyReference The encryption key reference. IntegrationServiceEnvironmenEncryptionKeyReference

IntegrationServiceEnvironmenEncryptionKeyReference

Name Description Value
keyName Gets the key name in the Key Vault. string
keyVault The key vault reference. ResourceReference
keyVersion Gets the version of the key specified in the keyName property. string

IntegrationServiceEnvironmentAccessEndpoint

Name Description Value
type The access endpoint type. 'External'
'Internal'
'NotSpecified'

IntegrationServiceEnvironmentProperties

Name Description Value
encryptionConfiguration The encryption configuration. IntegrationServiceEnvironmenEncryptionConfiguration
endpointsConfiguration The endpoints configuration. FlowEndpointsConfiguration
integrationServiceEnvironmentId Gets the tracking id. string
networkConfiguration The network configuration. NetworkConfiguration
provisioningState The provisioning state. 'Accepted'
'Canceled'
'Completed'
'Created'
'Creating'
'Deleted'
'Deleting'
'Failed'
'InProgress'
'Moving'
'NotSpecified'
'Pending'
'Ready'
'Registered'
'Registering'
'Renewing'
'Running'
'Succeeded'
'Unregistered'
'Unregistering'
'Updating'
'Waiting'
state The integration service environment state. 'Completed'
'Deleted'
'Disabled'
'Enabled'
'NotSpecified'
'Suspended'

IntegrationServiceEnvironmentSku

Name Description Value
capacity The sku capacity. int
name The sku name. 'Developer'
'NotSpecified'
'Premium'

IpAddress

Name Description Value
address The address. string

ManagedServiceIdentity

Name Description Value
type Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. 'None'
'SystemAssigned'
'UserAssigned' (required)
userAssignedIdentities The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

NetworkConfiguration

Name Description Value
accessEndpoint The access endpoint. IntegrationServiceEnvironmentAccessEndpoint
subnets The subnets. ResourceReference[]
virtualNetworkAddressSpace Gets the virtual network address space. string

ResourceReference

Name Description Value
id The resource id. string

ResourceTags

Name Description Value

UserAssignedIdentity

Name Description Value

ARM template resource definition

The integrationServiceEnvironments 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.Logic/integrationServiceEnvironments resource, add the following JSON to your template.

{
  "type": "Microsoft.Logic/integrationServiceEnvironments",
  "apiVersion": "2019-05-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "encryptionConfiguration": {
      "encryptionKeyReference": {
        "keyName": "string",
        "keyVault": {
          "id": "string"
        },
        "keyVersion": "string"
      }
    },
    "endpointsConfiguration": {
      "connector": {
        "accessEndpointIpAddresses": [
          {
            "address": "string"
          }
        ],
        "outgoingIpAddresses": [
          {
            "address": "string"
          }
        ]
      },
      "workflow": {
        "accessEndpointIpAddresses": [
          {
            "address": "string"
          }
        ],
        "outgoingIpAddresses": [
          {
            "address": "string"
          }
        ]
      }
    },
    "integrationServiceEnvironmentId": "string",
    "networkConfiguration": {
      "accessEndpoint": {
        "type": "string"
      },
      "subnets": [
        {
          "id": "string"
        }
      ],
      "virtualNetworkAddressSpace": "string"
    },
    "provisioningState": "string",
    "state": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Logic/integrationServiceEnvironments

Name Description Value
apiVersion The api version '2019-05-01'
identity Managed service identity properties. ManagedServiceIdentity
location The resource location. string
name The resource name string (required)
properties The integration service environment properties. IntegrationServiceEnvironmentProperties
sku The sku. IntegrationServiceEnvironmentSku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Logic/integrationServiceEnvironments'

FlowEndpoints

Name Description Value
accessEndpointIpAddresses The access endpoint ip address. IpAddress[]
outgoingIpAddresses The outgoing ip address. IpAddress[]

FlowEndpointsConfiguration

Name Description Value
connector The connector endpoints. FlowEndpoints
workflow The workflow endpoints. FlowEndpoints

IntegrationServiceEnvironmenEncryptionConfiguration

Name Description Value
encryptionKeyReference The encryption key reference. IntegrationServiceEnvironmenEncryptionKeyReference

IntegrationServiceEnvironmenEncryptionKeyReference

Name Description Value
keyName Gets the key name in the Key Vault. string
keyVault The key vault reference. ResourceReference
keyVersion Gets the version of the key specified in the keyName property. string

IntegrationServiceEnvironmentAccessEndpoint

Name Description Value
type The access endpoint type. 'External'
'Internal'
'NotSpecified'

IntegrationServiceEnvironmentProperties

Name Description Value
encryptionConfiguration The encryption configuration. IntegrationServiceEnvironmenEncryptionConfiguration
endpointsConfiguration The endpoints configuration. FlowEndpointsConfiguration
integrationServiceEnvironmentId Gets the tracking id. string
networkConfiguration The network configuration. NetworkConfiguration
provisioningState The provisioning state. 'Accepted'
'Canceled'
'Completed'
'Created'
'Creating'
'Deleted'
'Deleting'
'Failed'
'InProgress'
'Moving'
'NotSpecified'
'Pending'
'Ready'
'Registered'
'Registering'
'Renewing'
'Running'
'Succeeded'
'Unregistered'
'Unregistering'
'Updating'
'Waiting'
state The integration service environment state. 'Completed'
'Deleted'
'Disabled'
'Enabled'
'NotSpecified'
'Suspended'

IntegrationServiceEnvironmentSku

Name Description Value
capacity The sku capacity. int
name The sku name. 'Developer'
'NotSpecified'
'Premium'

IpAddress

Name Description Value
address The address. string

ManagedServiceIdentity

Name Description Value
type Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. 'None'
'SystemAssigned'
'UserAssigned' (required)
userAssignedIdentities The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

NetworkConfiguration

Name Description Value
accessEndpoint The access endpoint. IntegrationServiceEnvironmentAccessEndpoint
subnets The subnets. ResourceReference[]
virtualNetworkAddressSpace Gets the virtual network address space. string

ResourceReference

Name Description Value
id The resource id. string

ResourceTags

Name Description Value

UserAssignedIdentity

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Integration Service Environment Template

Deploy to Azure		 Template that creates a virtual network, 4 subnets, and then an Integration Service Environment (ISE), including non-native connectors. Use as a base for templates that require a Logic Apps ISE.

Terraform (AzAPI provider) resource definition

The integrationServiceEnvironments 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.Logic/integrationServiceEnvironments resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Logic/integrationServiceEnvironments@2019-05-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      encryptionConfiguration = {
        encryptionKeyReference = {
          keyName = "string"
          keyVault = {
            id = "string"
          }
          keyVersion = "string"
        }
      }
      endpointsConfiguration = {
        connector = {
          accessEndpointIpAddresses = [
            {
              address = "string"
            }
          ]
          outgoingIpAddresses = [
            {
              address = "string"
            }
          ]
        }
        workflow = {
          accessEndpointIpAddresses = [
            {
              address = "string"
            }
          ]
          outgoingIpAddresses = [
            {
              address = "string"
            }
          ]
        }
      }
      integrationServiceEnvironmentId = "string"
      networkConfiguration = {
        accessEndpoint = {
          type = "string"
        }
        subnets = [
          {
            id = "string"
          }
        ]
        virtualNetworkAddressSpace = "string"
      }
      provisioningState = "string"
      state = "string"
    }
    sku = {
      capacity = int
      name = "string"
    }
  }
}

Property Values

Microsoft.Logic/integrationServiceEnvironments

Name Description Value
identity Managed service identity properties. ManagedServiceIdentity
location The resource location. string
name The resource name string (required)
properties The integration service environment properties. IntegrationServiceEnvironmentProperties
sku The sku. IntegrationServiceEnvironmentSku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Logic/integrationServiceEnvironments@2019-05-01"

FlowEndpoints

Name Description Value
accessEndpointIpAddresses The access endpoint ip address. IpAddress[]
outgoingIpAddresses The outgoing ip address. IpAddress[]

FlowEndpointsConfiguration

Name Description Value
connector The connector endpoints. FlowEndpoints
workflow The workflow endpoints. FlowEndpoints

IntegrationServiceEnvironmenEncryptionConfiguration

Name Description Value
encryptionKeyReference The encryption key reference. IntegrationServiceEnvironmenEncryptionKeyReference

IntegrationServiceEnvironmenEncryptionKeyReference

Name Description Value
keyName Gets the key name in the Key Vault. string
keyVault The key vault reference. ResourceReference
keyVersion Gets the version of the key specified in the keyName property. string

IntegrationServiceEnvironmentAccessEndpoint

Name Description Value
type The access endpoint type. 'External'
'Internal'
'NotSpecified'

IntegrationServiceEnvironmentProperties

Name Description Value
encryptionConfiguration The encryption configuration. IntegrationServiceEnvironmenEncryptionConfiguration
endpointsConfiguration The endpoints configuration. FlowEndpointsConfiguration
integrationServiceEnvironmentId Gets the tracking id. string
networkConfiguration The network configuration. NetworkConfiguration
provisioningState The provisioning state. 'Accepted'
'Canceled'
'Completed'
'Created'
'Creating'
'Deleted'
'Deleting'
'Failed'
'InProgress'
'Moving'
'NotSpecified'
'Pending'
'Ready'
'Registered'
'Registering'
'Renewing'
'Running'
'Succeeded'
'Unregistered'
'Unregistering'
'Updating'
'Waiting'
state The integration service environment state. 'Completed'
'Deleted'
'Disabled'
'Enabled'
'NotSpecified'
'Suspended'

IntegrationServiceEnvironmentSku

Name Description Value
capacity The sku capacity. int
name The sku name. 'Developer'
'NotSpecified'
'Premium'

IpAddress

Name Description Value
address The address. string

ManagedServiceIdentity

Name Description Value
type Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. 'None'
'SystemAssigned'
'UserAssigned' (required)
userAssignedIdentities The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

NetworkConfiguration

Name Description Value
accessEndpoint The access endpoint. IntegrationServiceEnvironmentAccessEndpoint
subnets The subnets. ResourceReference[]
virtualNetworkAddressSpace Gets the virtual network address space. string

ResourceReference

Name Description Value
id The resource id. string

ResourceTags

Name Description Value

UserAssignedIdentity

Name Description Value