gateway

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

Overview

Name	gateway
Type	Resource
Id	azure.api_management.gateway

Fields

The following fields are returned by SELECT queries:

list_debug_credentials

Name	Datatype	Description
token	string	Gateway debug token.

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	Gateway description.
identity	object	The managed service identities assigned to this resource.
locationData	object	Gateway location.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_service

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	Gateway description.
identity	object	The managed service identities assigned to this resource.
locationData	object	Gateway location.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_debug_credentials	select	resource_group_name, service_name, gateway_id, subscription_id		Create new debug credentials for gateway.
get	select	resource_group_name, service_name, gateway_id, subscription_id		Gets the details of the Gateway specified by its identifier.
list_by_service	select	resource_group_name, service_name, subscription_id	$filter, $top, $skip	Lists a collection of gateways registered with service instance.
create_or_update	insert	resource_group_name, service_name, gateway_id, subscription_id		Creates or updates a Gateway to be used in Api Management instance.
update	update	resource_group_name, service_name, gateway_id, subscription_id		Updates the details of the gateway specified by its identifier.
create_or_update	replace	resource_group_name, service_name, gateway_id, subscription_id		Creates or updates a Gateway to be used in Api Management instance.
delete	delete	resource_group_name, service_name, gateway_id, subscription_id		Deletes specific Gateway.
get_entity_tag	exec	resource_group_name, service_name, gateway_id, subscription_id		Gets the entity state (Etag) version of the Gateway specified by its identifier.
list_keys	exec	resource_group_name, service_name, gateway_id, subscription_id		Retrieves gateway keys.
list_trace	exec	resource_group_name, service_name, gateway_id, subscription_id		Fetches trace collected by gateway.
regenerate_key	exec	resource_group_name, service_name, gateway_id, subscription_id, keyType		Regenerates specified gateway key invalidating any tokens created with it.
generate_token	exec	resource_group_name, service_name, gateway_id, subscription_id, keyType, expiry		Gets the Shared Access Authorization Token for the gateway.
invalidate_debug_credentials	exec	resource_group_name, service_name, gateway_id, subscription_id		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
gateway_id	string	Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || region | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |. Default value is None.
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.

SELECT examples

list_debug_credentials

Create new debug credentials for gateway.

SELECT
token
FROM azure.api_management.gateway
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND gateway_id = '{{ gateway_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets the details of the Gateway specified by its identifier.

SELECT
id,
name,
description,
identity,
locationData,
systemData,
type
FROM azure.api_management.gateway
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND gateway_id = '{{ gateway_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Lists a collection of gateways registered with service instance.

SELECT
id,
name,
description,
identity,
locationData,
systemData,
type
FROM azure.api_management.gateway
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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.gateway (
properties,
identity,
resource_group_name,
service_name,
gateway_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ gateway_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: gateway
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the gateway resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the gateway resource.
  - name: gateway_id
    value: "{{ gateway_id }}"
    description: Required parameter for the gateway resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the gateway resource.
  - name: properties
    description: |
      Gateway details.
    value:
      locationData:
        name: "{{ name }}"
        city: "{{ city }}"
        district: "{{ district }}"
        countryOrRegion: "{{ countryOrRegion }}"
      description: "{{ description }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Updates the details of the gateway specified by its identifier.

UPDATE azure.api_management.gateway
SET 
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND gateway_id = '{{ gateway_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
properties,
systemData,
type;

REPLACE examples

create_or_update

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

REPLACE azure.api_management.gateway
SET 
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND gateway_id = '{{ gateway_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
properties,
systemData,
type;

DELETE examples

delete

Deletes specific Gateway.

DELETE FROM azure.api_management.gateway
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND gateway_id = '{{ gateway_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_tag

Gets the entity state (Etag) version of the Gateway specified by its identifier.

EXEC azure.api_management.gateway.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@gateway_id='{{ gateway_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_keys

Retrieves gateway keys.

EXEC azure.api_management.gateway.list_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@gateway_id='{{ gateway_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_trace

Fetches trace collected by gateway.

EXEC azure.api_management.gateway.list_trace 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@gateway_id='{{ gateway_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"traceId": "{{ traceId }}"
}'
;

regenerate_key

Regenerates specified gateway key invalidating any tokens created with it.

EXEC azure.api_management.gateway.regenerate_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@gateway_id='{{ gateway_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyType": "{{ keyType }}"
}'
;

generate_token

Gets the Shared Access Authorization Token for the gateway.

EXEC azure.api_management.gateway.generate_token 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@gateway_id='{{ gateway_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyType": "{{ keyType }}", 
"expiry": "{{ expiry }}"
}'
;

invalidate_debug_credentials

Action is invalidating all debug credentials issued for gateway.

EXEC azure.api_management.gateway.invalidate_debug_credentials 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@gateway_id='{{ gateway_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;