Share via

HybridConnection interface

  • Reference
Package:
@azure/arm-appservice-profile-2020-09-01-hybrid

Hybrid Connection contract. This is used to configure a Hybrid Connection.

Extends
ProxyOnlyResource

Properties

hostname

The hostname of the endpoint.
port

The port of the endpoint.
relayArmUri

The ARM URI to the Service Bus relay.
relayName

The name of the Service Bus relay.
sendKeyName

The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.
sendKeyValue

The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned normally, use the POST /listKeys API instead.
serviceBusNamespace

The name of the Service Bus namespace.
serviceBusSuffix

The suffix for the service bus endpoint. By default this is .servicebus.windows.net

Inherited Properties

id

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.
kind

Kind of resource.
name

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

hostname

The hostname of the endpoint.

hostname?: string

Property Value

string

port

The port of the endpoint.

port?: number

Property Value

number

relayArmUri

The ARM URI to the Service Bus relay.

relayArmUri?: string

Property Value

string

relayName

The name of the Service Bus relay.

relayName?: string

Property Value

string

sendKeyName

The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.

sendKeyName?: string

Property Value

string

sendKeyValue

The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned normally, use the POST /listKeys API instead.

sendKeyValue?: string

Property Value

string

serviceBusNamespace

The name of the Service Bus namespace.

serviceBusNamespace?: string

Property Value

string

serviceBusSuffix

The suffix for the service bus endpoint. By default this is .servicebus.windows.net

serviceBusSuffix?: string

Property Value

string

Inherited Property Details

id

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyOnlyResource.id

kind

Kind of resource.

kind?: string

Property Value

string

Inherited From ProxyOnlyResource.kind

name

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyOnlyResource.name

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyOnlyResource.type