Package com.azure.resourcemanager.webpubsub.models

Interface WebPubSubResource

public interface WebPubSubResource
An immutable client-side representation of WebPubSubResource.

  • Method Details

    • 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.

    • 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

      WebPubSubTlsSettings 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.

    • 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.

    • networkACLs

      WebPubSubNetworkACLs 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.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      WebPubSubResourceInner innerModel()
      Gets the inner com.azure.resourcemanager.webpubsub.fluent.models.WebPubSubResourceInner object.
      Returns:
      the inner object.

    • update

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

    • refresh

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

    • refresh

      WebPubSubResource 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.

    • listKeysWithResponse

      com.azure.core.http.rest.Response<WebPubSubKeys> 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.

    • listKeys

      WebPubSubKeys 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.

    • regenerateKey

      WebPubSubKeys 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

      WebPubSubKeys 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.