Interface AppServicePlansClient

    • Method Detail

      • listAsync

        com.azure.core.http.rest.PagedFlux<AppServicePlanInner> listAsync​(Boolean detailed)
        Description for Get all App Service plans for a subscription.
        Parameters:
        detailed - Specify <code>true</code> to return all App Service plan properties. The default is <code>false</code>, which returns a subset of the properties. Retrieval of all properties may increase the API latency.
        Returns:
        collection of App Service plans.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - 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<AppServicePlanInner> list​(Boolean detailed,
                                                                         com.azure.core.util.Context context)
        Description for Get all App Service plans for a subscription.
        Parameters:
        detailed - Specify <code>true</code> to return all App Service plan properties. The default is <code>false</code>, which returns a subset of the properties. Retrieval of all properties may increase the API latency.
        context - The context to associate with this operation.
        Returns:
        collection of App Service plans.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - 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<AppServicePlanInner> listByResourceGroup​(String resourceGroupName,
                                                                                        com.azure.core.util.Context context)
        Description for Get all App Service plans in a resource group.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        context - The context to associate with this operation.
        Returns:
        collection of App Service plans.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getByResourceGroupWithResponseAsync

        Mono<com.azure.core.http.rest.Response<AppServicePlanInner>> getByResourceGroupWithResponseAsync​(String resourceGroupName,
                                                                                                         String name)
        Description for Get an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        app Service plan.
        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.
      • getByResourceGroupAsync

        Mono<AppServicePlanInner> getByResourceGroupAsync​(String resourceGroupName,
                                                          String name)
        Description for Get an App Service plan.
        Specified by:
        getByResourceGroupAsync in interface InnerSupportsGet<AppServicePlanInner>
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        app Service plan.
        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

        AppServicePlanInner getByResourceGroup​(String resourceGroupName,
                                               String name)
        Description for Get an App Service plan.
        Specified by:
        getByResourceGroup in interface InnerSupportsGet<AppServicePlanInner>
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        app Service plan.
        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<AppServicePlanInner> getByResourceGroupWithResponse​(String resourceGroupName,
                                                                                              String name,
                                                                                              com.azure.core.util.Context context)
        Description for Get an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        context - The context to associate with this operation.
        Returns:
        app Service plan.
        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.
      • createOrUpdateWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> createOrUpdateWithResponseAsync​(String resourceGroupName,
                                                                                                  String name,
                                                                                                  AppServicePlanInner appServicePlan)
        Description for Creates or updates an App Service Plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        appServicePlan - Details of the App Service plan.
        Returns:
        app Service plan.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • beginCreateOrUpdateAsync

        com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<AppServicePlanInner>,​AppServicePlanInner> beginCreateOrUpdateAsync​(String resourceGroupName,
                                                                                                                                                                     String name,
                                                                                                                                                                     AppServicePlanInner appServicePlan)
        Description for Creates or updates an App Service Plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        appServicePlan - Details of the App Service plan.
        Returns:
        app Service plan.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<AppServicePlanInner>,​AppServicePlanInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                                String name,
                                                                                                                                                                AppServicePlanInner appServicePlan)
        Description for Creates or updates an App Service Plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        appServicePlan - Details of the App Service plan.
        Returns:
        app Service plan.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<AppServicePlanInner>,​AppServicePlanInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                                String name,
                                                                                                                                                                AppServicePlanInner appServicePlan,
                                                                                                                                                                com.azure.core.util.Context context)
        Description for Creates or updates an App Service Plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        appServicePlan - Details of the App Service plan.
        context - The context to associate with this operation.
        Returns:
        app Service plan.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createOrUpdateAsync

        Mono<AppServicePlanInner> createOrUpdateAsync​(String resourceGroupName,
                                                      String name,
                                                      AppServicePlanInner appServicePlan)
        Description for Creates or updates an App Service Plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        appServicePlan - Details of the App Service plan.
        Returns:
        app Service plan.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createOrUpdate

        AppServicePlanInner createOrUpdate​(String resourceGroupName,
                                           String name,
                                           AppServicePlanInner appServicePlan)
        Description for Creates or updates an App Service Plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        appServicePlan - Details of the App Service plan.
        Returns:
        app Service plan.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • createOrUpdate

        AppServicePlanInner createOrUpdate​(String resourceGroupName,
                                           String name,
                                           AppServicePlanInner appServicePlan,
                                           com.azure.core.util.Context context)
        Description for Creates or updates an App Service Plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        appServicePlan - Details of the App Service plan.
        context - The context to associate with this operation.
        Returns:
        app Service plan.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Void>> deleteWithResponseAsync​(String resourceGroupName,
                                                                              String name)
        Description for Delete an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        the completion.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - 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 name)
        Description for Delete an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - 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 name,
                                                                   com.azure.core.util.Context context)
        Description for Delete an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        context - The context to associate with this operation.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateWithResponseAsync

        Mono<com.azure.core.http.rest.Response<AppServicePlanInner>> updateWithResponseAsync​(String resourceGroupName,
                                                                                             String name,
                                                                                             AppServicePlanPatchResource appServicePlan)
        Description for Creates or updates an App Service Plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        appServicePlan - Details of the App Service plan.
        Returns:
        app Service plan.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateWithResponse

        com.azure.core.http.rest.Response<AppServicePlanInner> updateWithResponse​(String resourceGroupName,
                                                                                  String name,
                                                                                  AppServicePlanPatchResource appServicePlan,
                                                                                  com.azure.core.util.Context context)
        Description for Creates or updates an App Service Plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        appServicePlan - Details of the App Service plan.
        context - The context to associate with this operation.
        Returns:
        app Service plan.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listCapabilitiesWithResponseAsync

        Mono<com.azure.core.http.rest.Response<List<CapabilityInner>>> listCapabilitiesWithResponseAsync​(String resourceGroupName,
                                                                                                         String name)
        Description for List all capabilities of an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        array of Capability.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listCapabilitiesAsync

        Mono<List<CapabilityInner>> listCapabilitiesAsync​(String resourceGroupName,
                                                          String name)
        Description for List all capabilities of an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        array of Capability.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listCapabilities

        List<CapabilityInner> listCapabilities​(String resourceGroupName,
                                               String name)
        Description for List all capabilities of an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        array of Capability.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listCapabilitiesWithResponse

        com.azure.core.http.rest.Response<List<CapabilityInner>> listCapabilitiesWithResponse​(String resourceGroupName,
                                                                                              String name,
                                                                                              com.azure.core.util.Context context)
        Description for List all capabilities of an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        context - The context to associate with this operation.
        Returns:
        array of Capability.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getHybridConnectionWithResponseAsync

        Mono<com.azure.core.http.rest.Response<HybridConnectionInner>> getHybridConnectionWithResponseAsync​(String resourceGroupName,
                                                                                                            String name,
                                                                                                            String namespaceName,
                                                                                                            String relayName)
        Description for Retrieve a Hybrid Connection in use in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        namespaceName - Name of the Service Bus namespace.
        relayName - Name of the Service Bus relay.
        Returns:
        hybrid Connection contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getHybridConnectionAsync

        Mono<HybridConnectionInner> getHybridConnectionAsync​(String resourceGroupName,
                                                             String name,
                                                             String namespaceName,
                                                             String relayName)
        Description for Retrieve a Hybrid Connection in use in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        namespaceName - Name of the Service Bus namespace.
        relayName - Name of the Service Bus relay.
        Returns:
        hybrid Connection contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getHybridConnection

        HybridConnectionInner getHybridConnection​(String resourceGroupName,
                                                  String name,
                                                  String namespaceName,
                                                  String relayName)
        Description for Retrieve a Hybrid Connection in use in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        namespaceName - Name of the Service Bus namespace.
        relayName - Name of the Service Bus relay.
        Returns:
        hybrid Connection contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getHybridConnectionWithResponse

        com.azure.core.http.rest.Response<HybridConnectionInner> getHybridConnectionWithResponse​(String resourceGroupName,
                                                                                                 String name,
                                                                                                 String namespaceName,
                                                                                                 String relayName,
                                                                                                 com.azure.core.util.Context context)
        Description for Retrieve a Hybrid Connection in use in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        namespaceName - Name of the Service Bus namespace.
        relayName - Name of the Service Bus relay.
        context - The context to associate with this operation.
        Returns:
        hybrid Connection contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteHybridConnectionWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Void>> deleteHybridConnectionWithResponseAsync​(String resourceGroupName,
                                                                                              String name,
                                                                                              String namespaceName,
                                                                                              String relayName)
        Description for Delete a Hybrid Connection in use in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        namespaceName - Name of the Service Bus namespace.
        relayName - Name of the Service Bus relay.
        Returns:
        the completion.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteHybridConnectionAsync

        Mono<Void> deleteHybridConnectionAsync​(String resourceGroupName,
                                               String name,
                                               String namespaceName,
                                               String relayName)
        Description for Delete a Hybrid Connection in use in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        namespaceName - Name of the Service Bus namespace.
        relayName - Name of the Service Bus relay.
        Returns:
        the completion.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteHybridConnection

        void deleteHybridConnection​(String resourceGroupName,
                                    String name,
                                    String namespaceName,
                                    String relayName)
        Description for Delete a Hybrid Connection in use in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        namespaceName - Name of the Service Bus namespace.
        relayName - Name of the Service Bus relay.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteHybridConnectionWithResponse

        com.azure.core.http.rest.Response<Void> deleteHybridConnectionWithResponse​(String resourceGroupName,
                                                                                   String name,
                                                                                   String namespaceName,
                                                                                   String relayName,
                                                                                   com.azure.core.util.Context context)
        Description for Delete a Hybrid Connection in use in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        namespaceName - Name of the Service Bus namespace.
        relayName - Name of the Service Bus relay.
        context - The context to associate with this operation.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listHybridConnectionKeysWithResponseAsync

        Mono<com.azure.core.http.rest.Response<HybridConnectionKeyInner>> listHybridConnectionKeysWithResponseAsync​(String resourceGroupName,
                                                                                                                    String name,
                                                                                                                    String namespaceName,
                                                                                                                    String relayName)
        Description for Get the send key name and value of a Hybrid Connection.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        namespaceName - The name of the Service Bus namespace.
        relayName - The name of the Service Bus relay.
        Returns:
        hybrid Connection key contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listHybridConnectionKeysAsync

        Mono<HybridConnectionKeyInner> listHybridConnectionKeysAsync​(String resourceGroupName,
                                                                     String name,
                                                                     String namespaceName,
                                                                     String relayName)
        Description for Get the send key name and value of a Hybrid Connection.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        namespaceName - The name of the Service Bus namespace.
        relayName - The name of the Service Bus relay.
        Returns:
        hybrid Connection key contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listHybridConnectionKeys

        HybridConnectionKeyInner listHybridConnectionKeys​(String resourceGroupName,
                                                          String name,
                                                          String namespaceName,
                                                          String relayName)
        Description for Get the send key name and value of a Hybrid Connection.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        namespaceName - The name of the Service Bus namespace.
        relayName - The name of the Service Bus relay.
        Returns:
        hybrid Connection key contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listHybridConnectionKeysWithResponse

        com.azure.core.http.rest.Response<HybridConnectionKeyInner> listHybridConnectionKeysWithResponse​(String resourceGroupName,
                                                                                                         String name,
                                                                                                         String namespaceName,
                                                                                                         String relayName,
                                                                                                         com.azure.core.util.Context context)
        Description for Get the send key name and value of a Hybrid Connection.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        namespaceName - The name of the Service Bus namespace.
        relayName - The name of the Service Bus relay.
        context - The context to associate with this operation.
        Returns:
        hybrid Connection key contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listWebAppsByHybridConnectionAsync

        com.azure.core.http.rest.PagedFlux<String> listWebAppsByHybridConnectionAsync​(String resourceGroupName,
                                                                                      String name,
                                                                                      String namespaceName,
                                                                                      String relayName)
        Description for Get all apps that use a Hybrid Connection in an App Service Plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        namespaceName - Name of the Hybrid Connection namespace.
        relayName - Name of the Hybrid Connection relay.
        Returns:
        collection of resources.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listWebAppsByHybridConnection

        com.azure.core.http.rest.PagedIterable<String> listWebAppsByHybridConnection​(String resourceGroupName,
                                                                                     String name,
                                                                                     String namespaceName,
                                                                                     String relayName)
        Description for Get all apps that use a Hybrid Connection in an App Service Plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        namespaceName - Name of the Hybrid Connection namespace.
        relayName - Name of the Hybrid Connection relay.
        Returns:
        collection of resources.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listWebAppsByHybridConnection

        com.azure.core.http.rest.PagedIterable<String> listWebAppsByHybridConnection​(String resourceGroupName,
                                                                                     String name,
                                                                                     String namespaceName,
                                                                                     String relayName,
                                                                                     com.azure.core.util.Context context)
        Description for Get all apps that use a Hybrid Connection in an App Service Plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        namespaceName - Name of the Hybrid Connection namespace.
        relayName - Name of the Hybrid Connection relay.
        context - The context to associate with this operation.
        Returns:
        collection of resources.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getHybridConnectionPlanLimitWithResponseAsync

        Mono<com.azure.core.http.rest.Response<HybridConnectionLimitsInner>> getHybridConnectionPlanLimitWithResponseAsync​(String resourceGroupName,
                                                                                                                           String name)
        Description for Get the maximum number of Hybrid Connections allowed in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        hybrid Connection limits contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getHybridConnectionPlanLimitAsync

        Mono<HybridConnectionLimitsInner> getHybridConnectionPlanLimitAsync​(String resourceGroupName,
                                                                            String name)
        Description for Get the maximum number of Hybrid Connections allowed in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        hybrid Connection limits contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getHybridConnectionPlanLimit

        HybridConnectionLimitsInner getHybridConnectionPlanLimit​(String resourceGroupName,
                                                                 String name)
        Description for Get the maximum number of Hybrid Connections allowed in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        hybrid Connection limits contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getHybridConnectionPlanLimitWithResponse

        com.azure.core.http.rest.Response<HybridConnectionLimitsInner> getHybridConnectionPlanLimitWithResponse​(String resourceGroupName,
                                                                                                                String name,
                                                                                                                com.azure.core.util.Context context)
        Description for Get the maximum number of Hybrid Connections allowed in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        context - The context to associate with this operation.
        Returns:
        hybrid Connection limits contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listHybridConnectionsAsync

        com.azure.core.http.rest.PagedFlux<HybridConnectionInner> listHybridConnectionsAsync​(String resourceGroupName,
                                                                                             String name)
        Description for Retrieve all Hybrid Connections in use in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        collection of hostname bindings.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listHybridConnections

        com.azure.core.http.rest.PagedIterable<HybridConnectionInner> listHybridConnections​(String resourceGroupName,
                                                                                            String name)
        Description for Retrieve all Hybrid Connections in use in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        collection of hostname bindings.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listHybridConnections

        com.azure.core.http.rest.PagedIterable<HybridConnectionInner> listHybridConnections​(String resourceGroupName,
                                                                                            String name,
                                                                                            com.azure.core.util.Context context)
        Description for Retrieve all Hybrid Connections in use in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        context - The context to associate with this operation.
        Returns:
        collection of hostname bindings.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • restartWebAppsWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Void>> restartWebAppsWithResponseAsync​(String resourceGroupName,
                                                                                      String name,
                                                                                      Boolean softRestart)
        Description for Restart all apps in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        softRestart - Specify <code>true</code> to perform a soft restart, applies the configuration settings and restarts the apps if necessary. The default is <code>false</code>, which always restarts and reprovisions the apps.
        Returns:
        the completion.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • restartWebAppsAsync

        Mono<Void> restartWebAppsAsync​(String resourceGroupName,
                                       String name,
                                       Boolean softRestart)
        Description for Restart all apps in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        softRestart - Specify <code>true</code> to perform a soft restart, applies the configuration settings and restarts the apps if necessary. The default is <code>false</code>, which always restarts and reprovisions the apps.
        Returns:
        the completion.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • restartWebAppsAsync

        Mono<Void> restartWebAppsAsync​(String resourceGroupName,
                                       String name)
        Description for Restart all apps in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        the completion.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • restartWebApps

        void restartWebApps​(String resourceGroupName,
                            String name)
        Description for Restart all apps in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • restartWebAppsWithResponse

        com.azure.core.http.rest.Response<Void> restartWebAppsWithResponse​(String resourceGroupName,
                                                                           String name,
                                                                           Boolean softRestart,
                                                                           com.azure.core.util.Context context)
        Description for Restart all apps in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        softRestart - Specify <code>true</code> to perform a soft restart, applies the configuration settings and restarts the apps if necessary. The default is <code>false</code>, which always restarts and reprovisions the apps.
        context - The context to associate with this operation.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listWebAppsAsync

        com.azure.core.http.rest.PagedFlux<SiteInner> listWebAppsAsync​(String resourceGroupName,
                                                                       String name,
                                                                       String skipToken,
                                                                       String filter,
                                                                       String top)
        Description for Get all apps associated with an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        skipToken - Skip to a web app in the list of webapps associated with app service plan. If specified, the resulting list will contain web apps starting from (including) the skipToken. Otherwise, the resulting list contains web apps from the start of the list.
        filter - Supported filter: $filter=state eq running. Returns only web apps that are currently running.
        top - List page size. If specified, results are paged.
        Returns:
        collection of App Service apps.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listWebAppsAsync

        com.azure.core.http.rest.PagedFlux<SiteInner> listWebAppsAsync​(String resourceGroupName,
                                                                       String name)
        Description for Get all apps associated with an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        collection of App Service apps.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listWebApps

        com.azure.core.http.rest.PagedIterable<SiteInner> listWebApps​(String resourceGroupName,
                                                                      String name)
        Description for Get all apps associated with an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        collection of App Service apps.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listWebApps

        com.azure.core.http.rest.PagedIterable<SiteInner> listWebApps​(String resourceGroupName,
                                                                      String name,
                                                                      String skipToken,
                                                                      String filter,
                                                                      String top,
                                                                      com.azure.core.util.Context context)
        Description for Get all apps associated with an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        skipToken - Skip to a web app in the list of webapps associated with app service plan. If specified, the resulting list will contain web apps starting from (including) the skipToken. Otherwise, the resulting list contains web apps from the start of the list.
        filter - Supported filter: $filter=state eq running. Returns only web apps that are currently running.
        top - List page size. If specified, results are paged.
        context - The context to associate with this operation.
        Returns:
        collection of App Service apps.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getServerFarmSkusWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Object>> getServerFarmSkusWithResponseAsync​(String resourceGroupName,
                                                                                           String name)
        Description for Gets all selectable SKUs for a given App Service Plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of App Service Plan.
        Returns:
        any object.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getServerFarmSkusAsync

        Mono<Object> getServerFarmSkusAsync​(String resourceGroupName,
                                            String name)
        Description for Gets all selectable SKUs for a given App Service Plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of App Service Plan.
        Returns:
        any object.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getServerFarmSkus

        Object getServerFarmSkus​(String resourceGroupName,
                                 String name)
        Description for Gets all selectable SKUs for a given App Service Plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of App Service Plan.
        Returns:
        any object.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getServerFarmSkusWithResponse

        com.azure.core.http.rest.Response<Object> getServerFarmSkusWithResponse​(String resourceGroupName,
                                                                                String name,
                                                                                com.azure.core.util.Context context)
        Description for Gets all selectable SKUs for a given App Service Plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of App Service Plan.
        context - The context to associate with this operation.
        Returns:
        any object.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listUsagesAsync

        com.azure.core.http.rest.PagedFlux<CsmUsageQuotaInner> listUsagesAsync​(String resourceGroupName,
                                                                               String name,
                                                                               String filter)
        Description for Gets server farm usage information.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of App Service Plan.
        filter - Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2').
        Returns:
        collection of CSM usage quotas.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listUsagesAsync

        com.azure.core.http.rest.PagedFlux<CsmUsageQuotaInner> listUsagesAsync​(String resourceGroupName,
                                                                               String name)
        Description for Gets server farm usage information.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of App Service Plan.
        Returns:
        collection of CSM usage quotas.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listUsages

        com.azure.core.http.rest.PagedIterable<CsmUsageQuotaInner> listUsages​(String resourceGroupName,
                                                                              String name)
        Description for Gets server farm usage information.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of App Service Plan.
        Returns:
        collection of CSM usage quotas.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listUsages

        com.azure.core.http.rest.PagedIterable<CsmUsageQuotaInner> listUsages​(String resourceGroupName,
                                                                              String name,
                                                                              String filter,
                                                                              com.azure.core.util.Context context)
        Description for Gets server farm usage information.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of App Service Plan.
        filter - Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2').
        context - The context to associate with this operation.
        Returns:
        collection of CSM usage quotas.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listVnetsWithResponseAsync

        Mono<com.azure.core.http.rest.Response<List<VnetInfoResourceInner>>> listVnetsWithResponseAsync​(String resourceGroupName,
                                                                                                        String name)
        Description for Get all Virtual Networks associated with an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        array of VnetInfoResource.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listVnetsAsync

        Mono<List<VnetInfoResourceInner>> listVnetsAsync​(String resourceGroupName,
                                                         String name)
        Description for Get all Virtual Networks associated with an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        array of VnetInfoResource.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listVnets

        List<VnetInfoResourceInner> listVnets​(String resourceGroupName,
                                              String name)
        Description for Get all Virtual Networks associated with an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        Returns:
        array of VnetInfoResource.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listVnetsWithResponse

        com.azure.core.http.rest.Response<List<VnetInfoResourceInner>> listVnetsWithResponse​(String resourceGroupName,
                                                                                             String name,
                                                                                             com.azure.core.util.Context context)
        Description for Get all Virtual Networks associated with an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        context - The context to associate with this operation.
        Returns:
        array of VnetInfoResource.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getVnetFromServerFarmWithResponseAsync

        Mono<com.azure.core.http.rest.Response<VnetInfoResourceInner>> getVnetFromServerFarmWithResponseAsync​(String resourceGroupName,
                                                                                                              String name,
                                                                                                              String vnetName)
        Description for Get a Virtual Network associated with an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        Returns:
        virtual Network information ARM 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.
      • getVnetFromServerFarmAsync

        Mono<VnetInfoResourceInner> getVnetFromServerFarmAsync​(String resourceGroupName,
                                                               String name,
                                                               String vnetName)
        Description for Get a Virtual Network associated with an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        Returns:
        virtual Network information ARM 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.
      • getVnetFromServerFarm

        VnetInfoResourceInner getVnetFromServerFarm​(String resourceGroupName,
                                                    String name,
                                                    String vnetName)
        Description for Get a Virtual Network associated with an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        Returns:
        virtual Network information ARM 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.
      • getVnetFromServerFarmWithResponse

        com.azure.core.http.rest.Response<VnetInfoResourceInner> getVnetFromServerFarmWithResponse​(String resourceGroupName,
                                                                                                   String name,
                                                                                                   String vnetName,
                                                                                                   com.azure.core.util.Context context)
        Description for Get a Virtual Network associated with an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        context - The context to associate with this operation.
        Returns:
        virtual Network information ARM 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.
      • getVnetGatewayWithResponseAsync

        Mono<com.azure.core.http.rest.Response<VnetGatewayInner>> getVnetGatewayWithResponseAsync​(String resourceGroupName,
                                                                                                  String name,
                                                                                                  String vnetName,
                                                                                                  String gatewayName)
        Description for Get a Virtual Network gateway.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        gatewayName - Name of the gateway. Only the 'primary' gateway is supported.
        Returns:
        the Virtual Network gateway contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getVnetGatewayAsync

        Mono<VnetGatewayInner> getVnetGatewayAsync​(String resourceGroupName,
                                                   String name,
                                                   String vnetName,
                                                   String gatewayName)
        Description for Get a Virtual Network gateway.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        gatewayName - Name of the gateway. Only the 'primary' gateway is supported.
        Returns:
        the Virtual Network gateway contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getVnetGateway

        VnetGatewayInner getVnetGateway​(String resourceGroupName,
                                        String name,
                                        String vnetName,
                                        String gatewayName)
        Description for Get a Virtual Network gateway.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        gatewayName - Name of the gateway. Only the 'primary' gateway is supported.
        Returns:
        the Virtual Network gateway contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getVnetGatewayWithResponse

        com.azure.core.http.rest.Response<VnetGatewayInner> getVnetGatewayWithResponse​(String resourceGroupName,
                                                                                       String name,
                                                                                       String vnetName,
                                                                                       String gatewayName,
                                                                                       com.azure.core.util.Context context)
        Description for Get a Virtual Network gateway.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        gatewayName - Name of the gateway. Only the 'primary' gateway is supported.
        context - The context to associate with this operation.
        Returns:
        the Virtual Network gateway contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateVnetGatewayWithResponseAsync

        Mono<com.azure.core.http.rest.Response<VnetGatewayInner>> updateVnetGatewayWithResponseAsync​(String resourceGroupName,
                                                                                                     String name,
                                                                                                     String vnetName,
                                                                                                     String gatewayName,
                                                                                                     VnetGatewayInner connectionEnvelope)
        Description for Update a Virtual Network gateway.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        gatewayName - Name of the gateway. Only the 'primary' gateway is supported.
        connectionEnvelope - Definition of the gateway.
        Returns:
        the Virtual Network gateway contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateVnetGatewayAsync

        Mono<VnetGatewayInner> updateVnetGatewayAsync​(String resourceGroupName,
                                                      String name,
                                                      String vnetName,
                                                      String gatewayName,
                                                      VnetGatewayInner connectionEnvelope)
        Description for Update a Virtual Network gateway.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        gatewayName - Name of the gateway. Only the 'primary' gateway is supported.
        connectionEnvelope - Definition of the gateway.
        Returns:
        the Virtual Network gateway contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateVnetGateway

        VnetGatewayInner updateVnetGateway​(String resourceGroupName,
                                           String name,
                                           String vnetName,
                                           String gatewayName,
                                           VnetGatewayInner connectionEnvelope)
        Description for Update a Virtual Network gateway.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        gatewayName - Name of the gateway. Only the 'primary' gateway is supported.
        connectionEnvelope - Definition of the gateway.
        Returns:
        the Virtual Network gateway contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateVnetGatewayWithResponse

        com.azure.core.http.rest.Response<VnetGatewayInner> updateVnetGatewayWithResponse​(String resourceGroupName,
                                                                                          String name,
                                                                                          String vnetName,
                                                                                          String gatewayName,
                                                                                          VnetGatewayInner connectionEnvelope,
                                                                                          com.azure.core.util.Context context)
        Description for Update a Virtual Network gateway.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        gatewayName - Name of the gateway. Only the 'primary' gateway is supported.
        connectionEnvelope - Definition of the gateway.
        context - The context to associate with this operation.
        Returns:
        the Virtual Network gateway contract.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listRoutesForVnetWithResponseAsync

        Mono<com.azure.core.http.rest.Response<List<VnetRouteInner>>> listRoutesForVnetWithResponseAsync​(String resourceGroupName,
                                                                                                         String name,
                                                                                                         String vnetName)
        Description for Get all routes that are associated with a Virtual Network in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        Returns:
        array of VnetRoute.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listRoutesForVnetAsync

        Mono<List<VnetRouteInner>> listRoutesForVnetAsync​(String resourceGroupName,
                                                          String name,
                                                          String vnetName)
        Description for Get all routes that are associated with a Virtual Network in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        Returns:
        array of VnetRoute.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listRoutesForVnet

        List<VnetRouteInner> listRoutesForVnet​(String resourceGroupName,
                                               String name,
                                               String vnetName)
        Description for Get all routes that are associated with a Virtual Network in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        Returns:
        array of VnetRoute.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listRoutesForVnetWithResponse

        com.azure.core.http.rest.Response<List<VnetRouteInner>> listRoutesForVnetWithResponse​(String resourceGroupName,
                                                                                              String name,
                                                                                              String vnetName,
                                                                                              com.azure.core.util.Context context)
        Description for Get all routes that are associated with a Virtual Network in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        context - The context to associate with this operation.
        Returns:
        array of VnetRoute.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getRouteForVnetWithResponseAsync

        Mono<com.azure.core.http.rest.Response<List<VnetRouteInner>>> getRouteForVnetWithResponseAsync​(String resourceGroupName,
                                                                                                       String name,
                                                                                                       String vnetName,
                                                                                                       String routeName)
        Description for Get a Virtual Network route in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        routeName - Name of the Virtual Network route.
        Returns:
        array of VnetRoute.
        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.
      • getRouteForVnetAsync

        Mono<List<VnetRouteInner>> getRouteForVnetAsync​(String resourceGroupName,
                                                        String name,
                                                        String vnetName,
                                                        String routeName)
        Description for Get a Virtual Network route in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        routeName - Name of the Virtual Network route.
        Returns:
        array of VnetRoute.
        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.
      • getRouteForVnet

        List<VnetRouteInner> getRouteForVnet​(String resourceGroupName,
                                             String name,
                                             String vnetName,
                                             String routeName)
        Description for Get a Virtual Network route in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        routeName - Name of the Virtual Network route.
        Returns:
        array of VnetRoute.
        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.
      • getRouteForVnetWithResponse

        com.azure.core.http.rest.Response<List<VnetRouteInner>> getRouteForVnetWithResponse​(String resourceGroupName,
                                                                                            String name,
                                                                                            String vnetName,
                                                                                            String routeName,
                                                                                            com.azure.core.util.Context context)
        Description for Get a Virtual Network route in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        routeName - Name of the Virtual Network route.
        context - The context to associate with this operation.
        Returns:
        array of VnetRoute.
        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.
      • createOrUpdateVnetRouteWithResponseAsync

        Mono<com.azure.core.http.rest.Response<VnetRouteInner>> createOrUpdateVnetRouteWithResponseAsync​(String resourceGroupName,
                                                                                                         String name,
                                                                                                         String vnetName,
                                                                                                         String routeName,
                                                                                                         VnetRouteInner route)
        Description for Create or update a Virtual Network route in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        routeName - Name of the Virtual Network route.
        route - Definition of the Virtual Network route.
        Returns:
        virtual Network route contract used to pass routing information for a Virtual Network.
        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.
      • createOrUpdateVnetRouteAsync

        Mono<VnetRouteInner> createOrUpdateVnetRouteAsync​(String resourceGroupName,
                                                          String name,
                                                          String vnetName,
                                                          String routeName,
                                                          VnetRouteInner route)
        Description for Create or update a Virtual Network route in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        routeName - Name of the Virtual Network route.
        route - Definition of the Virtual Network route.
        Returns:
        virtual Network route contract used to pass routing information for a Virtual Network.
        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.
      • createOrUpdateVnetRoute

        VnetRouteInner createOrUpdateVnetRoute​(String resourceGroupName,
                                               String name,
                                               String vnetName,
                                               String routeName,
                                               VnetRouteInner route)
        Description for Create or update a Virtual Network route in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        routeName - Name of the Virtual Network route.
        route - Definition of the Virtual Network route.
        Returns:
        virtual Network route contract used to pass routing information for a Virtual Network.
        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.
      • createOrUpdateVnetRouteWithResponse

        com.azure.core.http.rest.Response<VnetRouteInner> createOrUpdateVnetRouteWithResponse​(String resourceGroupName,
                                                                                              String name,
                                                                                              String vnetName,
                                                                                              String routeName,
                                                                                              VnetRouteInner route,
                                                                                              com.azure.core.util.Context context)
        Description for Create or update a Virtual Network route in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        routeName - Name of the Virtual Network route.
        route - Definition of the Virtual Network route.
        context - The context to associate with this operation.
        Returns:
        virtual Network route contract used to pass routing information for a Virtual Network.
        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.
      • deleteVnetRouteWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Void>> deleteVnetRouteWithResponseAsync​(String resourceGroupName,
                                                                                       String name,
                                                                                       String vnetName,
                                                                                       String routeName)
        Description for Delete a Virtual Network route in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        routeName - Name of the Virtual Network route.
        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.
      • deleteVnetRouteAsync

        Mono<Void> deleteVnetRouteAsync​(String resourceGroupName,
                                        String name,
                                        String vnetName,
                                        String routeName)
        Description for Delete a Virtual Network route in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        routeName - Name of the Virtual Network route.
        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.
      • deleteVnetRoute

        void deleteVnetRoute​(String resourceGroupName,
                             String name,
                             String vnetName,
                             String routeName)
        Description for Delete a Virtual Network route in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        routeName - Name of the Virtual Network route.
        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.
      • deleteVnetRouteWithResponse

        com.azure.core.http.rest.Response<Void> deleteVnetRouteWithResponse​(String resourceGroupName,
                                                                            String name,
                                                                            String vnetName,
                                                                            String routeName,
                                                                            com.azure.core.util.Context context)
        Description for Delete a Virtual Network route in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        routeName - Name of the Virtual Network route.
        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.
      • updateVnetRouteWithResponseAsync

        Mono<com.azure.core.http.rest.Response<VnetRouteInner>> updateVnetRouteWithResponseAsync​(String resourceGroupName,
                                                                                                 String name,
                                                                                                 String vnetName,
                                                                                                 String routeName,
                                                                                                 VnetRouteInner route)
        Description for Create or update a Virtual Network route in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        routeName - Name of the Virtual Network route.
        route - Definition of the Virtual Network route.
        Returns:
        virtual Network route contract used to pass routing information for a Virtual Network.
        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.
      • updateVnetRouteAsync

        Mono<VnetRouteInner> updateVnetRouteAsync​(String resourceGroupName,
                                                  String name,
                                                  String vnetName,
                                                  String routeName,
                                                  VnetRouteInner route)
        Description for Create or update a Virtual Network route in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        routeName - Name of the Virtual Network route.
        route - Definition of the Virtual Network route.
        Returns:
        virtual Network route contract used to pass routing information for a Virtual Network.
        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.
      • updateVnetRoute

        VnetRouteInner updateVnetRoute​(String resourceGroupName,
                                       String name,
                                       String vnetName,
                                       String routeName,
                                       VnetRouteInner route)
        Description for Create or update a Virtual Network route in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        routeName - Name of the Virtual Network route.
        route - Definition of the Virtual Network route.
        Returns:
        virtual Network route contract used to pass routing information for a Virtual Network.
        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.
      • updateVnetRouteWithResponse

        com.azure.core.http.rest.Response<VnetRouteInner> updateVnetRouteWithResponse​(String resourceGroupName,
                                                                                      String name,
                                                                                      String vnetName,
                                                                                      String routeName,
                                                                                      VnetRouteInner route,
                                                                                      com.azure.core.util.Context context)
        Description for Create or update a Virtual Network route in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        vnetName - Name of the Virtual Network.
        routeName - Name of the Virtual Network route.
        route - Definition of the Virtual Network route.
        context - The context to associate with this operation.
        Returns:
        virtual Network route contract used to pass routing information for a Virtual Network.
        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.
      • rebootWorkerWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Void>> rebootWorkerWithResponseAsync​(String resourceGroupName,
                                                                                    String name,
                                                                                    String workerName)
        Description for Reboot a worker machine in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        workerName - Name of worker machine, which typically starts with RD.
        Returns:
        the completion.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • rebootWorkerAsync

        Mono<Void> rebootWorkerAsync​(String resourceGroupName,
                                     String name,
                                     String workerName)
        Description for Reboot a worker machine in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        workerName - Name of worker machine, which typically starts with RD.
        Returns:
        the completion.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • rebootWorker

        void rebootWorker​(String resourceGroupName,
                          String name,
                          String workerName)
        Description for Reboot a worker machine in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        workerName - Name of worker machine, which typically starts with RD.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • rebootWorkerWithResponse

        com.azure.core.http.rest.Response<Void> rebootWorkerWithResponse​(String resourceGroupName,
                                                                         String name,
                                                                         String workerName,
                                                                         com.azure.core.util.Context context)
        Description for Reboot a worker machine in an App Service plan.
        Parameters:
        resourceGroupName - Name of the resource group to which the resource belongs.
        name - Name of the App Service plan.
        workerName - Name of worker machine, which typically starts with RD.
        context - The context to associate with this operation.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        DefaultErrorResponseErrorException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.