Users Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

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

public interface Users

Resource collection API of Users.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new UserContract resource.
abstract void	delete(String resourceGroupName, String serviceName, String userId, String ifMatch) Deletes specific user.
abstract void	deleteById(String id) Deletes specific user.
abstract Response<Void>	deleteByIdWithResponse(String id, String ifMatch, Boolean deleteSubscriptions, Boolean notify, AppType appType, Context context) Deletes specific user.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String userId, String ifMatch, Boolean deleteSubscriptions, Boolean notify, AppType appType, Context context) Deletes specific user.
abstract GenerateSsoUrlResult	generateSsoUrl(String resourceGroupName, String serviceName, String userId) Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.
abstract Response<GenerateSsoUrlResult>	generateSsoUrlWithResponse(String resourceGroupName, String serviceName, String userId, Context context) Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.
abstract UserContract	get(String resourceGroupName, String serviceName, String userId) Gets the details of the user specified by its identifier.
abstract UserContract	getById(String id) Gets the details of the user specified by its identifier.
abstract Response<UserContract>	getByIdWithResponse(String id, Context context) Gets the details of the user specified by its identifier.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String userId) Gets the entity state (Etag) version of the user specified by its identifier.
abstract UsersGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String userId, Context context) Gets the entity state (Etag) version of the user specified by its identifier.
abstract UserTokenResult	getSharedAccessToken(String resourceGroupName, String serviceName, String userId, UserTokenParameters parameters) Gets the Shared Access Authorization Token for the User.
abstract Response<UserTokenResult>	getSharedAccessTokenWithResponse(String resourceGroupName, String serviceName, String userId, UserTokenParameters parameters, Context context) Gets the Shared Access Authorization Token for the User.
abstract Response<UserContract>	getWithResponse(String resourceGroupName, String serviceName, String userId, Context context) Gets the details of the user specified by its identifier.
abstract PagedIterable<UserContract>	listByService(String resourceGroupName, String serviceName) Lists a collection of registered users in the specified service instance.
abstract PagedIterable<UserContract>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Boolean expandGroups, Context context) Lists a collection of registered users in the specified service instance.

Method Details

define

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

Begins definition for a new UserContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new UserContract definition.

delete

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

Deletes specific user.

Parameters:

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

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.

deleteById

public abstract void deleteById(String id)

Deletes specific user.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, String ifMatch, Boolean deleteSubscriptions, Boolean notify, AppType appType, Context context)

Deletes specific user.

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.

deleteSubscriptions - Whether to delete user's subscription or not.

notify - Send an Account Closed Email notification to the User.

appType - Determines the type of application which send the create user request. Default is legacy publisher portal.

context - The context to associate with this operation.

Returns:

the Response<T>.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String serviceName, String userId, String ifMatch, Boolean deleteSubscriptions, Boolean notify, AppType appType, Context context)

Deletes specific user.

Parameters:

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

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.

deleteSubscriptions - Whether to delete user's subscription or not.

notify - Send an Account Closed Email notification to the User.

appType - Determines the type of application which send the create user request. Default is legacy publisher portal.

context - The context to associate with this operation.

Returns:

the Response<T>.

generateSsoUrl

public abstract GenerateSsoUrlResult generateSsoUrl(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. The name is case insensitive.

serviceName - The name of the API Management service.

userId - User identifier. Must be unique in the current API Management service instance.

Returns:

generate SSO Url operations response details.

generateSsoUrlWithResponse

public abstract Response generateSsoUrlWithResponse(String resourceGroupName, String serviceName, String userId, Context context)

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. The name is case insensitive.

serviceName - The name of the API Management service.

userId - User identifier. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

generate SSO Url operations response details along with Response<T>.

get

public abstract UserContract get(String resourceGroupName, String serviceName, String userId)

Gets the details of the user 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.

userId - User identifier. Must be unique in the current API Management service instance.

Returns:

the details of the user specified by its identifier.

getById

public abstract UserContract getById(String id)

Gets the details of the user specified by its identifier.

Parameters:

id - the resource ID.

Returns:

the details of the user specified by its identifier.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Gets the details of the user specified by its identifier.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the details of the user specified by its identifier.

getEntityTag

public abstract void getEntityTag(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. The name is case insensitive.

serviceName - The name of the API Management service.

userId - User identifier. Must be unique in the current API Management service instance.

getEntityTagWithResponse

public abstract UsersGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String userId, Context context)

Gets the entity state (Etag) version of the user 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.

userId - User 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 user specified by its identifier.

getSharedAccessToken

public abstract UserTokenResult getSharedAccessToken(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. The name is case insensitive.

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 Shared Access Authorization Token for the User.

getSharedAccessTokenWithResponse

public abstract Response getSharedAccessTokenWithResponse(String resourceGroupName, String serviceName, String userId, UserTokenParameters parameters, Context context)

Gets the Shared Access Authorization Token for the User.

Parameters:

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

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.

context - The context to associate with this operation.

Returns:

the Shared Access Authorization Token for the User along with Response<T>.

getWithResponse

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

Gets the details of the user 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.

userId - User identifier. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

the details of the user specified by its identifier.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName)

Lists a collection of registered users in the specified 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 Users list representation as paginated response with PagedIterable<T>.

listByService

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

Lists a collection of registered users in the specified 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>| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| state | filter | eq | |</br>| registrationDate | filter | ge, le, eq, ne, gt, lt | |</br>| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| groups | expand | | |</br>.

top - Number of records to return.

skip - Number of records to skip.

expandGroups - Detailed Group in response.

context - The context to associate with this operation.

Returns:

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