Package com.azure.resourcemanager.apimanagement.models

Interface BackendContract

  • public interface BackendContract
    An immutable client-side representation of BackendContract.

    • Method Detail

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

      • url

        String url()
        Gets the url property: Runtime Url of the Backend.
        Returns:
        the url value.

      • protocol

        BackendProtocol protocol()
        Gets the protocol property: Backend communication protocol.
        Returns:
        the protocol value.

      • title

        String title()
        Gets the title property: Backend Title.
        Returns:
        the title value.

      • description

        String description()
        Gets the description property: Backend Description.
        Returns:
        the description value.

      • resourceId

        String resourceId()
        Gets the resourceId property: Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
        Returns:
        the resourceId value.

      • properties

        BackendProperties properties()
        Gets the properties property: Backend Properties contract.
        Returns:
        the properties value.

      • credentials

        BackendCredentialsContract credentials()
        Gets the credentials property: Backend Credentials Contract Properties.
        Returns:
        the credentials value.

      • proxy

        BackendProxyContract proxy()
        Gets the proxy property: Backend Proxy Contract Properties.
        Returns:
        the proxy value.

      • tls

        BackendTlsProperties tls()
        Gets the tls property: Backend TLS Properties.
        Returns:
        the tls value.

      • innerModel

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

      • update

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

      • refresh

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

      • refresh

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

      • reconnect

        void reconnect()
        Notifies the APIM proxy to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.
        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.

      • reconnectWithResponse

        com.azure.core.http.rest.Response<Void> reconnectWithResponse​(BackendReconnectContract parameters,
                                                              com.azure.core.util.Context context)
        Notifies the APIM proxy to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.
        Parameters:
        parameters - Reconnect request 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.