azure-native.documentdb.TableResourceTable
Explore with Pulumi AI
An Azure Cosmos DB Table. API Version: 2021-03-15.
Example Usage
CosmosDBTableReplace
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var tableResourceTable = new AzureNative.DocumentDB.TableResourceTable("tableResourceTable", new()
    {
        AccountName = "ddb1",
        Location = "West US",
        Options = null,
        Resource = new AzureNative.DocumentDB.Inputs.TableResourceArgs
        {
            Id = "tableName",
        },
        ResourceGroupName = "rg1",
        TableName = "tableName",
        Tags = null,
    });
});
package main
import (
	documentdb "github.com/pulumi/pulumi-azure-native-sdk/documentdb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := documentdb.NewTableResourceTable(ctx, "tableResourceTable", &documentdb.TableResourceTableArgs{
			AccountName: pulumi.String("ddb1"),
			Location:    pulumi.String("West US"),
			Options:     nil,
			Resource: &documentdb.TableResourceArgs{
				Id: pulumi.String("tableName"),
			},
			ResourceGroupName: pulumi.String("rg1"),
			TableName:         pulumi.String("tableName"),
			Tags:              nil,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.documentdb.TableResourceTable;
import com.pulumi.azurenative.documentdb.TableResourceTableArgs;
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 tableResourceTable = new TableResourceTable("tableResourceTable", TableResourceTableArgs.builder()        
            .accountName("ddb1")
            .location("West US")
            .options()
            .resource(Map.of("id", "tableName"))
            .resourceGroupName("rg1")
            .tableName("tableName")
            .tags()
            .build());
    }
}
import pulumi
import pulumi_azure_native as azure_native
table_resource_table = azure_native.documentdb.TableResourceTable("tableResourceTable",
    account_name="ddb1",
    location="West US",
    options=azure_native.documentdb.CreateUpdateOptionsArgs(),
    resource=azure_native.documentdb.TableResourceArgs(
        id="tableName",
    ),
    resource_group_name="rg1",
    table_name="tableName",
    tags={})
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const tableResourceTable = new azure_native.documentdb.TableResourceTable("tableResourceTable", {
    accountName: "ddb1",
    location: "West US",
    options: {},
    resource: {
        id: "tableName",
    },
    resourceGroupName: "rg1",
    tableName: "tableName",
    tags: {},
});
resources:
  tableResourceTable:
    type: azure-native:documentdb:TableResourceTable
    properties:
      accountName: ddb1
      location: West US
      options: {}
      resource:
        id: tableName
      resourceGroupName: rg1
      tableName: tableName
      tags: {}
Create TableResourceTable Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TableResourceTable(name: string, args: TableResourceTableArgs, opts?: CustomResourceOptions);@overload
def TableResourceTable(resource_name: str,
                       args: TableResourceTableArgs,
                       opts: Optional[ResourceOptions] = None)
@overload
def TableResourceTable(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       account_name: Optional[str] = None,
                       resource: Optional[TableResourceArgs] = None,
                       resource_group_name: Optional[str] = None,
                       location: Optional[str] = None,
                       options: Optional[CreateUpdateOptionsArgs] = None,
                       table_name: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None)func NewTableResourceTable(ctx *Context, name string, args TableResourceTableArgs, opts ...ResourceOption) (*TableResourceTable, error)public TableResourceTable(string name, TableResourceTableArgs args, CustomResourceOptions? opts = null)
public TableResourceTable(String name, TableResourceTableArgs args)
public TableResourceTable(String name, TableResourceTableArgs args, CustomResourceOptions options)
type: azure-native:documentdb:TableResourceTable
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 TableResourceTableArgs
- 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 TableResourceTableArgs
- 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 TableResourceTableArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TableResourceTableArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TableResourceTableArgs
- 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 tableResourceTableResource = new AzureNative.Documentdb.TableResourceTable("tableResourceTableResource", new()
{
    AccountName = "string",
    Resource = 
    {
        { "id", "string" },
    },
    ResourceGroupName = "string",
    Location = "string",
    Options = 
    {
        { "autoscaleSettings", 
        {
            { "maxThroughput", 0 },
        } },
        { "throughput", 0 },
    },
    TableName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
example, err := documentdb.NewTableResourceTable(ctx, "tableResourceTableResource", &documentdb.TableResourceTableArgs{
	AccountName: "string",
	Resource: map[string]interface{}{
		"id": "string",
	},
	ResourceGroupName: "string",
	Location:          "string",
	Options: map[string]interface{}{
		"autoscaleSettings": map[string]interface{}{
			"maxThroughput": 0,
		},
		"throughput": 0,
	},
	TableName: "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
})
var tableResourceTableResource = new TableResourceTable("tableResourceTableResource", TableResourceTableArgs.builder()
    .accountName("string")
    .resource(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .resourceGroupName("string")
    .location("string")
    .options(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .tableName("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());
table_resource_table_resource = azure_native.documentdb.TableResourceTable("tableResourceTableResource",
    account_name=string,
    resource={
        id: string,
    },
    resource_group_name=string,
    location=string,
    options={
        autoscaleSettings: {
            maxThroughput: 0,
        },
        throughput: 0,
    },
    table_name=string,
    tags={
        string: string,
    })
const tableResourceTableResource = new azure_native.documentdb.TableResourceTable("tableResourceTableResource", {
    accountName: "string",
    resource: {
        id: "string",
    },
    resourceGroupName: "string",
    location: "string",
    options: {
        autoscaleSettings: {
            maxThroughput: 0,
        },
        throughput: 0,
    },
    tableName: "string",
    tags: {
        string: "string",
    },
});
type: azure-native:documentdb:TableResourceTable
properties:
    accountName: string
    location: string
    options:
        autoscaleSettings:
            maxThroughput: 0
        throughput: 0
    resource:
        id: string
    resourceGroupName: string
    tableName: string
    tags:
        string: string
TableResourceTable 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 TableResourceTable resource accepts the following input properties:
- AccountName string
- Cosmos DB database account name.
- Resource
Pulumi.Azure Native. Document DB. Inputs. Table Resource 
- The standard JSON format of a Table
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- Location string
- The location of the resource group to which the resource belongs.
- Options
Pulumi.Azure Native. Document DB. Inputs. Create Update Options 
- A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- TableName string
- Cosmos DB table name.
- Dictionary<string, string>
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- AccountName string
- Cosmos DB database account name.
- Resource
TableResource Args 
- The standard JSON format of a Table
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- Location string
- The location of the resource group to which the resource belongs.
- Options
CreateUpdate Options Args 
- A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- TableName string
- Cosmos DB table name.
- map[string]string
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- accountName String
- Cosmos DB database account name.
- resource
TableResource 
- The standard JSON format of a Table
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- location String
- The location of the resource group to which the resource belongs.
- options
CreateUpdate Options 
- A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- tableName String
- Cosmos DB table name.
- Map<String,String>
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- accountName string
- Cosmos DB database account name.
- resource
TableResource 
- The standard JSON format of a Table
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- location string
- The location of the resource group to which the resource belongs.
- options
CreateUpdate Options 
- A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- tableName string
- Cosmos DB table name.
- {[key: string]: string}
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- account_name str
- Cosmos DB database account name.
- resource
TableResource Args 
- The standard JSON format of a Table
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- location str
- The location of the resource group to which the resource belongs.
- options
CreateUpdate Options Args 
- A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- table_name str
- Cosmos DB table name.
- Mapping[str, str]
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- accountName String
- Cosmos DB database account name.
- resource Property Map
- The standard JSON format of a Table
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- location String
- The location of the resource group to which the resource belongs.
- options Property Map
- A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
- tableName String
- Cosmos DB table name.
- Map<String>
- Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
Outputs
All input properties are implicitly available as output properties. Additionally, the TableResourceTable resource produces the following output properties:
Supporting Types
AutoscaleSettings, AutoscaleSettingsArgs    
- MaxThroughput int
- Represents maximum throughput, the resource can scale up to.
- MaxThroughput int
- Represents maximum throughput, the resource can scale up to.
- maxThroughput Integer
- Represents maximum throughput, the resource can scale up to.
- maxThroughput number
- Represents maximum throughput, the resource can scale up to.
- max_throughput int
- Represents maximum throughput, the resource can scale up to.
- maxThroughput Number
- Represents maximum throughput, the resource can scale up to.
AutoscaleSettingsResponse, AutoscaleSettingsResponseArgs      
- MaxThroughput int
- Represents maximum throughput, the resource can scale up to.
- MaxThroughput int
- Represents maximum throughput, the resource can scale up to.
- maxThroughput Integer
- Represents maximum throughput, the resource can scale up to.
- maxThroughput number
- Represents maximum throughput, the resource can scale up to.
- max_throughput int
- Represents maximum throughput, the resource can scale up to.
- maxThroughput Number
- Represents maximum throughput, the resource can scale up to.
CreateUpdateOptions, CreateUpdateOptionsArgs      
- AutoscaleSettings Pulumi.Azure Native. Document DB. Inputs. Autoscale Settings 
- Specifies the Autoscale settings.
- Throughput int
- Request Units per second. For example, "throughput": 10000.
- AutoscaleSettings AutoscaleSettings 
- Specifies the Autoscale settings.
- Throughput int
- Request Units per second. For example, "throughput": 10000.
- autoscaleSettings AutoscaleSettings 
- Specifies the Autoscale settings.
- throughput Integer
- Request Units per second. For example, "throughput": 10000.
- autoscaleSettings AutoscaleSettings 
- Specifies the Autoscale settings.
- throughput number
- Request Units per second. For example, "throughput": 10000.
- autoscale_settings AutoscaleSettings 
- Specifies the Autoscale settings.
- throughput int
- Request Units per second. For example, "throughput": 10000.
- autoscaleSettings Property Map
- Specifies the Autoscale settings.
- throughput Number
- Request Units per second. For example, "throughput": 10000.
TableGetPropertiesResponseOptions, TableGetPropertiesResponseOptionsArgs          
- AutoscaleSettings Pulumi.Azure Native. Document DB. Inputs. Autoscale Settings Response 
- Specifies the Autoscale settings.
- Throughput int
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- AutoscaleSettings AutoscaleSettings Response 
- Specifies the Autoscale settings.
- Throughput int
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscaleSettings AutoscaleSettings Response 
- Specifies the Autoscale settings.
- throughput Integer
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscaleSettings AutoscaleSettings Response 
- Specifies the Autoscale settings.
- throughput number
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale_settings AutoscaleSettings Response 
- Specifies the Autoscale settings.
- throughput int
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscaleSettings Property Map
- Specifies the Autoscale settings.
- throughput Number
- Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
TableGetPropertiesResponseResource, TableGetPropertiesResponseResourceArgs          
- Etag string
- A system generated property representing the resource etag required for optimistic concurrency control.
- Id string
- Name of the Cosmos DB table
- Rid string
- A system generated property. A unique identifier.
- Ts double
- A system generated property that denotes the last updated timestamp of the resource.
- Etag string
- A system generated property representing the resource etag required for optimistic concurrency control.
- Id string
- Name of the Cosmos DB table
- Rid string
- A system generated property. A unique identifier.
- Ts float64
- A system generated property that denotes the last updated timestamp of the resource.
- etag String
- A system generated property representing the resource etag required for optimistic concurrency control.
- id String
- Name of the Cosmos DB table
- rid String
- A system generated property. A unique identifier.
- ts Double
- A system generated property that denotes the last updated timestamp of the resource.
- etag string
- A system generated property representing the resource etag required for optimistic concurrency control.
- id string
- Name of the Cosmos DB table
- rid string
- A system generated property. A unique identifier.
- ts number
- A system generated property that denotes the last updated timestamp of the resource.
- etag String
- A system generated property representing the resource etag required for optimistic concurrency control.
- id String
- Name of the Cosmos DB table
- rid String
- A system generated property. A unique identifier.
- ts Number
- A system generated property that denotes the last updated timestamp of the resource.
TableResource, TableResourceArgs    
- Id string
- Name of the Cosmos DB table
- Id string
- Name of the Cosmos DB table
- id String
- Name of the Cosmos DB table
- id string
- Name of the Cosmos DB table
- id str
- Name of the Cosmos DB table
- id String
- Name of the Cosmos DB table
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:documentdb:TableResourceTable tableName /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0