Interface ProductSubscriptionsClient


  • public interface ProductSubscriptionsClient
    An instance of this class provides access to all the operations defined in ProductSubscriptionsClient.
    • Method Detail

      • list

        com.azure.core.http.rest.PagedIterable<SubscriptionContractInner> list​(String resourceGroupName,
                                                                               String serviceName,
                                                                               String productId)
        Lists the collection of subscriptions to the specified product.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        productId - Product 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 productId,
                                                                               String filter,
                                                                               Integer top,
                                                                               Integer skip,
                                                                               com.azure.core.util.Context context)
        Lists the collection of subscriptions to the specified product.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        productId - Product 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>| state | filter | eq | |</br>| user | expand | | |</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.