Package com.azure.resourcemanager.peering.models

Interface RegisteredPrefixes

public interface RegisteredPrefixes
Resource collection API of RegisteredPrefixes.

  • Method Summary

    Modifier and Type
    Method
    Description
    PeeringRegisteredPrefix.DefinitionStages.Blank
    define(String name)
    Begins definition for a new PeeringRegisteredPrefix resource.
    void
    delete(String resourceGroupName, String peeringName, String registeredPrefixName)
    Deletes an existing registered prefix with the specified name under the given subscription, resource group and peering.
    void
    deleteById(String id)
    Deletes an existing registered prefix with the specified name under the given subscription, resource group and peering.
    com.azure.core.http.rest.Response<Void>
    deleteByIdWithResponse(String id, com.azure.core.util.Context context)
    Deletes an existing registered prefix with the specified name under the given subscription, resource group and peering.
    com.azure.core.http.rest.Response<Void>
    deleteWithResponse(String resourceGroupName, String peeringName, String registeredPrefixName, com.azure.core.util.Context context)
    Deletes an existing registered prefix with the specified name under the given subscription, resource group and peering.
    PeeringRegisteredPrefix
    get(String resourceGroupName, String peeringName, String registeredPrefixName)
    Gets an existing registered prefix with the specified name under the given subscription, resource group and peering.
    PeeringRegisteredPrefix
    getById(String id)
    Gets an existing registered prefix with the specified name under the given subscription, resource group and peering.
    com.azure.core.http.rest.Response<PeeringRegisteredPrefix>
    getByIdWithResponse(String id, com.azure.core.util.Context context)
    Gets an existing registered prefix with the specified name under the given subscription, resource group and peering.
    com.azure.core.http.rest.Response<PeeringRegisteredPrefix>
    getWithResponse(String resourceGroupName, String peeringName, String registeredPrefixName, com.azure.core.util.Context context)
    Gets an existing registered prefix with the specified name under the given subscription, resource group and peering.
    com.azure.core.http.rest.PagedIterable<PeeringRegisteredPrefix>
    listByPeering(String resourceGroupName, String peeringName)
    Lists all registered prefixes under the given subscription, resource group and peering.
    com.azure.core.http.rest.PagedIterable<PeeringRegisteredPrefix>
    listByPeering(String resourceGroupName, String peeringName, com.azure.core.util.Context context)
    Lists all registered prefixes under the given subscription, resource group and peering.

  • Method Details

    • getWithResponse

      com.azure.core.http.rest.Response<PeeringRegisteredPrefix> getWithResponse(String resourceGroupName, String peeringName, String registeredPrefixName, com.azure.core.util.Context context)
      Gets an existing registered prefix with the specified name under the given subscription, resource group and peering.
      Parameters:
      resourceGroupName - The name of the resource group.
      peeringName - The name of the peering.
      registeredPrefixName - The name of the registered prefix.
      context - The context to associate with this operation.
      Returns:
      an existing registered prefix with the specified name under the given subscription, resource group and peering 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

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

    • listByPeering

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

    • listByPeering

      com.azure.core.http.rest.PagedIterable<PeeringRegisteredPrefix> listByPeering(String resourceGroupName, String peeringName, com.azure.core.util.Context context)
      Lists all registered prefixes under the given subscription, resource group and peering.
      Parameters:
      resourceGroupName - The name of the resource group.
      peeringName - The name of the peering.
      context - The context to associate with this operation.
      Returns:
      the paginated list of peering registered 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

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

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