ClientGroups Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.3.0-beta.1

public interface ClientGroups

Resource collection API of ClientGroups.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new ClientGroup resource.
abstract void	delete(String resourceGroupName, String namespaceName, String clientGroupName) Delete a client group.
abstract void	delete(String resourceGroupName, String namespaceName, String clientGroupName, Context context) Delete a client group.
abstract void	deleteById(String id) Delete a client group.
abstract void	deleteByIdWithResponse(String id, Context context) Delete a client group.
abstract ClientGroup	get(String resourceGroupName, String namespaceName, String clientGroupName) Get a client group.
abstract ClientGroup	getById(String id) Get a client group.
abstract Response<ClientGroup>	getByIdWithResponse(String id, Context context) Get a client group.
abstract Response<ClientGroup>	getWithResponse(String resourceGroupName, String namespaceName, String clientGroupName, Context context) Get a client group.
abstract PagedIterable<ClientGroup>	listByNamespace(String resourceGroupName, String namespaceName) List all client groups under a namespace.
abstract PagedIterable<ClientGroup>	listByNamespace(String resourceGroupName, String namespaceName, String filter, Integer top, Context context) List all client groups under a namespace.

Method Details

define

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

Begins definition for a new ClientGroup resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ClientGroup definition.

delete

public abstract void delete(String resourceGroupName, String namespaceName, String clientGroupName)

Delete a client group. Delete an existing client group.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

namespaceName - Name of the namespace.

clientGroupName - Name of the client group.

delete

public abstract void delete(String resourceGroupName, String namespaceName, String clientGroupName, Context context)

Delete a client group. Delete an existing client group.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

namespaceName - Name of the namespace.

clientGroupName - Name of the client group.

context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Delete a client group. Delete an existing client group.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete a client group. Delete an existing client group.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

get

public abstract ClientGroup get(String resourceGroupName, String namespaceName, String clientGroupName)

Get a client group. Get properties of a client group.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

namespaceName - Name of the namespace.

clientGroupName - Name of the client group.

Returns:

properties of a client group.

getById

public abstract ClientGroup getById(String id)

Get a client group. Get properties of a client group.

Parameters:

id - the resource ID.

Returns:

properties of a client group along with Response<T>.

getByIdWithResponse

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

Get a client group. Get properties of a client group.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

properties of a client group along with Response<T>.

getWithResponse

public abstract Response<ClientGroup> getWithResponse(String resourceGroupName, String namespaceName, String clientGroupName, Context context)

Get a client group. Get properties of a client group.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

namespaceName - Name of the namespace.

clientGroupName - Name of the client group.

context - The context to associate with this operation.

Returns:

properties of a client group along with Response<T>.

listByNamespace

public abstract PagedIterable<ClientGroup> listByNamespace(String resourceGroupName, String namespaceName)

List all client groups under a namespace. Get all the client groups under a namespace.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

namespaceName - Name of the namespace.

Returns:

all the client groups under a namespace as paginated response with PagedIterable<T>.

listByNamespace

public abstract PagedIterable<ClientGroup> listByNamespace(String resourceGroupName, String namespaceName, String filter, Integer top, Context context)

List all client groups under a namespace. Get all the client groups under a namespace.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

namespaceName - Name of the namespace.

filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

context - The context to associate with this operation.

Returns:

all the client groups under a namespace as paginated response with PagedIterable<T>.