Interface Prefixes


public interface Prefixes
Resource collection API of Prefixes.
  • Method Summary

    Modifier and Type
    Method
    Description
    define(String name)
    Begins definition for a new PeeringServicePrefix resource.
    void
    delete(String resourceGroupName, String peeringServiceName, String prefixName)
    Deletes an existing prefix with the specified name under the given subscription, resource group and peering service.
    void
    Deletes an existing prefix with the specified name under the given subscription, resource group and peering service.
    com.azure.core.http.rest.Response<Void>
    deleteByIdWithResponse(String id, com.azure.core.util.Context context)
    Deletes an existing prefix with the specified name under the given subscription, resource group and peering service.
    com.azure.core.http.rest.Response<Void>
    deleteWithResponse(String resourceGroupName, String peeringServiceName, String prefixName, com.azure.core.util.Context context)
    Deletes an existing prefix with the specified name under the given subscription, resource group and peering service.
    get(String resourceGroupName, String peeringServiceName, String prefixName)
    Gets an existing prefix with the specified name under the given subscription, resource group and peering service.
    Gets an existing prefix with the specified name under the given subscription, resource group and peering service.
    com.azure.core.http.rest.Response<PeeringServicePrefix>
    getByIdWithResponse(String id, String expand, com.azure.core.util.Context context)
    Gets an existing prefix with the specified name under the given subscription, resource group and peering service.
    com.azure.core.http.rest.Response<PeeringServicePrefix>
    getWithResponse(String resourceGroupName, String peeringServiceName, String prefixName, String expand, com.azure.core.util.Context context)
    Gets an existing prefix with the specified name under the given subscription, resource group and peering service.
    com.azure.core.http.rest.PagedIterable<PeeringServicePrefix>
    listByPeeringService(String resourceGroupName, String peeringServiceName)
    Lists all prefixes under the given subscription, resource group and peering service.
    com.azure.core.http.rest.PagedIterable<PeeringServicePrefix>
    listByPeeringService(String resourceGroupName, String peeringServiceName, String expand, com.azure.core.util.Context context)
    Lists all prefixes under the given subscription, resource group and peering service.
  • Method Details

    • getWithResponse

      com.azure.core.http.rest.Response<PeeringServicePrefix> getWithResponse(String resourceGroupName, String peeringServiceName, String prefixName, String expand, com.azure.core.util.Context context)
      Gets an existing prefix with the specified name under the given subscription, resource group and peering service.
      Parameters:
      resourceGroupName - The name of the resource group.
      peeringServiceName - The name of the peering service.
      prefixName - The name of the prefix.
      expand - The properties to be expanded.
      context - The context to associate with this operation.
      Returns:
      an existing prefix with the specified name under the given subscription, resource group and peering service 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.
    • get

      PeeringServicePrefix get(String resourceGroupName, String peeringServiceName, String prefixName)
      Gets an existing prefix with the specified name under the given subscription, resource group and peering service.
      Parameters:
      resourceGroupName - The name of the resource group.
      peeringServiceName - The name of the peering service.
      prefixName - The name of the prefix.
      Returns:
      an existing prefix with the specified name under the given subscription, resource group and peering service.
      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 peeringServiceName, String prefixName, com.azure.core.util.Context context)
      Deletes an existing prefix with the specified name under the given subscription, resource group and peering service.
      Parameters:
      resourceGroupName - The name of the resource group.
      peeringServiceName - The name of the peering service.
      prefixName - The name of the prefix.
      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 peeringServiceName, String prefixName)
      Deletes an existing prefix with the specified name under the given subscription, resource group and peering service.
      Parameters:
      resourceGroupName - The name of the resource group.
      peeringServiceName - The name of the peering service.
      prefixName - The name of the prefix.
      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.
    • listByPeeringService

      com.azure.core.http.rest.PagedIterable<PeeringServicePrefix> listByPeeringService(String resourceGroupName, String peeringServiceName)
      Lists all prefixes under the given subscription, resource group and peering service.
      Parameters:
      resourceGroupName - The name of the resource group.
      peeringServiceName - The name of the peering service.
      Returns:
      the paginated list of peering service prefixes 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.
    • listByPeeringService

      com.azure.core.http.rest.PagedIterable<PeeringServicePrefix> listByPeeringService(String resourceGroupName, String peeringServiceName, String expand, com.azure.core.util.Context context)
      Lists all prefixes under the given subscription, resource group and peering service.
      Parameters:
      resourceGroupName - The name of the resource group.
      peeringServiceName - The name of the peering service.
      expand - The properties to be expanded.
      context - The context to associate with this operation.
      Returns:
      the paginated list of peering service prefixes as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getById

      Gets an existing prefix with the specified name under the given subscription, resource group and peering service.
      Parameters:
      id - the resource ID.
      Returns:
      an existing prefix with the specified name under the given subscription, resource group and peering service 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<PeeringServicePrefix> getByIdWithResponse(String id, String expand, com.azure.core.util.Context context)
      Gets an existing prefix with the specified name under the given subscription, resource group and peering service.
      Parameters:
      id - the resource ID.
      expand - The properties to be expanded.
      context - The context to associate with this operation.
      Returns:
      an existing prefix with the specified name under the given subscription, resource group and peering service 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)
      Deletes an existing prefix with the specified name under the given subscription, resource group and peering service.
      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 an existing prefix with the specified name under the given subscription, resource group and peering service.
      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

      Begins definition for a new PeeringServicePrefix resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new PeeringServicePrefix definition.