api_gateways

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

Overview

Name	api_gateways
Type	Resource
Id	azure.api_management.api_gateways

Fields

vw_api_gateways

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
backend	text	field from the properties object
configuration_api	text	field from the properties object
created_at_utc	text	field from the properties object
etag	text	ETag of the resource.
frontend	text	field from the properties object
gatewayName	text	field from the properties object
location	text	Resource location.
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	API Management gateway resource SKU properties.
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.
target_provisioning_state	text	field from the properties object
type	text	Resource type for API Management resource is set to Microsoft.ApiManagement.
virtual_network_type	text	field from the properties object

api_gateways

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 an API Management gateway resource description.
sku	object	API Management gateway resource SKU properties.
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

Name	Accessible by	Required Params	Description
get	SELECT	gatewayName, resourceGroupName, subscriptionId	Gets an API Management gateway resource description.
list	SELECT	subscriptionId	List all API Management gateways within a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	List all API Management gateways within a resource group.
create_or_update	INSERT	gatewayName, resourceGroupName, subscriptionId, data__location, data__properties, data__sku	Creates or updates an API Management gateway. This is long running operation and could take several minutes to complete.
delete	DELETE	gatewayName, resourceGroupName, subscriptionId	Deletes an existing API Management gateway.
update	UPDATE	gatewayName, resourceGroupName, subscriptionId	Updates an existing API Management gateway.

SELECT examples

List all API Management gateways within a subscription.

vw_api_gateways

SELECT
id,
name,
backend,
configuration_api,
created_at_utc,
etag,
frontend,
gatewayName,
location,
provisioning_state,
resourceGroupName,
sku,
subscriptionId,
system_data,
tags,
target_provisioning_state,
type,
virtual_network_type
FROM azure.api_management.vw_api_gateways
WHERE subscriptionId = '{{ subscriptionId }}';

api_gateways

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

INSERT example

Use the following StackQL query and manifest file to create a new api_gateways resource.

All Properties

/*+ create */
INSERT INTO azure.api_management.api_gateways (
gatewayName,
resourceGroupName,
subscriptionId,
data__location,
data__properties,
data__sku,
properties,
sku,
location,
tags
)
SELECT 
'{{ gatewayName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ data__properties }}',
'{{ data__sku }}',
'{{ properties }}',
'{{ sku }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: targetProvisioningState
          value: string
        - name: createdAtUtc
          value: string
        - name: frontend
          value:
            - name: defaultHostname
              value: string
        - name: backend
          value:
            - name: subnet
              value:
                - name: id
                  value: string
        - name: configurationApi
          value:
            - name: hostname
              value: string
        - name: virtualNetworkType
          value: string
    - name: sku
      value:
        - name: name
          value: string
        - name: capacity
          value: integer
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: location
      value: string
    - name: etag
      value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: tags
      value: object

UPDATE example

Updates a api_gateways resource.

/*+ update */
UPDATE azure.api_management.api_gateways
SET 
properties = '{{ properties }}',
sku = '{{ sku }}',
tags = '{{ tags }}'
WHERE 
gatewayName = '{{ gatewayName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified api_gateways resource.

/*+ delete */
DELETE FROM azure.api_management.api_gateways
WHERE gatewayName = '{{ gatewayName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';