Groups Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface Groups

Resource collection API of Groups.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new GroupContract resource.
abstract void	delete(String resourceGroupName, String serviceName, String groupId, String ifMatch) Deletes specific group of the API Management service instance.
abstract void	deleteById(String id) Deletes specific group of the API Management service instance.
abstract Response<Void>	deleteByIdWithResponse(String id, String ifMatch, Context context) Deletes specific group of the API Management service instance.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String groupId, String ifMatch, Context context) Deletes specific group of the API Management service instance.
abstract GroupContract	get(String resourceGroupName, String serviceName, String groupId) Gets the details of the group specified by its identifier.
abstract GroupContract	getById(String id) Gets the details of the group specified by its identifier.
abstract Response<GroupContract>	getByIdWithResponse(String id, Context context) Gets the details of the group specified by its identifier.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String groupId) Gets the entity state (Etag) version of the group specified by its identifier.
abstract GroupsGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String groupId, Context context) Gets the entity state (Etag) version of the group specified by its identifier.
abstract Response<GroupContract>	getWithResponse(String resourceGroupName, String serviceName, String groupId, Context context) Gets the details of the group specified by its identifier.
abstract PagedIterable<GroupContract>	listByService(String resourceGroupName, String serviceName) Lists a collection of groups defined within a service instance.
abstract PagedIterable<GroupContract>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Context context) Lists a collection of groups defined within a service instance.

Method Details

define

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

Begins definition for a new GroupContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new GroupContract definition.

delete

public abstract void delete(String resourceGroupName, String serviceName, String groupId, String ifMatch)

Deletes specific group of the API Management service instance.

Parameters:

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

serviceName - The name of the API Management service.

groupId - Group identifier. Must be unique in the current API Management service instance.

ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

deleteById

public abstract void deleteById(String id)

Deletes specific group of the API Management service instance.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, String ifMatch, Context context)

Deletes specific group of the API Management service instance.

Parameters:

id - the resource ID.

ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

context - The context to associate with this operation.

Returns:

the Response<T>.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String serviceName, String groupId, String ifMatch, Context context)

Deletes specific group of the API Management service instance.

Parameters:

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

serviceName - The name of the API Management service.

groupId - Group identifier. Must be unique in the current API Management service instance.

ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

context - The context to associate with this operation.

Returns:

the Response<T>.

get

public abstract GroupContract get(String resourceGroupName, String serviceName, String groupId)

Gets the details of the group specified by its identifier.

Parameters:

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

serviceName - The name of the API Management service.

groupId - Group identifier. Must be unique in the current API Management service instance.

Returns:

the details of the group specified by its identifier.

getById

public abstract GroupContract getById(String id)

Gets the details of the group specified by its identifier.

Parameters:

id - the resource ID.

Returns:

the details of the group specified by its identifier.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Gets the details of the group specified by its identifier.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the details of the group specified by its identifier.

getEntityTag

public abstract void getEntityTag(String resourceGroupName, String serviceName, String groupId)

Gets the entity state (Etag) version of the group specified by its identifier.

Parameters:

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

serviceName - The name of the API Management service.

groupId - Group identifier. Must be unique in the current API Management service instance.

getEntityTagWithResponse

public abstract GroupsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String groupId, Context context)

Gets the entity state (Etag) version of the group specified by its identifier.

Parameters:

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

serviceName - The name of the API Management service.

groupId - Group identifier. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

the entity state (Etag) version of the group specified by its identifier.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serviceName, String groupId, Context context)

Gets the details of the group specified by its identifier.

Parameters:

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

serviceName - The name of the API Management service.

groupId - Group identifier. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

the details of the group specified by its identifier.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName)

Lists a collection of groups defined within a service instance.

Parameters:

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

serviceName - The name of the API Management service.

Returns:

paged Group list representation as paginated response with PagedIterable<T>.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Context context)

Lists a collection of groups defined within a service instance.

Parameters:

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

serviceName - The name of the API Management service.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| externalId | filter | eq | |</br>.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

paged Group list representation as paginated response with PagedIterable<T>.