Package com.azure.resourcemanager.apimanagement.fluent

Interface UserSubscriptionsClient

public interface UserSubscriptionsClient
An instance of this class provides access to all the operations defined in UserSubscriptionsClient.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<SubscriptionContractInner> list(String resourceGroupName, String serviceName, String userId)
      Lists the collection of subscriptions of the specified 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.
      Returns:
      paged Subscriptions 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.

    • list

      com.azure.core.http.rest.PagedIterable<SubscriptionContractInner> list(String resourceGroupName, String serviceName, String userId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)
      Lists the collection of subscriptions of the specified 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.
      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>|stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>|ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>|scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>|userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>|productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>.
      top - Number of records to return.
      skip - Number of records to skip.
      context - The context to associate with this operation.
      Returns:
      paged Subscriptions 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.

    • getWithResponse

      UserSubscriptionsGetResponse getWithResponse(String resourceGroupName, String serviceName, String userId, String sid, com.azure.core.util.Context context)
      Gets the specified Subscription entity associated with a particular 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.
      sid - Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
      context - The context to associate with this operation.
      Returns:
      the specified Subscription entity associated with a particular 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.

    • get

      SubscriptionContractInner get(String resourceGroupName, String serviceName, String userId, String sid)
      Gets the specified Subscription entity associated with a particular 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.
      sid - Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
      Returns:
      the specified Subscription entity associated with a particular 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.