Package com.azure.resourcemanager.apimanagement.models

Interface TagApiLinks

public interface TagApiLinks
Resource collection API of TagApiLinks.

  • Method Details

    • listByProduct

      com.azure.core.http.rest.PagedIterable<TagApiLinkContract> listByProduct(String resourceGroupName, String serviceName, String tagId)
      Lists a collection of the API links associated with a tag.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      tagId - Tag identifier. Must be unique in the current API Management service instance.
      Returns:
      paged Tag-API link list representation 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.

    • listByProduct

      com.azure.core.http.rest.PagedIterable<TagApiLinkContract> listByProduct(String resourceGroupName, String serviceName, String tagId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)
      Lists a collection of the API links associated with a tag.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      tagId - Tag identifier. Must be unique in the current API Management service instance.
      filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>.
      top - Number of records to return.
      skip - Number of records to skip.
      context - The context to associate with this operation.
      Returns:
      paged Tag-API link list representation 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<TagApiLinkContract> getWithResponse(String resourceGroupName, String serviceName, String tagId, String apiLinkId, com.azure.core.util.Context context)
      Gets the API link for the tag.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      tagId - Tag identifier. Must be unique in the current API Management service instance.
      apiLinkId - Tag-API link identifier. Must be unique in the current API Management service instance.
      context - The context to associate with this operation.
      Returns:
      the API link for the tag.
      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

      TagApiLinkContract get(String resourceGroupName, String serviceName, String tagId, String apiLinkId)
      Gets the API link for the tag.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      tagId - Tag identifier. Must be unique in the current API Management service instance.
      apiLinkId - Tag-API link identifier. Must be unique in the current API Management service instance.
      Returns:
      the API link for the tag.
      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 tagId, String apiLinkId, com.azure.core.util.Context context)
      Deletes the specified API from the specified tag.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      tagId - Tag identifier. Must be unique in the current API Management service instance.
      apiLinkId - Tag-API link identifier. Must be unique in the current API Management service instance.
      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 tagId, String apiLinkId)
      Deletes the specified API from the specified tag.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      tagId - Tag identifier. Must be unique in the current API Management service instance.
      apiLinkId - Tag-API link identifier. Must be unique in the current API Management service instance.
      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

      TagApiLinkContract getById(String id)
      Gets the API link for the tag.
      Parameters:
      id - the resource ID.
      Returns:
      the API link for the tag.
      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<TagApiLinkContract> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets the API link for the tag.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      the API link for the tag.
      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 the specified API from the specified tag.
      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 the specified API from the specified tag.
      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

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