Share via

Users 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.UsersInner>

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

Type representing Users.

Method Summary

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

Deletes specific user.
abstract rx.Observable<GenerateSsoUrlResult> generateSsoUrlAsync(String resourceGroupName, String serviceName, String userId)

Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.
abstract rx.Observable<GroupUserContract> getAsync(String resourceGroupName, String serviceName, String userId)

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

Gets the entity state (Etag) version of the user specified by its identifier.
abstract rx.Observable<UserTokenResult> getSharedAccessTokenAsync(String resourceGroupName, String serviceName, String userId, UserTokenParameters parameters)

Gets the Shared Access Authorization Token for the User.
abstract rx.Observable<GroupUserContract> listByServiceAsync(String resourceGroupName, String serviceName)

Lists a collection of registered users in the specified service instance.

Method Details

deleteAsync

public abstract Completable deleteAsync(String resourceGroupName, String serviceName, String userId, String ifMatch)

Deletes specific user.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
userId - User 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

generateSsoUrlAsync

public abstract Observable<GenerateSsoUrlResult> generateSsoUrlAsync(String resourceGroupName, String serviceName, String userId)

Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
userId - User identifier. Must be unique in the current API Management service instance.

Returns:

the observable for the request

getAsync

public abstract Observable<GroupUserContract> getAsync(String resourceGroupName, String serviceName, String userId)

Gets the details of the user specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
userId - User 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 userId)

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

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
userId - User identifier. Must be unique in the current API Management service instance.

Returns:

the observable for the request

getSharedAccessTokenAsync

public abstract Observable<UserTokenResult> getSharedAccessTokenAsync(String resourceGroupName, String serviceName, String userId, UserTokenParameters parameters)

Gets the Shared Access Authorization Token for the User.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
userId - User identifier. Must be unique in the current API Management service instance.
parameters - Create Authorization Token parameters.

Returns:

the observable for the request

listByServiceAsync

public abstract Observable<GroupUserContract> listByServiceAsync(String resourceGroupName, String serviceName)

Lists a collection of registered users in the specified 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