getTagKey function

Future<GetTagKeyResult> getTagKey(
  1. GetTagKeyArgs args, {
  2. InvokeOptions? options,
})

Get a tag key by org or project parent and shortName.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const environmentTagKey = gcp.tags.getTagKey({
    parent: "organizations/12345",
    shortName: "environment",
});
import pulumi
import pulumi_gcp as gcp

environment_tag_key = gcp.tags.get_tag_key(parent="organizations/12345",
    short_name="environment")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var environmentTagKey = Gcp.Tags.GetTagKey.Invoke(new()
    {
        Parent = "organizations/12345",
        ShortName = "environment",
    });

});
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/tags"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tags.LookupTagKey(ctx, &tags.LookupTagKeyArgs{
			Parent:    "organizations/12345",
			ShortName: "environment",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

data "gcp_tags_gettagkey" "environmentTagKey" {
  parent     = "organizations/12345"
  short_name = "environment"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.tags.TagsFunctions;
import com.pulumi.gcp.tags.inputs.GetTagKeyArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var environmentTagKey = TagsFunctions.getTagKey(GetTagKeyArgs.builder()
            .parent("organizations/12345")
            .shortName("environment")
            .build());

    }
}
variables:
  environmentTagKey:
    fn::invoke:
      function: gcp:tags:getTagKey
      arguments:
        parent: organizations/12345
        shortName: environment
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const environmentTagKey = gcp.tags.getTagKey({
    parent: "projects/abc",
    shortName: "environment",
});
import pulumi
import pulumi_gcp as gcp

environment_tag_key = gcp.tags.get_tag_key(parent="projects/abc",
    short_name="environment")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var environmentTagKey = Gcp.Tags.GetTagKey.Invoke(new()
    {
        Parent = "projects/abc",
        ShortName = "environment",
    });

});
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/tags"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tags.LookupTagKey(ctx, &tags.LookupTagKeyArgs{
			Parent:    "projects/abc",
			ShortName: "environment",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

data "gcp_tags_gettagkey" "environmentTagKey" {
  parent     = "projects/abc"
  short_name = "environment"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.tags.TagsFunctions;
import com.pulumi.gcp.tags.inputs.GetTagKeyArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var environmentTagKey = TagsFunctions.getTagKey(GetTagKeyArgs.builder()
            .parent("projects/abc")
            .shortName("environment")
            .build());

    }
}
variables:
  environmentTagKey:
    fn::invoke:
      function: gcp:tags:getTagKey
      arguments:
        parent: projects/abc
        shortName: environment

args Arguments passed to this invoke. Arguments for getTagKey. options Invoke options controlling this call.

Implementation

Future<GetTagKeyResult> getTagKey(
  GetTagKeyArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'gcp:tags/getTagKey:getTagKey',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetTagKeyResult.fromMap(result);
}