Package com.azure.resourcemanager.apimanagement.fluent

Interface GatewaysClient

  • public interface GatewaysClient
    An instance of this class provides access to all the operations defined in GatewaysClient.

    • Method Detail

      • listByService

        com.azure.core.http.rest.PagedIterable<GatewayContractInner> 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<GatewayContractInner> 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

        GatewayContractInner 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

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

      • createOrUpdate

        GatewayContractInner createOrUpdate​(String resourceGroupName,
                                    String serviceName,
                                    String gatewayId,
                                    GatewayContractInner parameters)
        Creates or updates a Gateway to be used in Api Management instance.
        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 details.
        Returns:
        gateway details.
        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.

      • createOrUpdateWithResponse

        GatewaysCreateOrUpdateResponse createOrUpdateWithResponse​(String resourceGroupName,
                                                          String serviceName,
                                                          String gatewayId,
                                                          GatewayContractInner parameters,
                                                          String ifMatch,
                                                          com.azure.core.util.Context context)
        Creates or updates a Gateway to be used in Api Management instance.
        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 details.
        ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.
        context - The context to associate with this operation.
        Returns:
        gateway details.
        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.

      • update

        GatewayContractInner update​(String resourceGroupName,
                            String serviceName,
                            String gatewayId,
                            String ifMatch,
                            GatewayContractInner parameters)
        Updates 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'.
        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.
        parameters - Gateway details.
        Returns:
        gateway details.
        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.

      • updateWithResponse

        GatewaysUpdateResponse updateWithResponse​(String resourceGroupName,
                                          String serviceName,
                                          String gatewayId,
                                          String ifMatch,
                                          GatewayContractInner parameters,
                                          com.azure.core.util.Context context)
        Updates 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'.
        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.
        parameters - Gateway details.
        context - The context to associate with this operation.
        Returns:
        gateway details.
        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

        GatewayKeysContractInner 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

        GatewaysListKeysResponse 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

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