TagOperationsClient Interface

public interface TagOperationsClient

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

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<TagsResourceInner>,TagsResourceInner> beginCreateOrUpdateAtScope(String scope, TagsResourceInner parameters)

Creates or updates the entire set of tags on a resource or subscription.

abstract SyncPoller<PollResult<TagsResourceInner>,TagsResourceInner> beginCreateOrUpdateAtScope(String scope, TagsResourceInner parameters, Context context)

Creates or updates the entire set of tags on a resource or subscription.

abstract PollerFlux<PollResult<TagsResourceInner>,TagsResourceInner> beginCreateOrUpdateAtScopeAsync(String scope, TagsResourceInner parameters)

Creates or updates the entire set of tags on a resource or subscription.

abstract SyncPoller<PollResult<Void>,Void> beginDeleteAtScope(String scope)

Deletes the entire set of tags on a resource or subscription.

abstract SyncPoller<PollResult<Void>,Void> beginDeleteAtScope(String scope, Context context)

Deletes the entire set of tags on a resource or subscription.

abstract PollerFlux<PollResult<Void>,Void> beginDeleteAtScopeAsync(String scope)

Deletes the entire set of tags on a resource or subscription.

abstract SyncPoller<PollResult<TagsResourceInner>,TagsResourceInner> beginUpdateAtScope(String scope, TagsPatchResource parameters)

Selectively updates the set of tags on a resource or subscription.

abstract SyncPoller<PollResult<TagsResourceInner>,TagsResourceInner> beginUpdateAtScope(String scope, TagsPatchResource parameters, Context context)

Selectively updates the set of tags on a resource or subscription.

abstract PollerFlux<PollResult<TagsResourceInner>,TagsResourceInner> beginUpdateAtScopeAsync(String scope, TagsPatchResource parameters)

Selectively updates the set of tags on a resource or subscription.

abstract TagDetailsInner createOrUpdate(String tagName)

Creates a predefined tag name.

abstract Mono<TagDetailsInner> createOrUpdateAsync(String tagName)

Creates a predefined tag name.

abstract TagsResourceInner createOrUpdateAtScope(String scope, TagsResourceInner parameters)

Creates or updates the entire set of tags on a resource or subscription.

abstract TagsResourceInner createOrUpdateAtScope(String scope, TagsResourceInner parameters, Context context)

Creates or updates the entire set of tags on a resource or subscription.

abstract Mono<TagsResourceInner> createOrUpdateAtScopeAsync(String scope, TagsResourceInner parameters)

Creates or updates the entire set of tags on a resource or subscription.

abstract Mono<Response<Flux<ByteBuffer>>> createOrUpdateAtScopeWithResponseAsync(String scope, TagsResourceInner parameters)

Creates or updates the entire set of tags on a resource or subscription.

abstract TagValueInner createOrUpdateValue(String tagName, String tagValue)

Creates a predefined value for a predefined tag name.

abstract Mono<TagValueInner> createOrUpdateValueAsync(String tagName, String tagValue)

Creates a predefined value for a predefined tag name.

abstract Response<TagValueInner> createOrUpdateValueWithResponse(String tagName, String tagValue, Context context)

Creates a predefined value for a predefined tag name.

abstract Mono<Response<TagValueInner>> createOrUpdateValueWithResponseAsync(String tagName, String tagValue)

Creates a predefined value for a predefined tag name.

abstract Response<TagDetailsInner> createOrUpdateWithResponse(String tagName, Context context)

Creates a predefined tag name.

abstract Mono<Response<TagDetailsInner>> createOrUpdateWithResponseAsync(String tagName)

Creates a predefined tag name.

abstract void delete(String tagName)

Deletes a predefined tag name.

abstract Mono<Void> deleteAsync(String tagName)

Deletes a predefined tag name.

abstract void deleteAtScope(String scope)

Deletes the entire set of tags on a resource or subscription.

abstract void deleteAtScope(String scope, Context context)

Deletes the entire set of tags on a resource or subscription.

abstract Mono<Void> deleteAtScopeAsync(String scope)

Deletes the entire set of tags on a resource or subscription.

abstract Mono<Response<Flux<ByteBuffer>>> deleteAtScopeWithResponseAsync(String scope)

Deletes the entire set of tags on a resource or subscription.

abstract void deleteValue(String tagName, String tagValue)

Deletes a predefined tag value for a predefined tag name.

abstract Mono<Void> deleteValueAsync(String tagName, String tagValue)

Deletes a predefined tag value for a predefined tag name.

abstract Response<Void> deleteValueWithResponse(String tagName, String tagValue, Context context)

Deletes a predefined tag value for a predefined tag name.

abstract Mono<Response<Void>> deleteValueWithResponseAsync(String tagName, String tagValue)

Deletes a predefined tag value for a predefined tag name.

abstract Response<Void> deleteWithResponse(String tagName, Context context)

Deletes a predefined tag name.

abstract Mono<Response<Void>> deleteWithResponseAsync(String tagName)

Deletes a predefined tag name.

abstract TagsResourceInner getAtScope(String scope)

Gets the entire set of tags on a resource or subscription.

abstract Mono<TagsResourceInner> getAtScopeAsync(String scope)

Gets the entire set of tags on a resource or subscription.

abstract Response<TagsResourceInner> getAtScopeWithResponse(String scope, Context context)

Gets the entire set of tags on a resource or subscription.

abstract Mono<Response<TagsResourceInner>> getAtScopeWithResponseAsync(String scope)

Gets the entire set of tags on a resource or subscription.

abstract PagedIterable<TagDetailsInner> list()

Gets a summary of tag usage under the subscription.

abstract PagedIterable<TagDetailsInner> list(Context context)

Gets a summary of tag usage under the subscription.

abstract PagedFlux<TagDetailsInner> listAsync()

Gets a summary of tag usage under the subscription.

abstract TagsResourceInner updateAtScope(String scope, TagsPatchResource parameters)

Selectively updates the set of tags on a resource or subscription.

abstract TagsResourceInner updateAtScope(String scope, TagsPatchResource parameters, Context context)

Selectively updates the set of tags on a resource or subscription.

abstract Mono<TagsResourceInner> updateAtScopeAsync(String scope, TagsPatchResource parameters)

Selectively updates the set of tags on a resource or subscription.

abstract Mono<Response<Flux<ByteBuffer>>> updateAtScopeWithResponseAsync(String scope, TagsPatchResource parameters)

Selectively updates the set of tags on a resource or subscription.

Method Details

beginCreateOrUpdateAtScope

public abstract SyncPoller,TagsResourceInner> beginCreateOrUpdateAtScope(String scope, TagsResourceInner parameters)

Creates or updates the entire set of tags on a resource or subscription. 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 - The parameters parameter.

Returns:

the SyncPoller<T,U> for polling of wrapper resource for tags API requests and responses.

beginCreateOrUpdateAtScope

public abstract SyncPoller,TagsResourceInner> beginCreateOrUpdateAtScope(String scope, TagsResourceInner parameters, Context context)

Creates or updates the entire set of tags on a resource or subscription. 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 - The parameters parameter.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of wrapper resource for tags API requests and responses.

beginCreateOrUpdateAtScopeAsync

public abstract PollerFlux,TagsResourceInner> beginCreateOrUpdateAtScopeAsync(String scope, TagsResourceInner parameters)

Creates or updates the entire set of tags on a resource or subscription. 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 - The parameters parameter.

Returns:

the PollerFlux<T,U> for polling of wrapper resource for tags API requests and responses.

beginDeleteAtScope

public abstract SyncPoller,Void> beginDeleteAtScope(String scope)

Deletes the entire set of tags on a resource or subscription.

Parameters:

scope - The resource scope.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDeleteAtScope

public abstract SyncPoller,Void> beginDeleteAtScope(String scope, 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 SyncPoller<T,U> for polling of long-running operation.

beginDeleteAtScopeAsync

public abstract PollerFlux,Void> beginDeleteAtScopeAsync(String scope)

Deletes the entire set of tags on a resource or subscription.

Parameters:

scope - The resource scope.

Returns:

the PollerFlux<T,U> for polling of long-running operation.

beginUpdateAtScope

public abstract SyncPoller,TagsResourceInner> beginUpdateAtScope(String scope, TagsPatchResource parameters)

Selectively updates the set of tags on a resource or subscription. 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 - The parameters parameter.

Returns:

the SyncPoller<T,U> for polling of wrapper resource for tags API requests and responses.

beginUpdateAtScope

public abstract SyncPoller,TagsResourceInner> beginUpdateAtScope(String scope, TagsPatchResource parameters, Context context)

Selectively updates the set of tags on a resource or subscription. 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 - The parameters parameter.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of wrapper resource for tags API requests and responses.

beginUpdateAtScopeAsync

public abstract PollerFlux,TagsResourceInner> beginUpdateAtScopeAsync(String scope, TagsPatchResource parameters)

Selectively updates the set of tags on a resource or subscription. 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 - The parameters parameter.

Returns:

the PollerFlux<T,U> for polling of wrapper resource for tags API requests and responses.

createOrUpdate

public abstract TagDetailsInner createOrUpdate(String tagName)

Creates a predefined tag name. 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.

createOrUpdateAsync

public abstract Mono createOrUpdateAsync(String tagName)

Creates a predefined tag name. 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.

createOrUpdateAtScope

public abstract TagsResourceInner createOrUpdateAtScope(String scope, TagsResourceInner parameters)

Creates or updates the entire set of tags on a resource or subscription. 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 - The parameters parameter.

Returns:

wrapper resource for tags API requests and responses.

createOrUpdateAtScope

public abstract TagsResourceInner createOrUpdateAtScope(String scope, TagsResourceInner parameters, Context context)

Creates or updates the entire set of tags on a resource or subscription. 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 - The parameters parameter.
context - The context to associate with this operation.

Returns:

wrapper resource for tags API requests and responses.

createOrUpdateAtScopeAsync

public abstract Mono createOrUpdateAtScopeAsync(String scope, TagsResourceInner parameters)

Creates or updates the entire set of tags on a resource or subscription. 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 - The parameters parameter.

Returns:

wrapper resource for tags API requests and responses on successful completion of Mono.

createOrUpdateAtScopeWithResponseAsync

public abstract Mono>> createOrUpdateAtScopeWithResponseAsync(String scope, TagsResourceInner parameters)

Creates or updates the entire set of tags on a resource or subscription. 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 - The parameters parameter.

Returns:

wrapper resource for tags API requests and responses along with Response<T> on successful completion of Mono.

createOrUpdateValue

public abstract TagValueInner createOrUpdateValue(String tagName, String tagValue)

Creates a predefined value for a predefined tag name. 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.

createOrUpdateValueAsync

public abstract Mono createOrUpdateValueAsync(String tagName, String tagValue)

Creates a predefined value for a predefined tag name. 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.

createOrUpdateValueWithResponse

public abstract Response createOrUpdateValueWithResponse(String tagName, String tagValue, Context context)

Creates a predefined value for a predefined tag name. 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<T>.

createOrUpdateValueWithResponseAsync

public abstract Mono> createOrUpdateValueWithResponseAsync(String tagName, String tagValue)

Creates a predefined value for a predefined tag name. 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<T> on successful completion of Mono.

createOrUpdateWithResponse

public abstract Response createOrUpdateWithResponse(String tagName, Context context)

Creates a predefined tag name. 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<T>.

createOrUpdateWithResponseAsync

public abstract Mono> createOrUpdateWithResponseAsync(String tagName)

Creates a predefined tag name. 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<T> on successful completion of Mono.

delete

public abstract void delete(String tagName)

Deletes a predefined tag name. 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.

deleteAsync

public abstract Mono deleteAsync(String tagName)

Deletes a predefined tag name. 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.

deleteAtScope

public abstract void deleteAtScope(String scope)

Deletes the entire set of tags on a resource or subscription.

Parameters:

scope - The resource scope.

deleteAtScope

public abstract void deleteAtScope(String scope, 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.

deleteAtScopeAsync

public abstract Mono 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.

deleteAtScopeWithResponseAsync

public abstract Mono>> deleteAtScopeWithResponseAsync(String scope)

Deletes the entire set of tags on a resource or subscription.

Parameters:

scope - The resource scope.

Returns:

the Response<T> on successful completion of Mono.

deleteValue

public abstract void deleteValue(String tagName, String tagValue)

Deletes a predefined tag value for a predefined tag name. 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.

deleteValueAsync

public abstract Mono deleteValueAsync(String tagName, String tagValue)

Deletes a predefined tag value for a predefined tag name. 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.

deleteValueWithResponse

public abstract Response deleteValueWithResponse(String tagName, String tagValue, Context context)

Deletes a predefined tag value for a predefined tag name. 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:

deleteValueWithResponseAsync

public abstract Mono> deleteValueWithResponseAsync(String tagName, String tagValue)

Deletes a predefined tag value for a predefined tag name. 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<T> on successful completion of Mono.

deleteWithResponse

public abstract Response deleteWithResponse(String tagName, Context context)

Deletes a predefined tag name. 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:

deleteWithResponseAsync

public abstract Mono> deleteWithResponseAsync(String tagName)

Deletes a predefined tag name. 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<T> on successful completion of Mono.

getAtScope

public abstract 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.

getAtScopeAsync

public abstract Mono 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.

getAtScopeWithResponse

public abstract Response getAtScopeWithResponse(String scope, 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<T>.

getAtScopeWithResponseAsync

public abstract Mono> 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<T> on successful completion of Mono.

list

public abstract PagedIterable list()

Gets a summary of tag usage under the subscription. 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<T>.

list

public abstract PagedIterable list(Context context)

Gets a summary of tag usage under the subscription. 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<T>.

listAsync

public abstract PagedFlux listAsync()

Gets a summary of tag usage under the subscription. 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<T>.

updateAtScope

public abstract TagsResourceInner updateAtScope(String scope, TagsPatchResource parameters)

Selectively updates the set of tags on a resource or subscription. 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 - The parameters parameter.

Returns:

wrapper resource for tags API requests and responses.

updateAtScope

public abstract TagsResourceInner updateAtScope(String scope, TagsPatchResource parameters, Context context)

Selectively updates the set of tags on a resource or subscription. 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 - The parameters parameter.
context - The context to associate with this operation.

Returns:

wrapper resource for tags API requests and responses.

updateAtScopeAsync

public abstract Mono updateAtScopeAsync(String scope, TagsPatchResource parameters)

Selectively updates the set of tags on a resource or subscription. 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 - The parameters parameter.

Returns:

wrapper resource for tags API requests and responses on successful completion of Mono.

updateAtScopeWithResponseAsync

public abstract Mono>> updateAtScopeWithResponseAsync(String scope, TagsPatchResource parameters)

Selectively updates the set of tags on a resource or subscription. 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 - The parameters parameter.

Returns:

wrapper resource for tags API requests and responses along with Response<T> on successful completion of Mono.

Applies to