Package com.azure.resourcemanager.apimanagement.models

Interface Gateways

  • public interface Gateways
    Resource collection API of Gateways.

    • Method Detail

      • listByService

        com.azure.core.http.rest.PagedIterable<GatewayContract> listByService​(String resourceGroupName,
                                                                      String serviceName)
        Lists a collection of gateways registered with service instance.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        Returns:
        paged Gateway list representation as paginated response with PagedIterable.
        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.

      • listByService

        com.azure.core.http.rest.PagedIterable<GatewayContract> listByService​(String resourceGroupName,
                                                                      String serviceName,
                                                                      String filter,
                                                                      Integer top,
                                                                      Integer skip,
                                                                      com.azure.core.util.Context context)
        Lists a collection of gateways registered with service instance.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| region | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>.
        top - Number of records to return.
        skip - Number of records to skip.
        context - The context to associate with this operation.
        Returns:
        paged Gateway list representation as paginated response with PagedIterable.
        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 gatewayId)
        Gets the entity state (Etag) version of the Gateway specified by its identifier.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
        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.

      • getEntityTagWithResponse

        GatewaysGetEntityTagResponse getEntityTagWithResponse​(String resourceGroupName,
                                                      String serviceName,
                                                      String gatewayId,
                                                      com.azure.core.util.Context context)
        Gets the entity state (Etag) version of the Gateway specified by its identifier.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
        context - The context to associate with this operation.
        Returns:
        the entity state (Etag) version of the Gateway 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

        GatewayContract get​(String resourceGroupName,
                    String serviceName,
                    String gatewayId)
        Gets the details of the Gateway specified by its identifier.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
        Returns:
        the details of the Gateway 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.

      • getWithResponse

        com.azure.core.http.rest.Response<GatewayContract> getWithResponse​(String resourceGroupName,
                                                                   String serviceName,
                                                                   String gatewayId,
                                                                   com.azure.core.util.Context context)
        Gets the details of the Gateway specified by its identifier.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
        context - The context to associate with this operation.
        Returns:
        the details of the Gateway 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.

      • delete

        void delete​(String resourceGroupName,
            String serviceName,
            String gatewayId,
            String ifMatch)
        Deletes specific Gateway.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
        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.

      • deleteWithResponse

        com.azure.core.http.rest.Response<Void> deleteWithResponse​(String resourceGroupName,
                                                           String serviceName,
                                                           String gatewayId,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)
        Deletes specific Gateway.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
        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.

      • listKeys

        GatewayKeysContract listKeys​(String resourceGroupName,
                             String serviceName,
                             String gatewayId)
        Retrieves gateway keys.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
        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.

      • listKeysWithResponse

        com.azure.core.http.rest.Response<GatewayKeysContract> listKeysWithResponse​(String resourceGroupName,
                                                                            String serviceName,
                                                                            String gatewayId,
                                                                            com.azure.core.util.Context context)
        Retrieves gateway keys.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
        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​(String resourceGroupName,
                   String serviceName,
                   String gatewayId,
                   GatewayKeyRegenerationRequestContract parameters)
        Regenerates specified gateway key invalidating any tokens created with it.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
        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​(String resourceGroupName,
                                                                  String serviceName,
                                                                  String gatewayId,
                                                                  GatewayKeyRegenerationRequestContract parameters,
                                                                  com.azure.core.util.Context context)
        Regenerates specified gateway key invalidating any tokens created with it.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
        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​(String resourceGroupName,
                                   String serviceName,
                                   String gatewayId,
                                   GatewayTokenRequestContract parameters)
        Gets the Shared Access Authorization Token for the gateway.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
        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​(String resourceGroupName,
                                                                                  String serviceName,
                                                                                  String gatewayId,
                                                                                  GatewayTokenRequestContract parameters,
                                                                                  com.azure.core.util.Context context)
        Gets the Shared Access Authorization Token for the gateway.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
        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.

      • getById

        GatewayContract getById​(String id)
        Gets the details of the Gateway specified by its identifier.
        Parameters:
        id - the resource ID.
        Returns:
        the details of the Gateway 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.

      • getByIdWithResponse

        com.azure.core.http.rest.Response<GatewayContract> getByIdWithResponse​(String id,
                                                                       com.azure.core.util.Context context)
        Gets the details of the Gateway specified by its identifier.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        the details of the Gateway 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.

      • deleteById

        void deleteById​(String id)
        Deletes specific Gateway.
        Parameters:
        id - the resource ID.
        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.

      • deleteByIdWithResponse

        com.azure.core.http.rest.Response<Void> deleteByIdWithResponse​(String id,
                                                               String ifMatch,
                                                               com.azure.core.util.Context context)
        Deletes specific Gateway.
        Parameters:
        id - the resource ID.
        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.

      • define

        GatewayContract.DefinitionStages.Blank define​(String name)
        Begins definition for a new GatewayContract resource.
        Parameters:
        name - resource name.
        Returns:
        the first stage of the new GatewayContract definition.