Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. bigqueryanalyticshub
  5. ListingSubscription
Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.bigqueryanalyticshub.ListingSubscription

Explore with Pulumi AI

gcp logo
Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
pulumi/pulumi-gcp

    A Bigquery Analytics Hub listing subscription

    To get more information about ListingSubscription, see:

    Example Usage

    Bigquery Analyticshub Listing Subscription Basic

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

const subscription = new gcp.bigqueryanalyticshub.DataExchange("subscription", {
    location: "US",
    dataExchangeId: "my_data_exchange",
    displayName: "my_data_exchange",
    description: "",
});
const subscriptionDataset = new gcp.bigquery.Dataset("subscription", {
    datasetId: "my_listing",
    friendlyName: "my_listing",
    description: "",
    location: "US",
});
const subscriptionListing = new gcp.bigqueryanalyticshub.Listing("subscription", {
    location: "US",
    dataExchangeId: subscription.dataExchangeId,
    listingId: "my_listing",
    displayName: "my_listing",
    description: "",
    bigqueryDataset: {
        dataset: subscriptionDataset.id,
    },
});
const subscriptionListingSubscription = new gcp.bigqueryanalyticshub.ListingSubscription("subscription", {
    location: "US",
    dataExchangeId: subscription.dataExchangeId,
    listingId: subscriptionListing.listingId,
    destinationDataset: {
        description: "A test subscription",
        friendlyName: "πŸ‘‹",
        labels: {
            testing: "123",
        },
        location: "US",
        datasetReference: {
            datasetId: "destination_dataset",
            projectId: subscriptionDataset.project,
        },
    },
});

    import pulumi
import pulumi_gcp as gcp

subscription = gcp.bigqueryanalyticshub.DataExchange("subscription",
    location="US",
    data_exchange_id="my_data_exchange",
    display_name="my_data_exchange",
    description="")
subscription_dataset = gcp.bigquery.Dataset("subscription",
    dataset_id="my_listing",
    friendly_name="my_listing",
    description="",
    location="US")
subscription_listing = gcp.bigqueryanalyticshub.Listing("subscription",
    location="US",
    data_exchange_id=subscription.data_exchange_id,
    listing_id="my_listing",
    display_name="my_listing",
    description="",
    bigquery_dataset={
        "dataset": subscription_dataset.id,
    })
subscription_listing_subscription = gcp.bigqueryanalyticshub.ListingSubscription("subscription",
    location="US",
    data_exchange_id=subscription.data_exchange_id,
    listing_id=subscription_listing.listing_id,
    destination_dataset={
        "description": "A test subscription",
        "friendly_name": "πŸ‘‹",
        "labels": {
            "testing": "123",
        },
        "location": "US",
        "dataset_reference": {
            "dataset_id": "destination_dataset",
            "project_id": subscription_dataset.project,
        },
    })

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/bigquery"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/bigqueryanalyticshub"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		subscription, err := bigqueryanalyticshub.NewDataExchange(ctx, "subscription", &bigqueryanalyticshub.DataExchangeArgs{
			Location:       pulumi.String("US"),
			DataExchangeId: pulumi.String("my_data_exchange"),
			DisplayName:    pulumi.String("my_data_exchange"),
			Description:    pulumi.String(""),
		})
		if err != nil {
			return err
		}
		subscriptionDataset, err := bigquery.NewDataset(ctx, "subscription", &bigquery.DatasetArgs{
			DatasetId:    pulumi.String("my_listing"),
			FriendlyName: pulumi.String("my_listing"),
			Description:  pulumi.String(""),
			Location:     pulumi.String("US"),
		})
		if err != nil {
			return err
		}
		subscriptionListing, err := bigqueryanalyticshub.NewListing(ctx, "subscription", &bigqueryanalyticshub.ListingArgs{
			Location:       pulumi.String("US"),
			DataExchangeId: subscription.DataExchangeId,
			ListingId:      pulumi.String("my_listing"),
			DisplayName:    pulumi.String("my_listing"),
			Description:    pulumi.String(""),
			BigqueryDataset: &bigqueryanalyticshub.ListingBigqueryDatasetArgs{
				Dataset: subscriptionDataset.ID(),
			},
		})
		if err != nil {
			return err
		}
		_, err = bigqueryanalyticshub.NewListingSubscription(ctx, "subscription", &bigqueryanalyticshub.ListingSubscriptionArgs{
			Location:       pulumi.String("US"),
			DataExchangeId: subscription.DataExchangeId,
			ListingId:      subscriptionListing.ListingId,
			DestinationDataset: &bigqueryanalyticshub.ListingSubscriptionDestinationDatasetArgs{
				Description:  pulumi.String("A test subscription"),
				FriendlyName: pulumi.String("πŸ‘‹"),
				Labels: pulumi.StringMap{
					"testing": pulumi.String("123"),
				},
				Location: pulumi.String("US"),
				DatasetReference: &bigqueryanalyticshub.ListingSubscriptionDestinationDatasetDatasetReferenceArgs{
					DatasetId: pulumi.String("destination_dataset"),
					ProjectId: subscriptionDataset.Project,
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var subscription = new Gcp.BigQueryAnalyticsHub.DataExchange("subscription", new()
    {
        Location = "US",
        DataExchangeId = "my_data_exchange",
        DisplayName = "my_data_exchange",
        Description = "",
    });

    var subscriptionDataset = new Gcp.BigQuery.Dataset("subscription", new()
    {
        DatasetId = "my_listing",
        FriendlyName = "my_listing",
        Description = "",
        Location = "US",
    });

    var subscriptionListing = new Gcp.BigQueryAnalyticsHub.Listing("subscription", new()
    {
        Location = "US",
        DataExchangeId = subscription.DataExchangeId,
        ListingId = "my_listing",
        DisplayName = "my_listing",
        Description = "",
        BigqueryDataset = new Gcp.BigQueryAnalyticsHub.Inputs.ListingBigqueryDatasetArgs
        {
            Dataset = subscriptionDataset.Id,
        },
    });

    var subscriptionListingSubscription = new Gcp.BigQueryAnalyticsHub.ListingSubscription("subscription", new()
    {
        Location = "US",
        DataExchangeId = subscription.DataExchangeId,
        ListingId = subscriptionListing.ListingId,
        DestinationDataset = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationDatasetArgs
        {
            Description = "A test subscription",
            FriendlyName = "πŸ‘‹",
            Labels = 
            {
                { "testing", "123" },
            },
            Location = "US",
            DatasetReference = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationDatasetDatasetReferenceArgs
            {
                DatasetId = "destination_dataset",
                ProjectId = subscriptionDataset.Project,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigqueryanalyticshub.DataExchange;
import com.pulumi.gcp.bigqueryanalyticshub.DataExchangeArgs;
import com.pulumi.gcp.bigquery.Dataset;
import com.pulumi.gcp.bigquery.DatasetArgs;
import com.pulumi.gcp.bigqueryanalyticshub.Listing;
import com.pulumi.gcp.bigqueryanalyticshub.ListingArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.ListingBigqueryDatasetArgs;
import com.pulumi.gcp.bigqueryanalyticshub.ListingSubscription;
import com.pulumi.gcp.bigqueryanalyticshub.ListingSubscriptionArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.ListingSubscriptionDestinationDatasetArgs;
import com.pulumi.gcp.bigqueryanalyticshub.inputs.ListingSubscriptionDestinationDatasetDatasetReferenceArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        var subscription = new DataExchange("subscription", DataExchangeArgs.builder()
            .location("US")
            .dataExchangeId("my_data_exchange")
            .displayName("my_data_exchange")
            .description("")
            .build());

        var subscriptionDataset = new Dataset("subscriptionDataset", DatasetArgs.builder()
            .datasetId("my_listing")
            .friendlyName("my_listing")
            .description("")
            .location("US")
            .build());

        var subscriptionListing = new Listing("subscriptionListing", ListingArgs.builder()
            .location("US")
            .dataExchangeId(subscription.dataExchangeId())
            .listingId("my_listing")
            .displayName("my_listing")
            .description("")
            .bigqueryDataset(ListingBigqueryDatasetArgs.builder()
                .dataset(subscriptionDataset.id())
                .build())
            .build());

        var subscriptionListingSubscription = new ListingSubscription("subscriptionListingSubscription", ListingSubscriptionArgs.builder()
            .location("US")
            .dataExchangeId(subscription.dataExchangeId())
            .listingId(subscriptionListing.listingId())
            .destinationDataset(ListingSubscriptionDestinationDatasetArgs.builder()
                .description("A test subscription")
                .friendlyName("πŸ‘‹")
                .labels(Map.of("testing", "123"))
                .location("US")
                .datasetReference(ListingSubscriptionDestinationDatasetDatasetReferenceArgs.builder()
                    .datasetId("destination_dataset")
                    .projectId(subscriptionDataset.project())
                    .build())
                .build())
            .build());

    }
}

    resources:
  subscription:
    type: gcp:bigqueryanalyticshub:DataExchange
    properties:
      location: US
      dataExchangeId: my_data_exchange
      displayName: my_data_exchange
      description: ""
  subscriptionListing:
    type: gcp:bigqueryanalyticshub:Listing
    name: subscription
    properties:
      location: US
      dataExchangeId: ${subscription.dataExchangeId}
      listingId: my_listing
      displayName: my_listing
      description: ""
      bigqueryDataset:
        dataset: ${subscriptionDataset.id}
  subscriptionDataset:
    type: gcp:bigquery:Dataset
    name: subscription
    properties:
      datasetId: my_listing
      friendlyName: my_listing
      description: ""
      location: US
  subscriptionListingSubscription:
    type: gcp:bigqueryanalyticshub:ListingSubscription
    name: subscription
    properties:
      location: US
      dataExchangeId: ${subscription.dataExchangeId}
      listingId: ${subscriptionListing.listingId}
      destinationDataset:
        description: A test subscription
        friendlyName: "\U0001F44B"
        labels:
          testing: '123'
        location: US
        datasetReference:
          datasetId: destination_dataset
          projectId: ${subscriptionDataset.project}

    Create ListingSubscription Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ListingSubscription(name: string, args: ListingSubscriptionArgs, opts?: CustomResourceOptions);
    @overload
def ListingSubscription(resource_name: str,
                        args: ListingSubscriptionArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def ListingSubscription(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        data_exchange_id: Optional[str] = None,
                        destination_dataset: Optional[ListingSubscriptionDestinationDatasetArgs] = None,
                        listing_id: Optional[str] = None,
                        location: Optional[str] = None,
                        project: Optional[str] = None)
    func NewListingSubscription(ctx *Context, name string, args ListingSubscriptionArgs, opts ...ResourceOption) (*ListingSubscription, error)
    public ListingSubscription(string name, ListingSubscriptionArgs args, CustomResourceOptions? opts = null)
    public ListingSubscription(String name, ListingSubscriptionArgs args)
public ListingSubscription(String name, ListingSubscriptionArgs args, CustomResourceOptions options)

    type: gcp:bigqueryanalyticshub:ListingSubscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ListingSubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ListingSubscriptionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ListingSubscriptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ListingSubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ListingSubscriptionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var listingSubscriptionResource = new Gcp.BigQueryAnalyticsHub.ListingSubscription("listingSubscriptionResource", new()
{
    DataExchangeId = "string",
    DestinationDataset = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationDatasetArgs
    {
        DatasetReference = new Gcp.BigQueryAnalyticsHub.Inputs.ListingSubscriptionDestinationDatasetDatasetReferenceArgs
        {
            DatasetId = "string",
            ProjectId = "string",
        },
        Location = "string",
        Description = "string",
        FriendlyName = "string",
        Labels = 
        {
            { "string", "string" },
        },
    },
    ListingId = "string",
    Location = "string",
    Project = "string",
});

    example, err := bigqueryanalyticshub.NewListingSubscription(ctx, "listingSubscriptionResource", &bigqueryanalyticshub.ListingSubscriptionArgs{
	DataExchangeId: pulumi.String("string"),
	DestinationDataset: &bigqueryanalyticshub.ListingSubscriptionDestinationDatasetArgs{
		DatasetReference: &bigqueryanalyticshub.ListingSubscriptionDestinationDatasetDatasetReferenceArgs{
			DatasetId: pulumi.String("string"),
			ProjectId: pulumi.String("string"),
		},
		Location:     pulumi.String("string"),
		Description:  pulumi.String("string"),
		FriendlyName: pulumi.String("string"),
		Labels: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	ListingId: pulumi.String("string"),
	Location:  pulumi.String("string"),
	Project:   pulumi.String("string"),
})

    var listingSubscriptionResource = new ListingSubscription("listingSubscriptionResource", ListingSubscriptionArgs.builder()
    .dataExchangeId("string")
    .destinationDataset(ListingSubscriptionDestinationDatasetArgs.builder()
        .datasetReference(ListingSubscriptionDestinationDatasetDatasetReferenceArgs.builder()
            .datasetId("string")
            .projectId("string")
            .build())
        .location("string")
        .description("string")
        .friendlyName("string")
        .labels(Map.of("string", "string"))
        .build())
    .listingId("string")
    .location("string")
    .project("string")
    .build());

    listing_subscription_resource = gcp.bigqueryanalyticshub.ListingSubscription("listingSubscriptionResource",
    data_exchange_id="string",
    destination_dataset={
        "dataset_reference": {
            "dataset_id": "string",
            "project_id": "string",
        },
        "location": "string",
        "description": "string",
        "friendly_name": "string",
        "labels": {
            "string": "string",
        },
    },
    listing_id="string",
    location="string",
    project="string")

    const listingSubscriptionResource = new gcp.bigqueryanalyticshub.ListingSubscription("listingSubscriptionResource", {
    dataExchangeId: "string",
    destinationDataset: {
        datasetReference: {
            datasetId: "string",
            projectId: "string",
        },
        location: "string",
        description: "string",
        friendlyName: "string",
        labels: {
            string: "string",
        },
    },
    listingId: "string",
    location: "string",
    project: "string",
});

    type: gcp:bigqueryanalyticshub:ListingSubscription
properties:
    dataExchangeId: string
    destinationDataset:
        datasetReference:
            datasetId: string
            projectId: string
        description: string
        friendlyName: string
        labels:
            string: string
        location: string
    listingId: string
    location: string
    project: string

    ListingSubscription Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ListingSubscription resource accepts the following input properties:

    DataExchangeId string
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    DestinationDataset ListingSubscriptionDestinationDataset
    The destination dataset for this subscription. Structure is documented below.
    ListingId string
    The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    Location string
    The name of the location for this subscription.
    Project string
    DataExchangeId string
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    DestinationDataset ListingSubscriptionDestinationDatasetArgs
    The destination dataset for this subscription. Structure is documented below.
    ListingId string
    The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    Location string
    The name of the location for this subscription.
    Project string
    dataExchangeId String
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    destinationDataset ListingSubscriptionDestinationDataset
    The destination dataset for this subscription. Structure is documented below.
    listingId String
    The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    location String
    The name of the location for this subscription.
    project String
    dataExchangeId string
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    destinationDataset ListingSubscriptionDestinationDataset
    The destination dataset for this subscription. Structure is documented below.
    listingId string
    The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    location string
    The name of the location for this subscription.
    project string
    data_exchange_id str
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    destination_dataset ListingSubscriptionDestinationDatasetArgs
    The destination dataset for this subscription. Structure is documented below.
    listing_id str
    The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    location str
    The name of the location for this subscription.
    project str
    dataExchangeId String
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    destinationDataset Property Map
    The destination dataset for this subscription. Structure is documented below.
    listingId String
    The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    location String
    The name of the location for this subscription.
    project String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ListingSubscription resource produces the following output properties:

    CreationTime string
    Timestamp when the subscription was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifyTime string
    Timestamp when the subscription was last modified.
    LinkedDatasetMaps List<ListingSubscriptionLinkedDatasetMap>
    Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
    LinkedResources List<ListingSubscriptionLinkedResource>
    Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
    Name string
    The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
    OrganizationDisplayName string
    Display name of the project of this subscription.
    OrganizationId string
    Organization of the project this subscription belongs to.
    ResourceType string
    Listing shared asset type.
    State string
    Current state of the subscription.
    SubscriberContact string
    Email of the subscriber.
    SubscriptionId string
    The subscription id used to reference the subscription.
    CreationTime string
    Timestamp when the subscription was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifyTime string
    Timestamp when the subscription was last modified.
    LinkedDatasetMaps []ListingSubscriptionLinkedDatasetMap
    Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
    LinkedResources []ListingSubscriptionLinkedResource
    Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
    Name string
    The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
    OrganizationDisplayName string
    Display name of the project of this subscription.
    OrganizationId string
    Organization of the project this subscription belongs to.
    ResourceType string
    Listing shared asset type.
    State string
    Current state of the subscription.
    SubscriberContact string
    Email of the subscriber.
    SubscriptionId string
    The subscription id used to reference the subscription.
    creationTime String
    Timestamp when the subscription was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifyTime String
    Timestamp when the subscription was last modified.
    linkedDatasetMaps List<ListingSubscriptionLinkedDatasetMap>
    Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
    linkedResources List<ListingSubscriptionLinkedResource>
    Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
    name String
    The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
    organizationDisplayName String
    Display name of the project of this subscription.
    organizationId String
    Organization of the project this subscription belongs to.
    resourceType String
    Listing shared asset type.
    state String
    Current state of the subscription.
    subscriberContact String
    Email of the subscriber.
    subscriptionId String
    The subscription id used to reference the subscription.
    creationTime string
    Timestamp when the subscription was created.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifyTime string
    Timestamp when the subscription was last modified.
    linkedDatasetMaps ListingSubscriptionLinkedDatasetMap[]
    Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
    linkedResources ListingSubscriptionLinkedResource[]
    Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
    name string
    The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
    organizationDisplayName string
    Display name of the project of this subscription.
    organizationId string
    Organization of the project this subscription belongs to.
    resourceType string
    Listing shared asset type.
    state string
    Current state of the subscription.
    subscriberContact string
    Email of the subscriber.
    subscriptionId string
    The subscription id used to reference the subscription.
    creation_time str
    Timestamp when the subscription was created.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modify_time str
    Timestamp when the subscription was last modified.
    linked_dataset_maps Sequence[ListingSubscriptionLinkedDatasetMap]
    Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
    linked_resources Sequence[ListingSubscriptionLinkedResource]
    Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
    name str
    The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
    organization_display_name str
    Display name of the project of this subscription.
    organization_id str
    Organization of the project this subscription belongs to.
    resource_type str
    Listing shared asset type.
    state str
    Current state of the subscription.
    subscriber_contact str
    Email of the subscriber.
    subscription_id str
    The subscription id used to reference the subscription.
    creationTime String
    Timestamp when the subscription was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifyTime String
    Timestamp when the subscription was last modified.
    linkedDatasetMaps List<Property Map>
    Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
    linkedResources List<Property Map>
    Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
    name String
    The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
    organizationDisplayName String
    Display name of the project of this subscription.
    organizationId String
    Organization of the project this subscription belongs to.
    resourceType String
    Listing shared asset type.
    state String
    Current state of the subscription.
    subscriberContact String
    Email of the subscriber.
    subscriptionId String
    The subscription id used to reference the subscription.

    Look up Existing ListingSubscription Resource

    Get an existing ListingSubscription resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ListingSubscriptionState, opts?: CustomResourceOptions): ListingSubscription
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        creation_time: Optional[str] = None,
        data_exchange_id: Optional[str] = None,
        destination_dataset: Optional[ListingSubscriptionDestinationDatasetArgs] = None,
        last_modify_time: Optional[str] = None,
        linked_dataset_maps: Optional[Sequence[ListingSubscriptionLinkedDatasetMapArgs]] = None,
        linked_resources: Optional[Sequence[ListingSubscriptionLinkedResourceArgs]] = None,
        listing_id: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        organization_display_name: Optional[str] = None,
        organization_id: Optional[str] = None,
        project: Optional[str] = None,
        resource_type: Optional[str] = None,
        state: Optional[str] = None,
        subscriber_contact: Optional[str] = None,
        subscription_id: Optional[str] = None) -> ListingSubscription
    func GetListingSubscription(ctx *Context, name string, id IDInput, state *ListingSubscriptionState, opts ...ResourceOption) (*ListingSubscription, error)
    public static ListingSubscription Get(string name, Input<string> id, ListingSubscriptionState? state, CustomResourceOptions? opts = null)
    public static ListingSubscription get(String name, Output<String> id, ListingSubscriptionState state, CustomResourceOptions options)
    resources:  _:    type: gcp:bigqueryanalyticshub:ListingSubscription    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreationTime string
    Timestamp when the subscription was created.
    DataExchangeId string
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    DestinationDataset ListingSubscriptionDestinationDataset
    The destination dataset for this subscription. Structure is documented below.
    LastModifyTime string
    Timestamp when the subscription was last modified.
    LinkedDatasetMaps List<ListingSubscriptionLinkedDatasetMap>
    Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
    LinkedResources List<ListingSubscriptionLinkedResource>
    Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
    ListingId string
    The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    Location string
    The name of the location for this subscription.
    Name string
    The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
    OrganizationDisplayName string
    Display name of the project of this subscription.
    OrganizationId string
    Organization of the project this subscription belongs to.
    Project string
    ResourceType string
    Listing shared asset type.
    State string
    Current state of the subscription.
    SubscriberContact string
    Email of the subscriber.
    SubscriptionId string
    The subscription id used to reference the subscription.
    CreationTime string
    Timestamp when the subscription was created.
    DataExchangeId string
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    DestinationDataset ListingSubscriptionDestinationDatasetArgs
    The destination dataset for this subscription. Structure is documented below.
    LastModifyTime string
    Timestamp when the subscription was last modified.
    LinkedDatasetMaps []ListingSubscriptionLinkedDatasetMapArgs
    Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
    LinkedResources []ListingSubscriptionLinkedResourceArgs
    Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
    ListingId string
    The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    Location string
    The name of the location for this subscription.
    Name string
    The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
    OrganizationDisplayName string
    Display name of the project of this subscription.
    OrganizationId string
    Organization of the project this subscription belongs to.
    Project string
    ResourceType string
    Listing shared asset type.
    State string
    Current state of the subscription.
    SubscriberContact string
    Email of the subscriber.
    SubscriptionId string
    The subscription id used to reference the subscription.
    creationTime String
    Timestamp when the subscription was created.
    dataExchangeId String
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    destinationDataset ListingSubscriptionDestinationDataset
    The destination dataset for this subscription. Structure is documented below.
    lastModifyTime String
    Timestamp when the subscription was last modified.
    linkedDatasetMaps List<ListingSubscriptionLinkedDatasetMap>
    Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
    linkedResources List<ListingSubscriptionLinkedResource>
    Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
    listingId String
    The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    location String
    The name of the location for this subscription.
    name String
    The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
    organizationDisplayName String
    Display name of the project of this subscription.
    organizationId String
    Organization of the project this subscription belongs to.
    project String
    resourceType String
    Listing shared asset type.
    state String
    Current state of the subscription.
    subscriberContact String
    Email of the subscriber.
    subscriptionId String
    The subscription id used to reference the subscription.
    creationTime string
    Timestamp when the subscription was created.
    dataExchangeId string
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    destinationDataset ListingSubscriptionDestinationDataset
    The destination dataset for this subscription. Structure is documented below.
    lastModifyTime string
    Timestamp when the subscription was last modified.
    linkedDatasetMaps ListingSubscriptionLinkedDatasetMap[]
    Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
    linkedResources ListingSubscriptionLinkedResource[]
    Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
    listingId string
    The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    location string
    The name of the location for this subscription.
    name string
    The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
    organizationDisplayName string
    Display name of the project of this subscription.
    organizationId string
    Organization of the project this subscription belongs to.
    project string
    resourceType string
    Listing shared asset type.
    state string
    Current state of the subscription.
    subscriberContact string
    Email of the subscriber.
    subscriptionId string
    The subscription id used to reference the subscription.
    creation_time str
    Timestamp when the subscription was created.
    data_exchange_id str
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    destination_dataset ListingSubscriptionDestinationDatasetArgs
    The destination dataset for this subscription. Structure is documented below.
    last_modify_time str
    Timestamp when the subscription was last modified.
    linked_dataset_maps Sequence[ListingSubscriptionLinkedDatasetMapArgs]
    Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
    linked_resources Sequence[ListingSubscriptionLinkedResourceArgs]
    Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
    listing_id str
    The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    location str
    The name of the location for this subscription.
    name str
    The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
    organization_display_name str
    Display name of the project of this subscription.
    organization_id str
    Organization of the project this subscription belongs to.
    project str
    resource_type str
    Listing shared asset type.
    state str
    Current state of the subscription.
    subscriber_contact str
    Email of the subscriber.
    subscription_id str
    The subscription id used to reference the subscription.
    creationTime String
    Timestamp when the subscription was created.
    dataExchangeId String
    The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    destinationDataset Property Map
    The destination dataset for this subscription. Structure is documented below.
    lastModifyTime String
    Timestamp when the subscription was last modified.
    linkedDatasetMaps List<Property Map>
    Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 > projects/123/datasets/my_dataset Structure is documented below.
    linkedResources List<Property Map>
    Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. Structure is documented below.
    listingId String
    The ID of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces.
    location String
    The name of the location for this subscription.
    name String
    The resource name of the subscription. e.g. "projects/myproject/locations/US/subscriptions/123"
    organizationDisplayName String
    Display name of the project of this subscription.
    organizationId String
    Organization of the project this subscription belongs to.
    project String
    resourceType String
    Listing shared asset type.
    state String
    Current state of the subscription.
    subscriberContact String
    Email of the subscriber.
    subscriptionId String
    The subscription id used to reference the subscription.

    Supporting Types

    ListingSubscriptionDestinationDataset, ListingSubscriptionDestinationDatasetArgs

    DatasetReference ListingSubscriptionDestinationDatasetDatasetReference
    A reference that identifies the destination dataset. Structure is documented below.
    Location string
    The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
    Description string
    A user-friendly description of the dataset.
    FriendlyName string
    A descriptive name for the dataset.
    Labels Dictionary<string, string>
    The labels associated with this dataset. You can use these to organize and group your datasets.
    DatasetReference ListingSubscriptionDestinationDatasetDatasetReference
    A reference that identifies the destination dataset. Structure is documented below.
    Location string
    The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
    Description string
    A user-friendly description of the dataset.
    FriendlyName string
    A descriptive name for the dataset.
    Labels map[string]string
    The labels associated with this dataset. You can use these to organize and group your datasets.
    datasetReference ListingSubscriptionDestinationDatasetDatasetReference
    A reference that identifies the destination dataset. Structure is documented below.
    location String
    The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
    description String
    A user-friendly description of the dataset.
    friendlyName String
    A descriptive name for the dataset.
    labels Map<String,String>
    The labels associated with this dataset. You can use these to organize and group your datasets.
    datasetReference ListingSubscriptionDestinationDatasetDatasetReference
    A reference that identifies the destination dataset. Structure is documented below.
    location string
    The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
    description string
    A user-friendly description of the dataset.
    friendlyName string
    A descriptive name for the dataset.
    labels {[key: string]: string}
    The labels associated with this dataset. You can use these to organize and group your datasets.
    dataset_reference ListingSubscriptionDestinationDatasetDatasetReference
    A reference that identifies the destination dataset. Structure is documented below.
    location str
    The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
    description str
    A user-friendly description of the dataset.
    friendly_name str
    A descriptive name for the dataset.
    labels Mapping[str, str]
    The labels associated with this dataset. You can use these to organize and group your datasets.
    datasetReference Property Map
    A reference that identifies the destination dataset. Structure is documented below.
    location String
    The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
    description String
    A user-friendly description of the dataset.
    friendlyName String
    A descriptive name for the dataset.
    labels Map<String>
    The labels associated with this dataset. You can use these to organize and group your datasets.

    ListingSubscriptionDestinationDatasetDatasetReference, ListingSubscriptionDestinationDatasetDatasetReferenceArgs

    DatasetId string
    A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
    ProjectId string
    The ID of the project containing this dataset.

    DatasetId string
    A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
    ProjectId string
    The ID of the project containing this dataset.

    datasetId String
    A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
    projectId String
    The ID of the project containing this dataset.

    datasetId string
    A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
    projectId string
    The ID of the project containing this dataset.

    dataset_id str
    A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
    project_id str
    The ID of the project containing this dataset.

    datasetId String
    A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
    projectId String
    The ID of the project containing this dataset.

    ListingSubscriptionLinkedDatasetMap, ListingSubscriptionLinkedDatasetMapArgs

    ResourceName string
    (Required) The identifier for this object. Format specified above.
    LinkedDataset string
    (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
    Listing string
    (Output) Output only. Listing for which linked resource is created.
    ResourceName string
    (Required) The identifier for this object. Format specified above.
    LinkedDataset string
    (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
    Listing string
    (Output) Output only. Listing for which linked resource is created.
    resourceName String
    (Required) The identifier for this object. Format specified above.
    linkedDataset String
    (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
    listing String
    (Output) Output only. Listing for which linked resource is created.
    resourceName string
    (Required) The identifier for this object. Format specified above.
    linkedDataset string
    (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
    listing string
    (Output) Output only. Listing for which linked resource is created.
    resource_name str
    (Required) The identifier for this object. Format specified above.
    linked_dataset str
    (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
    listing str
    (Output) Output only. Listing for which linked resource is created.
    resourceName String
    (Required) The identifier for this object. Format specified above.
    linkedDataset String
    (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
    listing String
    (Output) Output only. Listing for which linked resource is created.

    ListingSubscriptionLinkedResource, ListingSubscriptionLinkedResourceArgs

    LinkedDataset string
    (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
    Listing string
    (Output) Output only. Listing for which linked resource is created.
    LinkedDataset string
    (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
    Listing string
    (Output) Output only. Listing for which linked resource is created.
    linkedDataset String
    (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
    listing String
    (Output) Output only. Listing for which linked resource is created.
    linkedDataset string
    (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
    listing string
    (Output) Output only. Listing for which linked resource is created.
    linked_dataset str
    (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
    listing str
    (Output) Output only. Listing for which linked resource is created.
    linkedDataset String
    (Output) Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linkedDataset
    listing String
    (Output) Output only. Listing for which linked resource is created.

    Import

    ListingSubscription can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/subscriptions/{{subscription_id}}

    • {{project}}/{{location}}/{{subscription_id}}

    • {{location}}/{{subscription_id}}

    When using the pulumi import command, ListingSubscription can be imported using one of the formats above. For example:

    $ pulumi import gcp:bigqueryanalyticshub/listingSubscription:ListingSubscription default projects/{{project}}/locations/{{location}}/subscriptions/{{subscription_id}}

    $ pulumi import gcp:bigqueryanalyticshub/listingSubscription:ListingSubscription default {{project}}/{{location}}/{{subscription_id}}

    $ pulumi import gcp:bigqueryanalyticshub/listingSubscription:ListingSubscription default {{location}}/{{subscription_id}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
    pulumi/pulumi-gcp