Package com.azure.resourcemanager.apimanagement.models

Interface Tags

  • public interface Tags
    Resource collection API of Tags.

    • Method Detail

      • listByOperation

        com.azure.core.http.rest.PagedIterable<TagContract> listByOperation​(String resourceGroupName,
                                                                    String serviceName,
                                                                    String apiId,
                                                                    String operationId)
        Lists all Tags associated with the Operation.
        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.
        operationId - Operation identifier within an API. Must be unique in the current API Management service instance.
        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.

      • listByOperation

        com.azure.core.http.rest.PagedIterable<TagContract> listByOperation​(String resourceGroupName,
                                                                    String serviceName,
                                                                    String apiId,
                                                                    String operationId,
                                                                    String filter,
                                                                    Integer top,
                                                                    Integer skip,
                                                                    com.azure.core.util.Context context)
        Lists all Tags associated with the Operation.
        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.
        operationId - Operation identifier within an API. Must be unique in the current API Management service instance.
        filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| name | 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 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.

      • getEntityStateByOperation

        void getEntityStateByOperation​(String resourceGroupName,
                               String serviceName,
                               String apiId,
                               String operationId,
                               String tagId)
        Gets the entity state version of the tag 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.
        operationId - Operation identifier within an API. Must be unique in the current API Management service instance.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        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.

      • getEntityStateByOperationWithResponse

        TagsGetEntityStateByOperationResponse getEntityStateByOperationWithResponse​(String resourceGroupName,
                                                                            String serviceName,
                                                                            String apiId,
                                                                            String operationId,
                                                                            String tagId,
                                                                            com.azure.core.util.Context context)
        Gets the entity state version of the tag 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.
        operationId - Operation identifier within an API. Must be unique in the current API Management service instance.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        context - The context to associate with this operation.
        Returns:
        the entity state version of the tag 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.

      • getByOperation

        TagContract getByOperation​(String resourceGroupName,
                           String serviceName,
                           String apiId,
                           String operationId,
                           String tagId)
        Get tag associated with the Operation.
        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.
        operationId - Operation identifier within an API. Must be unique in the current API Management service instance.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        Returns:
        tag associated with the Operation.
        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.

      • getByOperationWithResponse

        com.azure.core.http.rest.Response<TagContract> getByOperationWithResponse​(String resourceGroupName,
                                                                          String serviceName,
                                                                          String apiId,
                                                                          String operationId,
                                                                          String tagId,
                                                                          com.azure.core.util.Context context)
        Get tag associated with the Operation.
        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.
        operationId - Operation identifier within an API. Must be unique in the current API Management service instance.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        context - The context to associate with this operation.
        Returns:
        tag associated with the Operation.
        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.

      • assignToOperation

        TagContract assignToOperation​(String resourceGroupName,
                              String serviceName,
                              String apiId,
                              String operationId,
                              String tagId)
        Assign tag to the Operation.
        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.
        operationId - Operation identifier within an API. Must be unique in the current API Management service instance.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        Returns:
        tag Contract 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.

      • assignToOperationWithResponse

        com.azure.core.http.rest.Response<TagContract> assignToOperationWithResponse​(String resourceGroupName,
                                                                             String serviceName,
                                                                             String apiId,
                                                                             String operationId,
                                                                             String tagId,
                                                                             com.azure.core.util.Context context)
        Assign tag to the Operation.
        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.
        operationId - Operation identifier within an API. Must be unique in the current API Management service instance.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        context - The context to associate with this operation.
        Returns:
        tag Contract details 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.

      • detachFromOperation

        void detachFromOperation​(String resourceGroupName,
                         String serviceName,
                         String apiId,
                         String operationId,
                         String tagId)
        Detach the tag from the Operation.
        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.
        operationId - Operation identifier within an API. Must be unique in the current API Management service instance.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        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.

      • detachFromOperationWithResponse

        com.azure.core.http.rest.Response<Void> detachFromOperationWithResponse​(String resourceGroupName,
                                                                        String serviceName,
                                                                        String apiId,
                                                                        String operationId,
                                                                        String tagId,
                                                                        com.azure.core.util.Context context)
        Detach the tag from the Operation.
        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.
        operationId - Operation identifier within an API. Must be unique in the current API Management service instance.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        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.

      • listByApi

        com.azure.core.http.rest.PagedIterable<TagContract> listByApi​(String resourceGroupName,
                                                              String serviceName,
                                                              String apiId)
        Lists all Tags associated with the API.
        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:
        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.

      • listByApi

        com.azure.core.http.rest.PagedIterable<TagContract> listByApi​(String resourceGroupName,
                                                              String serviceName,
                                                              String apiId,
                                                              String filter,
                                                              Integer top,
                                                              Integer skip,
                                                              com.azure.core.util.Context context)
        Lists all Tags associated with the API.
        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.
        filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| name | 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 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.

      • getEntityStateByApi

        void getEntityStateByApi​(String resourceGroupName,
                         String serviceName,
                         String apiId,
                         String tagId)
        Gets the entity state version of the tag 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.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        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.

      • getEntityStateByApiWithResponse

        TagsGetEntityStateByApiResponse getEntityStateByApiWithResponse​(String resourceGroupName,
                                                                String serviceName,
                                                                String apiId,
                                                                String tagId,
                                                                com.azure.core.util.Context context)
        Gets the entity state version of the tag 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.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        context - The context to associate with this operation.
        Returns:
        the entity state version of the tag 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.

      • getByApi

        TagContract getByApi​(String resourceGroupName,
                     String serviceName,
                     String apiId,
                     String tagId)
        Get tag associated with the API.
        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.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        Returns:
        tag associated with the API.
        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.

      • getByApiWithResponse

        com.azure.core.http.rest.Response<TagContract> getByApiWithResponse​(String resourceGroupName,
                                                                    String serviceName,
                                                                    String apiId,
                                                                    String tagId,
                                                                    com.azure.core.util.Context context)
        Get tag associated with the API.
        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.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        context - The context to associate with this operation.
        Returns:
        tag associated with the API.
        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.

      • assignToApi

        TagContract assignToApi​(String resourceGroupName,
                        String serviceName,
                        String apiId,
                        String tagId)
        Assign tag to the Api.
        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.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        Returns:
        tag Contract 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.

      • assignToApiWithResponse

        com.azure.core.http.rest.Response<TagContract> assignToApiWithResponse​(String resourceGroupName,
                                                                       String serviceName,
                                                                       String apiId,
                                                                       String tagId,
                                                                       com.azure.core.util.Context context)
        Assign tag to the Api.
        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.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        context - The context to associate with this operation.
        Returns:
        tag Contract 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.

      • detachFromApi

        void detachFromApi​(String resourceGroupName,
                   String serviceName,
                   String apiId,
                   String tagId)
        Detach the tag from the Api.
        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.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        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.

      • detachFromApiWithResponse

        com.azure.core.http.rest.Response<Void> detachFromApiWithResponse​(String resourceGroupName,
                                                                  String serviceName,
                                                                  String apiId,
                                                                  String tagId,
                                                                  com.azure.core.util.Context context)
        Detach the tag from the Api.
        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.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        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.

      • listByProduct

        com.azure.core.http.rest.PagedIterable<TagContract> listByProduct​(String resourceGroupName,
                                                                  String serviceName,
                                                                  String productId)
        Lists all Tags associated with the Product.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        productId - Product identifier. Must be unique in the current API Management service instance.
        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.

      • listByProduct

        com.azure.core.http.rest.PagedIterable<TagContract> listByProduct​(String resourceGroupName,
                                                                  String serviceName,
                                                                  String productId,
                                                                  String filter,
                                                                  Integer top,
                                                                  Integer skip,
                                                                  com.azure.core.util.Context context)
        Lists all Tags associated with the Product.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        productId - Product identifier. Must be unique in the current API Management service instance.
        filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| name | 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 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.

      • getEntityStateByProduct

        void getEntityStateByProduct​(String resourceGroupName,
                             String serviceName,
                             String productId,
                             String tagId)
        Gets the entity state version of the tag specified by its identifier.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        productId - Product identifier. Must be unique in the current API Management service instance.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        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.

      • getEntityStateByProductWithResponse

        TagsGetEntityStateByProductResponse getEntityStateByProductWithResponse​(String resourceGroupName,
                                                                        String serviceName,
                                                                        String productId,
                                                                        String tagId,
                                                                        com.azure.core.util.Context context)
        Gets the entity state version of the tag specified by its identifier.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        productId - Product identifier. Must be unique in the current API Management service instance.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        context - The context to associate with this operation.
        Returns:
        the entity state version of the tag 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.

      • getByProduct

        TagContract getByProduct​(String resourceGroupName,
                         String serviceName,
                         String productId,
                         String tagId)
        Get tag associated with the Product.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        productId - Product identifier. Must be unique in the current API Management service instance.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        Returns:
        tag associated with the Product.
        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.

      • getByProductWithResponse

        com.azure.core.http.rest.Response<TagContract> getByProductWithResponse​(String resourceGroupName,
                                                                        String serviceName,
                                                                        String productId,
                                                                        String tagId,
                                                                        com.azure.core.util.Context context)
        Get tag associated with the Product.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        productId - Product identifier. Must be unique in the current API Management service instance.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        context - The context to associate with this operation.
        Returns:
        tag associated with the Product.
        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.

      • assignToProduct

        TagContract assignToProduct​(String resourceGroupName,
                            String serviceName,
                            String productId,
                            String tagId)
        Assign tag to the Product.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        productId - Product identifier. Must be unique in the current API Management service instance.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        Returns:
        tag Contract 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.

      • assignToProductWithResponse

        com.azure.core.http.rest.Response<TagContract> assignToProductWithResponse​(String resourceGroupName,
                                                                           String serviceName,
                                                                           String productId,
                                                                           String tagId,
                                                                           com.azure.core.util.Context context)
        Assign tag to the Product.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        productId - Product identifier. Must be unique in the current API Management service instance.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        context - The context to associate with this operation.
        Returns:
        tag Contract details 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.

      • detachFromProduct

        void detachFromProduct​(String resourceGroupName,
                       String serviceName,
                       String productId,
                       String tagId)
        Detach the tag from the Product.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        productId - Product identifier. Must be unique in the current API Management service instance.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        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.

      • detachFromProductWithResponse

        com.azure.core.http.rest.Response<Void> detachFromProductWithResponse​(String resourceGroupName,
                                                                      String serviceName,
                                                                      String productId,
                                                                      String tagId,
                                                                      com.azure.core.util.Context context)
        Detach the tag from the Product.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        productId - Product identifier. Must be unique in the current API Management service instance.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        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.

      • listByService

        com.azure.core.http.rest.PagedIterable<TagContract> listByService​(String resourceGroupName,
                                                                  String serviceName)
        Lists a collection of tags defined within a service instance.
        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.

      • listByService

        com.azure.core.http.rest.PagedIterable<TagContract> listByService​(String resourceGroupName,
                                                                  String serviceName,
                                                                  String filter,
                                                                  Integer top,
                                                                  Integer skip,
                                                                  String scope,
                                                                  com.azure.core.util.Context context)
        Lists a collection of tags defined within a 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>.
        top - Number of records to return.
        skip - Number of records to skip.
        scope - Scope like 'apis', 'products' or 'apis/{apiId}.
        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.

      • getEntityState

        void getEntityState​(String resourceGroupName,
                    String serviceName,
                    String tagId)
        Gets the entity state version of the tag specified by its identifier.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        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.

      • getEntityStateWithResponse

        TagsGetEntityStateResponse getEntityStateWithResponse​(String resourceGroupName,
                                                      String serviceName,
                                                      String tagId,
                                                      com.azure.core.util.Context context)
        Gets the entity state version of the tag specified by its identifier.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        context - The context to associate with this operation.
        Returns:
        the entity state version of the tag 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

        TagContract get​(String resourceGroupName,
                String serviceName,
                String tagId)
        Gets the details of the tag specified by its identifier.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        Returns:
        the details of the tag 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<TagContract> getWithResponse​(String resourceGroupName,
                                                               String serviceName,
                                                               String tagId,
                                                               com.azure.core.util.Context context)
        Gets the details of the tag specified by its identifier.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        context - The context to associate with this operation.
        Returns:
        the details of the tag 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 tagId,
            String ifMatch)
        Deletes specific tag of the API Management service instance.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        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 tagId,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)
        Deletes specific tag of the API Management service instance.
        Parameters:
        resourceGroupName - The name of the resource group.
        serviceName - The name of the API Management service.
        tagId - Tag identifier. Must be unique in the current API Management service instance.
        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.

      • getById

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

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