Gateway Hostname Configuration - Get
Get details of a hostname configuration
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}?api-version=2021-08-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
gateway
|
path | True |
string |
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed' |
hc
|
path | True |
string |
Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity. |
resource
|
path | True |
string |
The name of the resource group. |
service
|
path | True |
string |
The name of the API Management service. Regex pattern: |
subscription
|
path | True |
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
Version of the API to be used with the client request. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The response body contains the specified Gateway entity. Headers ETag: string |
|
Other Status Codes |
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
ApiManagementGetGatewayHostnameConfiguration
Sample request
Sample response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default",
"type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
"name": "default",
"properties": {
"hostname": "*",
"certificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
"negotiateClientCertificate": false
}
}
Definitions
Name | Description |
---|---|
Error |
Error Field contract. |
Error |
Error Response. |
Gateway |
Gateway hostname configuration details. |
ErrorFieldContract
Error Field contract.
Name | Type | Description |
---|---|---|
code |
string |
Property level error code. |
message |
string |
Human-readable representation of property-level error. |
target |
string |
Property name. |
ErrorResponse
Error Response.
Name | Type | Description |
---|---|---|
error.code |
string |
Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. |
error.details |
The list of invalid fields send in request, in case of validation error. |
|
error.message |
string |
Human-readable representation of the error. |
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" |