integration_service_environment_managed_apis

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

Overview

Name	integration_service_environment_managed_apis
Type	Resource
Id	azure.logic.integration_service_environment_managed_apis

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the resource name.
apiDefinitionUrl	string	The API definition.
apiDefinitions	object	The api definitions.
backendService	object	The backend service.
capabilities	array	The capabilities.
category	string	The category. Known values are: "NotSpecified", "Enterprise", "Standard", and "Premium".
connectionParameters	object	The connection parameters.
deploymentParameters	object	The integration service environment managed api deployment parameters.
generalInformation	object	The api general information.
integrationServiceEnvironment	object	The integration service environment reference.
location	string	The resource location.
metadata	object	The metadata.
policies	object	The policies for the API.
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".
runtimeUrls	array	The runtime urls.
tags	object	The resource tags.
type	string	Gets the resource type.

list

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the resource name.
apiDefinitionUrl	string	The API definition.
apiDefinitions	object	The api definitions.
backendService	object	The backend service.
capabilities	array	The capabilities.
category	string	The category. Known values are: "NotSpecified", "Enterprise", "Standard", and "Premium".
connectionParameters	object	The connection parameters.
deploymentParameters	object	The integration service environment managed api deployment parameters.
generalInformation	object	The api general information.
integrationServiceEnvironment	object	The integration service environment reference.
location	string	The resource location.
metadata	object	The metadata.
policies	object	The policies for the API.
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".
runtimeUrls	array	The runtime urls.
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, api_name, subscription_id		Gets the integration service environment managed Api.
list	select	resource_group, integration_service_environment_name, subscription_id		Gets the integration service environment managed Apis.
delete	delete	resource_group, integration_service_environment_name, api_name, subscription_id		Deletes the integration service environment managed Api.
put	exec	resource_group, integration_service_environment_name, api_name, subscription_id		Puts the integration service environment managed Api.

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
api_name	string	The api name. Required.
integration_service_environment_name	string	The integration service environment name. Required.
resource_group	string	The resource group name. Required.
subscription_id	string

SELECT examples

get

Gets the integration service environment managed Api.

SELECT
id,
name,
apiDefinitionUrl,
apiDefinitions,
backendService,
capabilities,
category,
connectionParameters,
deploymentParameters,
generalInformation,
integrationServiceEnvironment,
location,
metadata,
policies,
provisioningState,
runtimeUrls,
tags,
type
FROM azure.logic.integration_service_environment_managed_apis
WHERE resource_group = '{{ resource_group }}' -- required
AND integration_service_environment_name = '{{ integration_service_environment_name }}' -- required
AND api_name = '{{ api_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the integration service environment managed Apis.

SELECT
id,
name,
apiDefinitionUrl,
apiDefinitions,
backendService,
capabilities,
category,
connectionParameters,
deploymentParameters,
generalInformation,
integrationServiceEnvironment,
location,
metadata,
policies,
provisioningState,
runtimeUrls,
tags,
type
FROM azure.logic.integration_service_environment_managed_apis
WHERE resource_group = '{{ resource_group }}' -- required
AND integration_service_environment_name = '{{ integration_service_environment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

DELETE examples

delete

Deletes the integration service environment managed Api.

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

Lifecycle Methods

put

Puts the integration service environment managed Api.

EXEC azure.logic.integration_service_environment_managed_apis.put 
@resource_group='{{ resource_group }}' --required, 
@integration_service_environment_name='{{ integration_service_environment_name }}' --required, 
@api_name='{{ api_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"properties": "{{ properties }}"
}'
;