gateway_hostname_configuration

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

Overview

Name	gateway_hostname_configuration
Type	Resource
Id	azure.api_management.gateway_hostname_configuration

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.
certificateId	string	Identifier of Certificate entity that will be used for TLS connection establishment.
hostname	string	Hostname value. Supports valid domain name, partial or full wildcard.
http2Enabled	boolean	Specifies if HTTP/2.0 is supported.
negotiateClientCertificate	boolean	Determines whether gateway requests client certificate.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tls10Enabled	boolean	Specifies if TLS 1.0 is supported.
tls11Enabled	boolean	Specifies if TLS 1.1 is supported.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_service

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.
certificateId	string	Identifier of Certificate entity that will be used for TLS connection establishment.
hostname	string	Hostname value. Supports valid domain name, partial or full wildcard.
http2Enabled	boolean	Specifies if HTTP/2.0 is supported.
negotiateClientCertificate	boolean	Determines whether gateway requests client certificate.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tls10Enabled	boolean	Specifies if TLS 1.0 is supported.
tls11Enabled	boolean	Specifies if TLS 1.1 is supported.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, gateway_id, hc_id, subscription_id		Get details of a hostname configuration.
list_by_service	select	resource_group_name, service_name, gateway_id, subscription_id	$filter, $top, $skip	Lists the collection of hostname configurations for the specified gateway.
create_or_update	insert	resource_group_name, service_name, gateway_id, hc_id, subscription_id		Creates of updates hostname configuration for a Gateway.
create_or_update	replace	resource_group_name, service_name, gateway_id, hc_id, subscription_id		Creates of updates hostname configuration for a Gateway.
delete	delete	resource_group_name, service_name, gateway_id, hc_id, subscription_id		Deletes the specified hostname configuration from the specified Gateway.
get_entity_tag	exec	resource_group_name, service_name, gateway_id, hc_id, subscription_id		Checks that hostname configuration entity specified by identifier exists for specified Gateway entity.

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_id	string	Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'. Required.
hc_id	string	Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || hostname | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |. Default value is None.
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.

SELECT examples

get

Get details of a hostname configuration.

SELECT
id,
name,
certificateId,
hostname,
http2Enabled,
negotiateClientCertificate,
systemData,
tls10Enabled,
tls11Enabled,
type
FROM azure.api_management.gateway_hostname_configuration
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND gateway_id = '{{ gateway_id }}' -- required
AND hc_id = '{{ hc_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Lists the collection of hostname configurations for the specified gateway.

SELECT
id,
name,
certificateId,
hostname,
http2Enabled,
negotiateClientCertificate,
systemData,
tls10Enabled,
tls11Enabled,
type
FROM azure.api_management.gateway_hostname_configuration
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND gateway_id = '{{ gateway_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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_configuration (
properties,
resource_group_name,
service_name,
gateway_id,
hc_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ gateway_id }}',
'{{ hc_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: gateway_hostname_configuration
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the gateway_hostname_configuration resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the gateway_hostname_configuration resource.
  - name: gateway_id
    value: "{{ gateway_id }}"
    description: Required parameter for the gateway_hostname_configuration resource.
  - name: hc_id
    value: "{{ hc_id }}"
    description: Required parameter for the gateway_hostname_configuration resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the gateway_hostname_configuration resource.
  - name: properties
    description: |
      Gateway hostname configuration details.
    value:
      hostname: "{{ hostname }}"
      certificateId: "{{ certificateId }}"
      negotiateClientCertificate: {{ negotiateClientCertificate }}
      tls10Enabled: {{ tls10Enabled }}
      tls11Enabled: {{ tls11Enabled }}
      http2Enabled: {{ http2Enabled }}

REPLACE examples

create_or_update

Creates of updates hostname configuration for a Gateway.

REPLACE azure.api_management.gateway_hostname_configuration
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND gateway_id = '{{ gateway_id }}' --required
AND hc_id = '{{ hc_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the specified hostname configuration from the specified Gateway.

DELETE FROM azure.api_management.gateway_hostname_configuration
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND gateway_id = '{{ gateway_id }}' --required
AND hc_id = '{{ hc_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_tag

Checks that hostname configuration entity specified by identifier exists for specified Gateway entity.

EXEC azure.api_management.gateway_hostname_configuration.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@gateway_id='{{ gateway_id }}' --required, 
@hc_id='{{ hc_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;