WebPubSubResource Interface

Package:
com.azure.resourcemanager.webpubsub.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-webpubsub:1.1.0

public interface WebPubSubResource

An immutable client-side representation of WebPubSubResource.

Method Summary

Modifier and Type Method and Description
abstract Boolean disableAadAuth()

Gets the disableAadAuth property: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
abstract 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.
abstract String externalIp()

Gets the externalIp property: The publicly accessible IP of the resource.
abstract String hostname()

Gets the hostname property: FQDN of the service instance.
abstract String hostnamePrefix()

Gets the hostnamePrefix property: Deprecated.
abstract String id()

Gets the id property: Fully qualified resource Id for the resource.
abstract ManagedIdentity identity()

Gets the identity property: A class represent managed identities used for request and response.
abstract WebPubSubResourceInner innerModel()

Gets the inner com.azure.resourcemanager.webpubsub.fluent.models.WebPubSubResourceInner object.
abstract ServiceKind kind()

Gets the kind property: The kind of the service.
abstract WebPubSubKeys listKeys()

Get the access keys of the resource.
abstract Response<WebPubSubKeys> listKeysWithResponse(Context context)

Get the access keys of the resource.
abstract LiveTraceConfiguration liveTraceConfiguration()

Gets the liveTraceConfiguration property: Live trace configuration of a Microsoft.SignalRService resource.
abstract String location()

Gets the location property: The geo-location where the resource lives.
abstract String name()

Gets the name property: The name of the resource.
abstract WebPubSubNetworkACLs networkACLs()

Gets the networkACLs property: Network ACLs for the resource.
abstract List<PrivateEndpointConnection> privateEndpointConnections()

Gets the privateEndpointConnections property: Private endpoint connections to the resource.
abstract ProvisioningState provisioningState()

Gets the provisioningState property: Provisioning state of the resource.
abstract String publicNetworkAccess()

Gets the publicNetworkAccess property: Enable or disable public network access.
abstract Integer publicPort()

Gets the publicPort property: The publicly accessible port of the resource which is designed for browser/client side usage.
abstract WebPubSubResource refresh()

Refreshes the resource to sync with Azure.
abstract WebPubSubResource refresh(Context context)

Refreshes the resource to sync with Azure.
abstract WebPubSubKeys regenerateKey(RegenerateKeyParameters parameters)

Regenerate the access key for the resource.
abstract WebPubSubKeys regenerateKey(RegenerateKeyParameters parameters, Context context)

Regenerate the access key for the resource.
abstract Region region()

Gets the region of the resource.
abstract String regionEndpointEnabled()

Gets the regionEndpointEnabled property: Enable or disable the regional endpoint.
abstract String regionName()

Gets the name of the resource region.
abstract String resourceGroupName()

Gets the name of the resource group.
abstract ResourceLogConfiguration resourceLogConfiguration()

Gets the resourceLogConfiguration property: Resource log configuration of a Microsoft.SignalRService resource.
abstract String resourceStopped()

Gets the resourceStopped property: Stop or start the resource.
abstract void restart()

Operation to restart a resource.
abstract void restart(Context context)

Operation to restart a resource.
abstract Integer serverPort()

Gets the serverPort property: The publicly accessible port of the resource which is designed for customer server side usage.
abstract List<SharedPrivateLinkResource> sharedPrivateLinkResources()

Gets the sharedPrivateLinkResources property: The list of shared private link resources.
abstract ResourceSku sku()

Gets the sku property: The billing information of the resource.
abstract WebPubSubSocketIOSettings socketIO()

Gets the socketIO property: SocketIO settings for the resource.
abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
abstract Map<String,String> tags()

Gets the tags property: Resource tags.
abstract WebPubSubTlsSettings tls()

Gets the tls property: TLS settings for the resource.
abstract String type()

Gets the type property: The type of the resource.
abstract Update update()

Begins update for the WebPubSubResource resource.
abstract String version()

Gets the version property: Version of the resource.

Method Details

disableAadAuth

public abstract 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.

disableLocalAuth

public abstract 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.

externalIp

public abstract String externalIp()

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

Returns:

the externalIp value.

hostname

public abstract String hostname()

Gets the hostname property: FQDN of the service instance.

Returns:

the hostname value.

hostnamePrefix

public abstract String hostnamePrefix()

Gets the hostnamePrefix property: Deprecated.

Returns:

the hostnamePrefix value.

id

public abstract String id()

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

Returns:

the id value.

identity

public abstract ManagedIdentity identity()

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

Returns:

the identity value.

innerModel

public abstract WebPubSubResourceInner innerModel()

Gets the inner com.azure.resourcemanager.webpubsub.fluent.models.WebPubSubResourceInner object.

Returns:

the inner object.

kind

public abstract ServiceKind kind()

Gets the kind property: The kind of the service.

Returns:

the kind value.

listKeys

public abstract WebPubSubKeys listKeys()

Get the access keys of the resource.

Returns:

the access keys of the resource.

listKeysWithResponse

public abstract Response<WebPubSubKeys> listKeysWithResponse(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<T>.

liveTraceConfiguration

public abstract LiveTraceConfiguration liveTraceConfiguration()

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

Returns:

the liveTraceConfiguration value.

location

public abstract String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

networkACLs

public abstract WebPubSubNetworkACLs networkACLs()

Gets the networkACLs property: Network ACLs for the resource.

Returns:

the networkACLs value.

privateEndpointConnections

public abstract List<PrivateEndpointConnection> privateEndpointConnections()

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

Returns:

the privateEndpointConnections value.

provisioningState

public abstract ProvisioningState provisioningState()

Gets the provisioningState property: Provisioning state of the resource.

Returns:

the provisioningState value.

publicNetworkAccess

public abstract 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.

publicPort

public abstract 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.

refresh

public abstract WebPubSubResource refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract WebPubSubResource refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

regenerateKey

public abstract 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.

regenerateKey

public abstract WebPubSubKeys regenerateKey(RegenerateKeyParameters parameters, 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.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionEndpointEnabled

public abstract String regionEndpointEnabled()

Gets the regionEndpointEnabled property: 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.

Returns:

the regionEndpointEnabled value.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

resourceLogConfiguration

public abstract ResourceLogConfiguration resourceLogConfiguration()

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

Returns:

the resourceLogConfiguration value.

resourceStopped

public abstract String resourceStopped()

Gets the resourceStopped property: 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.

Returns:

the resourceStopped value.

restart

public abstract void restart()

Operation to restart a resource.

restart

public abstract void restart(Context context)

Operation to restart a resource.

Parameters:

context - The context to associate with this operation.

serverPort

public abstract 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.

sharedPrivateLinkResources

public abstract List<SharedPrivateLinkResource> sharedPrivateLinkResources()

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

Returns:

the sharedPrivateLinkResources value.

sku

public abstract ResourceSku sku()

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

Returns:

the sku value.

socketIO

public abstract WebPubSubSocketIOSettings socketIO()

Gets the socketIO property: SocketIO settings for the resource.

Returns:

the socketIO value.

systemData

public abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

tags

public abstract Map<String,String> tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

tls

public abstract WebPubSubTlsSettings tls()

Gets the tls property: TLS settings for the resource.

Returns:

the tls value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract WebPubSubResource.Update update()

Begins update for the WebPubSubResource resource.

Returns:

the stage of resource update.

version

public abstract 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.

Applies to