Package com.azure.resourcemanager.edgeorder.fluent

Interface ResourceProvidersClient

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

    • Method Detail

      • listOperations

        com.azure.core.http.rest.PagedIterable<OperationInner> listOperations()
        This method gets all the operations that are exposed for customer.
        Returns:
        a list of REST API operations supported by an Azure Resource Provider.
        Throws:
        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.

      • listOperations

        com.azure.core.http.rest.PagedIterable<OperationInner> listOperations​(com.azure.core.util.Context context)
        This method gets all the operations that are exposed for customer.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        a list of REST API operations supported by an Azure Resource Provider.
        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<AddressResourceInner> list()
        Lists all the addresses available under the subscription.
        Returns:
        address Resource Collection.
        Throws:
        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<AddressResourceInner> list​(String filter,
                                                                  String skipToken,
                                                                  com.azure.core.util.Context context)
        Lists all the addresses available under the subscription.
        Parameters:
        filter - $filter is supported to filter based on shipping address properties. Filter supports only equals operation.
        skipToken - $skipToken is supported on Get list of addresses, which provides the next page in the list of addresses.
        context - The context to associate with this operation.
        Returns:
        address Resource Collection.
        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.

      • listProductFamilies

        com.azure.core.http.rest.PagedIterable<ProductFamilyInner> listProductFamilies​(ProductFamiliesRequest productFamiliesRequest)
        This method provides the list of product families for the given subscription.
        Parameters:
        productFamiliesRequest - Filters for showing the product families.
        Returns:
        the list of product families.
        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.

      • listProductFamilies

        com.azure.core.http.rest.PagedIterable<ProductFamilyInner> listProductFamilies​(ProductFamiliesRequest productFamiliesRequest,
                                                                               String expand,
                                                                               String skipToken,
                                                                               com.azure.core.util.Context context)
        This method provides the list of product families for the given subscription.
        Parameters:
        productFamiliesRequest - Filters for showing the product families.
        expand - $expand is supported on configurations parameter for product, which provides details on the configurations for the product.
        skipToken - $skipToken is supported on list of product families, which provides the next page in the list of product families.
        context - The context to associate with this operation.
        Returns:
        the list of product families.
        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.

      • listConfigurations

        com.azure.core.http.rest.PagedIterable<ConfigurationInner> listConfigurations​(ConfigurationsRequest configurationsRequest)
        This method provides the list of configurations for the given product family, product line and product under subscription.
        Parameters:
        configurationsRequest - Filters for showing the configurations.
        Returns:
        the list of configurations.
        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.

      • listConfigurations

        com.azure.core.http.rest.PagedIterable<ConfigurationInner> listConfigurations​(ConfigurationsRequest configurationsRequest,
                                                                              String skipToken,
                                                                              com.azure.core.util.Context context)
        This method provides the list of configurations for the given product family, product line and product under subscription.
        Parameters:
        configurationsRequest - Filters for showing the configurations.
        skipToken - $skipToken is supported on list of configurations, which provides the next page in the list of configurations.
        context - The context to associate with this operation.
        Returns:
        the list of configurations.
        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.

      • listProductFamiliesMetadata

        com.azure.core.http.rest.PagedIterable<ProductFamiliesMetadataDetailsInner> listProductFamiliesMetadata()
        This method provides the list of product families metadata for the given subscription.
        Returns:
        holds details about product family metadata.
        Throws:
        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.

      • listProductFamiliesMetadata

        com.azure.core.http.rest.PagedIterable<ProductFamiliesMetadataDetailsInner> listProductFamiliesMetadata​(String skipToken,
                                                                                                        com.azure.core.util.Context context)
        This method provides the list of product families metadata for the given subscription.
        Parameters:
        skipToken - $skipToken is supported on list of product families metadata, which provides the next page in the list of product families metadata.
        context - The context to associate with this operation.
        Returns:
        holds details about product family metadata.
        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.

      • listOrderAtSubscriptionLevel

        com.azure.core.http.rest.PagedIterable<OrderResourceInner> listOrderAtSubscriptionLevel()
        Lists order at subscription level.
        Returns:
        list of orders.
        Throws:
        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.

      • listOrderAtSubscriptionLevel

        com.azure.core.http.rest.PagedIterable<OrderResourceInner> listOrderAtSubscriptionLevel​(String skipToken,
                                                                                        com.azure.core.util.Context context)
        Lists order at subscription level.
        Parameters:
        skipToken - $skipToken is supported on Get list of order, which provides the next page in the list of order.
        context - The context to associate with this operation.
        Returns:
        list of orders.
        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.

      • listOrderItemsAtSubscriptionLevel

        com.azure.core.http.rest.PagedIterable<OrderItemResourceInner> listOrderItemsAtSubscriptionLevel()
        Lists order item at subscription level.
        Returns:
        list of orderItems.
        Throws:
        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.

      • listOrderItemsAtSubscriptionLevel

        com.azure.core.http.rest.PagedIterable<OrderItemResourceInner> listOrderItemsAtSubscriptionLevel​(String filter,
                                                                                                 String expand,
                                                                                                 String skipToken,
                                                                                                 com.azure.core.util.Context context)
        Lists order item at subscription level.
        Parameters:
        filter - $filter is supported to filter based on order id. Filter supports only equals operation.
        expand - $expand is supported on device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.
        skipToken - $skipToken is supported on Get list of order items, which provides the next page in the list of order items.
        context - The context to associate with this operation.
        Returns:
        list of orderItems.
        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.

      • listByResourceGroup

        com.azure.core.http.rest.PagedIterable<AddressResourceInner> listByResourceGroup​(String resourceGroupName)
        Lists all the addresses available under the given resource group.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        Returns:
        address Resource Collection.
        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.

      • listByResourceGroup

        com.azure.core.http.rest.PagedIterable<AddressResourceInner> listByResourceGroup​(String resourceGroupName,
                                                                                 String filter,
                                                                                 String skipToken,
                                                                                 com.azure.core.util.Context context)
        Lists all the addresses available under the given resource group.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        filter - $filter is supported to filter based on shipping address properties. Filter supports only equals operation.
        skipToken - $skipToken is supported on Get list of addresses, which provides the next page in the list of address.
        context - The context to associate with this operation.
        Returns:
        address Resource Collection.
        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.

      • getByResourceGroup

        AddressResourceInner getByResourceGroup​(String resourceGroupName,
                                        String addressName)
        Gets information about the specified address.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        addressName - The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.
        Returns:
        information about the specified address.
        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.

      • getByResourceGroupWithResponse

        com.azure.core.http.rest.Response<AddressResourceInner> getByResourceGroupWithResponse​(String resourceGroupName,
                                                                                       String addressName,
                                                                                       com.azure.core.util.Context context)
        Gets information about the specified address.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        addressName - The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.
        context - The context to associate with this operation.
        Returns:
        information about the specified address.
        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.

      • beginCreateAddress

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<AddressResourceInner>,​AddressResourceInner> beginCreateAddress​(String addressName,
                                                                                                                                                         String resourceGroupName,
                                                                                                                                                         AddressResourceInner addressResource)
        Creates a new address with the specified parameters. Existing address can be updated with this API.
        Parameters:
        addressName - The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        addressResource - Address details from request body.
        Returns:
        address Resource.
        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.

      • beginCreateAddress

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<AddressResourceInner>,​AddressResourceInner> beginCreateAddress​(String addressName,
                                                                                                                                                         String resourceGroupName,
                                                                                                                                                         AddressResourceInner addressResource,
                                                                                                                                                         com.azure.core.util.Context context)
        Creates a new address with the specified parameters. Existing address can be updated with this API.
        Parameters:
        addressName - The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        addressResource - Address details from request body.
        context - The context to associate with this operation.
        Returns:
        address Resource.
        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.

      • createAddress

        AddressResourceInner createAddress​(String addressName,
                                   String resourceGroupName,
                                   AddressResourceInner addressResource)
        Creates a new address with the specified parameters. Existing address can be updated with this API.
        Parameters:
        addressName - The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        addressResource - Address details from request body.
        Returns:
        address Resource.
        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.

      • createAddress

        AddressResourceInner createAddress​(String addressName,
                                   String resourceGroupName,
                                   AddressResourceInner addressResource,
                                   com.azure.core.util.Context context)
        Creates a new address with the specified parameters. Existing address can be updated with this API.
        Parameters:
        addressName - The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        addressResource - Address details from request body.
        context - The context to associate with this operation.
        Returns:
        address Resource.
        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.

      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                  String addressName)
        Deletes an address.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        addressName - The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.
        Returns:
        the completion.
        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.

      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                  String addressName,
                                                                                                                  com.azure.core.util.Context context)
        Deletes an address.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        addressName - The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.
        context - The context to associate with this operation.
        Returns:
        the completion.
        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 addressName)
        Deletes an address.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        addressName - The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.
        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 addressName,
            com.azure.core.util.Context context)
        Deletes an address.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        addressName - The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.
        context - The context to associate with this operation.
        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.

      • beginUpdateAddress

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<AddressResourceInner>,​AddressResourceInner> beginUpdateAddress​(String addressName,
                                                                                                                                                         String resourceGroupName,
                                                                                                                                                         AddressUpdateParameter addressUpdateParameter,
                                                                                                                                                         String ifMatch)
        Updates the properties of an existing address.
        Parameters:
        addressName - The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        addressUpdateParameter - Address update parameters from request body.
        ifMatch - Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.
        Returns:
        address Resource.
        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.

      • beginUpdateAddress

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<AddressResourceInner>,​AddressResourceInner> beginUpdateAddress​(String addressName,
                                                                                                                                                         String resourceGroupName,
                                                                                                                                                         AddressUpdateParameter addressUpdateParameter,
                                                                                                                                                         String ifMatch,
                                                                                                                                                         com.azure.core.util.Context context)
        Updates the properties of an existing address.
        Parameters:
        addressName - The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        addressUpdateParameter - Address update parameters from request body.
        ifMatch - Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.
        context - The context to associate with this operation.
        Returns:
        address Resource.
        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.

      • updateAddress

        AddressResourceInner updateAddress​(String addressName,
                                   String resourceGroupName,
                                   AddressUpdateParameter addressUpdateParameter,
                                   String ifMatch)
        Updates the properties of an existing address.
        Parameters:
        addressName - The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        addressUpdateParameter - Address update parameters from request body.
        ifMatch - Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.
        Returns:
        address Resource.
        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.

      • updateAddress

        AddressResourceInner updateAddress​(String addressName,
                                   String resourceGroupName,
                                   AddressUpdateParameter addressUpdateParameter)
        Updates the properties of an existing address.
        Parameters:
        addressName - The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        addressUpdateParameter - Address update parameters from request body.
        Returns:
        address Resource.
        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.

      • updateAddress

        AddressResourceInner updateAddress​(String addressName,
                                   String resourceGroupName,
                                   AddressUpdateParameter addressUpdateParameter,
                                   String ifMatch,
                                   com.azure.core.util.Context context)
        Updates the properties of an existing address.
        Parameters:
        addressName - The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        addressUpdateParameter - Address update parameters from request body.
        ifMatch - Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.
        context - The context to associate with this operation.
        Returns:
        address Resource.
        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.

      • listOrderAtResourceGroupLevel

        com.azure.core.http.rest.PagedIterable<OrderResourceInner> listOrderAtResourceGroupLevel​(String resourceGroupName)
        Lists order at resource group level.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        Returns:
        list of orders.
        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.

      • listOrderAtResourceGroupLevel

        com.azure.core.http.rest.PagedIterable<OrderResourceInner> listOrderAtResourceGroupLevel​(String resourceGroupName,
                                                                                         String skipToken,
                                                                                         com.azure.core.util.Context context)
        Lists order at resource group level.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        skipToken - $skipToken is supported on Get list of order, which provides the next page in the list of order.
        context - The context to associate with this operation.
        Returns:
        list of orders.
        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.

      • getOrderByName

        OrderResourceInner getOrderByName​(String orderName,
                                  String resourceGroupName,
                                  String location)
        Gets an order.
        Parameters:
        orderName - The name of the order.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        location - The name of Azure region.
        Returns:
        an order.
        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.

      • getOrderByNameWithResponse

        com.azure.core.http.rest.Response<OrderResourceInner> getOrderByNameWithResponse​(String orderName,
                                                                                 String resourceGroupName,
                                                                                 String location,
                                                                                 com.azure.core.util.Context context)
        Gets an order.
        Parameters:
        orderName - The name of the order.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        location - The name of Azure region.
        context - The context to associate with this operation.
        Returns:
        an order.
        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.

      • listOrderItemsAtResourceGroupLevel

        com.azure.core.http.rest.PagedIterable<OrderItemResourceInner> listOrderItemsAtResourceGroupLevel​(String resourceGroupName)
        Lists order item at resource group level.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        Returns:
        list of orderItems.
        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.

      • listOrderItemsAtResourceGroupLevel

        com.azure.core.http.rest.PagedIterable<OrderItemResourceInner> listOrderItemsAtResourceGroupLevel​(String resourceGroupName,
                                                                                                  String filter,
                                                                                                  String expand,
                                                                                                  String skipToken,
                                                                                                  com.azure.core.util.Context context)
        Lists order item at resource group level.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        filter - $filter is supported to filter based on order id. Filter supports only equals operation.
        expand - $expand is supported on device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.
        skipToken - $skipToken is supported on Get list of order items, which provides the next page in the list of order items.
        context - The context to associate with this operation.
        Returns:
        list of orderItems.
        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.

      • getOrderItemByName

        OrderItemResourceInner getOrderItemByName​(String orderItemName,
                                          String resourceGroupName)
        Gets an order item.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        Returns:
        an order item.
        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.

      • getOrderItemByNameWithResponse

        com.azure.core.http.rest.Response<OrderItemResourceInner> getOrderItemByNameWithResponse​(String orderItemName,
                                                                                         String resourceGroupName,
                                                                                         String expand,
                                                                                         com.azure.core.util.Context context)
        Gets an order item.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        expand - $expand is supported on device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.
        context - The context to associate with this operation.
        Returns:
        an order item.
        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.

      • beginCreateOrderItem

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<OrderItemResourceInner>,​OrderItemResourceInner> beginCreateOrderItem​(String orderItemName,
                                                                                                                                                               String resourceGroupName,
                                                                                                                                                               OrderItemResourceInner orderItemResource)
        Creates an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item API.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        orderItemResource - Order item details from request body.
        Returns:
        represents order item contract.
        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.

      • beginCreateOrderItem

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<OrderItemResourceInner>,​OrderItemResourceInner> beginCreateOrderItem​(String orderItemName,
                                                                                                                                                               String resourceGroupName,
                                                                                                                                                               OrderItemResourceInner orderItemResource,
                                                                                                                                                               com.azure.core.util.Context context)
        Creates an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item API.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        orderItemResource - Order item details from request body.
        context - The context to associate with this operation.
        Returns:
        represents order item contract.
        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.

      • createOrderItem

        OrderItemResourceInner createOrderItem​(String orderItemName,
                                       String resourceGroupName,
                                       OrderItemResourceInner orderItemResource)
        Creates an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item API.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        orderItemResource - Order item details from request body.
        Returns:
        represents order item contract.
        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.

      • createOrderItem

        OrderItemResourceInner createOrderItem​(String orderItemName,
                                       String resourceGroupName,
                                       OrderItemResourceInner orderItemResource,
                                       com.azure.core.util.Context context)
        Creates an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item API.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        orderItemResource - Order item details from request body.
        context - The context to associate with this operation.
        Returns:
        represents order item contract.
        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.

      • beginDeleteOrderItemByName

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDeleteOrderItemByName​(String orderItemName,
                                                                                                                                 String resourceGroupName)
        Deletes an order item.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        Returns:
        the completion.
        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.

      • beginDeleteOrderItemByName

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDeleteOrderItemByName​(String orderItemName,
                                                                                                                                 String resourceGroupName,
                                                                                                                                 com.azure.core.util.Context context)
        Deletes an order item.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        context - The context to associate with this operation.
        Returns:
        the completion.
        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.

      • deleteOrderItemByName

        void deleteOrderItemByName​(String orderItemName,
                           String resourceGroupName)
        Deletes an order item.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        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.

      • deleteOrderItemByName

        void deleteOrderItemByName​(String orderItemName,
                           String resourceGroupName,
                           com.azure.core.util.Context context)
        Deletes an order item.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        context - The context to associate with this operation.
        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.

      • beginUpdateOrderItem

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<OrderItemResourceInner>,​OrderItemResourceInner> beginUpdateOrderItem​(String orderItemName,
                                                                                                                                                               String resourceGroupName,
                                                                                                                                                               OrderItemUpdateParameter orderItemUpdateParameter,
                                                                                                                                                               String ifMatch)
        Updates the properties of an existing order item.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        orderItemUpdateParameter - order item update parameters from request body.
        ifMatch - Defines the If-Match condition. The patch will be performed only if the ETag of the order on the server matches this value.
        Returns:
        represents order item contract.
        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.

      • beginUpdateOrderItem

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<OrderItemResourceInner>,​OrderItemResourceInner> beginUpdateOrderItem​(String orderItemName,
                                                                                                                                                               String resourceGroupName,
                                                                                                                                                               OrderItemUpdateParameter orderItemUpdateParameter,
                                                                                                                                                               String ifMatch,
                                                                                                                                                               com.azure.core.util.Context context)
        Updates the properties of an existing order item.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        orderItemUpdateParameter - order item update parameters from request body.
        ifMatch - Defines the If-Match condition. The patch will be performed only if the ETag of the order on the server matches this value.
        context - The context to associate with this operation.
        Returns:
        represents order item contract.
        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.

      • updateOrderItem

        OrderItemResourceInner updateOrderItem​(String orderItemName,
                                       String resourceGroupName,
                                       OrderItemUpdateParameter orderItemUpdateParameter,
                                       String ifMatch)
        Updates the properties of an existing order item.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        orderItemUpdateParameter - order item update parameters from request body.
        ifMatch - Defines the If-Match condition. The patch will be performed only if the ETag of the order on the server matches this value.
        Returns:
        represents order item contract.
        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.

      • updateOrderItem

        OrderItemResourceInner updateOrderItem​(String orderItemName,
                                       String resourceGroupName,
                                       OrderItemUpdateParameter orderItemUpdateParameter)
        Updates the properties of an existing order item.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        orderItemUpdateParameter - order item update parameters from request body.
        Returns:
        represents order item contract.
        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.

      • updateOrderItem

        OrderItemResourceInner updateOrderItem​(String orderItemName,
                                       String resourceGroupName,
                                       OrderItemUpdateParameter orderItemUpdateParameter,
                                       String ifMatch,
                                       com.azure.core.util.Context context)
        Updates the properties of an existing order item.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        orderItemUpdateParameter - order item update parameters from request body.
        ifMatch - Defines the If-Match condition. The patch will be performed only if the ETag of the order on the server matches this value.
        context - The context to associate with this operation.
        Returns:
        represents order item contract.
        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.

      • cancelOrderItem

        void cancelOrderItem​(String orderItemName,
                     String resourceGroupName,
                     CancellationReason cancellationReason)
        Cancel order item.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        cancellationReason - Reason for cancellation.
        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.

      • cancelOrderItemWithResponse

        com.azure.core.http.rest.Response<Void> cancelOrderItemWithResponse​(String orderItemName,
                                                                    String resourceGroupName,
                                                                    CancellationReason cancellationReason,
                                                                    com.azure.core.util.Context context)
        Cancel order item.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        cancellationReason - Reason for cancellation.
        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.

      • beginReturnOrderItem

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginReturnOrderItem​(String orderItemName,
                                                                                                                           String resourceGroupName,
                                                                                                                           ReturnOrderItemDetails returnOrderItemDetails)
        Return order item.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        returnOrderItemDetails - Return order item CurrentStatus.
        Returns:
        the completion.
        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.

      • beginReturnOrderItem

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginReturnOrderItem​(String orderItemName,
                                                                                                                           String resourceGroupName,
                                                                                                                           ReturnOrderItemDetails returnOrderItemDetails,
                                                                                                                           com.azure.core.util.Context context)
        Return order item.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        returnOrderItemDetails - Return order item CurrentStatus.
        context - The context to associate with this operation.
        Returns:
        the completion.
        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.

      • returnOrderItem

        void returnOrderItem​(String orderItemName,
                     String resourceGroupName,
                     ReturnOrderItemDetails returnOrderItemDetails)
        Return order item.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        returnOrderItemDetails - Return order item CurrentStatus.
        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.

      • returnOrderItem

        void returnOrderItem​(String orderItemName,
                     String resourceGroupName,
                     ReturnOrderItemDetails returnOrderItemDetails,
                     com.azure.core.util.Context context)
        Return order item.
        Parameters:
        orderItemName - The name of the order item.
        resourceGroupName - The name of the resource group. The name is case insensitive.
        returnOrderItemDetails - Return order item CurrentStatus.
        context - The context to associate with this operation.
        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.