table_resources

Creates, updates, deletes, gets or lists a table_resources resource.

Overview

Name	table_resources
Type	Resource
Id	azure.cosmosdb.table_resources

Fields

The following fields are returned by SELECT queries:

get_table_throughput

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
identity	object	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
resource	object	:vartype resource: ~azure.mgmt.cosmosdb.models.ThroughputSettingsGetPropertiesResource
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	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".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_table_role_definition

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
assignableScopes	array	A set of fully qualified Scopes at or below which Table Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.
permissions	array	The set of operations allowed through this Role Definition.
roleName	string	A user-friendly name for the Role Definition. Must be unique for the database account.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_table_role_assignment

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
principalId	string	The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Table Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
provisioningState	string	Provisioning state of the resource.
roleDefinitionId	string	The unique identifier for the associated Role Definition.
scope	string	The data plane resource path for which access is being granted through this Table Role Assignment.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_tables

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
identity	object	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
options	object	:vartype options: ~azure.mgmt.cosmosdb.models.TableGetPropertiesOptions
resource	object	:vartype resource: ~azure.mgmt.cosmosdb.models.TableGetPropertiesResource
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	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".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_table_throughput	select	resource_group_name, account_name, table_name, subscription_id		Gets the RUs per second of the Table under an existing Azure Cosmos DB database account with the provided name.
get_table_role_definition	select	resource_group_name, account_name, role_definition_id, subscription_id		Retrieves the properties of an existing Azure Cosmos DB Table Role Definition with the given Id.
get_table_role_assignment	select	resource_group_name, account_name, role_assignment_id, subscription_id		Retrieves the properties of an existing Azure Cosmos DB Table Role Assignment with the given Id.
list_tables	select	resource_group_name, account_name, subscription_id		Lists the Tables under an existing Azure Cosmos DB database account.
create_update_table	insert	resource_group_name, account_name, table_name, subscription_id, properties		Create or update an Azure Cosmos DB Table.
create_update_table	replace	resource_group_name, account_name, table_name, subscription_id, properties		Create or update an Azure Cosmos DB Table.
delete_table	delete	resource_group_name, account_name, table_name, subscription_id		Deletes an existing Azure Cosmos DB Table.
list_table_role_definitions	exec	resource_group_name, account_name, subscription_id		Retrieves the list of all Azure Cosmos DB Table Role Definitions.
list_table_role_assignments	exec	resource_group_name, account_name, subscription_id		Retrieves the list of all Azure Cosmos DB Table Role Assignments.
update_table_throughput	exec	resource_group_name, account_name, table_name, subscription_id, properties		Update RUs per second of an Azure Cosmos DB Table.
get_table	exec	resource_group_name, account_name, table_name, subscription_id		Gets the Tables under an existing Azure Cosmos DB database account with the provided name.
create_update_table_role_definition	exec	resource_group_name, account_name, role_definition_id, subscription_id		Creates or updates an Azure Cosmos DB Table Role Definition.
delete_table_role_definition	exec	resource_group_name, account_name, role_definition_id, subscription_id		Deletes an existing Azure Cosmos DB Table Role Definition.
create_update_table_role_assignment	exec	resource_group_name, account_name, role_assignment_id, subscription_id		Creates or updates an Azure Cosmos DB Table Role Assignment.
delete_table_role_assignment	exec	resource_group_name, account_name, role_assignment_id, subscription_id		Deletes an existing Azure Cosmos DB Table Role Assignment.
migrate_table_to_autoscale	exec	resource_group_name, account_name, table_name, subscription_id		Migrate an Azure Cosmos DB Table from manual throughput to autoscale.
migrate_table_to_manual_throughput	exec	resource_group_name, account_name, table_name, subscription_id		Migrate an Azure Cosmos DB Table from autoscale to manual throughput.
retrieve_continuous_backup_information	exec	resource_group_name, account_name, table_name, subscription_id		Retrieves continuous backup information for a table.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_name	string	Cosmos DB database account name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
role_assignment_id	string	The GUID for the Role Assignment. Required.
role_definition_id	string	The GUID for the Role Definition. Required.
subscription_id	string
table_name	string	Cosmos DB table name. Required.

SELECT examples

get_table_throughput

Gets the RUs per second of the Table under an existing Azure Cosmos DB database account with the provided name.

SELECT
id,
name,
identity,
location,
resource,
systemData,
tags,
type
FROM azure.cosmosdb.table_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND table_name = '{{ table_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_table_role_definition

Retrieves the properties of an existing Azure Cosmos DB Table Role Definition with the given Id.

SELECT
id,
name,
assignableScopes,
permissions,
roleName,
systemData,
type
FROM azure.cosmosdb.table_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND role_definition_id = '{{ role_definition_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_table_role_assignment

Retrieves the properties of an existing Azure Cosmos DB Table Role Assignment with the given Id.

SELECT
id,
name,
principalId,
provisioningState,
roleDefinitionId,
scope,
systemData,
type
FROM azure.cosmosdb.table_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND role_assignment_id = '{{ role_assignment_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_tables

Lists the Tables under an existing Azure Cosmos DB database account.

SELECT
id,
name,
identity,
location,
options,
resource,
systemData,
tags,
type
FROM azure.cosmosdb.table_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_update_table

Create or update an Azure Cosmos DB Table.

INSERT INTO azure.cosmosdb.table_resources (
location,
tags,
identity,
properties,
resource_group_name,
account_name,
table_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ identity }}',
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ table_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: table_resources
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the table_resources resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the table_resources resource.
  - name: table_name
    value: "{{ table_name }}"
    description: Required parameter for the table_resources resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the table_resources resource.
  - name: location
    value: "{{ location }}"
    description: |
      The location of the resource group to which the resource belongs.
  - name: tags
    value: "{{ tags }}"
    description: |
      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".
  - name: identity
    description: |
      Identity for the resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: properties
    description: |
      Properties to create and update Azure Cosmos DB Table. Required.
    value:
      resource:
        id: "{{ id }}"
        restoreParameters:
          restoreSource: "{{ restoreSource }}"
          restoreTimestampInUtc: "{{ restoreTimestampInUtc }}"
          restoreWithTtlDisabled: {{ restoreWithTtlDisabled }}
        createMode: "{{ createMode }}"
      options:
        throughput: {{ throughput }}
        autoscaleSettings:
          maxThroughput: {{ maxThroughput }}

REPLACE examples

create_update_table

Create or update an Azure Cosmos DB Table.

REPLACE azure.cosmosdb.table_resources
SET 
location = '{{ location }}',
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND table_name = '{{ table_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete_table

Deletes an existing Azure Cosmos DB Table.

DELETE FROM azure.cosmosdb.table_resources
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND table_name = '{{ table_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_table_role_definitions

Retrieves the list of all Azure Cosmos DB Table Role Definitions.

EXEC azure.cosmosdb.table_resources.list_table_role_definitions 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_table_role_assignments

Retrieves the list of all Azure Cosmos DB Table Role Assignments.

EXEC azure.cosmosdb.table_resources.list_table_role_assignments 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_table_throughput

Update RUs per second of an Azure Cosmos DB Table.

EXEC azure.cosmosdb.table_resources.update_table_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@table_name='{{ table_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;

get_table

Gets the Tables under an existing Azure Cosmos DB database account with the provided name.

EXEC azure.cosmosdb.table_resources.get_table 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@table_name='{{ table_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_update_table_role_definition

Creates or updates an Azure Cosmos DB Table Role Definition.

EXEC azure.cosmosdb.table_resources.create_update_table_role_definition 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@role_definition_id='{{ role_definition_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete_table_role_definition

Deletes an existing Azure Cosmos DB Table Role Definition.

EXEC azure.cosmosdb.table_resources.delete_table_role_definition 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@role_definition_id='{{ role_definition_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_update_table_role_assignment

Creates or updates an Azure Cosmos DB Table Role Assignment.

EXEC azure.cosmosdb.table_resources.create_update_table_role_assignment 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@role_assignment_id='{{ role_assignment_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete_table_role_assignment

Deletes an existing Azure Cosmos DB Table Role Assignment.

EXEC azure.cosmosdb.table_resources.delete_table_role_assignment 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@role_assignment_id='{{ role_assignment_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

migrate_table_to_autoscale

Migrate an Azure Cosmos DB Table from manual throughput to autoscale.

EXEC azure.cosmosdb.table_resources.migrate_table_to_autoscale 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@table_name='{{ table_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

migrate_table_to_manual_throughput

Migrate an Azure Cosmos DB Table from autoscale to manual throughput.

EXEC azure.cosmosdb.table_resources.migrate_table_to_manual_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@table_name='{{ table_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

retrieve_continuous_backup_information

Retrieves continuous backup information for a table.

EXEC azure.cosmosdb.table_resources.retrieve_continuous_backup_information 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@table_name='{{ table_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}"
}'
;