Web Apps - List Host Name Bindings

Description for Get hostname bindings for an app or a deployment slot.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings?api-version=2024-04-01

URI Parameters

Name In Required Type Description
name
path True

string

Name of the app.

resourceGroupName
path True

string

Name of the resource group to which the resource belongs.

Regex pattern: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

api-version
query True

string

API Version

Responses

Name Type Description
200 OK

HostNameBindingCollection

OK

Other Status Codes

DefaultErrorResponse

App Service error response.

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

Definitions

Name Description
AzureResourceType

Azure resource type.

CustomHostNameDnsRecordType

Custom DNS record type.

DefaultErrorResponse

App Service error response.

Details
Error

Error model.

HostNameBinding

A hostname binding object.

HostNameBindingCollection

Collection of hostname bindings.

HostNameType

Hostname type.

SslState

SSL type

AzureResourceType

Azure resource type.

Name Type Description
TrafficManager

string

Website

string

CustomHostNameDnsRecordType

Custom DNS record type.

Name Type Description
A

string

CName

string

DefaultErrorResponse

App Service error response.

Name Type Description
error

Error

Error model.

Details

Name Type Description
code

string

Standardized string to programmatically identify the error.

message

string

Detailed error description and debugging information.

target

string

Detailed error description and debugging information.

Error

Error model.

Name Type Description
code

string

Standardized string to programmatically identify the error.

details

Details[]

Detailed errors.

innererror

string

More information to debug error.

message

string

Detailed error description and debugging information.

target

string

Detailed error description and debugging information.

HostNameBinding

A hostname binding object.

Name Type Description
id

string

Resource Id.

kind

string

Kind of resource.

name

string

Resource Name.

properties.azureResourceName

string

Azure resource name.

properties.azureResourceType

AzureResourceType

Azure resource type.

properties.customHostNameDnsRecordType

CustomHostNameDnsRecordType

Custom DNS record type.

properties.domainId

string

Fully qualified ARM domain resource URI.

properties.hostNameType

HostNameType

Hostname type.

properties.siteName

string

App Service app name.

properties.sslState

SslState

SSL type

properties.thumbprint

string

SSL certificate thumbprint

properties.virtualIP

string

Virtual IP address assigned to the hostname if IP based SSL is enabled.

type

string

Resource type.

HostNameBindingCollection

Collection of hostname bindings.

Name Type Description
nextLink

string

Link to next page of resources.

value

HostNameBinding[]

Collection of resources.

HostNameType

Hostname type.

Name Type Description
Managed

string

Verified

string

SslState

SSL type

Name Type Description
Disabled

string

IpBasedEnabled

string

SniEnabled

string