Package com.azure.resourcemanager.apicenter.models

Interface ApiDefinition

public interface ApiDefinition
An immutable client-side representation of ApiDefinition.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • properties

      ApiDefinitionProperties properties()
      Gets the properties property: The resource-specific properties for this resource.
      Returns:
      the properties value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
      Returns:
      the systemData value.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      ApiDefinitionInner innerModel()
      Gets the inner com.azure.resourcemanager.apicenter.fluent.models.ApiDefinitionInner object.
      Returns:
      the inner object.

    • update

      ApiDefinition.Update update()
      Begins update for the ApiDefinition resource.
      Returns:
      the stage of resource update.

    • refresh

      ApiDefinition refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      ApiDefinition refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • exportSpecification

      ApiSpecExportResult exportSpecification()
      Exports the API specification.
      Returns:
      the API specification export result.
      Throws:
      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.

    • exportSpecification

      ApiSpecExportResult exportSpecification(com.azure.core.util.Context context)
      Exports the API specification.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the API specification export result.
      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.

    • importSpecification

      void importSpecification(ApiSpecImportRequest body)
      Imports the API specification.
      Parameters:
      body - The content of the action request.
      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.

    • importSpecification

      void importSpecification(ApiSpecImportRequest body, com.azure.core.util.Context context)
      Imports the API specification.
      Parameters:
      body - The content of the action request.
      context - The context to associate with this operation.
      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.