Gateway Hostname Configuration - Create Or Update

  • Reference
Service:
API Management
API Version:
2024-05-01

Creates of updates hostname configuration for a Gateway.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}?api-version=2024-05-01

URI Parameters

Name In Required Type Description
gatewayId
 path True

string

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
hcId
 path True

string

Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
resourceGroupName
 path True

string

The name of the resource group. The name is case insensitive.
serviceName
 path True

string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

uuid

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

The API version to use for this operation.

Request Header

Name Required Type Description
If-Match

string

ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Request Body

Name Type Description
properties.certificateId

string

Identifier of Certificate entity that will be used for TLS connection establishment
properties.hostname

string

Hostname value. Supports valid domain name, partial or full wildcard
properties.http2Enabled

boolean

Specifies if HTTP/2.0 is supported
properties.negotiateClientCertificate

boolean

Determines whether gateway requests client certificate
properties.tls10Enabled

boolean

Specifies if TLS 1.0 is supported
properties.tls11Enabled

boolean

Specifies if TLS 1.1 is supported

Responses

Name Type Description
200 OK

GatewayHostnameConfigurationContract

The Gateway hostname configuration details were successfully updated.

Headers

ETag: string
201 Created

GatewayHostnameConfigurationContract

The new Gateway hostname configuration was successfully created.

Headers

ETag: string
Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementCreateGatewayHostnameConfiguration

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default?api-version=2024-05-01

{
  "properties": {
    "hostname": "*",
    "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    "negotiateClientCertificate": false,
    "tls10Enabled": false,
    "tls11Enabled": false,
    "http2Enabled": true
  }
}

Sample response

Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default",
  "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
  "name": "default",
  "properties": {
    "hostname": "*",
    "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    "negotiateClientCertificate": false,
    "tls10Enabled": false,
    "tls11Enabled": false,
    "http2Enabled": true
  }
}
Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default",
  "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
  "name": "default",
  "properties": {
    "hostname": "*",
    "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    "negotiateClientCertificate": false,
    "tls10Enabled": false,
    "tls11Enabled": false,
    "http2Enabled": true
  }
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
GatewayHostnameConfigurationContract

Gateway hostname configuration details.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

GatewayHostnameConfigurationContract

Gateway hostname configuration details.

Name Type 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
properties.certificateId

string

Identifier of Certificate entity that will be used for TLS connection establishment
properties.hostname

string

Hostname value. Supports valid domain name, partial or full wildcard
properties.http2Enabled

boolean

Specifies if HTTP/2.0 is supported
properties.negotiateClientCertificate

boolean

Determines whether gateway requests client certificate
properties.tls10Enabled

boolean

Specifies if TLS 1.0 is supported
properties.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"