Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. documentdb
  5. TableResourceTable
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.documentdb.TableResourceTable

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

An Azure Cosmos DB Table. Azure REST API version: 2023-04-15. Prior API version in Azure Native 1.x: 2021-03-15.

Other available API versions: 2023-03-15-preview, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview, 2024-11-15, 2024-12-01-preview.

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,
    });

});
Copy
package main

import (
	documentdb "github.com/pulumi/pulumi-azure-native-sdk/documentdb/v2"
	"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:     &documentdb.CreateUpdateOptionsArgs{},
			Resource: &documentdb.TableResourceArgs{
				Id: pulumi.String("tableName"),
			},
			ResourceGroupName: pulumi.String("rg1"),
			TableName:         pulumi.String("tableName"),
			Tags:              pulumi.StringMap{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 com.pulumi.azurenative.documentdb.inputs.CreateUpdateOptionsArgs;
import com.pulumi.azurenative.documentdb.inputs.TableResourceArgs;
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(TableResourceArgs.builder()
                .id("tableName")
                .build())
            .resourceGroupName("rg1")
            .tableName("tableName")
            .tags()
            .build());

    }
}
Copy
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: {},
});
Copy
import pulumi
import pulumi_azure_native as azure_native

table_resource_table = azure_native.documentdb.TableResourceTable("tableResourceTable",
    account_name="ddb1",
    location="West US",
    options={},
    resource={
        "id": "tableName",
    },
    resource_group_name="rg1",
    table_name="tableName",
    tags={})
Copy
resources:
  tableResourceTable:
    type: azure-native:documentdb:TableResourceTable
    properties:
      accountName: ddb1
      location: West US
      options: {}
      resource:
        id: tableName
      resourceGroupName: rg1
      tableName: tableName
      tags: {}
Copy

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 This property is required. string
The unique name of the resource.
args This property is required. TableResourceTableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. TableResourceTableArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TableResourceTableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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" },
    },
});
Copy
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",
	},
})
Copy
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());
Copy
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,
    })
Copy
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",
    },
});
Copy
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
Copy

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
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
Resource This property is required. Pulumi.AzureNative.DocumentDB.Inputs.TableResource
The standard JSON format of a Table
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
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.AzureNative.DocumentDB.Inputs.CreateUpdateOptions
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
TableName Changes to this property will trigger replacement. string
Cosmos DB table name.
Tags 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
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
Resource This property is required. TableResourceArgs
The standard JSON format of a Table
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
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 CreateUpdateOptionsArgs
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
TableName Changes to this property will trigger replacement. string
Cosmos DB table name.
Tags 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
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
resource This property is required. TableResource
The standard JSON format of a Table
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
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 CreateUpdateOptions
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
tableName Changes to this property will trigger replacement. String
Cosmos DB table name.
tags 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
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
resource This property is required. TableResource
The standard JSON format of a Table
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
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 CreateUpdateOptions
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
tableName Changes to this property will trigger replacement. string
Cosmos DB table name.
tags {[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
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB database account name.
resource This property is required. TableResourceArgs
The standard JSON format of a Table
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
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 CreateUpdateOptionsArgs
A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
table_name Changes to this property will trigger replacement. str
Cosmos DB table name.
tags 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
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
resource This property is required. Property Map
The standard JSON format of a Table
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
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 Changes to this property will trigger replacement. String
Cosmos DB table name.
tags 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:

Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the ARM resource.
Type string
The type of Azure resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the ARM resource.
Type string
The type of Azure resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the ARM resource.
type String
The type of Azure resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the ARM resource.
type string
The type of Azure resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the ARM resource.
type str
The type of Azure resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the ARM resource.
type String
The type of Azure resource.

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.AzureNative.DocumentDB.Inputs.AutoscaleSettings
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.AzureNative.DocumentDB.Inputs.AutoscaleSettingsResponse
Specifies the Autoscale settings.
Throughput int
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
AutoscaleSettings AutoscaleSettingsResponse
Specifies the Autoscale settings.
Throughput int
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscaleSettings AutoscaleSettingsResponse
Specifies the Autoscale settings.
throughput Integer
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
autoscaleSettings AutoscaleSettingsResponse
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 AutoscaleSettingsResponse
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 This property is required. string
A system generated property representing the resource etag required for optimistic concurrency control.
Id This property is required. string
Name of the Cosmos DB table
Rid This property is required. string
A system generated property. A unique identifier.
Ts This property is required. double
A system generated property that denotes the last updated timestamp of the resource.
Etag This property is required. string
A system generated property representing the resource etag required for optimistic concurrency control.
Id This property is required. string
Name of the Cosmos DB table
Rid This property is required. string
A system generated property. A unique identifier.
Ts This property is required. float64
A system generated property that denotes the last updated timestamp of the resource.
etag This property is required. String
A system generated property representing the resource etag required for optimistic concurrency control.
id This property is required. String
Name of the Cosmos DB table
rid This property is required. String
A system generated property. A unique identifier.
ts This property is required. Double
A system generated property that denotes the last updated timestamp of the resource.
etag This property is required. string
A system generated property representing the resource etag required for optimistic concurrency control.
id This property is required. string
Name of the Cosmos DB table
rid This property is required. string
A system generated property. A unique identifier.
ts This property is required. number
A system generated property that denotes the last updated timestamp of the resource.
etag This property is required. str
A system generated property representing the resource etag required for optimistic concurrency control.
id This property is required. str
Name of the Cosmos DB table
rid This property is required. str
A system generated property. A unique identifier.
ts This property is required. float
A system generated property that denotes the last updated timestamp of the resource.
etag This property is required. String
A system generated property representing the resource etag required for optimistic concurrency control.
id This property is required. String
Name of the Cosmos DB table
rid This property is required. String
A system generated property. A unique identifier.
ts This property is required. Number
A system generated property that denotes the last updated timestamp of the resource.

TableResource
, TableResourceArgs

Id This property is required. string
Name of the Cosmos DB table
Id This property is required. string
Name of the Cosmos DB table
id This property is required. String
Name of the Cosmos DB table
id This property is required. string
Name of the Cosmos DB table
id This property is required. str
Name of the Cosmos DB table
id This property is required. 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/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}
Copy

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

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native