Package com.azure.resourcemanager.apimanagement.models

Interface Users

  • public interface Users
    Resource collection API of Users.

    • Method Detail

      • listByService

        com.azure.core.http.rest.PagedIterable<UserContract> listByService​(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:
        paged Users 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<UserContract> listByService​(String resourceGroupName,
                                                                   String serviceName,
                                                                   String filter,
                                                                   Integer top,
                                                                   Integer skip,
                                                                   Boolean expandGroups,
                                                                   com.azure.core.util.Context context)
        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.
        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.
        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 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.
        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

        UsersGetEntityTagResponse getEntityTagWithResponse​(String resourceGroupName,
                                                   String serviceName,
                                                   String userId,
                                                   com.azure.core.util.Context context)
        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.
        context - The context to associate with this operation.
        Returns:
        the entity state (Etag) version of the user 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

        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.
        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.
        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<UserContract> getWithResponse​(String resourceGroupName,
                                                                String serviceName,
                                                                String userId,
                                                                com.azure.core.util.Context context)
        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.
        context - The context to associate with this operation.
        Returns:
        the details of the user 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 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.
        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 userId,
                                                           String ifMatch,
                                                           Boolean deleteSubscriptions,
                                                           Boolean notify,
                                                           AppType appType,
                                                           com.azure.core.util.Context context)
        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.
        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.
        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.

      • generateSsoUrl

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

      • generateSsoUrlWithResponse

        com.azure.core.http.rest.Response<GenerateSsoUrlResult> generateSsoUrlWithResponse​(String resourceGroupName,
                                                                                   String serviceName,
                                                                                   String userId,
                                                                                   com.azure.core.util.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.
        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.
        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.

      • getSharedAccessToken

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

      • getSharedAccessTokenWithResponse

        com.azure.core.http.rest.Response<UserTokenResult> getSharedAccessTokenWithResponse​(String resourceGroupName,
                                                                                    String serviceName,
                                                                                    String userId,
                                                                                    UserTokenParameters parameters,
                                                                                    com.azure.core.util.Context context)
        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.
        context - The context to associate with this operation.
        Returns:
        the Shared Access Authorization Token for the User along with 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

        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.
        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<UserContract> getByIdWithResponse​(String id,
                                                                    com.azure.core.util.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.
        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 user.
        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,
                                                               Boolean deleteSubscriptions,
                                                               Boolean notify,
                                                               AppType appType,
                                                               com.azure.core.util.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.
        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

        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.