Share via

Groups Interface

Package:
com.microsoft.azure.management.apimanagement.v2019_01_01
Maven Artifact:
com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1

Implements

com.microsoft.azure.arm.collection.SupportsCreating<Blank> com.microsoft.azure.arm.model.HasInner<com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.GroupsInner>

public interface Groups
extends com.microsoft.azure.arm.collection.SupportsCreating<Blank>, com.microsoft.azure.arm.model.HasInner<com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.GroupsInner>

Type representing Groups.

Method Summary

Modifier and Type Method and Description
abstract rx.Completable deleteAsync(String resourceGroupName, String serviceName, String groupId, String ifMatch)

Deletes specific group of the API Management service instance.
abstract rx.Observable<GroupContract> getAsync(String resourceGroupName, String serviceName, String groupId)

Gets the details of the group specified by its identifier.
abstract rx.Completable getEntityTagAsync(String resourceGroupName, String serviceName, String groupId)

Gets the entity state (Etag) version of the group specified by its identifier.
abstract rx.Observable<GroupContract> listByServiceAsync(String resourceGroupName, String serviceName)

Lists a collection of groups defined within a service instance.

Method Details

deleteAsync

public abstract Completable deleteAsync(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.

Returns:

the observable for the request

getAsync

public abstract Observable<GroupContract> getAsync(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 observable for the request

getEntityTagAsync

public abstract Completable getEntityTagAsync(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.

Returns:

the observable for the request

listByServiceAsync

public abstract Observable<GroupContract> listByServiceAsync(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:

the observable for the request

Applies to