Package com.azure.resourcemanager.apimanagement.models

Interface GatewayContract

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

  • 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.

    • locationData

      ResourceLocationDataContract locationData()
      Gets the locationData property: Gateway location.
      Returns:
      the locationData value.

    • description

      String description()
      Gets the description property: Gateway description.
      Returns:
      the description value.

    • resourceGroupName

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

    • innerModel

      GatewayContractInner innerModel()
      Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.GatewayContractInner object.
      Returns:
      the inner object.

    • update

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

    • refresh

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

    • refresh

      GatewayContract 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.

    • listKeysWithResponse

      com.azure.core.http.rest.Response<GatewayKeysContract> listKeysWithResponse(com.azure.core.util.Context context)
      Retrieves gateway keys.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      gateway authentication keys.
      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.

    • listKeys

      GatewayKeysContract listKeys()
      Retrieves gateway keys.
      Returns:
      gateway authentication keys.
      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.

    • regenerateKeyWithResponse

      com.azure.core.http.rest.Response<Void> regenerateKeyWithResponse(GatewayKeyRegenerationRequestContract parameters, com.azure.core.util.Context context)
      Regenerates specified gateway key invalidating any tokens created with it.
      Parameters:
      parameters - The parameters parameter.
      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.

    • regenerateKey

      void regenerateKey(GatewayKeyRegenerationRequestContract parameters)
      Regenerates specified gateway key invalidating any tokens created with it.
      Parameters:
      parameters - The parameters parameter.
      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.

    • generateTokenWithResponse

      com.azure.core.http.rest.Response<GatewayTokenContract> generateTokenWithResponse(GatewayTokenRequestContract parameters, com.azure.core.util.Context context)
      Gets the Shared Access Authorization Token for the gateway.
      Parameters:
      parameters - The parameters parameter.
      context - The context to associate with this operation.
      Returns:
      the Shared Access Authorization Token for the gateway 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.

    • generateToken

      GatewayTokenContract generateToken(GatewayTokenRequestContract parameters)
      Gets the Shared Access Authorization Token for the gateway.
      Parameters:
      parameters - The parameters parameter.
      Returns:
      the Shared Access Authorization Token for the gateway.
      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.

    • invalidateDebugCredentialsWithResponse

      com.azure.core.http.rest.Response<Void> invalidateDebugCredentialsWithResponse(com.azure.core.util.Context context)
      Action is invalidating all debug credentials issued for gateway.
      Parameters:
      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.

    • invalidateDebugCredentials

      void invalidateDebugCredentials()
      Action is invalidating all debug credentials issued for gateway.
      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.

    • listDebugCredentialsWithResponse

      com.azure.core.http.rest.Response<GatewayDebugCredentialsContract> listDebugCredentialsWithResponse(GatewayListDebugCredentialsContract parameters, com.azure.core.util.Context context)
      Create new debug credentials for gateway.
      Parameters:
      parameters - List debug credentials properties.
      context - The context to associate with this operation.
      Returns:
      gateway debug credentials 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.

    • listDebugCredentials

      GatewayDebugCredentialsContract listDebugCredentials(GatewayListDebugCredentialsContract parameters)
      Create new debug credentials for gateway.
      Parameters:
      parameters - List debug credentials properties.
      Returns:
      gateway debug credentials.
      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.

    • listTraceWithResponse

      com.azure.core.http.rest.Response<Map<String,Object>> listTraceWithResponse(GatewayListTraceContract parameters, com.azure.core.util.Context context)
      Fetches trace collected by gateway.
      Parameters:
      parameters - List trace properties.
      context - The context to associate with this operation.
      Returns:
      trace collected in gateway 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.

    • listTrace

      Map<String,Object> listTrace(GatewayListTraceContract parameters)
      Fetches trace collected by gateway.
      Parameters:
      parameters - List trace properties.
      Returns:
      trace collected in gateway.
      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.