TagsOperationsOperations interface
Interface representing a TagsOperations operations.
Properties
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| create |
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'. |
| create |
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. |
| create |
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. |
| delete | 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. |
| delete |
Deletes the entire set of tags on a resource or subscription. |
| delete |
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. |
| get |
Gets the entire set of tags on a resource or subscription. |
| 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. |
| update |
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. |
Property Details
beginCreateOrUpdateAtScope
Warning
This API is now deprecated.
use createOrUpdateAtScope instead
beginCreateOrUpdateAtScope: (scope: string, parameters: TagsResource, options?: TagsOperationsCreateOrUpdateAtScopeOptionalParams) => Promise<SimplePollerLike<OperationState<TagsResource>, TagsResource>>Property Value
(scope: string, parameters: TagsResource, options?: TagsOperationsCreateOrUpdateAtScopeOptionalParams) => Promise<SimplePollerLike<OperationState<TagsResource>, TagsResource>>
beginCreateOrUpdateAtScopeAndWait
Warning
This API is now deprecated.
use createOrUpdateAtScope instead
beginCreateOrUpdateAtScopeAndWait: (scope: string, parameters: TagsResource, options?: TagsOperationsCreateOrUpdateAtScopeOptionalParams) => Promise<TagsResource>Property Value
(scope: string, parameters: TagsResource, options?: TagsOperationsCreateOrUpdateAtScopeOptionalParams) => Promise<TagsResource>
beginDeleteAtScope
Warning
This API is now deprecated.
use deleteAtScope instead
beginDeleteAtScope: (scope: string, options?: TagsOperationsDeleteAtScopeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>Property Value
(scope: string, options?: TagsOperationsDeleteAtScopeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>
beginDeleteAtScopeAndWait
Warning
This API is now deprecated.
use deleteAtScope instead
beginDeleteAtScopeAndWait: (scope: string, options?: TagsOperationsDeleteAtScopeOptionalParams) => Promise<void>Property Value
(scope: string, options?: TagsOperationsDeleteAtScopeOptionalParams) => Promise<void>
beginUpdateAtScope
Warning
This API is now deprecated.
use updateAtScope instead
beginUpdateAtScope: (scope: string, parameters: TagsPatchResource, options?: TagsOperationsUpdateAtScopeOptionalParams) => Promise<SimplePollerLike<OperationState<TagsResource>, TagsResource>>Property Value
(scope: string, parameters: TagsPatchResource, options?: TagsOperationsUpdateAtScopeOptionalParams) => Promise<SimplePollerLike<OperationState<TagsResource>, TagsResource>>
beginUpdateAtScopeAndWait
Warning
This API is now deprecated.
use updateAtScope instead
beginUpdateAtScopeAndWait: (scope: string, parameters: TagsPatchResource, options?: TagsOperationsUpdateAtScopeOptionalParams) => Promise<TagsResource>Property Value
(scope: string, parameters: TagsPatchResource, options?: TagsOperationsUpdateAtScopeOptionalParams) => Promise<TagsResource>
createOrUpdate
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'.
createOrUpdate: (tagName: string, options?: TagsOperationsCreateOrUpdateOptionalParams) => Promise<TagDetails>Property Value
(tagName: string, options?: TagsOperationsCreateOrUpdateOptionalParams) => Promise<TagDetails>
createOrUpdateAtScope
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.
createOrUpdateAtScope: (scope: string, parameters: TagsResource, options?: TagsOperationsCreateOrUpdateAtScopeOptionalParams) => PollerLike<OperationState<TagsResource>, TagsResource>Property Value
(scope: string, parameters: TagsResource, options?: TagsOperationsCreateOrUpdateAtScopeOptionalParams) => PollerLike<OperationState<TagsResource>, TagsResource>
createOrUpdateValue
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.
createOrUpdateValue: (tagName: string, tagValue: string, options?: TagsOperationsCreateOrUpdateValueOptionalParams) => Promise<TagValue>Property Value
(tagName: string, tagValue: string, options?: TagsOperationsCreateOrUpdateValueOptionalParams) => Promise<TagValue>
delete
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.
delete: (tagName: string, options?: TagsOperationsDeleteOptionalParams) => Promise<void>Property Value
(tagName: string, options?: TagsOperationsDeleteOptionalParams) => Promise<void>
deleteAtScope
Deletes the entire set of tags on a resource or subscription.
deleteAtScope: (scope: string, options?: TagsOperationsDeleteAtScopeOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(scope: string, options?: TagsOperationsDeleteAtScopeOptionalParams) => PollerLike<OperationState<void>, void>
deleteValue
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.
deleteValue: (tagName: string, tagValue: string, options?: TagsOperationsDeleteValueOptionalParams) => Promise<void>Property Value
(tagName: string, tagValue: string, options?: TagsOperationsDeleteValueOptionalParams) => Promise<void>
getAtScope
Gets the entire set of tags on a resource or subscription.
getAtScope: (scope: string, options?: TagsOperationsGetAtScopeOptionalParams) => Promise<TagsResource>Property Value
(scope: string, options?: TagsOperationsGetAtScopeOptionalParams) => Promise<TagsResource>
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.
list: (options?: TagsOperationsListOptionalParams) => PagedAsyncIterableIterator<TagDetails, TagDetails[], PageSettings>Property Value
(options?: TagsOperationsListOptionalParams) => PagedAsyncIterableIterator<TagDetails, TagDetails[], PageSettings>
updateAtScope
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.
updateAtScope: (scope: string, parameters: TagsPatchResource, options?: TagsOperationsUpdateAtScopeOptionalParams) => PollerLike<OperationState<TagsResource>, TagsResource>Property Value
(scope: string, parameters: TagsPatchResource, options?: TagsOperationsUpdateAtScopeOptionalParams) => PollerLike<OperationState<TagsResource>, TagsResource>