Package com.azure.resourcemanager.apicenter.models

Interface Deployments

public interface Deployments
Resource collection API of Deployments.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<Deployment> list(String resourceGroupName, String serviceName, String workspaceName, String apiName)
      Returns a collection of API deployments.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      apiName - The name of the API.
      Returns:
      the response of a Deployment 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<Deployment> list(String resourceGroupName, String serviceName, String workspaceName, String apiName, String filter, com.azure.core.util.Context context)
      Returns a collection of API deployments.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      apiName - The name of the API.
      filter - OData filter parameter.
      context - The context to associate with this operation.
      Returns:
      the response of a Deployment 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.

    • getWithResponse

      com.azure.core.http.rest.Response<Deployment> getWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName, com.azure.core.util.Context context)
      Returns details of the API deployment.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      apiName - The name of the API.
      deploymentName - The name of the API deployment.
      context - The context to associate with this operation.
      Returns:
      aPI deployment entity.
      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

      Deployment get(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName)
      Returns details of the API deployment.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      apiName - The name of the API.
      deploymentName - The name of the API deployment.
      Returns:
      aPI deployment entity.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName, com.azure.core.util.Context context)
      Deletes API deployment.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      apiName - The name of the API.
      deploymentName - The name of the API deployment.
      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.

    • delete

      void delete(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName)
      Deletes API deployment.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      apiName - The name of the API.
      deploymentName - The name of the API 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.

    • headWithResponse

      com.azure.core.http.rest.Response<Void> headWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName, com.azure.core.util.Context context)
      Checks if specified API deployment exists.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      apiName - The name of the API.
      deploymentName - The name of the API deployment.
      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.

    • head

      void head(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName)
      Checks if specified API deployment exists.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      apiName - The name of the API.
      deploymentName - The name of the API 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.

    • getById

      Deployment getById(String id)
      Returns details of the API deployment.
      Parameters:
      id - the resource ID.
      Returns:
      aPI deployment entity.
      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<Deployment> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Returns details of the API deployment.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      aPI deployment entity.
      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)
      Deletes API deployment.
      Parameters:
      id - the resource ID.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteByIdWithResponse

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes API deployment.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • define

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