api_gateway_config_connections

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

Overview

Name	api_gateway_config_connections
Type	Resource
Id	azure.api_management.api_gateway_config_connections

Fields

The following fields are returned by SELECT queries:

get

Successfully got the API Management gateway config connection resource.

Name	Datatype	Description
etag	string	ETag of the resource.
properties	object	Properties of the API Management gateway config connection.

list_by_gateway

The API Management gateway config connection list.

Name	Datatype	Description
etag	string	ETag of the resource.
properties	object	Properties of the API Management gateway config connection.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, gatewayName, configConnectionName, subscriptionId		Gets an API Management gateway config connection resource description.
list_by_gateway	select	resourceGroupName, subscriptionId, gatewayName		List all API Management gateway config connections within a gateway.
create_or_update	insert	resourceGroupName, gatewayName, configConnectionName, 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	resourceGroupName, gatewayName, configConnectionName, If-Match, subscriptionId		Deletes an existing API Management gateway config connection.

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
If-Match	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
configConnectionName	string	The name of the API Management gateway config connection.
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 config connection resource description.

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

list_by_gateway

List all API Management gateway config connections within a gateway.

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

INSERT examples

create_or_update

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

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

Manifest

# Description fields are for documentation purposes
- name: api_gateway_config_connections
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the api_gateway_config_connections resource.
    - name: gatewayName
      value: string
      description: Required parameter for the api_gateway_config_connections resource.
    - name: configConnectionName
      value: string
      description: Required parameter for the api_gateway_config_connections resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the api_gateway_config_connections resource.
    - name: properties
      value: object
      description: |
        Properties of the API Management gateway config connection.

DELETE examples

delete

Deletes an existing API Management gateway config connection.

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