import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages an Azure Cosmos DB SQL API Dataset inside an Azure Data Factory. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const exampleResourceGroup = new azure.core.ResourceGroup("example", { * name: "example-resources", * location: "West Europe", * }); * const example = azure.cosmosdb.getAccount({ * name: "tfex-cosmosdb-account", * resourceGroupName: "tfex-cosmosdb-account-rg", * }); * const exampleFactory = new azure.datafactory.Factory("example", { * name: "example", * location: exampleResourceGroup.location, * resourceGroupName: exampleResourceGroup.name, * }); * const exampleLinkedServiceCosmosDb = new azure.datafactory.LinkedServiceCosmosDb("example", { * name: "example", * dataFactoryId: exampleFactory.id, * accountEndpoint: example.then(example => example.endpoint), * database: "foo", * }); * const exampleDatasetCosmosDBApi = new azure.datafactory.DatasetCosmosDBApi("example", { * name: "example", * dataFactoryId: exampleFactory.id, * linkedServiceName: exampleLinkedServiceCosmosDb.name, * collectionName: "bar", * }); * ``` * * ## Import * * Data Factory Datasets can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:datafactory/datasetCosmosDBApi:DatasetCosmosDBApi example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.DataFactory/factories/example/datasets/example * ``` */ export declare class DatasetCosmosDBApi extends pulumi.CustomResource { /** * Get an existing DatasetCosmosDBApi resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: DatasetCosmosDBApiState, opts?: pulumi.CustomResourceOptions): DatasetCosmosDBApi; /** * Returns true if the given object is an instance of DatasetCosmosDBApi. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is DatasetCosmosDBApi; /** * A map of additional properties to associate with the Data Factory Dataset. * * The following supported arguments are specific to Azure Cosmos DB SQL API Dataset: */ readonly additionalProperties: pulumi.Output<{ [key: string]: string; } | undefined>; /** * List of tags that can be used for describing the Data Factory Dataset. */ readonly annotations: pulumi.Output; /** * The collection name of the Data Factory Dataset Azure Cosmos DB SQL API. */ readonly collectionName: pulumi.Output; /** * The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource. */ readonly dataFactoryId: pulumi.Output; /** * The description for the Data Factory Dataset. */ readonly description: pulumi.Output; /** * The folder that this Dataset is in. If not specified, the Dataset will appear at the root level. */ readonly folder: pulumi.Output; /** * The Data Factory Linked Service name in which to associate the Dataset with. */ readonly linkedServiceName: pulumi.Output; /** * Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the [Microsoft documentation](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions. */ readonly name: pulumi.Output; /** * A map of parameters to associate with the Data Factory Dataset. */ readonly parameters: pulumi.Output<{ [key: string]: string; } | undefined>; /** * A `schemaColumn` block as defined below. */ readonly schemaColumns: pulumi.Output; /** * Create a DatasetCosmosDBApi resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: DatasetCosmosDBApiArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering DatasetCosmosDBApi resources. */ export interface DatasetCosmosDBApiState { /** * A map of additional properties to associate with the Data Factory Dataset. * * The following supported arguments are specific to Azure Cosmos DB SQL API Dataset: */ additionalProperties?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * List of tags that can be used for describing the Data Factory Dataset. */ annotations?: pulumi.Input[]>; /** * The collection name of the Data Factory Dataset Azure Cosmos DB SQL API. */ collectionName?: pulumi.Input; /** * The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource. */ dataFactoryId?: pulumi.Input; /** * The description for the Data Factory Dataset. */ description?: pulumi.Input; /** * The folder that this Dataset is in. If not specified, the Dataset will appear at the root level. */ folder?: pulumi.Input; /** * The Data Factory Linked Service name in which to associate the Dataset with. */ linkedServiceName?: pulumi.Input; /** * Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the [Microsoft documentation](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions. */ name?: pulumi.Input; /** * A map of parameters to associate with the Data Factory Dataset. */ parameters?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * A `schemaColumn` block as defined below. */ schemaColumns?: pulumi.Input[]>; } /** * The set of arguments for constructing a DatasetCosmosDBApi resource. */ export interface DatasetCosmosDBApiArgs { /** * A map of additional properties to associate with the Data Factory Dataset. * * The following supported arguments are specific to Azure Cosmos DB SQL API Dataset: */ additionalProperties?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * List of tags that can be used for describing the Data Factory Dataset. */ annotations?: pulumi.Input[]>; /** * The collection name of the Data Factory Dataset Azure Cosmos DB SQL API. */ collectionName?: pulumi.Input; /** * The Data Factory ID in which to associate the Linked Service with. Changing this forces a new resource. */ dataFactoryId: pulumi.Input; /** * The description for the Data Factory Dataset. */ description?: pulumi.Input; /** * The folder that this Dataset is in. If not specified, the Dataset will appear at the root level. */ folder?: pulumi.Input; /** * The Data Factory Linked Service name in which to associate the Dataset with. */ linkedServiceName: pulumi.Input; /** * Specifies the name of the Data Factory Dataset. Changing this forces a new resource to be created. Must be globally unique. See the [Microsoft documentation](https://docs.microsoft.com/azure/data-factory/naming-rules) for all restrictions. */ name?: pulumi.Input; /** * A map of parameters to associate with the Data Factory Dataset. */ parameters?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * A `schemaColumn` block as defined below. */ schemaColumns?: pulumi.Input[]>; }