Package com.azure.resourcemanager.apimanagement.models

Interface Products

  • public interface Products
    Resource collection API of Products.

    • Method Detail

      • listByService

        com.azure.core.http.rest.PagedIterable<ProductContract> listByService​(String resourceGroupName,
                                                                      String serviceName)
        Lists a collection of products in the specified service instance.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        Returns:
        paged Products 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<ProductContract> listByService​(String resourceGroupName,
                                                                      String serviceName,
                                                                      String filter,
                                                                      Integer top,
                                                                      Integer skip,
                                                                      Boolean expandGroups,
                                                                      String tags,
                                                                      com.azure.core.util.Context context)
        Lists a collection of products 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>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| state | filter | eq | |</br>| groups | expand | | |</br>.
        top - Number of records to return.
        skip - Number of records to skip.
        expandGroups - When set to true, the response contains an array of groups that have visibility to the product. The default is false.
        tags - Products which are part of a specific tag.
        context - The context to associate with this operation.
        Returns:
        paged Products 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 productId)
        Gets the entity state (Etag) version of the product specified by its identifier.
        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.
        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

        ProductsGetEntityTagResponse getEntityTagWithResponse​(String resourceGroupName,
                                                      String serviceName,
                                                      String productId,
                                                      com.azure.core.util.Context context)
        Gets the entity state (Etag) version of the product specified by its identifier.
        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.
        context - The context to associate with this operation.
        Returns:
        the entity state (Etag) version of the product 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

        ProductContract get​(String resourceGroupName,
                    String serviceName,
                    String productId)
        Gets the details of the product specified by its identifier.
        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:
        the details of the product 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<ProductContract> getWithResponse​(String resourceGroupName,
                                                                   String serviceName,
                                                                   String productId,
                                                                   com.azure.core.util.Context context)
        Gets the details of the product specified by its identifier.
        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.
        context - The context to associate with this operation.
        Returns:
        the details of the product 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 productId,
            String ifMatch)
        Delete 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.
        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 productId,
                                                           String ifMatch,
                                                           Boolean deleteSubscriptions,
                                                           com.azure.core.util.Context context)
        Delete 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.
        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 - Delete existing subscriptions associated with the product or not.
        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.

      • listByTags

        com.azure.core.http.rest.PagedIterable<TagResourceContract> listByTags​(String resourceGroupName,
                                                                       String serviceName)
        Lists a collection of products associated with tags.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        Returns:
        paged Tag 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.

      • listByTags

        com.azure.core.http.rest.PagedIterable<TagResourceContract> listByTags​(String resourceGroupName,
                                                                       String serviceName,
                                                                       String filter,
                                                                       Integer top,
                                                                       Integer skip,
                                                                       Boolean includeNotTaggedProducts,
                                                                       com.azure.core.util.Context context)
        Lists a collection of products associated with tags.
        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>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| state | filter | eq | substringof, contains, startswith, endswith |</br>.
        top - Number of records to return.
        skip - Number of records to skip.
        includeNotTaggedProducts - Include not tagged Products.
        context - The context to associate with this operation.
        Returns:
        paged Tag 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.

      • getById

        ProductContract getById​(String id)
        Gets the details of the product specified by its identifier.
        Parameters:
        id - the resource ID.
        Returns:
        the details of the product 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<ProductContract> getByIdWithResponse​(String id,
                                                                       com.azure.core.util.Context context)
        Gets the details of the product specified by its identifier.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        the details of the product 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)
        Delete product.
        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,
                                                               com.azure.core.util.Context context)
        Delete product.
        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 - Delete existing subscriptions associated with the product or not.
        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

        ProductContract.DefinitionStages.Blank define​(String name)
        Begins definition for a new ProductContract resource.
        Parameters:
        name - resource name.
        Returns:
        the first stage of the new ProductContract definition.