CommunicationServiceResource Interface

Package:
com.azure.resourcemanager.communication.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-communication:2.3.0

public interface CommunicationServiceResource

An immutable client-side representation of CommunicationServiceResource.

Method Summary

Modifier and Type Method and Description
abstract String dataLocation()

Gets the dataLocation property: The location where the communication service stores its data at rest.
abstract Boolean disableLocalAuth()

Gets the disableLocalAuth property: Disable local authentication for the CommunicationService.
abstract String hostname()

Gets the hostname property: FQDN of the CommunicationService instance.
abstract String id()

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

Gets the identity property: Managed service identity (system assigned and/or user assigned identities).
abstract String immutableResourceId()

Gets the immutableResourceId property: The immutable resource Id of the communication service.
abstract CommunicationServiceResourceInner innerModel()

Gets the inner com.azure.resourcemanager.communication.fluent.models.CommunicationServiceResourceInner object.
abstract List<String> linkedDomains()

Gets the linkedDomains property: List of email Domain resource Ids.
abstract LinkedNotificationHub linkNotificationHub()

Link Notification Hub Links an Azure Notification Hub to this communication service.
abstract Response<LinkedNotificationHub> linkNotificationHubWithResponse(LinkNotificationHubParameters linkNotificationHubParameters, Context context)

Link Notification Hub Links an Azure Notification Hub to this communication service.
abstract CommunicationServiceKeys listKeys()

List Keys Get the access keys of the CommunicationService resource.
abstract Response<CommunicationServiceKeys> listKeysWithResponse(Context context)

List Keys Get the access keys of the CommunicationService 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 String notificationHubId()

Gets the notificationHubId property: Resource ID of an Azure Notification Hub linked to this resource.
abstract CommunicationServicesProvisioningState provisioningState()

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

Gets the publicNetworkAccess property: Allow, disallow, or let network security perimeter configuration control public network access to the protected resource.
abstract CommunicationServiceResource refresh()

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

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

Regenerate Key Regenerate CommunicationService access key.
abstract Response<CommunicationServiceKeys> regenerateKeyWithResponse(RegenerateKeyParameters parameters, Context context)

Regenerate Key Regenerate CommunicationService access key.
abstract Region region()

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

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

Gets the name of the resource group.
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 String type()

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

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

Gets the version property: Version of the CommunicationService resource.

Method Details

dataLocation

public abstract String dataLocation()

Gets the dataLocation property: The location where the communication service stores its data at rest.

Returns:

the dataLocation value.

disableLocalAuth

public abstract Boolean disableLocalAuth()

Gets the disableLocalAuth property: Disable local authentication for the CommunicationService.

Returns:

the disableLocalAuth value.

hostname

public abstract String hostname()

Gets the hostname property: FQDN of the CommunicationService instance.

Returns:

the hostname value.

id

public abstract String id()

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

Returns:

the id value.

identity

public abstract ManagedServiceIdentity identity()

Gets the identity property: Managed service identity (system assigned and/or user assigned identities).

Returns:

the identity value.

immutableResourceId

public abstract String immutableResourceId()

Gets the immutableResourceId property: The immutable resource Id of the communication service.

Returns:

the immutableResourceId value.

innerModel

public abstract CommunicationServiceResourceInner innerModel()

Gets the inner com.azure.resourcemanager.communication.fluent.models.CommunicationServiceResourceInner object.

Returns:

the inner object.

linkedDomains

public abstract List<String> linkedDomains()

Gets the linkedDomains property: List of email Domain resource Ids.

Returns:

the linkedDomains value.

linkNotificationHub

public abstract LinkedNotificationHub linkNotificationHub()

Link Notification Hub Links an Azure Notification Hub to this communication service.

Returns:

a notification hub that has been linked to the communication service.

linkNotificationHubWithResponse

public abstract Response<LinkedNotificationHub> linkNotificationHubWithResponse(LinkNotificationHubParameters linkNotificationHubParameters, Context context)

Link Notification Hub Links an Azure Notification Hub to this communication service.

Parameters:

linkNotificationHubParameters - Parameters supplied to the operation.
context - The context to associate with this operation.

Returns:

a notification hub that has been linked to the communication service along with Response<T>.

listKeys

public abstract CommunicationServiceKeys listKeys()

List Keys Get the access keys of the CommunicationService resource.

Returns:

the access keys of the CommunicationService resource.

listKeysWithResponse

public abstract Response<CommunicationServiceKeys> listKeysWithResponse(Context context)

List Keys Get the access keys of the CommunicationService resource.

Parameters:

context - The context to associate with this operation.

Returns:

the access keys of the CommunicationService resource along with Response<T>.

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.

notificationHubId

public abstract String notificationHubId()

Gets the notificationHubId property: Resource ID of an Azure Notification Hub linked to this resource.

Returns:

the notificationHubId value.

provisioningState

public abstract CommunicationServicesProvisioningState provisioningState()

Gets the provisioningState property: Provisioning state of the resource.

Returns:

the provisioningState value.

publicNetworkAccess

public abstract PublicNetworkAccess publicNetworkAccess()

Gets the publicNetworkAccess property: Allow, disallow, or let network security perimeter configuration control public network access to the protected resource. Value is optional but if passed in, it must be 'Enabled', 'Disabled' or 'SecuredByPerimeter'.

Returns:

the publicNetworkAccess value.

refresh

public abstract CommunicationServiceResource refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract CommunicationServiceResource 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 CommunicationServiceKeys regenerateKey(RegenerateKeyParameters parameters)

Regenerate Key Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

Parameters:

parameters - Parameter that describes the Regenerate Key Operation.

Returns:

a class representing the access keys of a CommunicationService.

regenerateKeyWithResponse

public abstract Response<CommunicationServiceKeys> regenerateKeyWithResponse(RegenerateKeyParameters parameters, Context context)

Regenerate Key Regenerate CommunicationService access key. 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 representing the access keys of a CommunicationService along with Response<T>.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

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.

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.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract CommunicationServiceResource.Update update()

Begins update for the CommunicationServiceResource resource.

Returns:

the stage of resource update.

version

public abstract String version()

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

Returns:

the version value.

Applies to