Interface Groups
-
public interface Groups
Resource collection API of Groups.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description GroupContract.DefinitionStages.Blank
define(String name)
Begins definition for a new GroupContract resource.void
delete(String resourceGroupName, String serviceName, String groupId, String ifMatch)
Deletes specific group of the API Management service instance.void
deleteById(String id)
Deletes specific group of the API Management service instance.com.azure.core.http.rest.Response<Void>
deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.Context context)
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.GroupContract
get(String resourceGroupName, String serviceName, String groupId)
Gets the details of the group specified by its identifier.GroupContract
getById(String id)
Gets the details of the group specified by its identifier.com.azure.core.http.rest.Response<GroupContract>
getByIdWithResponse(String id, com.azure.core.util.Context context)
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.com.azure.core.http.rest.Response<GroupContract>
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<GroupContract>
listByService(String resourceGroupName, String serviceName)
Lists a collection of groups defined within a service instance.com.azure.core.http.rest.PagedIterable<GroupContract>
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.
-
-
-
Method Detail
-
listByService
com.azure.core.http.rest.PagedIterable<GroupContract> 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<GroupContract> 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
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.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
com.azure.core.http.rest.Response<GroupContract> 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.
-
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.
-
getById
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.
- 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.
-
getByIdWithResponse
com.azure.core.http.rest.Response<GroupContract> getByIdWithResponse(String id, com.azure.core.util.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.
- 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.
-
deleteById
void deleteById(String id)
Deletes specific group of the API Management service instance.- Parameters:
id
- the resource ID.- 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.
-
deleteByIdWithResponse
com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.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
. - 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.
-
define
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.
-
-