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

The following fields are returned by SELECT queries:

list_by_service

The response body contains a collection of Api entities in the gateway.

Name	Datatype	Description
properties	object	API entity contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_service	select	resourceGroupName, serviceName, gatewayId, subscriptionId	$filter, $top, $skip	Lists a collection of the APIs associated with a gateway.
create_or_update	insert	resourceGroupName, serviceName, gatewayId, apiId, subscriptionId		Adds an API to the specified Gateway.
delete	delete	resourceGroupName, serviceName, gatewayId, apiId, subscriptionId		Deletes the specified API from the specified Gateway.

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
apiId	string	API identifier. Must be unique in the current API Management service instance.
gatewayId	string	Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.

SELECT examples

list_by_service

Lists a collection of the APIs associated with a gateway.

SELECT
properties
FROM azure.api_management.gateway_apis
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND gatewayId = '{{ gatewayId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Adds an API to the specified Gateway.

INSERT INTO azure.api_management.gateway_apis (
data__properties,
resourceGroupName,
serviceName,
gatewayId,
apiId,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ gatewayId }}',
'{{ apiId }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: gateway_apis
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the gateway_apis resource.
    - name: serviceName
      value: string
      description: Required parameter for the gateway_apis resource.
    - name: gatewayId
      value: string
      description: Required parameter for the gateway_apis resource.
    - name: apiId
      value: string
      description: Required parameter for the gateway_apis resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the gateway_apis resource.
    - name: properties
      value: string
      description: |
        Association entity contract properties.

DELETE examples

delete

Deletes the specified API from the specified Gateway.

DELETE FROM azure.api_management.gateway_apis
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND gatewayId = '{{ gatewayId }}' --required
AND apiId = '{{ apiId }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;