integration_service_environments

Creates, updates, deletes, gets or lists an integration_service_environments resource.

Overview

Name	integration_service_environments
Type	Resource
Id	azure.logic_apps.integration_service_environments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the resource name.
identity	object	Managed service identity properties.
location	string	The resource location.
properties	object	The integration service environment properties.
sku	object	The sku.
tags	object	The resource tags.
type	string	Gets the resource type.

list_by_resource_group

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the resource name.
identity	object	Managed service identity properties.
location	string	The resource location.
properties	object	The integration service environment properties.
sku	object	The sku.
tags	object	The resource tags.
type	string	Gets the resource type.

list_by_subscription

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the resource name.
identity	object	Managed service identity properties.
location	string	The resource location.
properties	object	The integration service environment properties.
sku	object	The sku.
tags	object	The resource tags.
type	string	Gets the resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroup, integrationServiceEnvironmentName	api-version	Gets an integration service environment.
list_by_resource_group	select	subscriptionId, resourceGroup	api-version, $top	Gets a list of integration service environments by resource group.
list_by_subscription	select	subscriptionId	api-version, $top	Gets a list of integration service environments by subscription.
create_or_update	insert	subscriptionId, resourceGroup, integrationServiceEnvironmentName	api-version	Creates or updates an integration service environment.
update	update	subscriptionId, resourceGroup, integrationServiceEnvironmentName	api-version	Updates an integration service environment.
delete	delete	subscriptionId, resourceGroup, integrationServiceEnvironmentName	api-version	Deletes an integration service environment.
restart	exec	subscriptionId, resourceGroup, integrationServiceEnvironmentName	api-version	Restarts an integration service environment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
integrationServiceEnvironmentName	string	The integration service environment name.
resourceGroup	string	The resource group.
subscriptionId	string	The subscription id.
$top	integer (int32)	The number of items to be included in the result.
api-version	string	The API version.

SELECT examples

get

Gets an integration service environment.

SELECT
id,
name,
identity,
location,
properties,
sku,
tags,
type
FROM azure.logic_apps.integration_service_environments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroup = '{{ resourceGroup }}' -- required
AND integrationServiceEnvironmentName = '{{ integrationServiceEnvironmentName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

Gets a list of integration service environments by resource group.

SELECT
id,
name,
identity,
location,
properties,
sku,
tags,
type
FROM azure.logic_apps.integration_service_environments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroup = '{{ resourceGroup }}' -- required
AND api-version = '{{ api-version }}'
AND $top = '{{ $top }}'
;

list_by_subscription

Gets a list of integration service environments by subscription.

SELECT
id,
name,
identity,
location,
properties,
sku,
tags,
type
FROM azure.logic_apps.integration_service_environments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates an integration service environment.

INSERT INTO azure.logic_apps.integration_service_environments (
data__properties,
data__sku,
data__identity,
data__location,
data__tags,
subscriptionId,
resourceGroup,
integrationServiceEnvironmentName,
api-version
)
SELECT 
'{{ properties }}',
'{{ sku }}',
'{{ identity }}',
'{{ location }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroup }}',
'{{ integrationServiceEnvironmentName }}',
'{{ api-version }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: integration_service_environments
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the integration_service_environments resource.
    - name: resourceGroup
      value: string
      description: Required parameter for the integration_service_environments resource.
    - name: integrationServiceEnvironmentName
      value: string
      description: Required parameter for the integration_service_environments resource.
    - name: properties
      value: object
      description: |
        The integration service environment properties.
    - name: sku
      value: object
      description: |
        The sku.
    - name: identity
      value: object
      description: |
        Managed service identity properties.
    - name: location
      value: string
      description: |
        The resource location.
    - name: tags
      value: object
      description: |
        The resource tags.
    - name: api-version
      value: string
      description: The API version.

UPDATE examples

update

Updates an integration service environment.

UPDATE azure.logic_apps.integration_service_environments
SET 
data__properties = '{{ properties }}',
data__sku = '{{ sku }}',
data__identity = '{{ identity }}',
data__location = '{{ location }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroup = '{{ resourceGroup }}' --required
AND integrationServiceEnvironmentName = '{{ integrationServiceEnvironmentName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Deletes an integration service environment.

DELETE FROM azure.logic_apps.integration_service_environments
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroup = '{{ resourceGroup }}' --required
AND integrationServiceEnvironmentName = '{{ integrationServiceEnvironmentName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

restart

Restarts an integration service environment.

EXEC azure.logic_apps.integration_service_environments.restart 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroup='{{ resourceGroup }}' --required, 
@integrationServiceEnvironmentName='{{ integrationServiceEnvironmentName }}' --required, 
@api-version='{{ api-version }}'
;