Package com.azure.resourcemanager.apimanagement.models

Interface Apis

  • public interface Apis
    Resource collection API of Apis.

    • Method Detail

      • listByService

        com.azure.core.http.rest.PagedIterable<ApiContract> listByService​(String resourceGroupName,
                                                                  String serviceName)
        Lists all APIs of the API Management service instance.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        Returns:
        paged API 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<ApiContract> listByService​(String resourceGroupName,
                                                                  String serviceName,
                                                                  String filter,
                                                                  Integer top,
                                                                  Integer skip,
                                                                  String tags,
                                                                  Boolean expandApiVersionSet,
                                                                  com.azure.core.util.Context context)
        Lists all APIs of the API Management 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>| displayName | 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>| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| isCurrent | filter | eq, ne | |</br>.
        top - Number of records to return.
        skip - Number of records to skip.
        tags - Include tags in the response.
        expandApiVersionSet - Include full ApiVersionSet resource in response.
        context - The context to associate with this operation.
        Returns:
        paged API 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 apiId)
        Gets the entity state (Etag) version of the API specified by its identifier.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
        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

        ApisGetEntityTagResponse getEntityTagWithResponse​(String resourceGroupName,
                                                  String serviceName,
                                                  String apiId,
                                                  com.azure.core.util.Context context)
        Gets the entity state (Etag) version of the API specified by its identifier.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
        context - The context to associate with this operation.
        Returns:
        the entity state (Etag) version of the API 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

        ApiContract get​(String resourceGroupName,
                String serviceName,
                String apiId)
        Gets the details of the API specified by its identifier.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
        Returns:
        the details of the API 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<ApiContract> getWithResponse​(String resourceGroupName,
                                                               String serviceName,
                                                               String apiId,
                                                               com.azure.core.util.Context context)
        Gets the details of the API specified by its identifier.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
        context - The context to associate with this operation.
        Returns:
        the details of the API 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 apiId,
            String ifMatch)
        Deletes the specified API of the API Management service instance.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
        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 apiId,
                                                           String ifMatch,
                                                           Boolean deleteRevisions,
                                                           com.azure.core.util.Context context)
        Deletes the specified API of the API Management service instance.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
        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.
        deleteRevisions - Delete all revisions of the Api.
        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.

      • listByTags

        com.azure.core.http.rest.PagedIterable<TagResourceContract> listByTags​(String resourceGroupName,
                                                                       String serviceName)
        Lists a collection of apis associated with tags.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        Returns:
        paged Tag 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.

      • listByTags

        com.azure.core.http.rest.PagedIterable<TagResourceContract> listByTags​(String resourceGroupName,
                                                                       String serviceName,
                                                                       String filter,
                                                                       Integer top,
                                                                       Integer skip,
                                                                       Boolean includeNotTaggedApis,
                                                                       com.azure.core.util.Context context)
        Lists a collection of apis associated with tags.
        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>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| path | 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>| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| isCurrent | filter | eq | |</br>.
        top - Number of records to return.
        skip - Number of records to skip.
        includeNotTaggedApis - Include not tagged APIs.
        context - The context to associate with this operation.
        Returns:
        paged Tag 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.

      • getById

        ApiContract getById​(String id)
        Gets the details of the API specified by its identifier.
        Parameters:
        id - the resource ID.
        Returns:
        the details of the API 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<ApiContract> getByIdWithResponse​(String id,
                                                                   com.azure.core.util.Context context)
        Gets the details of the API specified by its identifier.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        the details of the API 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 the specified API of the API Management service instance.
        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,
                                                               Boolean deleteRevisions,
                                                               com.azure.core.util.Context context)
        Deletes the specified API of the API Management service instance.
        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.
        deleteRevisions - Delete all revisions of the Api.
        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

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