api_gateway

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

Overview

Name	api_gateway
Type	Resource
Id	azure.api_management.api_gateway

Fields

The following fields are returned by SELECT queries:

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.
backend	object	Information regarding how the gateway should integrate with backend systems.
configurationApi	object	Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
createdAtUtc	string (date-time)	Creation UTC date of the API Management gateway.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
etag	string	ETag of the resource.
frontend	object	Information regarding how the gateway should be exposed.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
sku	object	SKU properties of the API Management gateway. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
targetProvisioningState	string	The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualNetworkType	string	The type of VPN in which API Management gateway needs to be configured in. Known values are: "None", "External", and "Internal". (None, External, Internal)

list_by_resource_group

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.
backend	object	Information regarding how the gateway should integrate with backend systems.
configurationApi	object	Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
createdAtUtc	string (date-time)	Creation UTC date of the API Management gateway.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
etag	string	ETag of the resource.
frontend	object	Information regarding how the gateway should be exposed.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
sku	object	SKU properties of the API Management gateway. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
targetProvisioningState	string	The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualNetworkType	string	The type of VPN in which API Management gateway needs to be configured in. Known values are: "None", "External", and "Internal". (None, External, Internal)

list

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.
backend	object	Information regarding how the gateway should integrate with backend systems.
configurationApi	object	Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
createdAtUtc	string (date-time)	Creation UTC date of the API Management gateway.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
etag	string	ETag of the resource.
frontend	object	Information regarding how the gateway should be exposed.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
sku	object	SKU properties of the API Management gateway. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
targetProvisioningState	string	The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualNetworkType	string	The type of VPN in which API Management gateway needs to be configured in. Known values are: "None", "External", and "Internal". (None, External, Internal)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, gateway_name, subscription_id		Gets an API Management gateway resource description.
list_by_resource_group	select	resource_group_name, subscription_id		List all API Management gateways within a resource group.
list	select	subscription_id		List all API Management gateways within a subscription.
create_or_update	insert	resource_group_name, gateway_name, subscription_id, location, properties, sku		Creates or updates an API Management gateway. This is long running operation and could take several minutes to complete.
update	update	resource_group_name, gateway_name, subscription_id		Updates an existing API Management gateway.
create_or_update	replace	resource_group_name, gateway_name, subscription_id, location, properties, sku		Creates or updates an API Management gateway. This is long running operation and could take several minutes to complete.
delete	delete	resource_group_name, gateway_name, subscription_id		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
gateway_name	string	The name of the API Management gateway. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets an API Management gateway resource description.

SELECT
id,
name,
backend,
configurationApi,
createdAtUtc,
etag,
frontend,
location,
provisioningState,
sku,
systemData,
tags,
targetProvisioningState,
type,
virtualNetworkType
FROM azure.api_management.api_gateway
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND gateway_name = '{{ gateway_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List all API Management gateways within a resource group.

SELECT
id,
name,
backend,
configurationApi,
createdAtUtc,
etag,
frontend,
location,
provisioningState,
sku,
systemData,
tags,
targetProvisioningState,
type,
virtualNetworkType
FROM azure.api_management.api_gateway
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all API Management gateways within a subscription.

SELECT
id,
name,
backend,
configurationApi,
createdAtUtc,
etag,
frontend,
location,
provisioningState,
sku,
systemData,
tags,
targetProvisioningState,
type,
virtualNetworkType
FROM azure.api_management.api_gateway
WHERE subscription_id = '{{ subscription_id }}' -- 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_gateway (
tags,
location,
properties,
sku,
resource_group_name,
gateway_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ sku }}' /* required */,
'{{ resource_group_name }}',
'{{ gateway_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: api_gateway
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the api_gateway resource.
  - name: gateway_name
    value: "{{ gateway_name }}"
    description: Required parameter for the api_gateway resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the api_gateway resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties of the API Management gateway. Required.
    value:
      provisioningState: "{{ provisioningState }}"
      targetProvisioningState: "{{ targetProvisioningState }}"
      createdAtUtc: "{{ createdAtUtc }}"
      frontend:
        defaultHostname: "{{ defaultHostname }}"
      backend:
        subnet:
          id: "{{ id }}"
      configurationApi:
        hostname: "{{ hostname }}"
      virtualNetworkType: "{{ virtualNetworkType }}"
  - name: sku
    description: |
      SKU properties of the API Management gateway. Required.
    value:
      name: "{{ name }}"
      capacity: {{ capacity }}

UPDATE examples

update

Updates an existing API Management gateway.

UPDATE azure.api_management.api_gateway
SET 
tags = '{{ tags }}',
properties = '{{ properties }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND gateway_name = '{{ gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

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

REPLACE azure.api_management.api_gateway
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND gateway_name = '{{ gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
AND sku = '{{ sku }}' --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_gateway
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND gateway_name = '{{ gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;