Share via

WebPubSubResource interface

  • Reference
Package:
@azure/arm-webpubsub

A class represent a resource.

Extends
TrackedResource

Properties

disableAadAuth

DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
disableLocalAuth

DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.
externalIP

The publicly accessible IP of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
hostName

FQDN of the service instance. NOTE: This property will not be serialized. It can only be populated by the server.
hostNamePrefix

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

A class represent managed identities used for request and response
kind

The kind of the service
liveTraceConfiguration

Live trace configuration of a Microsoft.SignalRService resource.
networkACLs

Network ACLs for the resource
privateEndpointConnections

Private endpoint connections to the resource. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

Provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess

Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs.
publicPort

The publicly accessible port of the resource which is designed for browser/client side usage. NOTE: This property will not be serialized. It can only be populated by the server.
regionEndpointEnabled

Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed.
resourceLogConfiguration

Resource log configuration of a Microsoft.SignalRService resource.
resourceStopped

Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started.
serverPort

The publicly accessible port of the resource which is designed for customer server side usage. NOTE: This property will not be serialized. It can only be populated by the server.
sharedPrivateLinkResources

The list of shared private link resources. NOTE: This property will not be serialized. It can only be populated by the server.
sku

The billing information of the resource.
socketIO

SocketIO settings for the resource
tls

TLS settings for the resource
version

Version of the resource. Probably you need the same or higher version of client SDKs. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

disableAadAuth

DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.

disableAadAuth?: boolean

Property Value

boolean

disableLocalAuth

DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.

disableLocalAuth?: boolean

Property Value

boolean

externalIP

The publicly accessible IP of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

externalIP?: string

Property Value

string

hostName

FQDN of the service instance. NOTE: This property will not be serialized. It can only be populated by the server.

hostName?: string

Property Value

string

hostNamePrefix

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

hostNamePrefix?: string

Property Value

string

identity

A class represent managed identities used for request and response

identity?: ManagedIdentity

Property Value

ManagedIdentity

kind

The kind of the service

kind?: string

Property Value

string

liveTraceConfiguration

Live trace configuration of a Microsoft.SignalRService resource.

liveTraceConfiguration?: LiveTraceConfiguration

Property Value

LiveTraceConfiguration

networkACLs

Network ACLs for the resource

networkACLs?: WebPubSubNetworkACLs

Property Value

WebPubSubNetworkACLs

privateEndpointConnections

Private endpoint connections to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

Provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicNetworkAccess

Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs.

publicNetworkAccess?: string

Property Value

string

publicPort

The publicly accessible port of the resource which is designed for browser/client side usage. NOTE: This property will not be serialized. It can only be populated by the server.

publicPort?: number

Property Value

number

regionEndpointEnabled

Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed.

regionEndpointEnabled?: string

Property Value

string

resourceLogConfiguration

Resource log configuration of a Microsoft.SignalRService resource.

resourceLogConfiguration?: ResourceLogConfiguration

Property Value

ResourceLogConfiguration

resourceStopped

Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started.

resourceStopped?: string

Property Value

string

serverPort

The publicly accessible port of the resource which is designed for customer server side usage. NOTE: This property will not be serialized. It can only be populated by the server.

serverPort?: number

Property Value

number

sharedPrivateLinkResources

The list of shared private link resources. NOTE: This property will not be serialized. It can only be populated by the server.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Property Value

SharedPrivateLinkResource[]

sku

The billing information of the resource.

sku?: ResourceSku

Property Value

ResourceSku

socketIO

SocketIO settings for the resource

socketIO?: WebPubSubSocketIOSettings

Property Value

WebPubSubSocketIOSettings

tls

TLS settings for the resource

tls?: WebPubSubTlsSettings

Property Value

WebPubSubTlsSettings

version

Version of the resource. Probably you need the same or higher version of client SDKs. NOTE: This property will not be serialized. It can only be populated by the server.

version?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type