Package com.azure.resourcemanager.nginx.models

Interface Configurations

public interface Configurations
Resource collection API of Configurations.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<NginxConfiguration> list(String resourceGroupName, String deploymentName)
      List the Nginx configuration of given Nginx deployment.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      deploymentName - The name of targeted Nginx deployment.
      Returns:
      response of a list operation as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<NginxConfiguration> list(String resourceGroupName, String deploymentName, com.azure.core.util.Context context)
      List the Nginx configuration of given Nginx deployment.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      deploymentName - The name of targeted Nginx deployment.
      context - The context to associate with this operation.
      Returns:
      response of a list operation as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      NginxConfiguration get(String resourceGroupName, String deploymentName, String configurationName)
      Get the Nginx configuration of given Nginx deployment.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      deploymentName - The name of targeted Nginx deployment.
      configurationName - The name of configuration, only 'default' is supported value due to the singleton of Nginx conf.
      Returns:
      the Nginx configuration of given Nginx deployment.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      com.azure.core.http.rest.Response<NginxConfiguration> getWithResponse(String resourceGroupName, String deploymentName, String configurationName, com.azure.core.util.Context context)
      Get the Nginx configuration of given Nginx deployment.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      deploymentName - The name of targeted Nginx deployment.
      configurationName - The name of configuration, only 'default' is supported value due to the singleton of Nginx conf.
      context - The context to associate with this operation.
      Returns:
      the Nginx configuration of given Nginx deployment along with 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.

    • delete

      void delete(String resourceGroupName, String deploymentName, String configurationName)
      Reset the Nginx configuration of given Nginx deployment to default.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      deploymentName - The name of targeted Nginx deployment.
      configurationName - The name of configuration, only 'default' is supported value due to the singleton of Nginx conf.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String deploymentName, String configurationName, com.azure.core.util.Context context)
      Reset the Nginx configuration of given Nginx deployment to default.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      deploymentName - The name of targeted Nginx deployment.
      configurationName - The name of configuration, only 'default' is supported value due to the singleton of Nginx conf.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getById

      NginxConfiguration getById(String id)
      Get the Nginx configuration of given Nginx deployment.
      Parameters:
      id - the resource ID.
      Returns:
      the Nginx configuration of given Nginx deployment along with 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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<NginxConfiguration> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Get the Nginx configuration of given Nginx deployment.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      the Nginx configuration of given Nginx deployment along with 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.

    • deleteById

      void deleteById(String id)
      Reset the Nginx configuration of given Nginx deployment to default.
      Parameters:
      id - the resource ID.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Reset the Nginx configuration of given Nginx deployment to default.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • define

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