Package com.azure.resourcemanager.apimanagement.fluent

Interface GroupsClient

public interface GroupsClient

An instance of this class provides access to all the operations defined in GroupsClient.

Method Summary

Modifier and Type	Method	Description
GroupContractInner	createOrUpdate(String resourceGroupName, String serviceName, String groupId, GroupCreateParameters parameters)	Creates or Updates a group.
GroupsCreateOrUpdateResponse	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String groupId, GroupCreateParameters parameters, String ifMatch, com.azure.core.util.Context context)	Creates or Updates a group.
void	delete(String resourceGroupName, String serviceName, String groupId, String ifMatch)	Deletes specific group of the API Management service instance.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String groupId, String ifMatch, com.azure.core.util.Context context)	Deletes specific group of the API Management service instance.
GroupContractInner	get(String resourceGroupName, String serviceName, String groupId)	Gets the details of the group specified by its identifier.
void	getEntityTag(String resourceGroupName, String serviceName, String groupId)	Gets the entity state (Etag) version of the group specified by its identifier.
GroupsGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String groupId, com.azure.core.util.Context context)	Gets the entity state (Etag) version of the group specified by its identifier.
GroupsGetResponse	getWithResponse(String resourceGroupName, String serviceName, String groupId, com.azure.core.util.Context context)	Gets the details of the group specified by its identifier.
com.azure.core.http.rest.PagedIterable<GroupContractInner>	listByService(String resourceGroupName, String serviceName)	Lists a collection of groups defined within a service instance.
com.azure.core.http.rest.PagedIterable<GroupContractInner>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, com.azure.core.util.Context context)	Lists a collection of groups defined within a service instance.
GroupContractInner	update(String resourceGroupName, String serviceName, String groupId, String ifMatch, GroupUpdateParameters parameters)	Updates the details of the group specified by its identifier.
GroupsUpdateResponse	updateWithResponse(String resourceGroupName, String serviceName, String groupId, String ifMatch, GroupUpdateParameters parameters, com.azure.core.util.Context context)	Updates the details of the group specified by its identifier.

Method Detail

listByService

com.azure.core.http.rest.PagedIterable<GroupContractInner> listByService(String resourceGroupName,
                                                                         String serviceName)

Lists a collection of groups defined within a service instance.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

paged Group list representation 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.

listByService

com.azure.core.http.rest.PagedIterable<GroupContractInner> listByService(String resourceGroupName,
                                                                         String serviceName,
                                                                         String filter,
                                                                         Integer top,
                                                                         Integer skip,
                                                                         com.azure.core.util.Context context)

Lists a collection of groups defined within a service instance.

Parameters:

resourceGroupName - The name of the resource group.

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.

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.

getEntityTag

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.

serviceName - The name of the API Management service.

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

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.

getEntityTagWithResponse

GroupsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                    String serviceName,
                                                    String groupId,
                                                    com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - The name of the resource group.

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.

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.

get

GroupContractInner 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.

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.

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.

getWithResponse

GroupsGetResponse getWithResponse(String resourceGroupName,
                                  String serviceName,
                                  String groupId,
                                  com.azure.core.util.Context context)

Gets the details of the group specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

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.

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.

createOrUpdate

GroupContractInner createOrUpdate(String resourceGroupName,
                                  String serviceName,
                                  String groupId,
                                  GroupCreateParameters parameters)

Creates or Updates a group.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

parameters - Create parameters.

Returns:

contract details.

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.

createOrUpdateWithResponse

GroupsCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName,
                                                        String serviceName,
                                                        String groupId,
                                                        GroupCreateParameters parameters,
                                                        String ifMatch,
                                                        com.azure.core.util.Context context)

Creates or Updates a group.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

parameters - Create parameters.

ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.

context - The context to associate with this operation.

Returns:

contract details.

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.

update

GroupContractInner update(String resourceGroupName,
                          String serviceName,
                          String groupId,
                          String ifMatch,
                          GroupUpdateParameters parameters)

Updates the details of the group specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

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.

parameters - Update parameters.

Returns:

contract details.

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.

updateWithResponse

GroupsUpdateResponse updateWithResponse(String resourceGroupName,
                                        String serviceName,
                                        String groupId,
                                        String ifMatch,
                                        GroupUpdateParameters parameters,
                                        com.azure.core.util.Context context)

Updates the details of the group specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

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.

parameters - Update parameters.

context - The context to associate with this operation.

Returns:

contract details.

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

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.

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.

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.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String serviceName,
                                                           String groupId,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

Deletes specific group of the API Management service instance.

Parameters:

resourceGroupName - The name of the resource group.

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.

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.