gateway_hostname_configurations

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

Overview

Name	gateway_hostname_configurations
Type	Resource
Id	azure.api_management.gateway_hostname_configurations

Fields

vw_gateway_hostname_configurations

Name	Datatype	Description
certificate_id	text	field from the properties object
gatewayId	text	field from the properties object
hcId	text	field from the properties object
hostname	text	field from the properties object
http2_enabled	text	field from the properties object
negotiate_client_certificate	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
subscriptionId	text	field from the properties object
tls10_enabled	text	field from the properties object
tls11_enabled	text	field from the properties object

gateway_hostname_configurations

Name	Datatype	Description
properties	object	Gateway hostname configuration details.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	gatewayId, hcId, resourceGroupName, serviceName, subscriptionId	Get details of a hostname configuration
list_by_service	SELECT	gatewayId, resourceGroupName, serviceName, subscriptionId	Lists the collection of hostname configurations for the specified gateway.
create_or_update	INSERT	gatewayId, hcId, resourceGroupName, serviceName, subscriptionId	Creates of updates hostname configuration for a Gateway.
delete	DELETE	If-Match, gatewayId, hcId, resourceGroupName, serviceName, subscriptionId	Deletes the specified hostname configuration from the specified Gateway.

SELECT examples

Lists the collection of hostname configurations for the specified gateway.

vw_gateway_hostname_configurations

SELECT
certificate_id,
gatewayId,
hcId,
hostname,
http2_enabled,
negotiate_client_certificate,
resourceGroupName,
serviceName,
subscriptionId,
tls10_enabled,
tls11_enabled
FROM azure.api_management.vw_gateway_hostname_configurations
WHERE gatewayId = '{{ gatewayId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

gateway_hostname_configurations

SELECT
properties
FROM azure.api_management.gateway_hostname_configurations
WHERE gatewayId = '{{ gatewayId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.api_management.gateway_hostname_configurations (
gatewayId,
hcId,
resourceGroupName,
serviceName,
subscriptionId,
properties
)
SELECT 
'{{ gatewayId }}',
'{{ hcId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: hostname
          value: string
        - name: certificateId
          value: string
        - name: negotiateClientCertificate
          value: boolean
        - name: tls10Enabled
          value: boolean
        - name: tls11Enabled
          value: boolean
        - name: http2Enabled
          value: boolean

DELETE example

Deletes the specified gateway_hostname_configurations resource.

/*+ delete */
DELETE FROM azure.api_management.gateway_hostname_configurations
WHERE If-Match = '{{ If-Match }}'
AND gatewayId = '{{ gatewayId }}'
AND hcId = '{{ hcId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';