Package com.azure.resourcemanager.resources.fluent

Interface TagOperationsClient

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

    • Method Detail

      • deleteValueWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Void>> deleteValueWithResponseAsync​(String tagName,
                                                                           String tagValue)
        This operation allows deleting a value from the list of predefined values for an existing predefined tag name. The value being deleted must not be in use as a tag value for the given tag name for any resource.
        Parameters:
        tagName - The name of the tag.
        tagValue - The value of the tag to delete.
        Returns:
        the Response on successful completion of Mono.
        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.

      • deleteValueAsync

        Mono<Void> deleteValueAsync​(String tagName,
                            String tagValue)
        This operation allows deleting a value from the list of predefined values for an existing predefined tag name. The value being deleted must not be in use as a tag value for the given tag name for any resource.
        Parameters:
        tagName - The name of the tag.
        tagValue - The value of the tag to delete.
        Returns:
        A Mono that completes when a successful response is received.
        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.

      • deleteValue

        void deleteValue​(String tagName,
                 String tagValue)
        This operation allows deleting a value from the list of predefined values for an existing predefined tag name. The value being deleted must not be in use as a tag value for the given tag name for any resource.
        Parameters:
        tagName - The name of the tag.
        tagValue - The value of the tag to delete.
        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.

      • deleteValueWithResponse

        com.azure.core.http.rest.Response<Void> deleteValueWithResponse​(String tagName,
                                                                String tagValue,
                                                                com.azure.core.util.Context context)
        This operation allows deleting a value from the list of predefined values for an existing predefined tag name. The value being deleted must not be in use as a tag value for the given tag name for any resource.
        Parameters:
        tagName - The name of the tag.
        tagValue - The value of the tag to delete.
        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.

      • createOrUpdateValueWithResponseAsync

        Mono<com.azure.core.http.rest.Response<TagValueInner>> createOrUpdateValueWithResponseAsync​(String tagName,
                                                                                            String tagValue)
        This operation allows adding a value to the list of predefined values for an existing predefined tag name. A tag value can have a maximum of 256 characters.
        Parameters:
        tagName - The name of the tag.
        tagValue - The value of the tag to create.
        Returns:
        tag information along with Response on successful completion of Mono.
        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.

      • createOrUpdateValueAsync

        Mono<TagValueInner> createOrUpdateValueAsync​(String tagName,
                                             String tagValue)
        This operation allows adding a value to the list of predefined values for an existing predefined tag name. A tag value can have a maximum of 256 characters.
        Parameters:
        tagName - The name of the tag.
        tagValue - The value of the tag to create.
        Returns:
        tag information on successful completion of Mono.
        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.

      • createOrUpdateValue

        TagValueInner createOrUpdateValue​(String tagName,
                                  String tagValue)
        This operation allows adding a value to the list of predefined values for an existing predefined tag name. A tag value can have a maximum of 256 characters.
        Parameters:
        tagName - The name of the tag.
        tagValue - The value of the tag to create.
        Returns:
        tag information.
        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.

      • createOrUpdateValueWithResponse

        com.azure.core.http.rest.Response<TagValueInner> createOrUpdateValueWithResponse​(String tagName,
                                                                                 String tagValue,
                                                                                 com.azure.core.util.Context context)
        This operation allows adding a value to the list of predefined values for an existing predefined tag name. A tag value can have a maximum of 256 characters.
        Parameters:
        tagName - The name of the tag.
        tagValue - The value of the tag to create.
        context - The context to associate with this operation.
        Returns:
        tag information 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.

      • createOrUpdateWithResponseAsync

        Mono<com.azure.core.http.rest.Response<TagDetailsInner>> createOrUpdateWithResponseAsync​(String tagName)
        This operation allows adding a name to the list of predefined tag names for the given subscription. A tag name can have a maximum of 512 characters and is case-insensitive. Tag names cannot have the following prefixes which are reserved for Azure use: 'microsoft', 'azure', 'windows'.
        Parameters:
        tagName - The name of the tag to create.
        Returns:
        tag details along with Response on successful completion of Mono.
        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.

      • createOrUpdateAsync

        Mono<TagDetailsInner> createOrUpdateAsync​(String tagName)
        This operation allows adding a name to the list of predefined tag names for the given subscription. A tag name can have a maximum of 512 characters and is case-insensitive. Tag names cannot have the following prefixes which are reserved for Azure use: 'microsoft', 'azure', 'windows'.
        Parameters:
        tagName - The name of the tag to create.
        Returns:
        tag details on successful completion of Mono.
        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

        TagDetailsInner createOrUpdate​(String tagName)
        This operation allows adding a name to the list of predefined tag names for the given subscription. A tag name can have a maximum of 512 characters and is case-insensitive. Tag names cannot have the following prefixes which are reserved for Azure use: 'microsoft', 'azure', 'windows'.
        Parameters:
        tagName - The name of the tag to create.
        Returns:
        tag 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

        com.azure.core.http.rest.Response<TagDetailsInner> createOrUpdateWithResponse​(String tagName,
                                                                              com.azure.core.util.Context context)
        This operation allows adding a name to the list of predefined tag names for the given subscription. A tag name can have a maximum of 512 characters and is case-insensitive. Tag names cannot have the following prefixes which are reserved for Azure use: 'microsoft', 'azure', 'windows'.
        Parameters:
        tagName - The name of the tag to create.
        context - The context to associate with this operation.
        Returns:
        tag 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.

      • deleteWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Void>> deleteWithResponseAsync​(String tagName)
        This operation allows deleting a name from the list of predefined tag names for the given subscription. The name being deleted must not be in use as a tag name for any resource. All predefined values for the given name must have already been deleted.
        Parameters:
        tagName - The name of the tag.
        Returns:
        the Response on successful completion of Mono.
        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.

      • deleteAsync

        Mono<Void> deleteAsync​(String tagName)
        This operation allows deleting a name from the list of predefined tag names for the given subscription. The name being deleted must not be in use as a tag name for any resource. All predefined values for the given name must have already been deleted.
        Parameters:
        tagName - The name of the tag.
        Returns:
        A Mono that completes when a successful response is received.
        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 tagName)
        This operation allows deleting a name from the list of predefined tag names for the given subscription. The name being deleted must not be in use as a tag name for any resource. All predefined values for the given name must have already been deleted.
        Parameters:
        tagName - The name of the tag.
        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 tagName,
                                                           com.azure.core.util.Context context)
        This operation allows deleting a name from the list of predefined tag names for the given subscription. The name being deleted must not be in use as a tag name for any resource. All predefined values for the given name must have already been deleted.
        Parameters:
        tagName - The name of the tag.
        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.

      • listAsync

        com.azure.core.http.rest.PagedFlux<TagDetailsInner> listAsync()
        This operation performs a union of predefined tags, resource tags, resource group tags and subscription tags, and returns a summary of usage for each tag name and value under the given subscription. In case of a large number of tags, this operation may return a previously cached result.
        Returns:
        list of subscription tags as paginated response with PagedFlux.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • list

        com.azure.core.http.rest.PagedIterable<TagDetailsInner> list()
        This operation performs a union of predefined tags, resource tags, resource group tags and subscription tags, and returns a summary of usage for each tag name and value under the given subscription. In case of a large number of tags, this operation may return a previously cached result.
        Returns:
        list of subscription tags as paginated response with PagedIterable.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • list

        com.azure.core.http.rest.PagedIterable<TagDetailsInner> list​(com.azure.core.util.Context context)
        This operation performs a union of predefined tags, resource tags, resource group tags and subscription tags, and returns a summary of usage for each tag name and value under the given subscription. In case of a large number of tags, this operation may return a previously cached result.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        list of subscription tags 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.

      • createOrUpdateAtScopeWithResponseAsync

        Mono<com.azure.core.http.rest.Response<TagsResourceInner>> createOrUpdateAtScopeWithResponseAsync​(String scope,
                                                                                                  TagsResourceInner parameters)
        This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.
        Parameters:
        scope - The resource scope.
        parameters - Wrapper resource for tags API requests and responses.
        Returns:
        wrapper resource for tags API requests and responses along with Response on successful completion of Mono.
        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.

      • createOrUpdateAtScopeAsync

        Mono<TagsResourceInner> createOrUpdateAtScopeAsync​(String scope,
                                                   TagsResourceInner parameters)
        This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.
        Parameters:
        scope - The resource scope.
        parameters - Wrapper resource for tags API requests and responses.
        Returns:
        wrapper resource for tags API requests and responses on successful completion of Mono.
        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.

      • createOrUpdateAtScope

        TagsResourceInner createOrUpdateAtScope​(String scope,
                                        TagsResourceInner parameters)
        This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.
        Parameters:
        scope - The resource scope.
        parameters - Wrapper resource for tags API requests and responses.
        Returns:
        wrapper resource for tags API requests and responses.
        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.

      • createOrUpdateAtScopeWithResponse

        com.azure.core.http.rest.Response<TagsResourceInner> createOrUpdateAtScopeWithResponse​(String scope,
                                                                                       TagsResourceInner parameters,
                                                                                       com.azure.core.util.Context context)
        This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.
        Parameters:
        scope - The resource scope.
        parameters - Wrapper resource for tags API requests and responses.
        context - The context to associate with this operation.
        Returns:
        wrapper resource for tags API requests and responses 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.

      • updateAtScopeWithResponseAsync

        Mono<com.azure.core.http.rest.Response<TagsResourceInner>> updateAtScopeWithResponseAsync​(String scope,
                                                                                          TagsPatchResource parameters)
        This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags at the end of the operation. The 'replace' option replaces the entire set of existing tags with a new set. The 'merge' option allows adding tags with new names and updating the values of tags with existing names. The 'delete' option allows selectively deleting tags based on given names or name/value pairs.
        Parameters:
        scope - The resource scope.
        parameters - Wrapper resource for tags patch API request only.
        Returns:
        wrapper resource for tags API requests and responses along with Response on successful completion of Mono.
        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.

      • updateAtScopeAsync

        Mono<TagsResourceInner> updateAtScopeAsync​(String scope,
                                           TagsPatchResource parameters)
        This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags at the end of the operation. The 'replace' option replaces the entire set of existing tags with a new set. The 'merge' option allows adding tags with new names and updating the values of tags with existing names. The 'delete' option allows selectively deleting tags based on given names or name/value pairs.
        Parameters:
        scope - The resource scope.
        parameters - Wrapper resource for tags patch API request only.
        Returns:
        wrapper resource for tags API requests and responses on successful completion of Mono.
        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.

      • updateAtScope

        TagsResourceInner updateAtScope​(String scope,
                                TagsPatchResource parameters)
        This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags at the end of the operation. The 'replace' option replaces the entire set of existing tags with a new set. The 'merge' option allows adding tags with new names and updating the values of tags with existing names. The 'delete' option allows selectively deleting tags based on given names or name/value pairs.
        Parameters:
        scope - The resource scope.
        parameters - Wrapper resource for tags patch API request only.
        Returns:
        wrapper resource for tags API requests and responses.
        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.

      • updateAtScopeWithResponse

        com.azure.core.http.rest.Response<TagsResourceInner> updateAtScopeWithResponse​(String scope,
                                                                               TagsPatchResource parameters,
                                                                               com.azure.core.util.Context context)
        This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags at the end of the operation. The 'replace' option replaces the entire set of existing tags with a new set. The 'merge' option allows adding tags with new names and updating the values of tags with existing names. The 'delete' option allows selectively deleting tags based on given names or name/value pairs.
        Parameters:
        scope - The resource scope.
        parameters - Wrapper resource for tags patch API request only.
        context - The context to associate with this operation.
        Returns:
        wrapper resource for tags API requests and responses 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.

      • getAtScopeWithResponseAsync

        Mono<com.azure.core.http.rest.Response<TagsResourceInner>> getAtScopeWithResponseAsync​(String scope)
        Gets the entire set of tags on a resource or subscription.
        Parameters:
        scope - The resource scope.
        Returns:
        the entire set of tags on a resource or subscription along with Response on successful completion of Mono.
        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.

      • getAtScopeAsync

        Mono<TagsResourceInner> getAtScopeAsync​(String scope)
        Gets the entire set of tags on a resource or subscription.
        Parameters:
        scope - The resource scope.
        Returns:
        the entire set of tags on a resource or subscription on successful completion of Mono.
        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.

      • getAtScope

        TagsResourceInner getAtScope​(String scope)
        Gets the entire set of tags on a resource or subscription.
        Parameters:
        scope - The resource scope.
        Returns:
        the entire set of tags on a resource or subscription.
        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.

      • getAtScopeWithResponse

        com.azure.core.http.rest.Response<TagsResourceInner> getAtScopeWithResponse​(String scope,
                                                                            com.azure.core.util.Context context)
        Gets the entire set of tags on a resource or subscription.
        Parameters:
        scope - The resource scope.
        context - The context to associate with this operation.
        Returns:
        the entire set of tags on a resource or subscription 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.

      • deleteAtScopeWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Void>> deleteAtScopeWithResponseAsync​(String scope)
        Deletes the entire set of tags on a resource or subscription.
        Parameters:
        scope - The resource scope.
        Returns:
        the Response on successful completion of Mono.
        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.

      • deleteAtScopeAsync

        Mono<Void> deleteAtScopeAsync​(String scope)
        Deletes the entire set of tags on a resource or subscription.
        Parameters:
        scope - The resource scope.
        Returns:
        A Mono that completes when a successful response is received.
        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.

      • deleteAtScope

        void deleteAtScope​(String scope)
        Deletes the entire set of tags on a resource or subscription.
        Parameters:
        scope - The resource scope.
        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.

      • deleteAtScopeWithResponse

        com.azure.core.http.rest.Response<Void> deleteAtScopeWithResponse​(String scope,
                                                                  com.azure.core.util.Context context)
        Deletes the entire set of tags on a resource or subscription.
        Parameters:
        scope - The resource scope.
        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.