Package com.azure.resourcemanager.apimanagement.models

Interface ProductWikis

public interface ProductWikis
Resource collection API of ProductWikis.

  • Method Details

    • getEntityTagWithResponse

      ProductWikisGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String productId, com.azure.core.util.Context context)
      Gets the entity state (Etag) version of the Wiki for a Product specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      productId - Product identifier. Must be unique in the current API Management service instance.
      context - The context to associate with this operation.
      Returns:
      the entity state (Etag) version of the Wiki for a Product specified by its identifier.
      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.

    • getEntityTag

      void getEntityTag(String resourceGroupName, String serviceName, String productId)
      Gets the entity state (Etag) version of the Wiki for a Product specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      productId - Product 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.

    • getWithResponse

      com.azure.core.http.rest.Response<WikiContract> getWithResponse(String resourceGroupName, String serviceName, String productId, com.azure.core.util.Context context)
      Gets the details of the Wiki for a Product specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      productId - Product identifier. Must be unique in the current API Management service instance.
      context - The context to associate with this operation.
      Returns:
      the details of the Wiki for a Product specified by its identifier.
      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

      WikiContract get(String resourceGroupName, String serviceName, String productId)
      Gets the details of the Wiki for a Product specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      productId - Product identifier. Must be unique in the current API Management service instance.
      Returns:
      the details of the Wiki for a Product specified by its identifier.
      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.

    • createOrUpdateWithResponse

      com.azure.core.http.rest.Response<WikiContract> createOrUpdateWithResponse(String resourceGroupName, String serviceName, String productId, WikiContractInner parameters, String ifMatch, com.azure.core.util.Context context)
      Creates a new Wiki for a Product or updates an existing one.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      productId - Product identifier. Must be unique in the current API Management service instance.
      parameters - Create parameters.
      ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.
      context - The context to associate with this operation.
      Returns:
      wiki properties.
      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.

    • createOrUpdate

      WikiContract createOrUpdate(String resourceGroupName, String serviceName, String productId, WikiContractInner parameters)
      Creates a new Wiki for a Product or updates an existing one.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      productId - Product identifier. Must be unique in the current API Management service instance.
      parameters - Create parameters.
      Returns:
      wiki properties.
      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.

    • updateWithResponse

      com.azure.core.http.rest.Response<WikiContract> updateWithResponse(String resourceGroupName, String serviceName, String productId, String ifMatch, WikiUpdateContract parameters, com.azure.core.util.Context context)
      Updates the details of the Wiki for a Product specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      productId - Product identifier. Must be unique in the current API Management service instance.
      ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
      parameters - Wiki Update parameters.
      context - The context to associate with this operation.
      Returns:
      wiki properties.
      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.

    • update

      WikiContract update(String resourceGroupName, String serviceName, String productId, String ifMatch, WikiUpdateContract parameters)
      Updates the details of the Wiki for a Product specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      productId - Product identifier. Must be unique in the current API Management service instance.
      ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
      parameters - Wiki Update parameters.
      Returns:
      wiki properties.
      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 productId, String ifMatch, com.azure.core.util.Context context)
      Deletes the specified Wiki from a Product.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      productId - Product identifier. Must be unique in the current API Management service instance.
      ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
      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 productId, String ifMatch)
      Deletes the specified Wiki from a Product.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      productId - Product identifier. Must be unique in the current API Management service instance.
      ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
      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.