gateway_keys

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

Overview

Name	gateway_keys
Type	Resource
Id	azure.api_management.gateway_keys

Fields

The following fields are returned by SELECT queries:

list

The response body contains the specified Gateway keys.

Name	Datatype	Description
primary	string	Primary gateway key.
secondary	string	Secondary gateway key.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resourceGroupName, serviceName, gatewayId, subscriptionId		Retrieves gateway keys.

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
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.

SELECT examples

list

Retrieves gateway keys.

SELECT
primary,
secondary
FROM azure.api_management.gateway_keys
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND gatewayId = '{{ gatewayId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;