1. Docs
  2. Reference
  3. API
  4. Digital Ocean
  5. GetTags

GetTags

Returns a list of tags in your DigitalOcean account, with the ability to filter and sort the results. If no filters are specified, all tags will be returned.

Using GetTags

function getTags(args: GetTagsArgs, opts?: InvokeOptions): Promise<GetTagsResult>
function  get_tags(filters=None, sorts=None, opts=None)
func GetTags(ctx *Context, args *GetTagsArgs, opts ...InvokeOption) (*GetTagsResult, error)
public static class GetTags {
    public static Task<GetTagsResult> InvokeAsync(GetTagsArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Filters List<Pulumi.DigitalOcean.Inputs.GetTagsFilterArgs>

Filter the results. The filter block is documented below.

Sorts List<Pulumi.DigitalOcean.Inputs.GetTagsSortArgs>

Sort the results. The sort block is documented below.

Filters []GetTagsFilter

Filter the results. The filter block is documented below.

Sorts []GetTagsSort

Sort the results. The sort block is documented below.

filters GetTagsFilter[]

Filter the results. The filter block is documented below.

sorts GetTagsSort[]

Sort the results. The sort block is documented below.

filters List[GetTagsFilter]

Filter the results. The filter block is documented below.

sorts List[GetTagsSort]

Sort the results. The sort block is documented below.

GetTags Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Tags List<Pulumi.DigitalOcean.Outputs.GetTagsTag>
Filters List<Pulumi.DigitalOcean.Outputs.GetTagsFilter>
Sorts List<Pulumi.DigitalOcean.Outputs.GetTagsSort>
Id string

The provider-assigned unique ID for this managed resource.

Tags []GetTagsTag
Filters []GetTagsFilter
Sorts []GetTagsSort
id string

The provider-assigned unique ID for this managed resource.

tags GetTagsTag[]
filters GetTagsFilter[]
sorts GetTagsSort[]
id str

The provider-assigned unique ID for this managed resource.

tags List[GetTagsTag]
filters List[GetTagsFilter]
sorts List[GetTagsSort]

Supporting Types

GetTagsFilter

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Key string

Filter the tags by this key. This may be one of name, total_resource_count, droplets_count, images_count, volumes_count, volume_snapshots_count, or databases_count.

Values List<string>

Only retrieves tags which keys has value that matches one of the values provided here.

Key string

Filter the tags by this key. This may be one of name, total_resource_count, droplets_count, images_count, volumes_count, volume_snapshots_count, or databases_count.

Values []string

Only retrieves tags which keys has value that matches one of the values provided here.

key string

Filter the tags by this key. This may be one of name, total_resource_count, droplets_count, images_count, volumes_count, volume_snapshots_count, or databases_count.

values string[]

Only retrieves tags which keys has value that matches one of the values provided here.

key str

Filter the tags by this key. This may be one of name, total_resource_count, droplets_count, images_count, volumes_count, volume_snapshots_count, or databases_count.

values List[str]

Only retrieves tags which keys has value that matches one of the values provided here.

GetTagsSort

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Key string

Sort the tags by this key. This may be one of name, total_resource_count, droplets_count, images_count, volumes_count, volume_snapshots_count, or databases_count.

Direction string

The sort direction. This may be either asc or desc.

Key string

Sort the tags by this key. This may be one of name, total_resource_count, droplets_count, images_count, volumes_count, volume_snapshots_count, or databases_count.

Direction string

The sort direction. This may be either asc or desc.

key string

Sort the tags by this key. This may be one of name, total_resource_count, droplets_count, images_count, volumes_count, volume_snapshots_count, or databases_count.

direction string

The sort direction. This may be either asc or desc.

key str

Sort the tags by this key. This may be one of name, total_resource_count, droplets_count, images_count, volumes_count, volume_snapshots_count, or databases_count.

direction str

The sort direction. This may be either asc or desc.

GetTagsTag

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

DatabasesCount int

A count of the database clusters that the tag is applied to.

DropletsCount int

A count of the Droplets the tag is applied to.

ImagesCount int

A count of the images that the tag is applied to.

Name string

The name of the tag.

TotalResourceCount int

A count of the total number of resources that the tag is applied to.

VolumeSnapshotsCount int

A count of the volume snapshots that the tag is applied to.

VolumesCount int

A count of the volumes that the tag is applied to.

DatabasesCount int

A count of the database clusters that the tag is applied to.

DropletsCount int

A count of the Droplets the tag is applied to.

ImagesCount int

A count of the images that the tag is applied to.

Name string

The name of the tag.

TotalResourceCount int

A count of the total number of resources that the tag is applied to.

VolumeSnapshotsCount int

A count of the volume snapshots that the tag is applied to.

VolumesCount int

A count of the volumes that the tag is applied to.

databasesCount number

A count of the database clusters that the tag is applied to.

dropletsCount number

A count of the Droplets the tag is applied to.

imagesCount number

A count of the images that the tag is applied to.

name string

The name of the tag.

totalResourceCount number

A count of the total number of resources that the tag is applied to.

volumeSnapshotsCount number

A count of the volume snapshots that the tag is applied to.

volumesCount number

A count of the volumes that the tag is applied to.

databases_count float

A count of the database clusters that the tag is applied to.

droplets_count float

A count of the Droplets the tag is applied to.

images_count float

A count of the images that the tag is applied to.

name str

The name of the tag.

total_resource_count float

A count of the total number of resources that the tag is applied to.

volume_snapshots_count float

A count of the volume snapshots that the tag is applied to.

volumes_count float

A count of the volumes that the tag is applied to.

Package Details

Repository
https://github.com/pulumi/pulumi-digitalocean
License
Apache-2.0
Notes
This Pulumi package is based on the digitalocean Terraform Provider.