Class SignalRProperties


  • public final class SignalRProperties
    extends Object
    A class that describes the properties of the resource.
    • Constructor Detail

      • SignalRProperties

        public SignalRProperties()
    • Method Detail

      • provisioningState

        public ProvisioningState provisioningState()
        Get the provisioningState property: Provisioning state of the resource.
        Returns:
        the provisioningState value.
      • externalIp

        public String externalIp()
        Get the externalIp property: The publicly accessible IP of the resource.
        Returns:
        the externalIp value.
      • hostname

        public String hostname()
        Get the hostname property: FQDN of the service instance.
        Returns:
        the hostname 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.
      • 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.
      • 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.
      • privateEndpointConnections

        public List<PrivateEndpointConnectionInner> privateEndpointConnections()
        Get the privateEndpointConnections property: Private endpoint connections to the resource.
        Returns:
        the privateEndpointConnections value.
      • sharedPrivateLinkResources

        public List<SharedPrivateLinkResourceInner> sharedPrivateLinkResources()
        Get the sharedPrivateLinkResources property: The list of shared private link resources.
        Returns:
        the sharedPrivateLinkResources value.
      • tls

        public SignalRTlsSettings tls()
        Get the tls property: TLS settings for the resource.
        Returns:
        the tls value.
      • withTls

        public SignalRProperties withTls​(SignalRTlsSettings tls)
        Set the tls property: TLS settings for the resource.
        Parameters:
        tls - the tls value to set.
        Returns:
        the SignalRProperties object itself.
      • hostnamePrefix

        public String hostnamePrefix()
        Get the hostnamePrefix property: Deprecated.
        Returns:
        the hostnamePrefix 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.
      • withFeatures

        public SignalRProperties 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 SignalRProperties object itself.
      • liveTraceConfiguration

        public LiveTraceConfiguration liveTraceConfiguration()
        Get the liveTraceConfiguration property: Live trace configuration of a Microsoft.SignalRService resource.
        Returns:
        the liveTraceConfiguration value.
      • withLiveTraceConfiguration

        public SignalRProperties withLiveTraceConfiguration​(LiveTraceConfiguration liveTraceConfiguration)
        Set the liveTraceConfiguration property: Live trace configuration of a Microsoft.SignalRService resource.
        Parameters:
        liveTraceConfiguration - the liveTraceConfiguration value to set.
        Returns:
        the SignalRProperties object itself.
      • resourceLogConfiguration

        public ResourceLogConfiguration resourceLogConfiguration()
        Get the resourceLogConfiguration property: Resource log configuration of a Microsoft.SignalRService resource.
        Returns:
        the resourceLogConfiguration value.
      • withResourceLogConfiguration

        public SignalRProperties withResourceLogConfiguration​(ResourceLogConfiguration resourceLogConfiguration)
        Set the resourceLogConfiguration property: Resource log configuration of a Microsoft.SignalRService resource.
        Parameters:
        resourceLogConfiguration - the resourceLogConfiguration value to set.
        Returns:
        the SignalRProperties object itself.
      • cors

        public SignalRCorsSettings cors()
        Get the cors property: Cross-Origin Resource Sharing (CORS) settings.
        Returns:
        the cors value.
      • withCors

        public SignalRProperties withCors​(SignalRCorsSettings cors)
        Set the cors property: Cross-Origin Resource Sharing (CORS) settings.
        Parameters:
        cors - the cors value to set.
        Returns:
        the SignalRProperties object itself.
      • 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.
      • withUpstream

        public SignalRProperties 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 SignalRProperties object itself.
      • networkACLs

        public SignalRNetworkACLs networkACLs()
        Get the networkACLs property: Network ACLs for the resource.
        Returns:
        the networkACLs value.
      • withNetworkACLs

        public SignalRProperties withNetworkACLs​(SignalRNetworkACLs networkACLs)
        Set the networkACLs property: Network ACLs for the resource.
        Parameters:
        networkACLs - the networkACLs value to set.
        Returns:
        the SignalRProperties object itself.
      • 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.
      • withPublicNetworkAccess

        public SignalRProperties 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 SignalRProperties object itself.
      • 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.
      • withDisableLocalAuth

        public SignalRProperties 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 SignalRProperties object itself.
      • 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.
      • withDisableAadAuth

        public SignalRProperties 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 SignalRProperties object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.