Package com.azure.resourcemanager.signalr.models

Interface SignalRResource

  • public interface SignalRResource
    An immutable client-side representation of SignalRResource.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • name

        String name()
        Gets the name property: The name of the resource.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: The type of the resource.
        Returns:
        the type value.

      • location

        String location()
        Gets the location property: The geo-location where the resource lives.
        Returns:
        the location value.

      • tags

        Map<String,​String> tags()
        Gets the tags property: Resource tags.
        Returns:
        the tags value.

      • sku

        ResourceSku sku()
        Gets the sku property: The billing information of the resource.
        Returns:
        the sku value.

      • kind

        ServiceKind kind()
        Gets the kind property: The kind of the service, it can be SignalR or RawWebSockets.
        Returns:
        the kind value.

      • identity

        ManagedIdentity identity()
        Gets the identity property: A class represent managed identities used for request and response.
        Returns:
        the identity value.

      • systemData

        com.azure.core.management.SystemData systemData()
        Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
        Returns:
        the systemData value.

      • provisioningState

        ProvisioningState provisioningState()
        Gets the provisioningState property: Provisioning state of the resource.
        Returns:
        the provisioningState value.

      • externalIp

        String externalIp()
        Gets the externalIp property: The publicly accessible IP of the resource.
        Returns:
        the externalIp value.

      • hostname

        String hostname()
        Gets the hostname property: FQDN of the service instance.
        Returns:
        the hostname value.

      • publicPort

        Integer publicPort()
        Gets the publicPort property: The publicly accessible port of the resource which is designed for browser/client side usage.
        Returns:
        the publicPort value.

      • serverPort

        Integer serverPort()
        Gets the serverPort property: The publicly accessible port of the resource which is designed for customer server side usage.
        Returns:
        the serverPort value.

      • version

        String version()
        Gets the version property: Version of the resource. Probably you need the same or higher version of client SDKs.
        Returns:
        the version value.

      • privateEndpointConnections

        List<PrivateEndpointConnection> privateEndpointConnections()
        Gets the privateEndpointConnections property: Private endpoint connections to the resource.
        Returns:
        the privateEndpointConnections value.

      • sharedPrivateLinkResources

        List<SharedPrivateLinkResource> sharedPrivateLinkResources()
        Gets the sharedPrivateLinkResources property: The list of shared private link resources.
        Returns:
        the sharedPrivateLinkResources value.

      • tls

        SignalRTlsSettings tls()
        Gets the tls property: TLS settings for the resource.
        Returns:
        the tls value.

      • hostnamePrefix

        String hostnamePrefix()
        Gets the hostnamePrefix property: Deprecated.
        Returns:
        the hostnamePrefix value.

      • features

        List<SignalRFeature> features()
        Gets 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.

      • liveTraceConfiguration

        LiveTraceConfiguration liveTraceConfiguration()
        Gets the liveTraceConfiguration property: Live trace configuration of a Microsoft.SignalRService resource.
        Returns:
        the liveTraceConfiguration value.

      • resourceLogConfiguration

        ResourceLogConfiguration resourceLogConfiguration()
        Gets the resourceLogConfiguration property: Resource log configuration of a Microsoft.SignalRService resource.
        Returns:
        the resourceLogConfiguration value.

      • cors

        SignalRCorsSettings cors()
        Gets the cors property: Cross-Origin Resource Sharing (CORS) settings.
        Returns:
        the cors value.

      • upstream

        ServerlessUpstreamSettings upstream()
        Gets the upstream property: The settings for the Upstream when the service is in server-less mode.
        Returns:
        the upstream value.

      • networkACLs

        SignalRNetworkACLs networkACLs()
        Gets the networkACLs property: Network ACLs for the resource.
        Returns:
        the networkACLs value.

      • publicNetworkAccess

        String publicNetworkAccess()
        Gets 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.

      • disableLocalAuth

        Boolean disableLocalAuth()
        Gets 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.

      • disableAadAuth

        Boolean disableAadAuth()
        Gets the disableAadAuth property: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
        Returns:
        the disableAadAuth value.

      • region

        com.azure.core.management.Region region()
        Gets the region of the resource.
        Returns:
        the region of the resource.

      • regionName

        String regionName()
        Gets the name of the resource region.
        Returns:
        the name of the resource region.

      • innerModel

        SignalRResourceInner innerModel()
        Gets the inner com.azure.resourcemanager.signalr.fluent.models.SignalRResourceInner object.
        Returns:
        the inner object.

      • update

        SignalRResource.Update update()
        Begins update for the SignalRResource resource.
        Returns:
        the stage of resource update.

      • refresh

        SignalRResource refresh()
        Refreshes the resource to sync with Azure.
        Returns:
        the refreshed resource.

      • refresh

        SignalRResource refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.

      • listKeys

        SignalRKeys listKeys()
        Get the access keys of the resource.
        Returns:
        the access keys of the resource.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listKeysWithResponse

        com.azure.core.http.rest.Response<SignalRKeys> listKeysWithResponse​(com.azure.core.util.Context context)
        Get the access keys of the resource.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the access keys of the resource along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • regenerateKey

        SignalRKeys regenerateKey​(RegenerateKeyParameters parameters)
        Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
        Parameters:
        parameters - Parameter that describes the Regenerate Key Operation.
        Returns:
        a class represents the access keys of the resource.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • regenerateKey

        SignalRKeys regenerateKey​(RegenerateKeyParameters parameters,
                          com.azure.core.util.Context context)
        Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
        Parameters:
        parameters - Parameter that describes the Regenerate Key Operation.
        context - The context to associate with this operation.
        Returns:
        a class represents the access keys of the resource.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • restart

        void restart()
        Operation to restart a resource.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • restart

        void restart​(com.azure.core.util.Context context)
        Operation to restart a resource.
        Parameters:
        context - The context to associate with this operation.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.