integration_service_environments

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

Overview

Name	integration_service_environments
Type	Resource
Id	azure.logic.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.
encryptionConfiguration	object	The encryption configuration.
endpointsConfiguration	object	The endpoints configuration.
identity	object	Managed service identity properties.
integrationServiceEnvironmentId	string	Gets the tracking id.
location	string	The resource location.
networkConfiguration	object	The network configuration.
provisioningState	string	The provisioning state. Known values are: "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", "Moving", "Updating", "Registering", "Registered", "Unregistering", "Unregistered", "Completed", "Renewing", "Pending", "Waiting", and "InProgress".
sku	object	The sku.
state	string	The integration service environment state. Known values are: "NotSpecified", "Completed", "Enabled", "Disabled", "Deleted", and "Suspended".
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.
encryptionConfiguration	object	The encryption configuration.
endpointsConfiguration	object	The endpoints configuration.
identity	object	Managed service identity properties.
integrationServiceEnvironmentId	string	Gets the tracking id.
location	string	The resource location.
networkConfiguration	object	The network configuration.
provisioningState	string	The provisioning state. Known values are: "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", "Moving", "Updating", "Registering", "Registered", "Unregistering", "Unregistered", "Completed", "Renewing", "Pending", "Waiting", and "InProgress".
sku	object	The sku.
state	string	The integration service environment state. Known values are: "NotSpecified", "Completed", "Enabled", "Disabled", "Deleted", and "Suspended".
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.
encryptionConfiguration	object	The encryption configuration.
endpointsConfiguration	object	The endpoints configuration.
identity	object	Managed service identity properties.
integrationServiceEnvironmentId	string	Gets the tracking id.
location	string	The resource location.
networkConfiguration	object	The network configuration.
provisioningState	string	The provisioning state. Known values are: "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", "Moving", "Updating", "Registering", "Registered", "Unregistering", "Unregistered", "Completed", "Renewing", "Pending", "Waiting", and "InProgress".
sku	object	The sku.
state	string	The integration service environment state. Known values are: "NotSpecified", "Completed", "Enabled", "Disabled", "Deleted", and "Suspended".
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	resource_group, integration_service_environment_name, subscription_id		Gets an integration service environment.
list_by_resource_group	select	resource_group, subscription_id	$top	Gets a list of integration service environments by resource group.
list_by_subscription	select	subscription_id	$top	Gets a list of integration service environments by subscription.
create_or_update	insert	resource_group, integration_service_environment_name, subscription_id		Creates or updates an integration service environment.
update	update	resource_group, integration_service_environment_name, subscription_id		Updates an integration service environment.
create_or_update	replace	resource_group, integration_service_environment_name, subscription_id		Creates or updates an integration service environment.
delete	delete	resource_group, integration_service_environment_name, subscription_id		Deletes an integration service environment.
restart	exec	resource_group, integration_service_environment_name, subscription_id		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
integration_service_environment_name	string	The integration service environment name. Required.
resource_group	string	The resource group. Required.
subscription_id	string
$top	integer	The number of items to be included in the result. Default value is None.

SELECT examples

get

Gets an integration service environment.

SELECT
id,
name,
encryptionConfiguration,
endpointsConfiguration,
identity,
integrationServiceEnvironmentId,
location,
networkConfiguration,
provisioningState,
sku,
state,
tags,
type
FROM azure.logic.integration_service_environments
WHERE resource_group = '{{ resource_group }}' -- required
AND integration_service_environment_name = '{{ integration_service_environment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets a list of integration service environments by resource group.

SELECT
id,
name,
encryptionConfiguration,
endpointsConfiguration,
identity,
integrationServiceEnvironmentId,
location,
networkConfiguration,
provisioningState,
sku,
state,
tags,
type
FROM azure.logic.integration_service_environments
WHERE resource_group = '{{ resource_group }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

list_by_subscription

Gets a list of integration service environments by subscription.

SELECT
id,
name,
encryptionConfiguration,
endpointsConfiguration,
identity,
integrationServiceEnvironmentId,
location,
networkConfiguration,
provisioningState,
sku,
state,
tags,
type
FROM azure.logic.integration_service_environments
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates an integration service environment.

INSERT INTO azure.logic.integration_service_environments (
location,
tags,
properties,
sku,
identity,
resource_group,
integration_service_environment_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ sku }}',
'{{ identity }}',
'{{ resource_group }}',
'{{ integration_service_environment_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: integration_service_environments
props:
  - name: resource_group
    value: "{{ resource_group }}"
    description: Required parameter for the integration_service_environments resource.
  - name: integration_service_environment_name
    value: "{{ integration_service_environment_name }}"
    description: Required parameter for the integration_service_environments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the integration_service_environments resource.
  - name: location
    value: "{{ location }}"
    description: |
      The resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      The resource tags.
  - name: properties
    description: |
      The integration service environment properties.
    value:
      provisioningState: "{{ provisioningState }}"
      state: "{{ state }}"
      integrationServiceEnvironmentId: "{{ integrationServiceEnvironmentId }}"
      endpointsConfiguration:
        workflow:
          outgoingIpAddresses:
            - address: "{{ address }}"
          accessEndpointIpAddresses:
            - address: "{{ address }}"
        connector:
          outgoingIpAddresses:
            - address: "{{ address }}"
          accessEndpointIpAddresses:
            - address: "{{ address }}"
      networkConfiguration:
        virtualNetworkAddressSpace: "{{ virtualNetworkAddressSpace }}"
        accessEndpoint:
          type: "{{ type }}"
        subnets:
          - id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
      encryptionConfiguration:
        encryptionKeyReference:
          keyVault:
            id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
          keyName: "{{ keyName }}"
          keyVersion: "{{ keyVersion }}"
  - name: sku
    description: |
      The sku.
    value:
      name: "{{ name }}"
      capacity: {{ capacity }}
  - name: identity
    description: |
      Managed service identity properties.
    value:
      type: "{{ type }}"
      tenantId: "{{ tenantId }}"
      principalId: "{{ principalId }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Updates an integration service environment.

UPDATE azure.logic.integration_service_environments
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}',
sku = '{{ sku }}',
identity = '{{ identity }}'
WHERE 
resource_group = '{{ resource_group }}' --required
AND integration_service_environment_name = '{{ integration_service_environment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
tags,
type;

REPLACE examples

create_or_update

Creates or updates an integration service environment.

REPLACE azure.logic.integration_service_environments
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}',
sku = '{{ sku }}',
identity = '{{ identity }}'
WHERE 
resource_group = '{{ resource_group }}' --required
AND integration_service_environment_name = '{{ integration_service_environment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Deletes an integration service environment.

DELETE FROM azure.logic.integration_service_environments
WHERE resource_group = '{{ resource_group }}' --required
AND integration_service_environment_name = '{{ integration_service_environment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

restart

Restarts an integration service environment.

EXEC azure.logic.integration_service_environments.restart 
@resource_group='{{ resource_group }}' --required, 
@integration_service_environment_name='{{ integration_service_environment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;