Interface CommunicationServices
-
public interface CommunicationServices
Resource collection API of CommunicationServices.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description NameAvailability
checkNameAvailability()
Checks that the CommunicationService name is valid and is not already in use.com.azure.core.http.rest.Response<NameAvailability>
checkNameAvailabilityWithResponse(NameAvailabilityParameters nameAvailabilityParameters, com.azure.core.util.Context context)
Checks that the CommunicationService name is valid and is not already in use.CommunicationServiceResource.DefinitionStages.Blank
define(String name)
Begins definition for a new CommunicationServiceResource resource.void
delete(String resourceGroupName, String communicationServiceName, com.azure.core.util.Context context)
Operation to delete a CommunicationService.void
deleteById(String id)
Operation to delete a CommunicationService.void
deleteByIdWithResponse(String id, com.azure.core.util.Context context)
Operation to delete a CommunicationService.void
deleteByResourceGroup(String resourceGroupName, String communicationServiceName)
Operation to delete a CommunicationService.CommunicationServiceResource
getById(String id)
Get the CommunicationService and its properties.com.azure.core.http.rest.Response<CommunicationServiceResource>
getByIdWithResponse(String id, com.azure.core.util.Context context)
Get the CommunicationService and its properties.CommunicationServiceResource
getByResourceGroup(String resourceGroupName, String communicationServiceName)
Get the CommunicationService and its properties.com.azure.core.http.rest.Response<CommunicationServiceResource>
getByResourceGroupWithResponse(String resourceGroupName, String communicationServiceName, com.azure.core.util.Context context)
Get the CommunicationService and its properties.LinkedNotificationHub
linkNotificationHub(String resourceGroupName, String communicationServiceName)
Links an Azure Notification Hub to this communication service.com.azure.core.http.rest.Response<LinkedNotificationHub>
linkNotificationHubWithResponse(String resourceGroupName, String communicationServiceName, LinkNotificationHubParameters linkNotificationHubParameters, com.azure.core.util.Context context)
Links an Azure Notification Hub to this communication service.com.azure.core.http.rest.PagedIterable<CommunicationServiceResource>
list()
Handles requests to list all resources in a subscription.com.azure.core.http.rest.PagedIterable<CommunicationServiceResource>
list(com.azure.core.util.Context context)
Handles requests to list all resources in a subscription.com.azure.core.http.rest.PagedIterable<CommunicationServiceResource>
listByResourceGroup(String resourceGroupName)
Handles requests to list all resources in a resource group.com.azure.core.http.rest.PagedIterable<CommunicationServiceResource>
listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
Handles requests to list all resources in a resource group.CommunicationServiceKeys
listKeys(String resourceGroupName, String communicationServiceName)
Get the access keys of the CommunicationService resource.com.azure.core.http.rest.Response<CommunicationServiceKeys>
listKeysWithResponse(String resourceGroupName, String communicationServiceName, com.azure.core.util.Context context)
Get the access keys of the CommunicationService resource.CommunicationServiceKeys
regenerateKey(String resourceGroupName, String communicationServiceName, RegenerateKeyParameters parameters)
Regenerate CommunicationService access key.com.azure.core.http.rest.Response<CommunicationServiceKeys>
regenerateKeyWithResponse(String resourceGroupName, String communicationServiceName, RegenerateKeyParameters parameters, com.azure.core.util.Context context)
Regenerate CommunicationService access key.
-
-
-
Method Detail
-
checkNameAvailability
NameAvailability checkNameAvailability()
Checks that the CommunicationService name is valid and is not already in use.- Returns:
- result of the request to check name availability.
- 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.
-
checkNameAvailabilityWithResponse
com.azure.core.http.rest.Response<NameAvailability> checkNameAvailabilityWithResponse(NameAvailabilityParameters nameAvailabilityParameters, com.azure.core.util.Context context)
Checks that the CommunicationService name is valid and is not already in use.- Parameters:
nameAvailabilityParameters
- Parameters supplied to the operation.context
- The context to associate with this operation.- Returns:
- result of the request to check name availability 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.
-
linkNotificationHub
LinkedNotificationHub linkNotificationHub(String resourceGroupName, String communicationServiceName)
Links an Azure Notification Hub to this communication service.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.communicationServiceName
- The name of the CommunicationService resource.- Returns:
- a notification hub that has been linked to the communication service.
- 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.
-
linkNotificationHubWithResponse
com.azure.core.http.rest.Response<LinkedNotificationHub> linkNotificationHubWithResponse(String resourceGroupName, String communicationServiceName, LinkNotificationHubParameters linkNotificationHubParameters, com.azure.core.util.Context context)
Links an Azure Notification Hub to this communication service.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.communicationServiceName
- The name of the CommunicationService resource.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
. - 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.
-
list
com.azure.core.http.rest.PagedIterable<CommunicationServiceResource> list()
Handles requests to list all resources in a subscription.- Returns:
- object that includes an array of CommunicationServices and a possible link for next set.
- 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.
-
list
com.azure.core.http.rest.PagedIterable<CommunicationServiceResource> list(com.azure.core.util.Context context)
Handles requests to list all resources in a subscription.- Parameters:
context
- The context to associate with this operation.- Returns:
- object that includes an array of CommunicationServices and a possible link for next set.
- 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.
-
listByResourceGroup
com.azure.core.http.rest.PagedIterable<CommunicationServiceResource> listByResourceGroup(String resourceGroupName)
Handles requests to list all resources in a resource group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.- Returns:
- object that includes an array of CommunicationServices and a possible link for next set.
- 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.
-
listByResourceGroup
com.azure.core.http.rest.PagedIterable<CommunicationServiceResource> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
Handles requests to list all resources in a resource group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.context
- The context to associate with this operation.- Returns:
- object that includes an array of CommunicationServices and a possible link for next set.
- 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.
-
getByResourceGroup
CommunicationServiceResource getByResourceGroup(String resourceGroupName, String communicationServiceName)
Get the CommunicationService and its properties.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.communicationServiceName
- The name of the CommunicationService resource.- Returns:
- the CommunicationService and its properties.
- 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.
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<CommunicationServiceResource> getByResourceGroupWithResponse(String resourceGroupName, String communicationServiceName, com.azure.core.util.Context context)
Get the CommunicationService and its properties.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.communicationServiceName
- The name of the CommunicationService resource.context
- The context to associate with this operation.- Returns:
- the CommunicationService and its properties 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.
-
deleteByResourceGroup
void deleteByResourceGroup(String resourceGroupName, String communicationServiceName)
Operation to delete a CommunicationService.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.communicationServiceName
- The name of the CommunicationService 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.
-
delete
void delete(String resourceGroupName, String communicationServiceName, com.azure.core.util.Context context)
Operation to delete a CommunicationService.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.communicationServiceName
- The name of the CommunicationService resource.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.
-
listKeys
CommunicationServiceKeys listKeys(String resourceGroupName, String communicationServiceName)
Get the access keys of the CommunicationService resource.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.communicationServiceName
- The name of the CommunicationService resource.- Returns:
- the access keys of the CommunicationService 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.
-
listKeysWithResponse
com.azure.core.http.rest.Response<CommunicationServiceKeys> listKeysWithResponse(String resourceGroupName, String communicationServiceName, com.azure.core.util.Context context)
Get the access keys of the CommunicationService resource.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.communicationServiceName
- The name of the CommunicationService resource.context
- The context to associate with this operation.- Returns:
- the access keys of the CommunicationService 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
CommunicationServiceKeys regenerateKey(String resourceGroupName, String communicationServiceName, RegenerateKeyParameters parameters)
Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.communicationServiceName
- The name of the CommunicationService resource.parameters
- Parameter that describes the Regenerate Key Operation.- Returns:
- a class representing the access keys of a CommunicationService.
- 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.
-
regenerateKeyWithResponse
com.azure.core.http.rest.Response<CommunicationServiceKeys> regenerateKeyWithResponse(String resourceGroupName, String communicationServiceName, RegenerateKeyParameters parameters, com.azure.core.util.Context context)
Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.communicationServiceName
- The name of the CommunicationService resource.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
. - 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.
-
getById
CommunicationServiceResource getById(String id)
Get the CommunicationService and its properties.- Parameters:
id
- the resource ID.- Returns:
- the CommunicationService and its properties 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.
-
getByIdWithResponse
com.azure.core.http.rest.Response<CommunicationServiceResource> getByIdWithResponse(String id, com.azure.core.util.Context context)
Get the CommunicationService and its properties.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- the CommunicationService and its properties 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.
-
deleteById
void deleteById(String id)
Operation to delete a CommunicationService.- Parameters:
id
- the resource ID.- 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.
-
deleteByIdWithResponse
void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
Operation to delete a CommunicationService.- Parameters:
id
- the resource ID.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.
-
define
CommunicationServiceResource.DefinitionStages.Blank define(String name)
Begins definition for a new CommunicationServiceResource resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new CommunicationServiceResource definition.
-
-