gateway_apis

Creates, updates, deletes, gets or lists a gateway_apis resource.

Overview

Name	gateway_apis
Type	Resource
Id	azure.api_management.gateway_apis

Fields

Name	Datatype	Description
properties	object	API Entity Properties

Methods

Name	Accessible by	Required Params	Description
list_by_service	SELECT	gatewayId, resourceGroupName, serviceName, subscriptionId	Lists a collection of the APIs associated with a gateway.
create_or_update	INSERT	apiId, gatewayId, resourceGroupName, serviceName, subscriptionId	Adds an API to the specified Gateway.
delete	DELETE	apiId, gatewayId, resourceGroupName, serviceName, subscriptionId	Deletes the specified API from the specified Gateway.

SELECT examples

Lists a collection of the APIs associated with a gateway.

SELECT
properties
FROM azure.api_management.gateway_apis
WHERE gatewayId = '{{ gatewayId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new gateway_apis resource.

All Properties

/*+ create */
INSERT INTO azure.api_management.gateway_apis (
apiId,
gatewayId,
resourceGroupName,
serviceName,
subscriptionId,
properties
)
SELECT 
'{{ apiId }}',
'{{ gatewayId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value: string

DELETE example

Deletes the specified gateway_apis resource.

/*+ delete */
DELETE FROM azure.api_management.gateway_apis
WHERE apiId = '{{ apiId }}'
AND gatewayId = '{{ gatewayId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';