Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getGatewayHostnameConfiguration
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.getGatewayHostnameConfiguration

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Get details of a hostname configuration

Uses Azure REST API version 2022-09-01-preview.

Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.

Using getGatewayHostnameConfiguration

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGatewayHostnameConfiguration(args: GetGatewayHostnameConfigurationArgs, opts?: InvokeOptions): Promise<GetGatewayHostnameConfigurationResult>
function getGatewayHostnameConfigurationOutput(args: GetGatewayHostnameConfigurationOutputArgs, opts?: InvokeOptions): Output<GetGatewayHostnameConfigurationResult>
Copy
def get_gateway_hostname_configuration(gateway_id: Optional[str] = None,
                                       hc_id: Optional[str] = None,
                                       resource_group_name: Optional[str] = None,
                                       service_name: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetGatewayHostnameConfigurationResult
def get_gateway_hostname_configuration_output(gateway_id: Optional[pulumi.Input[str]] = None,
                                       hc_id: Optional[pulumi.Input[str]] = None,
                                       resource_group_name: Optional[pulumi.Input[str]] = None,
                                       service_name: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetGatewayHostnameConfigurationResult]
Copy
func LookupGatewayHostnameConfiguration(ctx *Context, args *LookupGatewayHostnameConfigurationArgs, opts ...InvokeOption) (*LookupGatewayHostnameConfigurationResult, error)
func LookupGatewayHostnameConfigurationOutput(ctx *Context, args *LookupGatewayHostnameConfigurationOutputArgs, opts ...InvokeOption) LookupGatewayHostnameConfigurationResultOutput
Copy

> Note: This function is named LookupGatewayHostnameConfiguration in the Go SDK.

public static class GetGatewayHostnameConfiguration 
{
    public static Task<GetGatewayHostnameConfigurationResult> InvokeAsync(GetGatewayHostnameConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayHostnameConfigurationResult> Invoke(GetGatewayHostnameConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGatewayHostnameConfigurationResult> getGatewayHostnameConfiguration(GetGatewayHostnameConfigurationArgs args, InvokeOptions options)
public static Output<GetGatewayHostnameConfigurationResult> getGatewayHostnameConfiguration(GetGatewayHostnameConfigurationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getGatewayHostnameConfiguration
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GatewayId
This property is required.
Changes to this property will trigger replacement.
string
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
HcId
This property is required.
Changes to this property will trigger replacement.
string
Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
GatewayId
This property is required.
Changes to this property will trigger replacement.
string
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
HcId
This property is required.
Changes to this property will trigger replacement.
string
Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
gatewayId
This property is required.
Changes to this property will trigger replacement.
String
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
hcId
This property is required.
Changes to this property will trigger replacement.
String
Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
gatewayId
This property is required.
Changes to this property will trigger replacement.
string
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
hcId
This property is required.
Changes to this property will trigger replacement.
string
Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
gateway_id
This property is required.
Changes to this property will trigger replacement.
str
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
hc_id
This property is required.
Changes to this property will trigger replacement.
str
Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
gatewayId
This property is required.
Changes to this property will trigger replacement.
String
Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
hcId
This property is required.
Changes to this property will trigger replacement.
String
Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.

getGatewayHostnameConfiguration Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
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
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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 bool
Specifies if HTTP/2.0 is supported
NegotiateClientCertificate bool
Determines whether gateway requests client certificate
Tls10Enabled bool
Specifies if TLS 1.0 is supported
Tls11Enabled bool
Specifies if TLS 1.1 is supported
AzureApiVersion string
The Azure API version of the resource.
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
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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 bool
Specifies if HTTP/2.0 is supported
NegotiateClientCertificate bool
Determines whether gateway requests client certificate
Tls10Enabled bool
Specifies if TLS 1.0 is supported
Tls11Enabled bool
Specifies if TLS 1.1 is supported
azureApiVersion String
The Azure API version of the resource.
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
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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
tls10Enabled Boolean
Specifies if TLS 1.0 is supported
tls11Enabled Boolean
Specifies if TLS 1.1 is supported
azureApiVersion string
The Azure API version of the resource.
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
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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
tls10Enabled boolean
Specifies if TLS 1.0 is supported
tls11Enabled boolean
Specifies if TLS 1.1 is supported
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
certificate_id str
Identifier of Certificate entity that will be used for TLS connection establishment
hostname str
Hostname value. Supports valid domain name, partial or full wildcard
http2_enabled bool
Specifies if HTTP/2.0 is supported
negotiate_client_certificate bool
Determines whether gateway requests client certificate
tls10_enabled bool
Specifies if TLS 1.0 is supported
tls11_enabled bool
Specifies if TLS 1.1 is supported
azureApiVersion String
The Azure API version of the resource.
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
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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
tls10Enabled Boolean
Specifies if TLS 1.0 is supported
tls11Enabled Boolean
Specifies if TLS 1.1 is supported

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native