api_gateway_config_connections

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

Overview

Name	api_gateway_config_connections
Type	Resource
Id	azure.api_management.api_gateway_config_connections

Fields

vw_api_gateway_config_connections

Name	Datatype	Description
configConnectionName	text	field from the properties object
default_hostname	text	field from the properties object
etag	text	ETag of the resource.
gatewayName	text	field from the properties object
hostnames	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
source_id	text	field from the properties object
subscriptionId	text	field from the properties object

api_gateway_config_connections

Name	Datatype	Description
etag	string	ETag of the resource.
properties	object

Methods

Name	Accessible by	Required Params	Description
get	SELECT	configConnectionName, gatewayName, resourceGroupName, subscriptionId	Gets an API Management gateway config connection resource description.
list_by_gateway	SELECT	gatewayName, resourceGroupName, subscriptionId	List all API Management gateway config connections within a gateway.
create_or_update	INSERT	configConnectionName, gatewayName, resourceGroupName, subscriptionId, data__properties	Creates or updates an API Management gateway config connection. This is long running operation and could take several minutes to complete.
delete	DELETE	If-Match, configConnectionName, gatewayName, resourceGroupName, subscriptionId	Deletes an existing API Management gateway config connection.

SELECT examples

List all API Management gateway config connections within a gateway.

vw_api_gateway_config_connections

SELECT
configConnectionName,
default_hostname,
etag,
gatewayName,
hostnames,
provisioning_state,
resourceGroupName,
source_id,
subscriptionId
FROM azure.api_management.vw_api_gateway_config_connections
WHERE gatewayName = '{{ gatewayName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

api_gateway_config_connections

SELECT
etag,
properties
FROM azure.api_management.api_gateway_config_connections
WHERE gatewayName = '{{ gatewayName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.api_management.api_gateway_config_connections (
configConnectionName,
gatewayName,
resourceGroupName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ configConnectionName }}',
'{{ gatewayName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: sourceId
          value: string
        - name: defaultHostname
          value: string
        - name: hostnames
          value:
            - string
    - name: etag
      value: string

DELETE example

Deletes the specified api_gateway_config_connections resource.

/*+ delete */
DELETE FROM azure.api_management.api_gateway_config_connections
WHERE If-Match = '{{ If-Match }}'
AND configConnectionName = '{{ configConnectionName }}'
AND gatewayName = '{{ gatewayName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';