Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Tags

Package version

Class representing a Tags.

Hierarchy

  • Tags

Index

Constructors

Methods

Constructors

constructor

Methods

createOrUpdate

  • createOrUpdate(tagName: string, options?: msRest.RequestOptionsBase): Promise<Models.TagsCreateOrUpdateResponse>
  • createOrUpdate(tagName: string, callback: msRest.ServiceCallback<TagDetails>): void
  • createOrUpdate(tagName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<TagDetails>): void

  • The tag name can have a maximum of 512 characters and is case insensitive. Tag names created by Azure have prefixes of microsoft, azure, or windows. You cannot create tags with one of these prefixes.

    summary

    Creates a tag in the subscription.

    Parameters

    • tagName: string

      The name of the tag to create.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.TagsCreateOrUpdateResponse>

    Promise<Models.TagsCreateOrUpdateResponse>

  • Parameters

    • tagName: string

      The name of the tag to create.

    • callback: msRest.ServiceCallback<TagDetails>

      The callback

    Returns void

  • Parameters

    • tagName: string

      The name of the tag to create.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<TagDetails>

      The callback

    Returns void

createOrUpdateValue

  • createOrUpdateValue(tagName: string, tagValue: string, options?: msRest.RequestOptionsBase): Promise<Models.TagsCreateOrUpdateValueResponse>
  • createOrUpdateValue(tagName: string, tagValue: string, callback: msRest.ServiceCallback<TagValue>): void
  • createOrUpdateValue(tagName: string, tagValue: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<TagValue>): void

  • Creates a tag value. The name of the tag must already exist.

    Parameters

    • tagName: string

      The name of the tag.

    • tagValue: string

      The value of the tag to create.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.TagsCreateOrUpdateValueResponse>

    Promise<Models.TagsCreateOrUpdateValueResponse>

  • Parameters

    • tagName: string

      The name of the tag.

    • tagValue: string

      The value of the tag to create.

    • callback: msRest.ServiceCallback<TagValue>

      The callback

    Returns void

  • Parameters

    • tagName: string

      The name of the tag.

    • tagValue: string

      The value of the tag to create.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<TagValue>

      The callback

    Returns void

deleteMethod

  • deleteMethod(tagName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(tagName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(tagName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • You must remove all values from a resource tag before you can delete it.

    summary

    Deletes a tag from the subscription.

    Parameters

    • tagName: string

      The name of the tag.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • tagName: string

      The name of the tag.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • tagName: string

      The name of the tag.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

deleteValue

  • deleteValue(tagName: string, tagValue: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteValue(tagName: string, tagValue: string, callback: msRest.ServiceCallback<void>): void
  • deleteValue(tagName: string, tagValue: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes a tag value.

    Parameters

    • tagName: string

      The name of the tag.

    • tagValue: string

      The value of the tag to delete.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • tagName: string

      The name of the tag.

    • tagValue: string

      The value of the tag to delete.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • tagName: string

      The name of the tag.

    • tagValue: string

      The value of the tag to delete.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

list

  • list(options?: msRest.RequestOptionsBase): Promise<Models.TagsListResponse>
  • list(callback: msRest.ServiceCallback<TagsListResult>): void
  • list(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<TagsListResult>): void

  • Gets the names and values of all resource tags that are defined in a subscription.

    Parameters

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.TagsListResponse>

    Promise<Models.TagsListResponse>

  • Parameters

    Returns void

  • Parameters

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<TagsListResult>

      The callback

    Returns void

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.TagsListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<TagsListResult>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<TagsListResult>): void

  • Gets the names and values of all resource tags that are defined in a subscription.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.TagsListNextResponse>

    Promise<Models.TagsListNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<TagsListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<TagsListResult>

      The callback

    Returns void

Generated using TypeDoc