SignalRResourceInner Class

public final class SignalRResourceInner
extends Resource

A class represent a resource.

Constructor Summary

Constructor Description
SignalRResourceInner()

Creates an instance of SignalRResourceInner class.

Method Summary

Modifier and Type Method and Description
SignalRCorsSettings cors()

Get the cors property: Cross-Origin Resource Sharing (CORS) settings.

Boolean disableAadAuth()

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

Boolean disableLocalAuth()

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

String externalIp()

Get the externalIp property: The publicly accessible IP of the resource.

List<SignalRFeature> features()

Get the features property: List of the featureFlags.

static SignalRResourceInner fromJson(JsonReader jsonReader)

Reads an instance of SignalRResourceInner from the JsonReader.

String hostname()

Get the hostname property: FQDN of the service instance.

String hostnamePrefix()

Get the hostnamePrefix property: Deprecated.

String id()

Get the id property: Fully qualified resource Id for the resource.

ManagedIdentity identity()

Get the identity property: A class represent managed identities used for request and response.

ServiceKind kind()

Get the kind property: The kind of the service, it can be SignalR or RawWebSockets.

LiveTraceConfiguration liveTraceConfiguration()

Get the liveTraceConfiguration property: Live trace configuration of a Microsoft.SignalRService resource.

String name()

Get the name property: The name of the resource.

SignalRNetworkACLs networkACLs()

Get the networkACLs property: Network ACLs for the resource.

List<PrivateEndpointConnectionInner> privateEndpointConnections()

Get the privateEndpointConnections property: Private endpoint connections to the resource.

ProvisioningState provisioningState()

Get the provisioningState property: Provisioning state of the resource.

String publicNetworkAccess()

Get the publicNetworkAccess property: Enable or disable public network access.

Integer publicPort()

Get the publicPort property: The publicly accessible port of the resource which is designed for browser/client side usage.

ResourceLogConfiguration resourceLogConfiguration()

Get the resourceLogConfiguration property: Resource log configuration of a Microsoft.SignalRService resource.

ServerlessSettings serverless()

Get the serverless property: Serverless settings.

Integer serverPort()

Get the serverPort property: The publicly accessible port of the resource which is designed for customer server side usage.

List<SharedPrivateLinkResourceInner> sharedPrivateLinkResources()

Get the sharedPrivateLinkResources property: The list of shared private link resources.

ResourceSku sku()

Get the sku property: The billing information of the resource.

SystemData systemData()

Get the systemData property: Metadata pertaining to creation and last modification of the resource.

SignalRTlsSettings tls()

Get the tls property: TLS settings for the resource.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.

ServerlessUpstreamSettings upstream()

Get the upstream property: The settings for the Upstream when the service is in server-less mode.

void validate()

Validates the instance.

String version()

Get the version property: Version of the resource.

SignalRResourceInner withCors(SignalRCorsSettings cors)

Set the cors property: Cross-Origin Resource Sharing (CORS) settings.

SignalRResourceInner withDisableAadAuth(Boolean disableAadAuth)

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

SignalRResourceInner withDisableLocalAuth(Boolean disableLocalAuth)

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

SignalRResourceInner withFeatures(List<SignalRFeature> features)

Set the features property: List of the featureFlags.

SignalRResourceInner withIdentity(ManagedIdentity identity)

Set the identity property: A class represent managed identities used for request and response.

SignalRResourceInner withKind(ServiceKind kind)

Set the kind property: The kind of the service, it can be SignalR or RawWebSockets.

SignalRResourceInner withLiveTraceConfiguration(LiveTraceConfiguration liveTraceConfiguration)

Set the liveTraceConfiguration property: Live trace configuration of a Microsoft.SignalRService resource.

SignalRResourceInner withLocation(String location)
SignalRResourceInner withNetworkACLs(SignalRNetworkACLs networkACLs)

Set the networkACLs property: Network ACLs for the resource.

SignalRResourceInner withPublicNetworkAccess(String publicNetworkAccess)

Set the publicNetworkAccess property: Enable or disable public network access.

SignalRResourceInner withResourceLogConfiguration(ResourceLogConfiguration resourceLogConfiguration)

Set the resourceLogConfiguration property: Resource log configuration of a Microsoft.SignalRService resource.

SignalRResourceInner withServerless(ServerlessSettings serverless)

Set the serverless property: Serverless settings.

SignalRResourceInner withSku(ResourceSku sku)

Set the sku property: The billing information of the resource.

SignalRResourceInner withTags(Map<String,String> tags)
SignalRResourceInner withTls(SignalRTlsSettings tls)

Set the tls property: TLS settings for the resource.

SignalRResourceInner withUpstream(ServerlessUpstreamSettings upstream)

Set the upstream property: The settings for the Upstream when the service is in server-less mode.

Methods inherited from ProxyResource

Methods inherited from Resource

Methods inherited from java.lang.Object

Constructor Details

SignalRResourceInner

public SignalRResourceInner()

Creates an instance of SignalRResourceInner class.

Method Details

cors

public SignalRCorsSettings cors()

Get the cors property: Cross-Origin Resource Sharing (CORS) settings.

Returns:

the cors value.

disableAadAuth

public Boolean disableAadAuth()

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

Returns:

the disableAadAuth value.

disableLocalAuth

public Boolean disableLocalAuth()

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

Returns:

the disableLocalAuth value.

externalIp

public String externalIp()

Get the externalIp property: The publicly accessible IP of the resource.

Returns:

the externalIp value.

features

public List<SignalRFeature> features()

Get the features property: List of the featureFlags. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.

Returns:

the features value.

fromJson

public static SignalRResourceInner fromJson(JsonReader jsonReader)

Reads an instance of SignalRResourceInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SignalRResourceInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

hostname

public String hostname()

Get the hostname property: FQDN of the service instance.

Returns:

the hostname value.

hostnamePrefix

public String hostnamePrefix()

Get the hostnamePrefix property: Deprecated.

Returns:

the hostnamePrefix value.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

SignalRResourceInner.id()

Returns:

the id value.

identity

public ManagedIdentity identity()

Get the identity property: A class represent managed identities used for request and response.

Returns:

the identity value.

kind

public ServiceKind kind()

Get the kind property: The kind of the service, it can be SignalR or RawWebSockets.

Returns:

the kind value.

liveTraceConfiguration

public LiveTraceConfiguration liveTraceConfiguration()

Get the liveTraceConfiguration property: Live trace configuration of a Microsoft.SignalRService resource.

Returns:

the liveTraceConfiguration value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

SignalRResourceInner.name()

Returns:

the name value.

networkACLs

public SignalRNetworkACLs networkACLs()

Get the networkACLs property: Network ACLs for the resource.

Returns:

the networkACLs value.

privateEndpointConnections

public List<PrivateEndpointConnectionInner> privateEndpointConnections()

Get the privateEndpointConnections property: Private endpoint connections to the resource.

Returns:

the privateEndpointConnections value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: Provisioning state of the resource.

Returns:

the provisioningState value.

publicNetworkAccess

public String publicNetworkAccess()

Get the publicNetworkAccess property: 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.

Returns:

the publicNetworkAccess value.

publicPort

public Integer publicPort()

Get the publicPort property: The publicly accessible port of the resource which is designed for browser/client side usage.

Returns:

the publicPort value.

resourceLogConfiguration

public ResourceLogConfiguration resourceLogConfiguration()

Get the resourceLogConfiguration property: Resource log configuration of a Microsoft.SignalRService resource.

Returns:

the resourceLogConfiguration value.

serverless

public ServerlessSettings serverless()

Get the serverless property: Serverless settings.

Returns:

the serverless value.

serverPort

public Integer serverPort()

Get the serverPort property: The publicly accessible port of the resource which is designed for customer server side usage.

Returns:

the serverPort value.

sharedPrivateLinkResources

public List<SharedPrivateLinkResourceInner> sharedPrivateLinkResources()

Get the sharedPrivateLinkResources property: The list of shared private link resources.

Returns:

the sharedPrivateLinkResources value.

sku

public ResourceSku sku()

Get the sku property: The billing information of the resource.

Returns:

the sku value.

systemData

public SystemData systemData()

Get the systemData property: Metadata pertaining to creation and last modification of the resource.

Returns:

the systemData value.

tls

public SignalRTlsSettings tls()

Get the tls property: TLS settings for the resource.

Returns:

the tls value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SignalRResourceInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

SignalRResourceInner.type()

Returns:

the type value.

upstream

public ServerlessUpstreamSettings upstream()

Get the upstream property: The settings for the Upstream when the service is in server-less mode.

Returns:

the upstream value.

validate

public void validate()

Validates the instance.

version

public String version()

Get the version property: Version of the resource. Probably you need the same or higher version of client SDKs.

Returns:

the version value.

withCors

public SignalRResourceInner withCors(SignalRCorsSettings cors)

Set the cors property: Cross-Origin Resource Sharing (CORS) settings.

Parameters:

cors - the cors value to set.

Returns:

the SignalRResourceInner object itself.

withDisableAadAuth

public SignalRResourceInner withDisableAadAuth(Boolean disableAadAuth)

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

Parameters:

disableAadAuth - the disableAadAuth value to set.

Returns:

the SignalRResourceInner object itself.

withDisableLocalAuth

public SignalRResourceInner withDisableLocalAuth(Boolean disableLocalAuth)

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

Parameters:

disableLocalAuth - the disableLocalAuth value to set.

Returns:

the SignalRResourceInner object itself.

withFeatures

public SignalRResourceInner withFeatures(List<SignalRFeature> features)

Set the features property: List of the featureFlags. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.

Parameters:

features - the features value to set.

Returns:

the SignalRResourceInner object itself.

withIdentity

public SignalRResourceInner withIdentity(ManagedIdentity identity)

Set the identity property: A class represent managed identities used for request and response.

Parameters:

identity - the identity value to set.

Returns:

the SignalRResourceInner object itself.

withKind

public SignalRResourceInner withKind(ServiceKind kind)

Set the kind property: The kind of the service, it can be SignalR or RawWebSockets.

Parameters:

kind - the kind value to set.

Returns:

the SignalRResourceInner object itself.

withLiveTraceConfiguration

public SignalRResourceInner withLiveTraceConfiguration(LiveTraceConfiguration liveTraceConfiguration)

Set the liveTraceConfiguration property: Live trace configuration of a Microsoft.SignalRService resource.

Parameters:

liveTraceConfiguration - the liveTraceConfiguration value to set.

Returns:

the SignalRResourceInner object itself.

withLocation

public SignalRResourceInner withLocation(String location)

Overrides:

SignalRResourceInner.withLocation(String location)

Parameters:

location

withNetworkACLs

public SignalRResourceInner withNetworkACLs(SignalRNetworkACLs networkACLs)

Set the networkACLs property: Network ACLs for the resource.

Parameters:

networkACLs - the networkACLs value to set.

Returns:

the SignalRResourceInner object itself.

withPublicNetworkAccess

public SignalRResourceInner withPublicNetworkAccess(String publicNetworkAccess)

Set the publicNetworkAccess property: 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.

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the SignalRResourceInner object itself.

withResourceLogConfiguration

public SignalRResourceInner withResourceLogConfiguration(ResourceLogConfiguration resourceLogConfiguration)

Set the resourceLogConfiguration property: Resource log configuration of a Microsoft.SignalRService resource.

Parameters:

resourceLogConfiguration - the resourceLogConfiguration value to set.

Returns:

the SignalRResourceInner object itself.

withServerless

public SignalRResourceInner withServerless(ServerlessSettings serverless)

Set the serverless property: Serverless settings.

Parameters:

serverless - the serverless value to set.

Returns:

the SignalRResourceInner object itself.

withSku

public SignalRResourceInner withSku(ResourceSku sku)

Set the sku property: The billing information of the resource.

Parameters:

sku - the sku value to set.

Returns:

the SignalRResourceInner object itself.

withTags

public SignalRResourceInner withTags(Map<String,String> tags)

Overrides:

SignalRResourceInner.withTags(Map<String,String> tags)

Parameters:

tags

withTls

public SignalRResourceInner withTls(SignalRTlsSettings tls)

Set the tls property: TLS settings for the resource.

Parameters:

tls - the tls value to set.

Returns:

the SignalRResourceInner object itself.

withUpstream

public SignalRResourceInner withUpstream(ServerlessUpstreamSettings upstream)

Set the upstream property: The settings for the Upstream when the service is in server-less mode.

Parameters:

upstream - the upstream value to set.

Returns:

the SignalRResourceInner object itself.

Applies to