azure-native.apimanagement.getApiGatewayHostnameBinding

Azure Native v3.13.0, Jan 28 26

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.13.0 published on Wednesday, Jan 28, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

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.13.0 published on Wednesday, Jan 28, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

Using getApiGatewayHostnameBinding

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 getApiGatewayHostnameBinding(args: GetApiGatewayHostnameBindingArgs, opts?: InvokeOptions): Promise<GetApiGatewayHostnameBindingResult>
function getApiGatewayHostnameBindingOutput(args: GetApiGatewayHostnameBindingOutputArgs, opts?: InvokeOptions): Output<GetApiGatewayHostnameBindingResult>

def get_api_gateway_hostname_binding(gateway_name: Optional[str] = None,
                                     hostname_binding_name: Optional[str] = None,
                                     resource_group_name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetApiGatewayHostnameBindingResult
def get_api_gateway_hostname_binding_output(gateway_name: Optional[pulumi.Input[str]] = None,
                                     hostname_binding_name: Optional[pulumi.Input[str]] = None,
                                     resource_group_name: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetApiGatewayHostnameBindingResult]

func LookupApiGatewayHostnameBinding(ctx *Context, args *LookupApiGatewayHostnameBindingArgs, opts ...InvokeOption) (*LookupApiGatewayHostnameBindingResult, error)
func LookupApiGatewayHostnameBindingOutput(ctx *Context, args *LookupApiGatewayHostnameBindingOutputArgs, opts ...InvokeOption) LookupApiGatewayHostnameBindingResultOutput

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

public static class GetApiGatewayHostnameBinding 
{
    public static Task<GetApiGatewayHostnameBindingResult> InvokeAsync(GetApiGatewayHostnameBindingArgs args, InvokeOptions? opts = null)
    public static Output<GetApiGatewayHostnameBindingResult> Invoke(GetApiGatewayHostnameBindingInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiGatewayHostnameBindingResult> getApiGatewayHostnameBinding(GetApiGatewayHostnameBindingArgs args, InvokeOptions options)
public static Output<GetApiGatewayHostnameBindingResult> getApiGatewayHostnameBinding(GetApiGatewayHostnameBindingArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:apimanagement:getApiGatewayHostnameBinding
  arguments:
    # arguments dictionary

The following arguments are supported:

GatewayName string: The name of the API Management gateway.
HostnameBindingName string: Gateway hostname binding identifier. Must be unique in the scope of parent Gateway entity.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

GatewayName string: The name of the API Management gateway.
HostnameBindingName string: Gateway hostname binding identifier. Must be unique in the scope of parent Gateway entity.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

gatewayName String: The name of the API Management gateway.
hostnameBindingName String: Gateway hostname binding identifier. Must be unique in the scope of parent Gateway entity.
resourceGroupName String: The name of the resource group. The name is case insensitive.

gatewayName string: The name of the API Management gateway.
hostnameBindingName string: Gateway hostname binding identifier. Must be unique in the scope of parent Gateway entity.
resourceGroupName string: The name of the resource group. The name is case insensitive.

gateway_name str: The name of the API Management gateway.
hostname_binding_name str: Gateway hostname binding identifier. Must be unique in the scope of parent Gateway entity.
resource_group_name str: The name of the resource group. The name is case insensitive.

gatewayName String: The name of the API Management gateway.
hostnameBindingName String: Gateway hostname binding identifier. Must be unique in the scope of parent Gateway entity.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getApiGatewayHostnameBinding Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
Certificate Pulumi.AzureNative.ApiManagement.Outputs.GatewayHostnameBindingCertificateResponse: The hostnames of the data-plane gateway to which requests can be sent.
ETag string: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
Hostname string: The default hostname of the data-plane gateway.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
KeyVault Pulumi.AzureNative.ApiManagement.Outputs.GatewayHostnameBindingKeyVaultResponse: The link to the API Management service workspace.
Name string: The name of the resource
ProvisioningState string: The current provisioning state of the API Management gateway hostname binding.
SystemData Pulumi.AzureNative.ApiManagement.Outputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

AzureApiVersion string: The Azure API version of the resource.
Certificate GatewayHostnameBindingCertificateResponse: The hostnames of the data-plane gateway to which requests can be sent.
ETag string: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
Hostname string: The default hostname of the data-plane gateway.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
KeyVault GatewayHostnameBindingKeyVaultResponse: The link to the API Management service workspace.
Name string: The name of the resource
ProvisioningState string: The current provisioning state of the API Management gateway hostname binding.
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

azureApiVersion String: The Azure API version of the resource.
certificate GatewayHostnameBindingCertificateResponse: The hostnames of the data-plane gateway to which requests can be sent.
eTag String: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
hostname String: The default hostname of the data-plane gateway.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
keyVault GatewayHostnameBindingKeyVaultResponse: The link to the API Management service workspace.
name String: The name of the resource
provisioningState String: The current provisioning state of the API Management gateway hostname binding.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

azureApiVersion string: The Azure API version of the resource.
certificate GatewayHostnameBindingCertificateResponse: The hostnames of the data-plane gateway to which requests can be sent.
eTag string: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
hostname string: The default hostname of the data-plane gateway.
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
keyVault GatewayHostnameBindingKeyVaultResponse: The link to the API Management service workspace.
name string: The name of the resource
provisioningState string: The current provisioning state of the API Management gateway hostname binding.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

azure_api_version str: The Azure API version of the resource.
certificate GatewayHostnameBindingCertificateResponse: The hostnames of the data-plane gateway to which requests can be sent.
e_tag str: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
hostname str: The default hostname of the data-plane gateway.
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
key_vault GatewayHostnameBindingKeyVaultResponse: The link to the API Management service workspace.
name str: The name of the resource
provisioning_state str: The current provisioning state of the API Management gateway hostname binding.
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

azureApiVersion String: The Azure API version of the resource.
certificate Property Map: The hostnames of the data-plane gateway to which requests can be sent.
eTag String: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
hostname String: The default hostname of the data-plane gateway.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
keyVault Property Map: The link to the API Management service workspace.
name String: The name of the resource
provisioningState String: The current provisioning state of the API Management gateway hostname binding.
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

GatewayHostnameBindingCertificateResponse

Expiry string: The expiration date of the certificate.
Subject string: The subject of the certificate.
Thumbprint string: The thumbprint of the certificate.

Expiry string: The expiration date of the certificate.
Subject string: The subject of the certificate.
Thumbprint string: The thumbprint of the certificate.

expiry String: The expiration date of the certificate.
subject String: The subject of the certificate.
thumbprint String: The thumbprint of the certificate.

expiry string: The expiration date of the certificate.
subject string: The subject of the certificate.
thumbprint string: The thumbprint of the certificate.

expiry str: The expiration date of the certificate.
subject str: The subject of the certificate.
thumbprint str: The thumbprint of the certificate.

expiry String: The expiration date of the certificate.
subject String: The subject of the certificate.
thumbprint String: The thumbprint of the certificate.

GatewayHostnameBindingKeyVaultLastStatusResponse

Code string: The last status of the Key Vault certificate fetch process.
LastSuccessTimeStampUtc string: The last time the Key Vault certificate fetch process was successful. Only when the fetch process has succeeded at least once and current state is failed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
TimeStampUtc string: The last time the Key Vault certificate fetch process was attempted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Code string: The last status of the Key Vault certificate fetch process.
LastSuccessTimeStampUtc string: The last time the Key Vault certificate fetch process was successful. Only when the fetch process has succeeded at least once and current state is failed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
TimeStampUtc string: The last time the Key Vault certificate fetch process was attempted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

code String: The last status of the Key Vault certificate fetch process.
lastSuccessTimeStampUtc String: The last time the Key Vault certificate fetch process was successful. Only when the fetch process has succeeded at least once and current state is failed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
timeStampUtc String: The last time the Key Vault certificate fetch process was attempted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

code string: The last status of the Key Vault certificate fetch process.
lastSuccessTimeStampUtc string: The last time the Key Vault certificate fetch process was successful. Only when the fetch process has succeeded at least once and current state is failed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
timeStampUtc string: The last time the Key Vault certificate fetch process was attempted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

code str: The last status of the Key Vault certificate fetch process.
last_success_time_stamp_utc str: The last time the Key Vault certificate fetch process was successful. Only when the fetch process has succeeded at least once and current state is failed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
time_stamp_utc str: The last time the Key Vault certificate fetch process was attempted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

code String: The last status of the Key Vault certificate fetch process.
lastSuccessTimeStampUtc String: The last time the Key Vault certificate fetch process was successful. Only when the fetch process has succeeded at least once and current state is failed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
timeStampUtc String: The last time the Key Vault certificate fetch process was attempted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

GatewayHostnameBindingKeyVaultResponse

SecretId string: The current provisioning state of the API Management gateway hostname binding.
IdentityClientId string: The default hostname of the data-plane gateway.
LastStatus Pulumi.AzureNative.ApiManagement.Inputs.GatewayHostnameBindingKeyVaultLastStatusResponse: The last status of the Key Vault certificate fetch process.

SecretId string: The current provisioning state of the API Management gateway hostname binding.
IdentityClientId string: The default hostname of the data-plane gateway.
LastStatus GatewayHostnameBindingKeyVaultLastStatusResponse: The last status of the Key Vault certificate fetch process.

secretId String: The current provisioning state of the API Management gateway hostname binding.
identityClientId String: The default hostname of the data-plane gateway.
lastStatus GatewayHostnameBindingKeyVaultLastStatusResponse: The last status of the Key Vault certificate fetch process.

secretId string: The current provisioning state of the API Management gateway hostname binding.
identityClientId string: The default hostname of the data-plane gateway.
lastStatus GatewayHostnameBindingKeyVaultLastStatusResponse: The last status of the Key Vault certificate fetch process.

secret_id str: The current provisioning state of the API Management gateway hostname binding.
identity_client_id str: The default hostname of the data-plane gateway.
last_status GatewayHostnameBindingKeyVaultLastStatusResponse: The last status of the Key Vault certificate fetch process.

secretId String: The current provisioning state of the API Management gateway hostname binding.
identityClientId String: The default hostname of the data-plane gateway.
lastStatus Property Map: The last status of the Key Vault certificate fetch process.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.