Package com.azure.resourcemanager.apimanagement.models

Interface GatewayContract

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

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

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

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

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

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

      • regenerateKey

        void regenerateKey​(GatewayKeyRegenerationRequestContract parameters)
        Regenerates specified gateway key invalidating any tokens created with it.
        Parameters:
        parameters - Gateway key regeneration request contract 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.

      • 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 - Gateway key regeneration request contract properties.
        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.

      • generateToken

        GatewayTokenContract generateToken​(GatewayTokenRequestContract parameters)
        Gets the Shared Access Authorization Token for the gateway.
        Parameters:
        parameters - Gateway token request contract properties.
        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.

      • 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 - Gateway token request contract properties.
        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.