WebPubSubs Interface

Package:

com.azure.resourcemanager.webpubsub.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-webpubsub:1.1.0-beta.2

public interface WebPubSubs

Resource collection API of WebPubSubs.

Method Summary

Modifier and Type	Method and Description
abstract NameAvailability	checkNameAvailability(String location, NameAvailabilityParameters parameters) Checks that the resource name is valid and is not already in use.
abstract Response<NameAvailability>	checkNameAvailabilityWithResponse(String location, NameAvailabilityParameters parameters, Context context) Checks that the resource name is valid and is not already in use.
abstract Blank	define(String name) Begins definition for a new WebPubSubResource resource.
abstract void	delete(String resourceGroupName, String resourceName, Context context) Operation to delete a resource.
abstract void	deleteById(String id) Operation to delete a resource.
abstract void	deleteByIdWithResponse(String id, Context context) Operation to delete a resource.
abstract void	deleteByResourceGroup(String resourceGroupName, String resourceName) Operation to delete a resource.
abstract WebPubSubResource	getById(String id) Get the resource and its properties.
abstract Response<WebPubSubResource>	getByIdWithResponse(String id, Context context) Get the resource and its properties.
abstract WebPubSubResource	getByResourceGroup(String resourceGroupName, String resourceName) Get the resource and its properties.
abstract Response<WebPubSubResource>	getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context) Get the resource and its properties.
abstract PagedIterable<WebPubSubResource>	list() Handles requests to list all resources in a subscription.
abstract PagedIterable<WebPubSubResource>	list(Context context) Handles requests to list all resources in a subscription.
abstract PagedIterable<WebPubSubResource>	listByResourceGroup(String resourceGroupName) Handles requests to list all resources in a resource group.
abstract PagedIterable<WebPubSubResource>	listByResourceGroup(String resourceGroupName, Context context) Handles requests to list all resources in a resource group.
abstract WebPubSubKeys	listKeys(String resourceGroupName, String resourceName) Get the access keys of the resource.
abstract Response<WebPubSubKeys>	listKeysWithResponse(String resourceGroupName, String resourceName, Context context) Get the access keys of the resource.
abstract SkuList	listReplicaSkus(String resourceGroupName, String resourceName, String replicaName) List all available skus of the replica resource.
abstract Response<SkuList>	listReplicaSkusWithResponse(String resourceGroupName, String resourceName, String replicaName, Context context) List all available skus of the replica resource.
abstract SkuList	listSkus(String resourceGroupName, String resourceName) List all available skus of the resource.
abstract Response<SkuList>	listSkusWithResponse(String resourceGroupName, String resourceName, Context context) List all available skus of the resource.
abstract WebPubSubKeys	regenerateKey(String resourceGroupName, String resourceName, RegenerateKeyParameters parameters) Regenerate the access key for the resource.
abstract WebPubSubKeys	regenerateKey(String resourceGroupName, String resourceName, RegenerateKeyParameters parameters, Context context) Regenerate the access key for the resource.
abstract void	restart(String resourceGroupName, String resourceName) Operation to restart a resource.
abstract void	restart(String resourceGroupName, String resourceName, Context context) Operation to restart a resource.

Method Details

checkNameAvailability

public abstract NameAvailability checkNameAvailability(String location, NameAvailabilityParameters parameters)

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.

checkNameAvailabilityWithResponse

public abstract Response<NameAvailability> checkNameAvailabilityWithResponse(String location, NameAvailabilityParameters parameters, 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<T>.

define

public abstract WebPubSubResource.DefinitionStages.Blank define(String name)

Begins definition for a new WebPubSubResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new WebPubSubResource definition.

delete

public abstract void delete(String resourceGroupName, String resourceName, Context context)

Operation to delete a resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - The name of the resource.

context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Operation to delete a resource.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Operation to delete a resource.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String resourceName)

Operation to delete a resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - The name of the resource.

getById

public abstract WebPubSubResource getById(String id)

Get the resource and its properties.

Parameters:

id - the resource ID.

Returns:

the resource and its properties along with Response<T>.

getByIdWithResponse

public abstract Response<WebPubSubResource> getByIdWithResponse(String id, 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<T>.

getByResourceGroup

public abstract WebPubSubResource getByResourceGroup(String resourceGroupName, String resourceName)

Get the resource and its properties.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - The name of the resource.

Returns:

the resource and its properties.

getByResourceGroupWithResponse

public abstract Response<WebPubSubResource> getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context)

Get the resource and its properties.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - The name of the resource.

context - The context to associate with this operation.

Returns:

the resource and its properties along with Response<T>.

list

public abstract PagedIterable<WebPubSubResource> 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<T>.

list

public abstract PagedIterable<WebPubSubResource> list(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 resources and a possible link for next set as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<WebPubSubResource> 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 resources and a possible link for next set as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<WebPubSubResource> listByResourceGroup(String resourceGroupName, 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 resources and a possible link for next set as paginated response with PagedIterable<T>.

listKeys

public abstract WebPubSubKeys listKeys(String resourceGroupName, String resourceName)

Get the access keys of the resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - The name of the resource.

Returns:

the access keys of the resource.

listKeysWithResponse

public abstract Response<WebPubSubKeys> listKeysWithResponse(String resourceGroupName, String resourceName, Context context)

Get the access keys of the resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - The name of the resource.

context - The context to associate with this operation.

Returns:

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

listReplicaSkus

public abstract SkuList listReplicaSkus(String resourceGroupName, String resourceName, String replicaName)

List all available skus of the replica resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - The name of the resource.

replicaName - The name of the replica.

Returns:

the list skus operation response.

listReplicaSkusWithResponse

public abstract Response<SkuList> listReplicaSkusWithResponse(String resourceGroupName, String resourceName, String replicaName, Context context)

List all available skus of the replica resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - The name of the resource.

replicaName - The name of the replica.

context - The context to associate with this operation.

Returns:

the list skus operation response along with Response<T>.

listSkus

public abstract SkuList listSkus(String resourceGroupName, String resourceName)

List all available skus of the resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - The name of the resource.

Returns:

the list skus operation response.

listSkusWithResponse

public abstract Response<SkuList> listSkusWithResponse(String resourceGroupName, String resourceName, Context context)

List all available skus of the resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - The name of the resource.

context - The context to associate with this operation.

Returns:

the list skus operation response along with Response<T>.

regenerateKey

public abstract WebPubSubKeys 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. The name is case insensitive.

resourceName - The name of the resource.

parameters - Parameter that describes the Regenerate Key Operation.

Returns:

a class represents the access keys of the resource.

regenerateKey

public abstract WebPubSubKeys regenerateKey(String resourceGroupName, String resourceName, RegenerateKeyParameters parameters, 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. The name is case insensitive.

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.

restart

public abstract void restart(String resourceGroupName, String resourceName)

Operation to restart a resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - The name of the resource.

restart

public abstract void restart(String resourceGroupName, String resourceName, Context context)

Operation to restart a resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - The name of the resource.

context - The context to associate with this operation.