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

The following fields are returned by SELECT queries:

get

The response body contains the specified Gateway entity.

Name	Datatype	Description
properties	object	Gateway hostname configuration details.

list_by_service

Collection of hostname configuration entities.

Name	Datatype	Description
properties	object	Gateway hostname configuration details.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, gatewayId, hcId, subscriptionId		Get details of a hostname configuration
list_by_service	select	resourceGroupName, serviceName, gatewayId, subscriptionId	$filter, $top, $skip	Lists the collection of hostname configurations for the specified gateway.
create_or_update	insert	resourceGroupName, serviceName, gatewayId, hcId, subscriptionId	If-Match	Creates of updates hostname configuration for a Gateway.
delete	delete	resourceGroupName, serviceName, gatewayId, hcId, If-Match, subscriptionId		Deletes the specified hostname configuration from the specified 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
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.
gatewayId	string	Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
hcId	string	Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| hostname | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

SELECT examples

get

Get details of a hostname configuration

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

list_by_service

Lists the collection of hostname configurations for the specified gateway.

SELECT
properties
FROM azure.api_management.gateway_hostname_configurations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND gatewayId = '{{ gatewayId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Creates of updates hostname configuration for a Gateway.

INSERT INTO azure.api_management.gateway_hostname_configurations (
data__properties,
resourceGroupName,
serviceName,
gatewayId,
hcId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ gatewayId }}',
'{{ hcId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: gateway_hostname_configurations
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the gateway_hostname_configurations resource.
    - name: serviceName
      value: string
      description: Required parameter for the gateway_hostname_configurations resource.
    - name: gatewayId
      value: string
      description: Required parameter for the gateway_hostname_configurations resource.
    - name: hcId
      value: string
      description: Required parameter for the gateway_hostname_configurations resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the gateway_hostname_configurations resource.
    - name: properties
      value: object
      description: |
        Gateway hostname configuration details.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

DELETE examples

delete

Deletes the specified hostname configuration from the specified Gateway.

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