gateways

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

Overview

Name	gateways
Type	Resource
Id	azure.api_management.gateways

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified Gateway entity.

Name	Datatype	Description
properties	object	Gateway details.

list_by_service

Lists a collection of Gateway entities.

Name	Datatype	Description
properties	object	Gateway details.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, gatewayId, subscriptionId		Gets the details of the Gateway specified by its identifier.
list_by_service	select	resourceGroupName, serviceName, subscriptionId	$filter, $top, $skip	Lists a collection of gateways registered with service instance.
create_or_update	insert	resourceGroupName, serviceName, gatewayId, subscriptionId	If-Match	Creates or updates a Gateway to be used in Api Management instance.
update	update	resourceGroupName, serviceName, gatewayId, If-Match, subscriptionId		Updates the details of the gateway specified by its identifier.
delete	delete	resourceGroupName, serviceName, gatewayId, If-Match, subscriptionId		Deletes specific Gateway.
regenerate_key	exec	resourceGroupName, serviceName, gatewayId, subscriptionId, keyType		Regenerates specified gateway key invalidating any tokens created with it.
generate_token	exec	resourceGroupName, serviceName, gatewayId, subscriptionId, keyType, expiry		Gets the Shared Access Authorization Token for the gateway.
invalidate_debug_credentials	exec	subscriptionId, resourceGroupName, serviceName, gatewayId		Action is invalidating all debug credentials issued for 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
If-Match	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
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>| region | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | 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.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

SELECT examples

get

Gets the details of the Gateway specified by its identifier.

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

list_by_service

Lists a collection of gateways registered with service instance.

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

INSERT examples

create_or_update

Creates or updates a Gateway to be used in Api Management instance.

INSERT INTO azure.api_management.gateways (
data__properties,
resourceGroupName,
serviceName,
gatewayId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ gatewayId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: gateways
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the gateways resource.
    - name: serviceName
      value: string
      description: Required parameter for the gateways resource.
    - name: gatewayId
      value: string
      description: Required parameter for the gateways resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the gateways resource.
    - name: properties
      value: object
      description: |
        Gateway details.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

UPDATE examples

update

Updates the details of the gateway specified by its identifier.

UPDATE azure.api_management.gateways
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND gatewayId = '{{ gatewayId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes specific Gateway.

DELETE FROM azure.api_management.gateways
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND gatewayId = '{{ gatewayId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

regenerate_key

Regenerates specified gateway key invalidating any tokens created with it.

EXEC azure.api_management.gateways.regenerate_key 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@gatewayId='{{ gatewayId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"keyType": "{{ keyType }}"
}'
;

generate_token

Gets the Shared Access Authorization Token for the gateway.

EXEC azure.api_management.gateways.generate_token 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@gatewayId='{{ gatewayId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"keyType": "{{ keyType }}", 
"expiry": "{{ expiry }}"
}'
;

invalidate_debug_credentials

Action is invalidating all debug credentials issued for gateway.

EXEC azure.api_management.gateways.invalidate_debug_credentials 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@gatewayId='{{ gatewayId }}' --required
;