WebPubSubReplicas Interface

public interface WebPubSubReplicas

Resource collection API of WebPubSubReplicas.

Method Summary

Modifier and Type Method and Description
abstract Blank define(String name)

Begins definition for a new Replica resource.

abstract void delete(String resourceGroupName, String resourceName, String replicaName)

Operation to delete a replica.

abstract void deleteById(String id)

Operation to delete a replica.

abstract Response<Void> deleteByIdWithResponse(String id, Context context)

Operation to delete a replica.

abstract Response<Void> deleteWithResponse(String resourceGroupName, String resourceName, String replicaName, Context context)

Operation to delete a replica.

abstract Replica get(String resourceGroupName, String resourceName, String replicaName)

Get the replica and its properties.

abstract Replica getById(String id)

Get the replica and its properties.

abstract Response<Replica> getByIdWithResponse(String id, Context context)

Get the replica and its properties.

abstract Response<Replica> getWithResponse(String resourceGroupName, String resourceName, String replicaName, Context context)

Get the replica and its properties.

abstract PagedIterable<Replica> list(String resourceGroupName, String resourceName)

List all replicas belong to this resource.

abstract PagedIterable<Replica> list(String resourceGroupName, String resourceName, Context context)

List all replicas belong to this resource.

abstract void restart(String resourceGroupName, String resourceName, String replicaName)

Operation to restart a replica.

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

Operation to restart a replica.

Method Details

define

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

Begins definition for a new Replica resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Replica definition.

delete

public abstract void delete(String resourceGroupName, String resourceName, String replicaName)

Operation to delete a replica.

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.

deleteById

public abstract void deleteById(String id)

Operation to delete a replica.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response<Void> deleteByIdWithResponse(String id, Context context)

Operation to delete a replica.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

deleteWithResponse

public abstract Response<Void> deleteWithResponse(String resourceGroupName, String resourceName, String replicaName, Context context)

Operation to delete a replica.

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:

get

public abstract Replica get(String resourceGroupName, String resourceName, String replicaName)

Get the replica and its properties.

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 replica and its properties.

getById

public abstract Replica getById(String id)

Get the replica and its properties.

Parameters:

id - the resource ID.

Returns:

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

getByIdWithResponse

public abstract Response<Replica> getByIdWithResponse(String id, Context context)

Get the replica and its properties.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

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

getWithResponse

public abstract Response<Replica> getWithResponse(String resourceGroupName, String resourceName, String replicaName, Context context)

Get the replica and its properties.

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 replica and its properties along with Response<T>.

list

public abstract PagedIterable<Replica> list(String resourceGroupName, String resourceName)

List all replicas belong to this resource.

Parameters:

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

Returns:

the paginated response with PagedIterable<T>.

list

public abstract PagedIterable<Replica> list(String resourceGroupName, String resourceName, Context context)

List all replicas belong to this 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 paginated response with PagedIterable<T>.

restart

public abstract void restart(String resourceGroupName, String resourceName, String replicaName)

Operation to restart a replica.

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.

restart

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

Operation to restart a replica.

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.

Applies to