api_gateways

Creates, updates, deletes, gets or lists an api_gateways resource.

Overview

Name	api_gateways
Type	Resource
Id	azure.api_management.api_gateways

Fields

The following fields are returned by SELECT queries:

get

Successfully got the API Management gateway Resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	ETag of the resource.
location	string	Resource location.
properties	object	Properties of the API Management gateway.
sku	object	SKU properties of the API Management gateway.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	Resource type for API Management resource is set to Microsoft.ApiManagement.

list_by_resource_group

The API Management gateways list.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	ETag of the resource.
location	string	Resource location.
properties	object	Properties of the API Management gateway.
sku	object	SKU properties of the API Management gateway.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	Resource type for API Management resource is set to Microsoft.ApiManagement.

list

The API Management gateways list.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	ETag of the resource.
location	string	Resource location.
properties	object	Properties of the API Management gateway.
sku	object	SKU properties of the API Management gateway.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	Resource type for API Management resource is set to Microsoft.ApiManagement.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, gatewayName, subscriptionId		Gets an API Management gateway resource description.
list_by_resource_group	select	resourceGroupName, subscriptionId		List all API Management gateways within a resource group.
list	select	subscriptionId		List all API Management gateways within a subscription.
create_or_update	insert	resourceGroupName, gatewayName, subscriptionId, data__location, data__sku, data__properties		Creates or updates an API Management gateway. This is long running operation and could take several minutes to complete.
update	update	resourceGroupName, gatewayName, subscriptionId		Updates an existing API Management gateway.
delete	delete	resourceGroupName, gatewayName, subscriptionId		Deletes an existing API Management 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
gatewayName	string	The name of the API Management gateway.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets an API Management gateway resource description.

SELECT
id,
name,
etag,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.api_management.api_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND gatewayName = '{{ gatewayName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

List all API Management gateways within a resource group.

SELECT
id,
name,
etag,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.api_management.api_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

List all API Management gateways within a subscription.

SELECT
id,
name,
etag,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.api_management.api_gateways
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates an API Management gateway. This is long running operation and could take several minutes to complete.

INSERT INTO azure.api_management.api_gateways (
data__properties,
data__sku,
data__location,
data__tags,
resourceGroupName,
gatewayName,
subscriptionId
)
SELECT 
'{{ properties }}' /* required */,
'{{ sku }}' /* required */,
'{{ location }}' /* required */,
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ gatewayName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: api_gateways
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the api_gateways resource.
    - name: gatewayName
      value: string
      description: Required parameter for the api_gateways resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the api_gateways resource.
    - name: properties
      value: object
      description: |
        Properties of the API Management gateway.
    - name: sku
      value: object
      description: |
        SKU properties of the API Management gateway.
    - name: location
      value: string
      description: |
        Resource location.
    - name: tags
      value: object
      description: |
        Resource tags.

UPDATE examples

update

Updates an existing API Management gateway.

UPDATE azure.api_management.api_gateways
SET 
data__properties = '{{ properties }}',
data__sku = '{{ sku }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND gatewayName = '{{ gatewayName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
etag,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes an existing API Management gateway.

DELETE FROM azure.api_management.api_gateways
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND gatewayName = '{{ gatewayName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;