Interface SignalRs
public interface SignalRs
Resource collection API of SignalRs.
-
Method Summary
Modifier and TypeMethodDescriptioncheckNameAvailability
(String location, NameAvailabilityParameters parameters) Checks that the resource name is valid and is not already in use.com.azure.core.http.rest.Response<NameAvailability>
checkNameAvailabilityWithResponse
(String location, NameAvailabilityParameters parameters, com.azure.core.util.Context context) Checks that the resource name is valid and is not already in use.Begins definition for a new SignalRResource resource.void
Operation to delete a resource.void
deleteById
(String id) Operation to delete a resource.void
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Operation to delete a resource.void
deleteByResourceGroup
(String resourceGroupName, String resourceName) Operation to delete a resource.Get the resource and its properties.com.azure.core.http.rest.Response<SignalRResource>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Get the resource and its properties.getByResourceGroup
(String resourceGroupName, String resourceName) Get the resource and its properties.com.azure.core.http.rest.Response<SignalRResource>
getByResourceGroupWithResponse
(String resourceGroupName, String resourceName, com.azure.core.util.Context context) Get the resource and its properties.com.azure.core.http.rest.PagedIterable<SignalRResource>
list()
Handles requests to list all resources in a subscription.com.azure.core.http.rest.PagedIterable<SignalRResource>
list
(com.azure.core.util.Context context) Handles requests to list all resources in a subscription.com.azure.core.http.rest.PagedIterable<SignalRResource>
listByResourceGroup
(String resourceGroupName) Handles requests to list all resources in a resource group.com.azure.core.http.rest.PagedIterable<SignalRResource>
listByResourceGroup
(String resourceGroupName, com.azure.core.util.Context context) Handles requests to list all resources in a resource group.Get the access keys of the resource.com.azure.core.http.rest.Response<SignalRKeys>
listKeysWithResponse
(String resourceGroupName, String resourceName, com.azure.core.util.Context context) Get the access keys of the resource.List all available skus of the resource.com.azure.core.http.rest.Response<SkuList>
listSkusWithResponse
(String resourceGroupName, String resourceName, com.azure.core.util.Context context) List all available skus of the resource.regenerateKey
(String resourceGroupName, String resourceName, RegenerateKeyParameters parameters) Regenerate the access key for the resource.regenerateKey
(String resourceGroupName, String resourceName, RegenerateKeyParameters parameters, com.azure.core.util.Context context) Regenerate the access key for the resource.void
Operation to restart a resource.void
Operation to restart a resource.
-
Method Details
-
checkNameAvailabilityWithResponse
com.azure.core.http.rest.Response<NameAvailability> checkNameAvailabilityWithResponse(String location, NameAvailabilityParameters parameters, com.azure.core.util.Context context) Checks that the resource name is valid and is not already in use.- Parameters:
location
- the region.parameters
- 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.
-
checkNameAvailability
Checks that the resource name is valid and is not already in use.- Parameters:
location
- the region.parameters
- Parameters supplied to the operation.- Returns:
- result of the request to check name availability.
- 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<SignalRResource> list()Handles requests to list all resources in a subscription.- Returns:
- object that includes an array of resources and a possible link for next set as paginated response with
PagedIterable
. - 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
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 resources and a possible link for next set as paginated response with
PagedIterable
. - 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<SignalRResource> listByResourceGroup(String resourceGroupName) Handles requests to list all resources in a resource group.- Parameters:
resourceGroupName
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.- Returns:
- object that includes an array of resources and a possible link for next set as paginated response with
PagedIterable
. - 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<SignalRResource> 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 that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.context
- The context to associate with this operation.- Returns:
- object that includes an array of resources and a possible link for next set as paginated response with
PagedIterable
. - 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<SignalRResource> getByResourceGroupWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context) Get the resource and its properties.- Parameters:
resourceGroupName
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.resourceName
- The name of the resource.context
- The context to associate with this operation.- Returns:
- the resource 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.
-
getByResourceGroup
Get the resource and its properties.- Parameters:
resourceGroupName
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.resourceName
- The name of the resource.- Returns:
- the resource 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.
-
deleteByResourceGroup
Operation to delete a resource.- Parameters:
resourceGroupName
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.resourceName
- The name 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.
-
delete
Operation to delete a resource.- Parameters:
resourceGroupName
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.resourceName
- The name of the 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.
-
listKeysWithResponse
com.azure.core.http.rest.Response<SignalRKeys> listKeysWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context) Get the access keys of the resource.- Parameters:
resourceGroupName
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.resourceName
- The name of the resource.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
Get the access keys of the resource.- Parameters:
resourceGroupName
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.resourceName
- The name of the resource.- Returns:
- 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(String resourceGroupName, String resourceName, RegenerateKeyParameters parameters) Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.- Parameters:
resourceGroupName
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.resourceName
- The name of the resource.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(String resourceGroupName, String resourceName, 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:
resourceGroupName
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.resourceName
- The name of the resource.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
Operation to restart a resource.- Parameters:
resourceGroupName
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.resourceName
- The name 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
Operation to restart a resource.- Parameters:
resourceGroupName
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.resourceName
- The name of the 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.
-
listSkusWithResponse
com.azure.core.http.rest.Response<SkuList> listSkusWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context) List all available skus of the resource.- Parameters:
resourceGroupName
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.resourceName
- The name of the resource.context
- The context to associate with this operation.- Returns:
- the list skus operation response 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.
-
listSkus
List all available skus of the resource.- Parameters:
resourceGroupName
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.resourceName
- The name of the resource.- Returns:
- the list skus operation 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
Get the resource and its properties.- Parameters:
id
- the resource ID.- Returns:
- the resource 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<SignalRResource> getByIdWithResponse(String id, com.azure.core.util.Context context) Get the resource and its properties.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- the resource 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
Operation to delete a resource.- 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
Operation to delete a resource.- 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
Begins definition for a new SignalRResource resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new SignalRResource definition.
-